primevue
Version:
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
210 lines (197 loc) • 6.12 kB
TypeScript
/**
*
* 1D handle rendered inside `InputColorSlider`. Position is computed by the parent slider via
* its provided `handleStyle`; keyboard arrow handling delegates to the slider's `onKeyDown`.
*
* @module inputcolorsliderhandle
*
*/
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, CSSProperties, HTMLAttributes, VNode } from 'vue';
/**
* Custom passthrough(pt) option type, used to forward attributes via {@link InputColorSliderHandlePassThroughOptions}.
*/
export declare type InputColorSliderHandlePassThroughOptionType =
InputColorSliderHandlePassThroughAttributes | ((options: InputColorSliderHandlePassThroughMethodOptions) => InputColorSliderHandlePassThroughAttributes | string) | string | null | undefined;
/**
* Custom passthrough(pt) option method.
*/
export interface InputColorSliderHandlePassThroughMethodOptions {
/**
* Defines instance.
*/
instance: any;
/**
* Defines valid properties.
*/
props: InputColorSliderHandleProps;
/**
* 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 InputColorSliderHandleProps.pt}
*/
export interface InputColorSliderHandlePassThroughOptions {
/**
* Used to pass attributes to the root's DOM element.
*/
root?: InputColorSliderHandlePassThroughOptionType;
/**
* Used to manage all lifecycle hooks.
* @see {@link BaseComponent.ComponentHooks}
*/
hooks?: ComponentHooks;
}
/**
* Custom passthrough attributes for each DOM elements.
*/
export interface InputColorSliderHandlePassThroughAttributes {
[key: string]: any;
}
/**
* Defines valid properties in InputColorSliderHandle component.
*/
export interface InputColorSliderHandleProps {
/**
* 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 {InputColorSliderHandlePassThroughOptions}
*/
pt?: PassThrough<InputColorSliderHandlePassThroughOptions>;
/**
* 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;
}
/**
* Root element attributes forwarded to the consumer when `asChild` is enabled.
*/
export interface InputColorSliderHandleA11yAttrs extends HTMLAttributes {
/**
* ARIA role for the handle.
*/
role: 'slider';
/**
* Roving tabindex; `-1` when the parent `InputColor` or this slider is disabled.
*/
tabindex: 0 | -1;
/**
* Reflects the disabled state of the parent `InputColor` or this slider.
*/
'aria-disabled'?: boolean;
/**
* Orientation of the parent slider.
*/
'aria-orientation': 'horizontal' | 'vertical';
/**
* Accessible label, set to the slider's channel name.
*/
'aria-label': string;
/**
* Minimum value of the channel range.
*/
'aria-valuemin': number;
/**
* Maximum value of the channel range.
*/
'aria-valuemax': number;
/**
* Current value of the channel.
*/
'aria-valuenow': number;
/**
* Human-readable channel + value string.
*/
'aria-valuetext': string;
/**
* Marker carrying disabled / dragging / orientation state for CSS hooks.
*/
'data-p': string;
/**
* Inline style supplied by the parent slider that positions the handle along the track.
*/
style: CSSProperties;
/**
* Keyboard handler delegated to the parent slider for arrow / home / end navigation.
*/
onKeydown: (event: KeyboardEvent) => void;
}
/**
* Defines valid slots in InputColorSliderHandle component.
*/
export interface InputColorSliderHandleSlots {
/**
* 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 handle root.
*/
class: string;
/**
* Attributes to spread on the consumer's root element so the handle's ARIA wiring,
* keyboard handler and parent-driven position style stay intact.
*/
a11yAttrs: InputColorSliderHandleA11yAttrs;
}): VNode[];
}
/**
* Defines valid emits in InputColorSliderHandle component.
*/
export interface InputColorSliderHandleEmitsOptions {}
/**
* Type alias for emits resolved from {@link InputColorSliderHandleEmitsOptions}.
*/
export declare type InputColorSliderHandleEmits = EmitFn<InputColorSliderHandleEmitsOptions>;
/**
* **PrimeVue - InputColorSliderHandle**
*
* _1D handle rendered inside `InputColorSlider`._
*
* [Live Demo](https://www.primevue.dev/inputcolor/)
* --- ---
* 
*
* @group Component
*
*/
declare const InputColorSliderHandle: DefineComponent<InputColorSliderHandleProps, InputColorSliderHandleSlots, InputColorSliderHandleEmits>;
declare module 'vue' {
export interface GlobalComponents {
InputColorSliderHandle: DefineComponent<InputColorSliderHandleProps, InputColorSliderHandleSlots, InputColorSliderHandleEmits>;
}
}
export default InputColorSliderHandle;