@primeuix/themes/types/knob/index.d.ts

Themes for PrimeUI Libraries

/**
 *
 * Knob Design Tokens
 *
 * @module knob
 *
 */

import type { ColorScheme as CS, DesignTokens, ExtendedCSS, ExtendedTokens } from '..';

/**
 * Design Token Sections
 */
export declare namespace KnobTokenSections {
    interface Root {
        /**
         * Transition duration of root
         *
         * @designToken knob.transition.duration
         */
        transitionDuration?: string;
        /**
         * Focus ring of root
         */
        focusRing?: {
            /**
             * Focus ring width of root
             *
             * @designToken knob.focus.ring.width
             */
            width?: string;
            /**
             * Focus ring style of root
             *
             * @designToken knob.focus.ring.style
             */
            style?: string;
            /**
             * Focus ring color of root
             *
             * @designToken knob.focus.ring.color
             */
            color?: string;
            /**
             * Focus ring offset of root
             *
             * @designToken knob.focus.ring.offset
             */
            offset?: string;
            /**
             * Focus ring shadow of root
             *
             * @designToken knob.focus.ring.shadow
             */
            shadow?: string;
        };
    }

    interface Value {
        /**
         * Background of value
         *
         * @designToken knob.value.background
         */
        background?: string;
    }

    interface Range {
        /**
         * Background of range
         *
         * @designToken knob.range.background
         */
        background?: string;
    }

    interface Text {
        /**
         * Color of text
         *
         * @designToken knob.text.color
         */
        color?: string;
    }

    /* Static Sections */
    type ColorScheme = CS<KnobDesignTokens>;
    type CSS = ExtendedCSS;
    type Extend = ExtendedTokens;
}

/**
 *
 * _Knob Design Tokens_
 *
 * @group components
 * @module knob
 * @see
 * --- ---
 * **Compatible Libraries**
 *
 * [![PrimeNG](https://i.postimg.cc/63f7jVST/primeng-icon-24.png)](https://primeng.org/theming/styled)
 * [![PrimeVue](https://i.postimg.cc/cC1vVgyh/primevue-icon-24.png)](https://primevue.org/theming/styled)
 * --- ---
 * **Figma UI Kit**
 *
 * [PrimeNG](https://primeng.org/uikit) | [PrimeVue](https://primevue.org/uikit)
 *
 */
export interface KnobDesignTokens extends DesignTokens<KnobDesignTokens> {
    /**
     * Used to pass tokens of the root section
     */
    root?: KnobTokenSections.Root;
    /**
     * Used to pass tokens of the value section
     */
    value?: KnobTokenSections.Value;
    /**
     * Used to pass tokens of the range section
     */
    range?: KnobTokenSections.Range;
    /**
     * Used to pass tokens of the text section
     */
    text?: KnobTokenSections.Text;
}