Flash

Alpha
Review pending by accessibility team

Source

On this page

import {Flash} from '@primer/react'

The Flash component informs users of successful or pending actions.

Examples

Default

<>
  <Flash>Default Flash</Flash>
  <Flash variant="success">Success Flash</Flash>
  <Flash variant="warning">Warning Flash</Flash>
  <Flash variant="danger">Danger Flash</Flash>
</>

<>
  <Flash>Default Flash</Flash>
  <Flash variant="success">Success Flash</Flash>
  <Flash variant="warning">Warning Flash</Flash>
  <Flash variant="danger">Danger Flash</Flash>
</>

With an icon

Flash components with icons inside of them will automatically set the correct color for the icon depending on the type of Flash, as well as applying the correct right margin.

<Flash variant="success">
  <StyledOcticon icon={CheckIcon} />
  Success!
</Flash>

<Flash variant="success">
  <StyledOcticon icon={CheckIcon} />
  Success!
</Flash>

Props

Flash

Name	Type	Default	Description
full	boolean	false	Creates a full width Flash component
variant	'default' \| 'success' \| 'warning' \| 'danger'	'default'	Sets the background color and border
sx	SystemStyleObject		Style overrides to apply to the component. See also overriding styles.
as	React.ElementType	"div"	The underlying element to render — either a HTML element name or a React component.
ref	React.RefObject<HTMLDivElement>		A ref to the element rendered by this component. Because this component is polymorphic, the type will vary based on the value of the `as` prop.
Additional props are passed to the `<div>` element. See MDN for a list of props accepted by the `<div>` element. If an `as` prop is specified, the accepted props will change accordingly.

Status

Alpha

Component props are documented on primer.style/react.
Component does not have any unnecessary third-party dependencies.
Component can adapt to different themes.
Component can adapt to different screen sizes.
Component has 100% test coverage.

Beta

Component is used in a production application.
Common usage examples are documented on primer.style/react.
Common usage examples are documented in storybook stories.
Component has been reviewed by a systems designer and any resulting issues have been addressed.
Component has been manually reviewed by the accessibility team and any resulting issues have been addressed.

Stable

Component API has been stable with no breaking changes for at least one month.
Feedback on API usability has been sought from developers using the component and any resulting issues have been addressed.
Component has corresponding design guidelines documented in the interface guidelines.
Component has corresponding Figma component in the Primer Web library.

Edit this page on GitHub

1 contributor

Last edited by colebemis on December 17, 2021