Spectrum 2 is now available! Check out the S2 InlineAlert docs and the migration docs.

InlineAlert

Inline alerts display a non-modal message associated with objects in a view. These are often used in form validation, providing a place to aggregate feedback related to multiple fields.

install	`yarn add @adobe/react-spectrum`
added	3.29.0
usage	`import {InlineAlert} from '@adobe/react-spectrum'`

View guidelines

Example#

<InlineAlert>
  <Heading>Payment Information</Heading>
  <Content>
    Enter your billing address, shipping address, and payment method to
    complete your purchase.
  </Content>
</InlineAlert>

<InlineAlert>
  <Heading>Payment Information</Heading>
  <Content>
    Enter your billing address, shipping address, and
    payment method to complete your purchase.
  </Content>
</InlineAlert>

<InlineAlert>
  <Heading>
    Payment Information
  </Heading>
  <Content>
    Enter your billing
    address, shipping
    address, and
    payment method to
    complete your
    purchase.
  </Content>
</InlineAlert>

Content#

Inline alerts contain a title and body. They also include an icon for non-neutral variants.

<InlineAlert variant="positive">
  <Heading>Payment Information</Heading>
  <Content>
    Enter your billing address, shipping address, and payment method to
    complete your purchase.
  </Content>
</InlineAlert>

<InlineAlert variant="positive">
  <Heading>Payment Information</Heading>
  <Content>
    Enter your billing address, shipping address, and
    payment method to complete your purchase.
  </Content>
</InlineAlert>

<InlineAlert variant="positive">
  <Heading>
    Payment Information
  </Heading>
  <Content>
    Enter your billing
    address, shipping
    address, and
    payment method to
    complete your
    purchase.
  </Content>
</InlineAlert>

Accessibility#

Inline alerts are given the alert role, which means they should only be used for information that requires the user's immediate attention.

Internationalization#

To internationalize an InlineAlert, localized strings should be set as the title and body content of the InlineAlert. For languages that are read right-to-left (e.g. Hebrew and Arabic), the InlineAlert is automatically flipped.

Props#

Name	Type	Default	Description
`children`	`ReactNode`	—	The contents of the Inline Alert.
`variant`	`'neutral' \| 'info' \| 'positive' \| 'notice' \| 'negative'`	`'neutral'`	The visual style of the Inline Alert.
`autoFocus`	`boolean`	—	Whether to automatically focus the Inline Alert when it first renders.

Layout

Name	Type	Description
`flex`	`Responsive<string \| number \| boolean>`	When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
`flexGrow`	`Responsive<number>`	When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
`flexShrink`	`Responsive<number>`	When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
`flexBasis`	`Responsive<number \| string>`	When used in a flex layout, specifies the initial main size of the element. See MDN.
`alignSelf`	`Responsive<'auto' \| 'normal' \| 'start' \| 'end' \| 'center' \| 'flex-start' \| 'flex-end' \| 'self-start' \| 'self-end' \| 'stretch'>`	Overrides the `alignItems` property of a flex or grid container. See MDN.
`justifySelf`	`Responsive<'auto' \| 'normal' \| 'start' \| 'end' \| 'flex-start' \| 'flex-end' \| 'self-start' \| 'self-end' \| 'center' \| 'left' \| 'right' \| 'stretch'>`	Specifies how the element is justified inside a flex or grid container. See MDN.
`order`	`Responsive<number>`	The layout order for the element within a flex or grid container. See MDN.
`gridArea`	`Responsive<string>`	When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
`gridColumn`	`Responsive<string>`	When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
`gridRow`	`Responsive<string>`	When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
`gridColumnStart`	`Responsive<string>`	When used in a grid layout, specifies the starting column to span within the grid. See MDN.
`gridColumnEnd`	`Responsive<string>`	When used in a grid layout, specifies the ending column to span within the grid. See MDN.
`gridRowStart`	`Responsive<string>`	When used in a grid layout, specifies the starting row to span within the grid. See MDN.
`gridRowEnd`	`Responsive<string>`	When used in a grid layout, specifies the ending row to span within the grid. See MDN.

Spacing

Name	Type	Description
`margin`	`Responsive<DimensionValue>`	The margin for all four sides of the element. See MDN.
`marginTop`	`Responsive<DimensionValue>`	The margin for the top side of the element. See MDN.
`marginBottom`	`Responsive<DimensionValue>`	The margin for the bottom side of the element. See MDN.
`marginStart`	`Responsive<DimensionValue>`	The margin for the logical start side of the element, depending on layout direction. See MDN.
`marginEnd`	`Responsive<DimensionValue>`	The margin for the logical end side of an element, depending on layout direction. See MDN.
`marginX`	`Responsive<DimensionValue>`	The margin for both the left and right sides of the element. See MDN.
`marginY`	`Responsive<DimensionValue>`	The margin for both the top and bottom sides of the element. See MDN.

Sizing

Name	Type	Description
`width`	`Responsive<DimensionValue>`	The width of the element. See MDN.
`minWidth`	`Responsive<DimensionValue>`	The minimum width of the element. See MDN.
`maxWidth`	`Responsive<DimensionValue>`	The maximum width of the element. See MDN.
`height`	`Responsive<DimensionValue>`	The height of the element. See MDN.
`minHeight`	`Responsive<DimensionValue>`	The minimum height of the element. See MDN.
`maxHeight`	`Responsive<DimensionValue>`	The maximum height of the element. See MDN.

Positioning

Name	Type	Description
`position`	`Responsive<'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky'>`	Specifies how the element is positioned. See MDN.
`top`	`Responsive<DimensionValue>`	The top position for the element. See MDN.
`bottom`	`Responsive<DimensionValue>`	The bottom position for the element. See MDN.
`left`	`Responsive<DimensionValue>`	The left position for the element. See MDN. Consider using `start` instead for RTL support.
`right`	`Responsive<DimensionValue>`	The right position for the element. See MDN. Consider using `start` instead for RTL support.
`start`	`Responsive<DimensionValue>`	The logical start position for the element, depending on layout direction. See MDN.
`end`	`Responsive<DimensionValue>`	The logical end position for the element, depending on layout direction. See MDN.
`zIndex`	`Responsive<number>`	The stacking order for the element. See MDN.
`isHidden`	`Responsive<boolean>`	Hides the element.

Accessibility

Name	Type	Description
`id`	`string`	The element's unique identifier. See MDN.

Advanced

Name	Type	Description
`UNSAFE_className`	`string`	Sets the CSS className for the element. Only use as a last resort. Use style props instead.
`UNSAFE_style`	`CSSProperties`	Sets inline style for the element. Only use as a last resort. Use style props instead.

Visual options#

Variant#

View guidelines

When inline alerts have a semantic meaning, they should use the appropriate variant. The default variant is neutral, and should be used when the message is neutral in tone or when its semantics do not fit any of the other variants.

Informative#

<InlineAlert variant="info">
  <Heading>Accepted Payment Methods</Heading>
  <Content>
    Only major credit cards are accepted for payment. Direct debit is
    currently unavailable.
  </Content>
</InlineAlert>

<InlineAlert variant="info">
  <Heading>Accepted Payment Methods</Heading>
  <Content>
    Only major credit cards are accepted for payment.
    Direct debit is currently unavailable.
  </Content>
</InlineAlert>

<InlineAlert variant="info">
  <Heading>
    Accepted Payment
    Methods
  </Heading>
  <Content>
    Only major credit
    cards are accepted
    for payment. Direct
    debit is currently
    unavailable.
  </Content>
</InlineAlert>

Positive#

<InlineAlert variant="positive">
  <Heading>Purchase completed</Heading>
  <Content>
    You'll get a confirmation email with your order details shortly.
  </Content>
</InlineAlert>

<InlineAlert variant="positive">
  <Heading>Purchase completed</Heading>
  <Content>
    You'll get a confirmation email with your order
    details shortly.
  </Content>
</InlineAlert>

<InlineAlert variant="positive">
  <Heading>
    Purchase completed
  </Heading>
  <Content>
    You'll get a
    confirmation email
    with your order
    details shortly.
  </Content>
</InlineAlert>

Notice#

<InlineAlert variant="notice">
  <Heading>Update payment information</Heading>
  <Content>
    The saved credit card for your account has expired. Update your payment
    information to complete the purchase.
  </Content>
</InlineAlert>

<InlineAlert variant="notice">
  <Heading>Update payment information</Heading>
  <Content>
    The saved credit card for your account has expired.
    Update your payment information to complete the
    purchase.
  </Content>
</InlineAlert>

<InlineAlert variant="notice">
  <Heading>
    Update payment
    information
  </Heading>
  <Content>
    The saved credit
    card for your
    account has
    expired. Update
    your payment
    information to
    complete the
    purchase.
  </Content>
</InlineAlert>

Negative#

<InlineAlert variant="negative">
  <Heading>Unable to process payment</Heading>
  <Content>
    There was an error processing your payment. Please check that your credit
    card information is correct, then try again.
  </Content>
</InlineAlert>

<InlineAlert variant="negative">
  <Heading>Unable to process payment</Heading>
  <Content>
    There was an error processing your payment. Please
    check that your credit card information is correct,
    then try again.
  </Content>
</InlineAlert>

<InlineAlert variant="negative">
  <Heading>
    Unable to process
    payment
  </Heading>
  <Content>
    There was an error
    processing your
    payment. Please
    check that your
    credit card
    information is
    correct, then try
    again.
  </Content>
</InlineAlert>