@workday/canvas-kit-react
Version:
The parent module that contains all Workday Canvas Kit React components
73 lines • 3.25 kB
TypeScript
import * as React from 'react';
import { CanvasSystemIcon } from '@workday/design-assets-types';
import { GenericStyle } from '@workday/canvas-kit-react/common';
import { CSSProperties } from '@workday/canvas-kit-react/tokens';
/**
* @deprecated ⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in Preview instead.
*/
export declare enum StatusIndicatorType {
Gray = "gray",
Orange = "orange",
Blue = "blue",
Green = "green",
Red = "red",
Transparent = "transparent"
}
/**
* @deprecated ⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in Preview instead.
*/
export declare enum StatusIndicatorEmphasis {
High = "high",
Low = "low"
}
/**
* @deprecated ⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in Preview instead.
*/
export interface StatusIndicatorGenericStyle extends GenericStyle {
styles: CSSProperties;
variants: {
[statusType in StatusIndicatorType]: {
[statusEmphasis in StatusIndicatorEmphasis]?: CSSProperties;
};
};
}
/**
* @deprecated ⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in Preview instead.
*/
export declare const statusIndicatorStyles: StatusIndicatorGenericStyle;
/**
* @deprecated ⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in Preview instead.
*/
export interface StatusIndicatorProps extends React.HTMLAttributes<HTMLSpanElement> {
/**
* The type of the StatusIndicator. Accepts `Gray`, `Orange`, `Blue`, `Green`, `Red`, or `Transparent`.
*/
type: StatusIndicatorType;
/**
* The emphasis of the StatusIndicator. Accepts `High` or `Low`.
* @default StatusIndicatorEmphasis.High
*/
emphasis?: StatusIndicatorEmphasis;
/**
* The maxWidth of the container before it truncates
* @default 200
*/
maxWidth?: number;
/**
* The text of the StatusIndicator.
*/
label: string;
/**
* The icon of the StatusIndicator.
*/
icon?: CanvasSystemIcon;
}
/**
* @deprecated ⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in Preview instead.
*/
export declare class StatusIndicator extends React.Component<StatusIndicatorProps> {
static Type: typeof StatusIndicatorType;
static Emphasis: typeof StatusIndicatorEmphasis;
render(): React.JSX.Element;
}
//# sourceMappingURL=StatusIndicator.d.ts.map