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.

installyarn add @react-spectrum/statuslight
version3.0.0-rc.2
usageimport {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#


NameTypeDefaultDescription
childrenReactNodeThe 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.
isDisabledbooleanWhether the status light is disabled.
UNSAFE_classNamestring
UNSAFE_styleCSSProperties
Layout
NameTypeDefaultDescription
flexstringnumberboolean
flexGrownumber
flexShrinknumber
flexBasisnumberstring
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'
flexOrdernumber
gridAreastring
gridColumnstring
gridRowstring
gridColumnStartstring
gridColumnEndstring
gridRowStartstring
gridRowEndstring
Spacing
NameTypeDefaultDescription
marginDimensionValue
marginTopDimensionValue
marginLeftDimensionValue
marginRightDimensionValue
marginBottomDimensionValue
marginStartDimensionValue
marginEndDimensionValue
marginXDimensionValue
marginYDimensionValue
Sizing
NameTypeDefaultDescription
widthDimensionValue
minWidthDimensionValue
maxWidthDimensionValue
heightDimensionValue
minHeightDimensionValue
maxHeightDimensionValue
Positioning
NameTypeDefaultDescription
position'static' | 'relative' | 'absolute' | 'fixed' | 'sticky'
topDimensionValue
bottomDimensionValue
leftDimensionValue
rightDimensionValue
startDimensionValue
endDimensionValue
zIndexnumber
isHiddenboolean
Accessibility
NameTypeDefaultDescription
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.
idstring

Visual options#


Variant#

View guidelines

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#

View guidelines

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>