/** * Z-index design tokens for BeatUI. * * Defines a consistent layering system for stacking context management. * Values increase in increments of 10 to allow intermediate values when needed. * The scale covers common UI layers from base content through navigation, * overlays, tooltips, and notifications. * * @module */ /** * Z-index scale definitions mapping layer names to numeric values. * * | Name | Value | Use case | * |--------------|-------|-------------------------| * | base | 0 | Default stacking | * | raised | 100 | Slightly elevated items | * | navigation | 200 | Nav bars, headers | * | sidebar | 200 | Side navigation | * | overlay | 500 | Backdrop overlays | * | modal | 600 | Modal dialogs | * | tooltip | 700 | Tooltip content | * | popover | 800 | Popover menus | * | notification | 900 | Toast notifications | * | maximum | 1000 | Highest priority | */ export declare const zIndex: { readonly base: 0; readonly raised: 100; readonly navigation: 200; readonly sidebar: 200; readonly overlay: 500; readonly modal: 600; readonly tooltip: 700; readonly popover: 800; readonly notification: 900; readonly maximum: 1000; }; /** * Union type of all available z-index layer names. */ export type ZIndexName = keyof typeof zIndex; /** * Returns the CSS custom property name for a z-index layer. * * @param level - The z-index layer name * @returns The CSS variable name (e.g., `'--z-index-modal'`) * * @example * ```ts * getZIndexVarName('modal') // '--z-index-modal' * ``` */ export declare function getZIndexVarName(level: ZIndexName): string; /** * Returns a CSS `var()` expression referencing the z-index custom property. * * @param level - The z-index layer name * @returns A CSS `var()` string (e.g., `'var(--z-index-modal)'`) * * @example * ```ts * getZIndexVar('modal') // 'var(--z-index-modal)' * ``` */ export declare function getZIndexVar(level: ZIndexName): string; /** * Generates CSS custom property declarations for all z-index tokens. * * @returns A record mapping CSS variable names to their numeric string values * * @example * ```ts * const vars = generateZIndexVariables() * // vars['--z-index-modal'] === '60' * ``` */ export declare function generateZIndexVariables(): Record;