@awsui/components-react
Version:
On July 19th, 2022, we launched [Cloudscape Design System](https://cloudscape.design). Cloudscape is an evolution of AWS-UI. It consists of user interface guidelines, front-end components, design resources, and development tools for building intuitive, en
43 lines (42 loc) • 1.42 kB
TypeScript
import { BaseComponentProps } from '../internal/base-component';
/**
* @awsuiSystem core
*/
export interface StatusIndicatorProps extends BaseComponentProps {
/**
* Specifies the status type.
*/
type?: StatusIndicatorProps.Type;
/**
* A text fragment that communicates the status.
*/
children?: React.ReactNode;
/**
* Specifies an `aria-label` for the icon. If the status text alone does not fully describe the status,
* use this to communicate additional context.
*/
iconAriaLabel?: string;
/**
* Specifies an override for the status indicator color.
*/
colorOverride?: StatusIndicatorProps.Color;
/**
* Specifies if the text content should wrap. If you set it to false, it prevents the text from wrapping
* and truncates it with an ellipsis.
*/
wrapText?: boolean;
/**
* Attributes to add to the native element.
* Some attributes will be automatically combined with internal attribute values:
* - `className` will be appended.
* - Event handlers will be chained, unless the default is prevented.
*
* We do not support using this attribute to apply custom styling.
*
* @awsuiSystem core
*/
}
export declare namespace StatusIndicatorProps {
type Type = 'error' | 'warning' | 'success' | 'info' | 'stopped' | 'pending' | 'in-progress' | 'loading' | 'not-started';
type Color = 'blue' | 'grey' | 'green' | 'red' | 'yellow';
}