baseline-kit 3.0.1 → 5.0.0

package/dist/guide.d.ts

@@ -0,0 +1,146 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as React from 'react';
+
+/**
+ * @baseline-kit/core - Pure type definitions
+ * Framework-agnostic types for the baseline-kit system
+ */
+type Spacing = number | [number, number] | {
+    start?: number;
+    end?: number;
+};
+type PaddingValue = number | [number, number] | [number, number, number] | [number, number, number, number] | {
+    top?: number;
+    bottom?: number;
+    left?: number;
+    right?: number;
+};
+type SpacingProps = {
+    padding?: PaddingValue;
+    block?: Spacing;
+    inline?: Spacing;
+};
+type GuideVariant = 'line' | 'pattern' | 'fixed' | 'auto';
+type GuideColumnValue = string | number | undefined | 'auto';
+type GuideColumnsPattern = readonly GuideColumnValue[];
+type Variant = 'line' | 'flat' | 'pattern';
+type BaselineVariant = Exclude<Variant, 'pattern'>;
+type DebuggingMode = 'none' | 'hidden' | 'visible';
+type BaseGuideConfig = {
+    gap?: number | string;
+    base?: number;
+};
+type PatternConfig = BaseGuideConfig & {
+    variant: 'pattern';
+    columns: GuideColumnsPattern;
+    columnWidth?: never;
+};
+type FixedConfig = BaseGuideConfig & {
+    variant: 'fixed';
+    columns: number;
+    columnWidth?: number | string;
+};
+type AutoConfig = BaseGuideConfig & {
+    variant: 'auto';
+    columnWidth: number | string;
+    columns?: never;
+};
+type LineConfig = BaseGuideConfig & {
+    variant?: 'line';
+    columns?: never;
+    columnWidth?: never;
+};
+type GuideConfig = PatternConfig | AutoConfig | FixedConfig | LineConfig;
+
+type DebugColors = {
+    line: string;
+    flat: string;
+    text: string;
+};
+type ConfigSchema = {
+    base: number;
+    baseline: {
+        variant: BaselineVariant;
+        debugging: DebuggingMode;
+        colors: Record<BaselineVariant, string>;
+    };
+    guide: {
+        variant: GuideVariant;
+        debugging: DebuggingMode;
+        colors: Record<GuideVariant, string>;
+    };
+    spacer: {
+        variant: Variant;
+        debugging: DebuggingMode;
+        colors: DebugColors;
+    };
+    box: {
+        debugging: DebuggingMode;
+        colors: DebugColors;
+    };
+    padder: {
+        debugging: DebuggingMode;
+        color: string;
+    };
+};
+
+type MergeConfigParams = {
+    parentConfig: ConfigSchema;
+    base?: number;
+    baseline?: Partial<ConfigSchema['baseline']>;
+    guide?: Partial<ConfigSchema['guide']>;
+    spacer?: Partial<ConfigSchema['spacer']>;
+    box?: Partial<ConfigSchema['box']>;
+    padder?: Partial<ConfigSchema['padder']>;
+};
+declare const mergeConfig: (params: MergeConfigParams) => ConfigSchema;
+type CSSVariablesParams = {
+    base: number;
+    baseline: ConfigSchema['baseline'];
+    guide: ConfigSchema['guide'];
+    spacer: ConfigSchema['spacer'];
+    box: ConfigSchema['box'];
+    padder: ConfigSchema['padder'];
+};
+declare const createCSSVariables: (params: CSSVariablesParams) => Record<string, string>;
+
+type ConfigProps = {
+    children: React.ReactNode;
+    base?: number;
+    baseline?: Partial<ConfigSchema['baseline']>;
+    guide?: Partial<ConfigSchema['guide']>;
+    spacer?: Partial<ConfigSchema['spacer']>;
+    box?: Partial<ConfigSchema['box']>;
+    padder?: Partial<ConfigSchema['padder']>;
+};
+/**
+ * Configuration provider for baseline-kit components.
+ */
+declare function Config({ children, base, baseline, guide, spacer, box, padder, }: ConfigProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Common props shared across library components.
+ */
+type ComponentsProps = {
+    debugging?: DebuggingMode;
+    className?: string;
+    style?: React.CSSProperties;
+    height?: React.CSSProperties['height'];
+    width?: React.CSSProperties['width'];
+} & SpacingProps;
+
+type GuideProps = {
+    align?: React.CSSProperties['justifyContent'];
+    variant?: GuideVariant;
+    columns?: number | readonly (string | number | undefined | 'auto')[];
+    columnWidth?: React.CSSProperties['width'];
+    maxWidth?: React.CSSProperties['maxWidth'];
+    color?: React.CSSProperties['color'];
+    children?: React.ReactNode;
+    gap?: number;
+    ssrMode?: boolean;
+} & ComponentsProps & Omit<GuideConfig, 'columns' | 'columnWidth' | 'gap'>;
+declare const Guide: React.NamedExoticComponent<GuideProps>;
+
+export { Config, Guide, createCSSVariables, mergeConfig };
+export type { ConfigSchema, DebuggingMode, GuideConfig, GuideProps, GuideVariant };