@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.
23 lines (22 loc) • 1.12 kB
TypeScript
import { Scale, Variant } from '../../variations';
export declare const HEADING_SCALES: readonly ["xs", "sm", "md", "lg", "xl"];
export type HeadingScale = Extract<Scale, (typeof HEADING_SCALES)[number]>;
export declare const SEMANTIC_BY_SCALE: Record<HeadingScale, string>;
export declare const HEADING_VARIANTS: readonly ["danger", "danger-contrast", "warning", "warning-contrast", "success", "success-contrast", "information", "information-contrast", "discovery", "discovery-contrast", "planet", "planet-contrast", "brand", "brand-contrast", "signature", "ai", "primary", "secondary", "tertiary", "contrast", "inverse"];
export type HeadingVariant = Extract<Variant, (typeof HEADING_VARIANTS)[number]>;
export type HeadingProperties = {
/**
* Scale of the content
*/
scale?: HeadingScale;
/**
* Variant to apply to the content
*/
variant?: HeadingVariant;
/**
* Whether the content color is not invertible.
*
* Useful when your text is displayed above a dark or light background which doesn't change in light/dark mode.
*/
isNotInvertible?: boolean;
};