primevue/inputcolorslidertrack/index.d.ts

PrimeVue is a premium UI library for Vue featuring a rich set of 90+ components, a theme designer, various theme alternatives such as Material, Bootstrap, Tailwind, premium templates and professional support. In addition, it integrates with PrimeBlock, wh

/**
 *
 * Visual track layer rendered inside `InputColorSlider`. The slider's gradient is supplied
 * via CSS custom property `--slider-background` set on the slider root.
 *
 * @module inputcolorslidertrack
 *
 */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough';
import type { Component, VNode } from 'vue';

/**
 * Custom passthrough(pt) option type, used to forward attributes via {@link InputColorSliderTrackPassThroughOptions}.
 */
export declare type InputColorSliderTrackPassThroughOptionType =
    InputColorSliderTrackPassThroughAttributes | ((options: InputColorSliderTrackPassThroughMethodOptions) => InputColorSliderTrackPassThroughAttributes | string) | string | null | undefined;

/**
 * Custom passthrough(pt) option method.
 */
export interface InputColorSliderTrackPassThroughMethodOptions {
    /**
     * Defines instance.
     */
    instance: any;
    /**
     * Defines valid properties.
     */
    props: InputColorSliderTrackProps;
    /**
     * Defines valid attributes.
     */
    attrs: any;
    /**
     * Defines parent options.
     */
    parent: any;
    /**
     * Defines passthrough(pt) options in global config.
     */
    global: object | undefined;
}

/**
 * Custom passthrough(pt) options.
 * @see {@link InputColorSliderTrackProps.pt}
 */
export interface InputColorSliderTrackPassThroughOptions {
    /**
     * Used to pass attributes to the root's DOM element.
     */
    root?: InputColorSliderTrackPassThroughOptionType;
    /**
     * Used to manage all lifecycle hooks.
     * @see {@link BaseComponent.ComponentHooks}
     */
    hooks?: ComponentHooks;
}

/**
 * Custom passthrough attributes for each DOM elements.
 */
export interface InputColorSliderTrackPassThroughAttributes {
    [key: string]: any;
}

/**
 * Defines valid properties in InputColorSliderTrack component.
 */
export interface InputColorSliderTrackProps {
    /**
     * Use to change the HTML tag of root element.
     * @defaultValue DIV
     */
    as?: string | Component | undefined;
    /**
     * When enabled, it changes the default rendered element for the one passed as a child element.
     * @defaultValue false
     */
    asChild?: boolean | undefined;
    /**
     * It generates scoped CSS variables using design tokens for the component.
     */
    dt?: DesignToken<any>;
    /**
     * Used to pass attributes to DOM elements inside the component.
     * @type {InputColorSliderTrackPassThroughOptions}
     */
    pt?: PassThrough<InputColorSliderTrackPassThroughOptions>;
    /**
     * Used to configure passthrough(pt) options of the component.
     * @type {PassThroughOptions}
     */
    ptOptions?: PassThroughOptions;
    /**
     * When enabled, it removes component related styles in the core.
     * @defaultValue false
     */
    unstyled?: boolean;
}

/**
 * Defines valid slots in InputColorSliderTrack component.
 */
export interface InputColorSliderTrackSlots {
    /**
     * Custom root element template. Receives scope props when `asChild` is enabled.
     * @param {Object} scope - default slot's params.
     */
    default(scope: {
        /**
         * Style class of the slider track root.
         */
        class: string;
    }): VNode[];
}

/**
 * Defines valid emits in InputColorSliderTrack component.
 */
export interface InputColorSliderTrackEmitsOptions {}

/**
 * Type alias for emits resolved from {@link InputColorSliderTrackEmitsOptions}.
 */
export declare type InputColorSliderTrackEmits = EmitFn<InputColorSliderTrackEmitsOptions>;

/**
 * **PrimeVue - InputColorSliderTrack**
 *
 * _Visual track layer rendered inside `InputColorSlider`._
 *
 * [Live Demo](https://www.primevue.dev/inputcolor/)
 * --- ---
 * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
 *
 * @group Component
 *
 */
declare const InputColorSliderTrack: DefineComponent<InputColorSliderTrackProps, InputColorSliderTrackSlots, InputColorSliderTrackEmits>;

declare module 'vue' {
    export interface GlobalComponents {
        InputColorSliderTrack: DefineComponent<InputColorSliderTrackProps, InputColorSliderTrackSlots, InputColorSliderTrackEmits>;
    }
}

export default InputColorSliderTrack;