@arbor-css/core 0.0.89 → 0.0.91

package/dist/presets/arborPreset/modeSchema/modeSchema.d.ts

@@ -0,0 +1,820 @@
+export interface ArborModeSchemaOptions<TColorName extends PropertyKey> {
+    colorNames: TColorName[];
+}
+export declare function createArborModeSchema<TColorName extends string>(options: ArborModeSchemaOptions<TColorName>): {
+    scalar: {
+        density: {
+            purpose: "scalar";
+            description: "A scaling factor for density. Higher density means smaller, tighter spacing and size";
+        };
+    };
+    primitive: {
+        color: Record<TColorName, {
+            $neutral: {
+                $root: {
+                    purpose: "color";
+                    description: string;
+                };
+                paper: {
+                    purpose: "color";
+                    description: "An extremely light shade, good for backgrounds and surfaces";
+                };
+                wash: {
+                    purpose: "color";
+                    description: "A very faint but slightly vibrant shade, good for backgrounds and surfaces";
+                };
+                light: {
+                    purpose: "color";
+                    description: "A light shade, good for emphasized surfaces.";
+                };
+                mid: {
+                    purpose: "color";
+                    description: "The main shade, good for primary actions and decoration.";
+                };
+                heavy: {
+                    purpose: "color";
+                    description: "A heavy shade, good for text emphasis and accents.";
+                };
+                ink: {
+                    purpose: "color";
+                    description: "A very dark but still slightly vibrant shade, good for text and high contrast elements.";
+                };
+            };
+            $root: {
+                purpose: "color";
+                description: string;
+            };
+            paper: {
+                purpose: "color";
+                description: "An extremely light shade, good for backgrounds and surfaces";
+            };
+            wash: {
+                purpose: "color";
+                description: "A very faint but slightly vibrant shade, good for backgrounds and surfaces";
+            };
+            light: {
+                purpose: "color";
+                description: "A light shade, good for emphasized surfaces.";
+            };
+            mid: {
+                purpose: "color";
+                description: "The main shade, good for primary actions and decoration.";
+            };
+            heavy: {
+                purpose: "color";
+                description: "A heavy shade, good for text emphasis and accents.";
+            };
+            ink: {
+                purpose: "color";
+                description: "A very dark but still slightly vibrant shade, good for text and high contrast elements.";
+            };
+        }>;
+        spacing: {
+            $root: {
+                purpose: "spacing";
+                description: string;
+            };
+            '2xs': "spacing";
+            xs: "spacing";
+            sm: "spacing";
+            md: "spacing";
+            lg: "spacing";
+            xl: "spacing";
+            '2xl': "spacing";
+        };
+        typography: {
+            xs: {
+                size: {
+                    purpose: "font-size";
+                    description: "The size of the font used in this typography level";
+                };
+                weight: {
+                    purpose: "font-weight";
+                    description: "The weight of the font used in this typography level";
+                };
+                lineHeight: {
+                    purpose: "line-height";
+                    description: "The line height of the font used in this typography level";
+                };
+            };
+            sm: {
+                size: {
+                    purpose: "font-size";
+                    description: "The size of the font used in this typography level";
+                };
+                weight: {
+                    purpose: "font-weight";
+                    description: "The weight of the font used in this typography level";
+                };
+                lineHeight: {
+                    purpose: "line-height";
+                    description: "The line height of the font used in this typography level";
+                };
+            };
+            md: {
+                size: {
+                    purpose: "font-size";
+                    description: "The size of the font used in this typography level";
+                };
+                weight: {
+                    purpose: "font-weight";
+                    description: "The weight of the font used in this typography level";
+                };
+                lineHeight: {
+                    purpose: "line-height";
+                    description: "The line height of the font used in this typography level";
+                };
+            };
+            lg: {
+                size: {
+                    purpose: "font-size";
+                    description: "The size of the font used in this typography level";
+                };
+                weight: {
+                    purpose: "font-weight";
+                    description: "The weight of the font used in this typography level";
+                };
+                lineHeight: {
+                    purpose: "line-height";
+                    description: "The line height of the font used in this typography level";
+                };
+            };
+            xl: {
+                size: {
+                    purpose: "font-size";
+                    description: "The size of the font used in this typography level";
+                };
+                weight: {
+                    purpose: "font-weight";
+                    description: "The weight of the font used in this typography level";
+                };
+                lineHeight: {
+                    purpose: "line-height";
+                    description: "The line height of the font used in this typography level";
+                };
+            };
+            '2xl': {
+                size: {
+                    purpose: "font-size";
+                    description: "The size of the font used in this typography level";
+                };
+                weight: {
+                    purpose: "font-weight";
+                    description: "The weight of the font used in this typography level";
+                };
+                lineHeight: {
+                    purpose: "line-height";
+                    description: "The line height of the font used in this typography level";
+                };
+            };
+            '3xl': {
+                size: {
+                    purpose: "font-size";
+                    description: "The size of the font used in this typography level";
+                };
+                weight: {
+                    purpose: "font-weight";
+                    description: "The weight of the font used in this typography level";
+                };
+                lineHeight: {
+                    purpose: "line-height";
+                    description: "The line height of the font used in this typography level";
+                };
+            };
+            '4xl': {
+                size: {
+                    purpose: "font-size";
+                    description: "The size of the font used in this typography level";
+                };
+                weight: {
+                    purpose: "font-weight";
+                    description: "The weight of the font used in this typography level";
+                };
+                lineHeight: {
+                    purpose: "line-height";
+                    description: "The line height of the font used in this typography level";
+                };
+            };
+            '5xl': {
+                size: {
+                    purpose: "font-size";
+                    description: "The size of the font used in this typography level";
+                };
+                weight: {
+                    purpose: "font-weight";
+                    description: "The weight of the font used in this typography level";
+                };
+                lineHeight: {
+                    purpose: "line-height";
+                    description: "The line height of the font used in this typography level";
+                };
+            };
+            '6xl': {
+                size: {
+                    purpose: "font-size";
+                    description: "The size of the font used in this typography level";
+                };
+                weight: {
+                    purpose: "font-weight";
+                    description: "The weight of the font used in this typography level";
+                };
+                lineHeight: {
+                    purpose: "line-height";
+                    description: "The line height of the font used in this typography level";
+                };
+            };
+        };
+        shadow: {
+            xs: {
+                $root: {
+                    purpose: "shadow";
+                    description: string;
+                };
+                x: {
+                    purpose: "shadow-x";
+                    description: "Horizontal offset of the shadow";
+                };
+                y: {
+                    purpose: "shadow-y";
+                    description: "Vertical offset of the shadow";
+                };
+                blur: {
+                    purpose: "shadow-blur";
+                    description: "Blur radius of the shadow";
+                };
+                spread: {
+                    purpose: "shadow-spread";
+                    description: "Spread radius of the shadow";
+                };
+                color: {
+                    purpose: "shadow-color";
+                    description: "Color of the shadow";
+                };
+            };
+            sm: {
+                $root: {
+                    purpose: "shadow";
+                    description: string;
+                };
+                x: {
+                    purpose: "shadow-x";
+                    description: "Horizontal offset of the shadow";
+                };
+                y: {
+                    purpose: "shadow-y";
+                    description: "Vertical offset of the shadow";
+                };
+                blur: {
+                    purpose: "shadow-blur";
+                    description: "Blur radius of the shadow";
+                };
+                spread: {
+                    purpose: "shadow-spread";
+                    description: "Spread radius of the shadow";
+                };
+                color: {
+                    purpose: "shadow-color";
+                    description: "Color of the shadow";
+                };
+            };
+            md: {
+                $root: {
+                    purpose: "shadow";
+                    description: string;
+                };
+                x: {
+                    purpose: "shadow-x";
+                    description: "Horizontal offset of the shadow";
+                };
+                y: {
+                    purpose: "shadow-y";
+                    description: "Vertical offset of the shadow";
+                };
+                blur: {
+                    purpose: "shadow-blur";
+                    description: "Blur radius of the shadow";
+                };
+                spread: {
+                    purpose: "shadow-spread";
+                    description: "Spread radius of the shadow";
+                };
+                color: {
+                    purpose: "shadow-color";
+                    description: "Color of the shadow";
+                };
+            };
+            lg: {
+                $root: {
+                    purpose: "shadow";
+                    description: string;
+                };
+                x: {
+                    purpose: "shadow-x";
+                    description: "Horizontal offset of the shadow";
+                };
+                y: {
+                    purpose: "shadow-y";
+                    description: "Vertical offset of the shadow";
+                };
+                blur: {
+                    purpose: "shadow-blur";
+                    description: "Blur radius of the shadow";
+                };
+                spread: {
+                    purpose: "shadow-spread";
+                    description: "Spread radius of the shadow";
+                };
+                color: {
+                    purpose: "shadow-color";
+                    description: "Color of the shadow";
+                };
+            };
+            xl: {
+                $root: {
+                    purpose: "shadow";
+                    description: string;
+                };
+                x: {
+                    purpose: "shadow-x";
+                    description: "Horizontal offset of the shadow";
+                };
+                y: {
+                    purpose: "shadow-y";
+                    description: "Vertical offset of the shadow";
+                };
+                blur: {
+                    purpose: "shadow-blur";
+                    description: "Blur radius of the shadow";
+                };
+                spread: {
+                    purpose: "shadow-spread";
+                    description: "Spread radius of the shadow";
+                };
+                color: {
+                    purpose: "shadow-color";
+                    description: "Color of the shadow";
+                };
+            };
+        };
+        easing: {
+            $root: {
+                purpose: "easing-function";
+                description: string;
+            };
+            tight: "easing-function";
+            medium: "easing-function";
+            loose: "easing-function";
+        };
+        duration: {
+            $root: {
+                purpose: "duration";
+                description: string;
+            };
+            short: "duration";
+            medium: "duration";
+            long: "duration";
+        };
+    };
+    action: {
+        padding: {
+            $root: {
+                purpose: "other";
+                description: string;
+            };
+            inline: {
+                purpose: "spacing";
+                description: "Inline (horizontal, usually) padding";
+            };
+            block: {
+                purpose: "spacing";
+                description: "Block (vertical, usually) padding";
+            };
+        };
+        roundness: {
+            purpose: "scalar";
+            description: "This token controls the overall roundness of actions and stacks with the root roundness token";
+        };
+        radius: {
+            purpose: "border-radius";
+            description: "This token captures the border-radius of actions, taking into account the overall roundness";
+        };
+        primary: {
+            fg: {
+                purpose: "color";
+                description: "Intended for use as the foreground color";
+            };
+            bg: {
+                purpose: "color";
+                description: "Intended for use as the background color";
+            };
+            border: {
+                purpose: "color";
+                description: "Intended for use as the border color, if desired";
+            };
+        };
+        secondary: {
+            fg: {
+                purpose: "color";
+                description: "Intended for use as the foreground color";
+            };
+            bg: {
+                purpose: "color";
+                description: "Intended for use as the background color";
+            };
+            border: {
+                purpose: "color";
+                description: "Intended for use as the border color, if desired";
+            };
+        };
+        ambient: {
+            fg: {
+                purpose: "color";
+                description: "Intended for use as the foreground color";
+            };
+            bg: {
+                purpose: "color";
+                description: "Intended for use as the background color";
+            };
+            border: {
+                purpose: "color";
+                description: "Intended for use as the border color, if desired";
+            };
+        };
+    };
+    control: {
+        fg: {
+            purpose: "color";
+            description: "Intended for use as the foreground color";
+        };
+        bg: {
+            purpose: "color";
+            description: "Intended for use as the background color";
+        };
+        border: {
+            purpose: "color";
+            description: "Intended for use as the border color, if desired";
+        };
+        padding: {
+            $root: {
+                purpose: "other";
+                description: string;
+            };
+            inline: {
+                purpose: "spacing";
+                description: "Inline (horizontal, usually) padding";
+            };
+            block: {
+                purpose: "spacing";
+                description: "Block (vertical, usually) padding";
+            };
+        };
+        roundness: {
+            purpose: "scalar";
+            description: "This token controls the overall roundness of controls and stacks with the root roundness token";
+        };
+        radius: {
+            purpose: "border-radius";
+            description: "This token captures the border-radius of controls, taking into account the overall roundness";
+        };
+    };
+    surface: {
+        padding: {
+            $root: {
+                purpose: "other";
+                description: string;
+            };
+            inline: {
+                purpose: "spacing";
+                description: "Inline (horizontal, usually) padding";
+            };
+            block: {
+                purpose: "spacing";
+                description: "Block (vertical, usually) padding";
+            };
+        };
+        roundness: {
+            purpose: "scalar";
+            description: "This token controls the overall roundness of surfaces and stacks with the root roundness token";
+        };
+        radius: {
+            purpose: "border-radius";
+            description: "This token captures the border-radius of surfaces, taking into account the overall roundness";
+        };
+        primary: {
+            fg: {
+                purpose: "color";
+                description: "Intended for use as the foreground color";
+            };
+            bg: {
+                purpose: "color";
+                description: "Intended for use as the background color";
+            };
+            border: {
+                purpose: "color";
+                description: "Intended for use as the border color, if desired";
+            };
+        };
+        secondary: {
+            fg: {
+                purpose: "color";
+                description: "Intended for use as the foreground color";
+            };
+            bg: {
+                purpose: "color";
+                description: "Intended for use as the background color";
+            };
+            border: {
+                purpose: "color";
+                description: "Intended for use as the border color, if desired";
+            };
+        };
+        ambient: {
+            fg: {
+                purpose: "color";
+                description: "Intended for use as the foreground color";
+            };
+            bg: {
+                purpose: "color";
+                description: "Intended for use as the background color";
+            };
+            border: {
+                purpose: "color";
+                description: "Intended for use as the border color, if desired";
+            };
+        };
+    };
+    text: {
+        primary: {
+            size: "font-size";
+            weight: "font-weight";
+            lineHeight: "line-height";
+            font: "font-family";
+        };
+        secondary: {
+            size: "font-size";
+            weight: "font-weight";
+            lineHeight: "line-height";
+            font: "font-family";
+        };
+        ambient: {
+            size: "font-size";
+            weight: "font-weight";
+            lineHeight: "line-height";
+            font: "font-family";
+        };
+    };
+    color: {
+        main: {
+            $root: {
+                purpose: "color";
+                description: string;
+            };
+            paper: {
+                purpose: "color";
+                description: "An extremely light shade, good for backgrounds and surfaces";
+            };
+            wash: {
+                purpose: "color";
+                description: "A very faint but slightly vibrant shade, good for backgrounds and surfaces";
+            };
+            light: {
+                purpose: "color";
+                description: "A light shade, good for emphasized surfaces.";
+            };
+            mid: {
+                purpose: "color";
+                description: "The main shade, good for primary actions and decoration.";
+            };
+            heavy: {
+                purpose: "color";
+                description: "A heavy shade, good for text emphasis and accents.";
+            };
+            ink: {
+                purpose: "color";
+                description: "A very dark but still slightly vibrant shade, good for text and high contrast elements.";
+            };
+        };
+        neutral: {
+            $root: {
+                purpose: "color";
+                description: string;
+            };
+            paper: {
+                purpose: "color";
+                description: "An extremely light shade, good for backgrounds and surfaces";
+            };
+            wash: {
+                purpose: "color";
+                description: "A very faint but slightly vibrant shade, good for backgrounds and surfaces";
+            };
+            light: {
+                purpose: "color";
+                description: "A light shade, good for emphasized surfaces.";
+            };
+            mid: {
+                purpose: "color";
+                description: "The main shade, good for primary actions and decoration.";
+            };
+            heavy: {
+                purpose: "color";
+                description: "A heavy shade, good for text emphasis and accents.";
+            };
+            ink: {
+                purpose: "color";
+                description: "A very dark but still slightly vibrant shade, good for text and high contrast elements.";
+            };
+        };
+    };
+    spacing: {
+        $root: {
+            purpose: "spacing";
+            description: string;
+        };
+        xs: "spacing";
+        sm: "spacing";
+        md: "spacing";
+        lg: "spacing";
+        xl: "spacing";
+    };
+    lineWidth: {
+        $root: {
+            purpose: "border-width";
+            description: string;
+        };
+        sm: {
+            purpose: "border-width";
+            description: "A hairline border width. Always >= 1px. If the global border width is small, this may be the same as \"md\"";
+        };
+        md: {
+            purpose: "border-width";
+            description: "A general-purpose border width";
+        };
+        lg: {
+            purpose: "border-width";
+            description: "A thicker border, good for emphasis";
+        };
+    };
+    radius: {
+        $root: {
+            purpose: "border-radius";
+            description: string;
+        };
+        xs: "border-radius";
+        sm: "border-radius";
+        md: "border-radius";
+        lg: "border-radius";
+        xl: "border-radius";
+    };
+    shadow: {
+        $root: {
+            purpose: "shadow";
+            description: string;
+        };
+        color: {
+            purpose: "color";
+            description: "If specified, this token overrides shadow colors from primitives";
+        };
+        sm: {
+            x: {
+                purpose: "size";
+                description: "Horizontal offset of the shadow";
+            };
+            y: {
+                purpose: "size";
+                description: "Vertical offset of the shadow";
+            };
+            blur: {
+                purpose: "size";
+                description: "Blur radius of the shadow";
+            };
+            spread: {
+                purpose: "size";
+                description: "Spread radius of the shadow";
+            };
+            color: {
+                purpose: "color";
+                description: "Color of the shadow";
+            };
+            $root: {
+                purpose: "shadow";
+                description: string;
+            };
+        };
+        md: {
+            x: {
+                purpose: "size";
+                description: "Horizontal offset of the shadow";
+            };
+            y: {
+                purpose: "size";
+                description: "Vertical offset of the shadow";
+            };
+            blur: {
+                purpose: "size";
+                description: "Blur radius of the shadow";
+            };
+            spread: {
+                purpose: "size";
+                description: "Spread radius of the shadow";
+            };
+            color: {
+                purpose: "color";
+                description: "Color of the shadow";
+            };
+            $root: {
+                purpose: "shadow";
+                description: string;
+            };
+        };
+        lg: {
+            x: {
+                purpose: "size";
+                description: "Horizontal offset of the shadow";
+            };
+            y: {
+                purpose: "size";
+                description: "Vertical offset of the shadow";
+            };
+            blur: {
+                purpose: "size";
+                description: "Blur radius of the shadow";
+            };
+            spread: {
+                purpose: "size";
+                description: "Spread radius of the shadow";
+            };
+            color: {
+                purpose: "color";
+                description: "Color of the shadow";
+            };
+            $root: {
+                purpose: "shadow";
+                description: string;
+            };
+        };
+        xl: {
+            x: {
+                purpose: "size";
+                description: "Horizontal offset of the shadow";
+            };
+            y: {
+                purpose: "size";
+                description: "Vertical offset of the shadow";
+            };
+            blur: {
+                purpose: "size";
+                description: "Blur radius of the shadow";
+            };
+            spread: {
+                purpose: "size";
+                description: "Spread radius of the shadow";
+            };
+            color: {
+                purpose: "color";
+                description: "Color of the shadow";
+            };
+            $root: {
+                purpose: "shadow";
+                description: string;
+            };
+        };
+    };
+    easing: {
+        $root: {
+            purpose: "easing-function";
+            description: string;
+        };
+        tight: {
+            purpose: "easing-function";
+            description: "A short, snappy easing, good for tight interactions";
+        };
+        medium: {
+            purpose: "easing-function";
+            description: "A medium easing, good for general use";
+        };
+        loose: {
+            purpose: "easing-function";
+            description: "A long, relaxed easing, good for slow interactions and animations";
+        };
+    };
+    duration: {
+        $root: {
+            purpose: "duration";
+            description: string;
+        };
+        short: {
+            purpose: "duration";
+            description: "A short, snappy duration, good for fast interactions and large animations";
+        };
+        medium: {
+            purpose: "duration";
+            description: "A medium duration, good for general use, fast enough for interactions";
+        };
+        long: {
+            purpose: "duration";
+            description: "A long, relaxed duration, good for slow interactions and animations";
+        };
+    };
+};
+export type ArborModeSchema<TColorName extends string = string> = ReturnType<typeof createArborModeSchema<TColorName>>;
+//# sourceMappingURL=modeSchema.d.ts.map