@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.
28 lines (27 loc) • 801 B
TypeScript
export declare const MODAL_CLOSED_BY: readonly ["any", "closerequest", "none"];
export type ModalClosedBy = (typeof MODAL_CLOSED_BY)[number];
export type ModalProperties = {
/**
* Whether the modal can be closed by a close icon button.
*/
closable?: boolean;
/**
* The reason for closing the modal.
* Can be 'any', 'closerequest', or 'none'.
*
* @see [Native dialog element closedby attribute documentation]{@link https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/dialog#attributes}
*
* @default 'any'
*/
closedBy?: ModalClosedBy;
};
export type ModalContentProperties = {
/**
* The title of the modal.
*/
header?: string;
/**
* Whether the modal has an icon.
*/
hasIcon?: boolean;
};