Variable tokens

Type declaration

• • (
        tokens: Record<string, any>,
        options?: {
            formatKey?: (key: string, kebabCase: boolean) => string;
            important?: boolean;
            kebabCase?: boolean;
            prefix?: string;
            target?: HTMLElement;
        },
    ): {
        apply: (obj: Record<string, any>, currentPrefix?: string) => void;
        getAppliedVariables: () => string[];
        remove: () => void;
        update: (newTokens: Record<string, any>, basePrefix?: string) => void;
    }

  • Parameters

    • tokens: Record<string, any>

      JavaScript object containing design tokens
    • options: {
          formatKey?: (key: string, kebabCase: boolean) => string;
          important?: boolean;
          kebabCase?: boolean;
          prefix?: string;
          target?: HTMLElement;
      } = {}

      Configuration options

    Returns {
        apply: (obj: Record<string, any>, currentPrefix?: string) => void;
        getAppliedVariables: () => string[];
        remove: () => void;
        update: (newTokens: Record<string, any>, basePrefix?: string) => void;
    }

    Object containing apply, update, and remove methods