Info alert:Beta feature
This beta component is currently under review and is still open for further evolution. It is available for use in product. Beta components are considered for promotion on a quarterly basis. Please join in and give us your feedback or submit any questions on the PatternFly forum or via Slack. To learn more about the process, visit our about page or our Beta components page on GitHub.
The status component's purpose is to display status with icon and text to the user.
Basic status
Status component consinsts of an icon configured using icon and a message, specified with label.
Warning
Status with description
Optionally a description can be displayed by passing it to the description property.
Warning
1 issue foundIcon only status
The iconOnly flag allows to hide the status message and show only an icon with a tooltip.
Props
Status
| Name | Type | Default | Description |
|---|---|---|---|
| statusrequired | IconStatus | Status to control icon color | |
| description | string | Description to be displayed under the label | |
| icon | React.ReactElement | Status icon | |
| iconOnly | boolean | If true, only displays icon | |
| iconTitle | string | Icon title for accessibility | |
| label | string | Status label text | |
| onClick | (event: React.MouseEvent<HTMLElement, MouseEvent>) => void | Optional link variant onClick callback | |
| ouiaId | string | number | 'Status' | Custom OUIA ID |
| popoverProps | PopoverProps | Props for the optional popover | |
| variant | StatusVariant | 'plain' | Variant of the status component to be displayed |
