StatusLight
Status lights are used to color code categories and labels commonly found in data visualization. When status lights have a semantic meaning, they should use semantic variant colors.
install | yarn add @react-spectrum/statuslight |
---|---|
version | 3.0.0-rc.2 |
usage | import {StatusLight} from '@react-spectrum/statuslight' |
Example#
<StatusLight variant="positive">Ready</StatusLight>
<StatusLight variant="positive">Ready</StatusLight>
<StatusLight variant="positive">
Ready
</StatusLight>
Content#
A visible label is always required and can be provided by passing children. To indicate status, use the variant prop.
<StatusLight variant="positive">Semantic color</StatusLight>
<StatusLight variant="yellow">Label color</StatusLight>
<StatusLight variant="positive">Semantic color</StatusLight>
<StatusLight variant="yellow">Label color</StatusLight>
<StatusLight variant="positive">
Semantic color
</StatusLight>
<StatusLight variant="yellow">
Label color
</StatusLight>
Accessibility#
If a visible label isn't specified, an aria-label
must be provided for accessibility. If the StatusLight is labeled by a separate element, an aria-labelledby
prop must be provided using the id of the labeling element instead.
In cases where the status changes at runtime, it may be appropriate to add role="status"
so that the status change will be announced politely by assistive technology.
Internationalization#
To internationalize a StatusLight, a localized string should be set as the child content of the StatusLight. For languages that are read right-to-left (e.g. Hebrew and Arabic), the StatusLight is automatically flipped.
Props#
Name | Type | Default | Description |
children | ReactNode | — | The content to display as the label. |
variant | 'positive'
| 'negative'
| 'notice'
| 'info'
| 'neutral'
| 'celery'
| 'chartreuse'
| 'yellow'
| 'magenta'
| 'fuchsia'
| 'purple'
| 'indigo'
| 'seafoam' | — | The variant changes the color of the status light. When status lights have a semantic meaning, they should use the variant for semantic colors. |
isDisabled | boolean | — | Whether the status light is disabled. |
UNSAFE_className | string | — | |
UNSAFE_style | CSSProperties | — |
Layout
Name | Type | Default | Description |
flex | string | number | boolean | — | |
flexGrow | number | — | |
flexShrink | number | — | |
flexBasis | number | string | — | |
alignSelf | 'auto'
| 'normal'
| 'start'
| 'end'
| 'flex-start'
| 'flex-end'
| 'self-start'
| 'self-end'
| 'center'
| 'stretch' | — | |
justifySelf | 'auto'
| 'normal'
| 'start'
| 'end'
| 'flex-start'
| 'flex-end'
| 'self-start'
| 'self-end'
| 'center'
| 'left'
| 'right'
| 'stretch' | — | |
flexOrder | number | — | |
gridArea | string | — | |
gridColumn | string | — | |
gridRow | string | — | |
gridColumnStart | string | — | |
gridColumnEnd | string | — | |
gridRowStart | string | — | |
gridRowEnd | string | — |
Spacing
Name | Type | Default | Description |
margin | DimensionValue | — | |
marginTop | DimensionValue | — | |
marginLeft | DimensionValue | — | |
marginRight | DimensionValue | — | |
marginBottom | DimensionValue | — | |
marginStart | DimensionValue | — | |
marginEnd | DimensionValue | — | |
marginX | DimensionValue | — | |
marginY | DimensionValue | — |
Sizing
Name | Type | Default | Description |
width | DimensionValue | — | |
minWidth | DimensionValue | — | |
maxWidth | DimensionValue | — | |
height | DimensionValue | — | |
minHeight | DimensionValue | — | |
maxHeight | DimensionValue | — |
Positioning
Name | Type | Default | Description |
position | 'static'
| 'relative'
| 'absolute'
| 'fixed'
| 'sticky' | — | |
top | DimensionValue | — | |
bottom | DimensionValue | — | |
left | DimensionValue | — | |
right | DimensionValue | — | |
start | DimensionValue | — | |
end | DimensionValue | — | |
zIndex | number | — | |
isHidden | boolean | — |
Accessibility
Name | Type | Default | Description |
role | 'status' | — | An accessibility role for the status light. Should be set when the status can change at runtime, and no more than one status light will update simultaneously. For cases where multiple statuses can change at the same time, use a Toast instead. |
id | string | — |
Visual options#
Variant#
When status lights have a semantic meaning, they should use semantic colors. Use the appropriate color to indicate status as follows.
<StatusLight variant="neutral">
Gray: Archived, Deleted, Paused, Draft, Not Started, Ended
</StatusLight>
<StatusLight variant="positive">
Green: Approved, Complete, Success, New, Purchased, Licensed
</StatusLight>
<StatusLight variant="notice">
Orange: Needs Approval, Pending, Scheduled, Syncing, Indexing, Processing
</StatusLight>
<StatusLight variant="negative">
Red: Error, Alert, Rejected, Failed
</StatusLight>
<StatusLight variant="info">
Blue: Active, In Use, Live, Published
</StatusLight>
<StatusLight variant="neutral">
Gray: Archived, Deleted, Paused, Draft, Not Started,
Ended
</StatusLight>
<StatusLight variant="positive">
Green: Approved, Complete, Success, New, Purchased,
Licensed
</StatusLight>
<StatusLight variant="notice">
Orange: Needs Approval, Pending, Scheduled, Syncing,
Indexing, Processing
</StatusLight>
<StatusLight variant="negative">
Red: Error, Alert, Rejected, Failed
</StatusLight>
<StatusLight variant="info">
Blue: Active, In Use, Live, Published
</StatusLight>
<StatusLight variant="neutral">
Gray: Archived,
Deleted, Paused,
Draft, Not Started,
Ended
</StatusLight>
<StatusLight variant="positive">
Green: Approved,
Complete, Success,
New, Purchased,
Licensed
</StatusLight>
<StatusLight variant="notice">
Orange: Needs
Approval, Pending,
Scheduled, Syncing,
Indexing, Processing
</StatusLight>
<StatusLight variant="negative">
Red: Error, Alert,
Rejected, Failed
</StatusLight>
<StatusLight variant="info">
Blue: Active, In Use,
Live, Published
</StatusLight>
When status lights are used to color code categories and labels commonly found in data visualization, they use label colors. The ideal usage for these is when there are 8 or fewer categories or labels being color coded. Use them in the following order to ensure the greatest possible color differences for multiple forms of color blindness:
<StatusLight variant="indigo">Indigo</StatusLight>
<StatusLight variant="celery">Celery</StatusLight>
<StatusLight variant="magenta">Magenta</StatusLight>
<StatusLight variant="yellow">Yellow</StatusLight>
<StatusLight variant="fuchsia">Fuchsia</StatusLight>
<StatusLight variant="seafoam">Seafoam</StatusLight>
<StatusLight variant="chartreuse">Chartreuse</StatusLight>
<StatusLight variant="purple">Purple</StatusLight>
<StatusLight variant="indigo">Indigo</StatusLight>
<StatusLight variant="celery">Celery</StatusLight>
<StatusLight variant="magenta">Magenta</StatusLight>
<StatusLight variant="yellow">Yellow</StatusLight>
<StatusLight variant="fuchsia">Fuchsia</StatusLight>
<StatusLight variant="seafoam">Seafoam</StatusLight>
<StatusLight variant="chartreuse">Chartreuse</StatusLight>
<StatusLight variant="purple">Purple</StatusLight>
<StatusLight variant="indigo">
Indigo
</StatusLight>
<StatusLight variant="celery">
Celery
</StatusLight>
<StatusLight variant="magenta">
Magenta
</StatusLight>
<StatusLight variant="yellow">
Yellow
</StatusLight>
<StatusLight variant="fuchsia">
Fuchsia
</StatusLight>
<StatusLight variant="seafoam">
Seafoam
</StatusLight>
<StatusLight variant="chartreuse">
Chartreuse
</StatusLight>
<StatusLight variant="purple">
Purple
</StatusLight>
Disabled#
Use the isDisabled
prop to match the state of a containing element.
Note that the isDisabled
prop alters the visual style of the StatusLight,
but does not convey any state information to assistive technology.
<StatusLight variant="yellow" isDisabled >Yellow</StatusLight>
<StatusLight variant="yellow" isDisabled>
Yellow
</StatusLight>
<StatusLight
variant="yellow"
isDisabled>
Yellow
</StatusLight>