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.2.6
usage	`import {StatusLight} from '@react-spectrum/statuslight'`

View guidelines

Spectrum

Example#

<StatusLight variant="positive">Ready</StatusLight>

<StatusLight variant="positive">Ready</StatusLight>

<StatusLight variant="positive">
  Ready
</StatusLight>

Content#

A visible label 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
`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.
`children`	`ReactNode`	—	The content to display as the label.
`isDisabled`	`boolean`	—	Whether the status light is disabled.

Layout

Name	Type	Default	Description
`flex`	`Responsive<string \| number \| boolean>`	—	When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
`flexGrow`	`Responsive<number>`	—	When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
`flexShrink`	`Responsive<number>`	—	When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
`flexBasis`	`Responsive<number \| string>`	—	When used in a flex layout, specifies the initial main size of the element. See MDN.
`alignSelf`	`Responsive<'auto' \| 'normal' \| 'start' \| 'end' \| 'center' \| 'flex-start' \| 'flex-end' \| 'self-start' \| 'self-end' \| 'stretch'>`	—	Overrides the `alignItems` property of a flex or grid container. See MDN.
`justifySelf`	`Responsive<'auto' \| 'normal' \| 'start' \| 'end' \| 'flex-start' \| 'flex-end' \| 'self-start' \| 'self-end' \| 'center' \| 'left' \| 'right' \| 'stretch'>`	—	Specifies how the element is justified inside a flex or grid container. See MDN.
`order`	`Responsive<number>`	—	The layout order for the element within a flex or grid container. See MDN.
`gridArea`	`Responsive<string>`	—	When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
`gridColumn`	`Responsive<string>`	—	When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
`gridRow`	`Responsive<string>`	—	When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
`gridColumnStart`	`Responsive<string>`	—	When used in a grid layout, specifies the starting column to span within the grid. See MDN.
`gridColumnEnd`	`Responsive<string>`	—	When used in a grid layout, specifies the ending column to span within the grid. See MDN.
`gridRowStart`	`Responsive<string>`	—	When used in a grid layout, specifies the starting row to span within the grid. See MDN.
`gridRowEnd`	`Responsive<string>`	—	When used in a grid layout, specifies the ending row to span within the grid. See MDN.

Spacing

Name	Type	Default	Description
`margin`	`Responsive<DimensionValue>`	—	The margin for all four sides of the element. See MDN.
`marginTop`	`Responsive<DimensionValue>`	—	The margin for the top side of the element. See MDN.
`marginBottom`	`Responsive<DimensionValue>`	—	The margin for the bottom side of the element. See MDN.
`marginStart`	`Responsive<DimensionValue>`	—	The margin for the logical start side of the element, depending on layout direction. See MDN.
`marginEnd`	`Responsive<DimensionValue>`	—	The margin for the logical end side of an element, depending on layout direction. See MDN.
`marginX`	`Responsive<DimensionValue>`	—	The margin for both the left and right sides of the element. See MDN.
`marginY`	`Responsive<DimensionValue>`	—	The margin for both the top and bottom sides of the element. See MDN.

Sizing

Name	Type	Default	Description
`width`	`Responsive<DimensionValue>`	—	The width of the element. See MDN.
`minWidth`	`Responsive<DimensionValue>`	—	The minimum width of the element. See MDN.
`maxWidth`	`Responsive<DimensionValue>`	—	The maximum width of the element. See MDN.
`height`	`Responsive<DimensionValue>`	—	The height of the element. See MDN.
`minHeight`	`Responsive<DimensionValue>`	—	The minimum height of the element. See MDN.
`maxHeight`	`Responsive<DimensionValue>`	—	The maximum height of the element. See MDN.

Positioning

Name	Type	Default	Description
`position`	`Responsive<'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky'>`	—	Specifies how the element is positioned. See MDN.
`top`	`Responsive<DimensionValue>`	—	The top position for the element. See MDN.
`bottom`	`Responsive<DimensionValue>`	—	The bottom position for the element. See MDN.
`left`	`Responsive<DimensionValue>`	—	The left position for the element. See MDN. Consider using `start` instead for RTL support.
`right`	`Responsive<DimensionValue>`	—	The right position for the element. See MDN. Consider using `start` instead for RTL support.
`start`	`Responsive<DimensionValue>`	—	The logical start position for the element, depending on layout direction. See MDN.
`end`	`Responsive<DimensionValue>`	—	The logical end position for the element, depending on layout direction. See MDN.
`zIndex`	`Responsive<number>`	—	The stacking order for the element. See MDN.
`isHidden`	`Responsive<boolean>`	—	Hides the element.

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`	—	The element's unique identifier. See MDN.

Advanced

Name	Type	Default	Description
`UNSAFE_className`	`string`	—	Sets the CSS className for the element. Only use as a last resort. Use style props instead.
`UNSAFE_style`	`CSSProperties`	—	Sets inline style for the element. Only use as a last resort. Use style props instead.

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>