Flash
Use flash component to inform users of successful or pending actions.
- Alpha
- Not reviewed for accessibility
import {Flash} from '@primer/react'
The Flash component informs users of successful or pending actions.
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.
| 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 |
| 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. | |
| as | React.ElementType | "div" | The underlying element to render — either a HTML element name or a React component. |
| sx | SystemStyleObject | Style overrides to apply to the component. See also overriding styles. |