import {Flash} from '@primer/react'
The Flash component informs users of successful or pending actions.
<><Flash>Default Flash</Flash><Flash variant="success">Success Flash</Flash><Flash variant="warning">Warning Flash</Flash><Flash variant="danger">Danger Flash</Flash></>
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>
| 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. | |||