Skip to main content

Status Indicator

v.5.0.0

Installation

yarn add @mercell/status-indicator-react

Usage

Using the Status Indicator component is as simple as importing it like this.

import { StatusIndicator } from '@mercell/status-indicator-react';
Live Editor
Result

Types, definitions, etc.

StatusIndicatorProps
interface StatusIndicatorProps {
scheme: FunctionScheme<'waiting' | 'inactive'>;
small?: boolean;
Icon?: CarbonIconType;
} & JSX.IntrinsicElements['div']

type FunctionScheme<T = ''> =
| 'information'
| 'success'
| 'error'
| 'waiting'
| 'inactive'
| T;
NameTypeDefaultRequiredDescription
schemeFunctionScheme-yesScheme to select the color of the alert. important, error, inactive, information, success or waiting
smallboolean-noStyling for smaller status indicators
iconCarbonIconType-noPossibility to add icon