Package Exports
- @workday/canvas-kit-react-status-indicator
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@workday/canvas-kit-react-status-indicator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Canvas Kit Status Indicator
A component showing a status indicator of a given type, emphasis and label.
Installation
yarn add @workday/canvas-kit-react
or
yarn add @workday/canvas-kit-react-status-indicator
Usage
import * as React from 'react';
import {StatusIndicator} from '@workday/canvas-kit-react-status-indicator';
<StatusIndicator type={StatusIndicator.Type.Orange} label={'Status'} />;
Static Properties
Type: StatusType
<StatusIndicator type={StatusIndicator.Type.Red} label={'Status'} />
Emphasis: StatusEmphasis
<StatusIndicator
type={StatusIndicator.Type.Red}
emphasis={StatusIndicator.Emphasis.Low}
label={'Status'}
/>
Component Props
Required
type: StatusType
Type of status indicator. The Canvas system has predefined types that are meant to indicate various kinds of statuses.
label: string
Text of the status message.
Optional
emphasis: StatusEmphasis
Emphasis of status indicator. Currently supports High(default) and Low emphasis.
icon: CanvasSystemIcon
Icon to be used with the label text.