@engie-group/fluid-design-system
Version:
The Fluid Design System is ENGIE’s open-source library to create, build and deliver ENGIE digital services in a more efficient way.
40 lines (39 loc) • 1.45 kB
TypeScript
import { Scale, Variant } from '../../variations';
export declare const INLINE_MESSAGE_VARIANTS: readonly ["error", "fatal-error", "information", "success", "warning", "discovery", "planet"];
export type InlineMessageVariant = Extract<Variant | 'error' | 'fatal-error', (typeof INLINE_MESSAGE_VARIANTS)[number]>;
export declare const INLINE_MESSAGE_ACTION_POSITION: readonly ["bottom", "right"];
export type InlineMessageActionPosition = (typeof INLINE_MESSAGE_ACTION_POSITION)[number];
export declare const INLINE_MESSAGE_SCALES: readonly ["sm", "md"];
export type InlineMessageScale = Extract<Scale, (typeof INLINE_MESSAGE_SCALES)[number]>;
export type InlineMessageProperties = {
/**
* Scale of the inline message. Impacts the size of the text.
*
* @default 'md'
**/
scale?: InlineMessageScale;
/**
* Semantic variations of the inline message.
*
* @default 'error'
*/
variant?: InlineMessageVariant;
/**
* Used to set the position of the action element.
*
* @default 'right'
*/
actionPosition?: InlineMessageActionPosition;
/**
* Whether the inline-message has a status indicator icon or not.
*
* @default true
*/
hasStatus?: boolean;
/**
* Whether the inline-message has a close icon or not. Don't forget to add a callback function to handle the close event.
*
* @default false
*/
isClosable?: boolean;
};