126 lines
2.9 KiB
TypeScript
Executable File
126 lines
2.9 KiB
TypeScript
Executable File
/**
|
|
*
|
|
* Slider is a component to provide input with a drag handle.
|
|
*
|
|
* [Live Demo](https://www.primevue.org/slider/)
|
|
*
|
|
* @module slider
|
|
*
|
|
*/
|
|
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
|
|
|
|
/**
|
|
* Custom slide end event.
|
|
* @see {@link SliderEmits.slideend}
|
|
*/
|
|
export interface SliderSlideEndEvent {
|
|
/**
|
|
* Original event
|
|
*/
|
|
originalEvent: Event;
|
|
/**
|
|
* New value.
|
|
*/
|
|
value: number;
|
|
}
|
|
|
|
/**
|
|
* Defines valid properties in Slider component.
|
|
*/
|
|
export interface SliderProps {
|
|
/**
|
|
* Value of the component.
|
|
*/
|
|
modelValue?: number | number[] | undefined;
|
|
/**
|
|
* Mininum boundary value.
|
|
* @defaultValue 0
|
|
*/
|
|
min?: number | undefined;
|
|
/**
|
|
* Maximum boundary value.
|
|
* @defaultValue 100
|
|
*/
|
|
max?: number | undefined;
|
|
/**
|
|
* Orientation of the slider.
|
|
* @defaultValue horizontal
|
|
*/
|
|
orientation?: 'horizontal' | 'vertical' | undefined;
|
|
/**
|
|
* Step factor to increment/decrement the value.
|
|
* @defaultValue 1
|
|
*/
|
|
step?: number | undefined;
|
|
/**
|
|
* When speficed, allows two boundary values to be picked.
|
|
* @defaultValue false
|
|
*/
|
|
range?: boolean | undefined;
|
|
/**
|
|
* When present, it specifies that the component should be disabled.
|
|
* @defaultValue false
|
|
*/
|
|
disabled?: boolean | undefined;
|
|
/**
|
|
* Index of the element in tabbing order.
|
|
*/
|
|
tabindex?: number | undefined;
|
|
/**
|
|
* Establishes relationships between the component and label(s) where its value should be one or more element IDs.
|
|
*/
|
|
'aria-labelledby'?: string | undefined;
|
|
/**
|
|
* Used to define a string that labels the element.
|
|
*/
|
|
'aria-label'?: string | undefined;
|
|
}
|
|
|
|
/**
|
|
* Defines valid slots in Slider component.
|
|
*/
|
|
export interface SliderSlots {}
|
|
|
|
/**
|
|
* Defines valid emits in Slider component.
|
|
*/
|
|
export interface SliderEmits {
|
|
/**
|
|
* Emitted when the value changes.
|
|
* @param {number | number[]} value - New value.
|
|
*/
|
|
'update:modelValue'(value: number | number[]): void;
|
|
/**
|
|
* Callback to invoke on value change.
|
|
* @param {number} value - New value
|
|
*/
|
|
change(value: number): void;
|
|
/**
|
|
* Callback to invoke when slide ends.
|
|
* @param {SliderSlideEndEvent} event - Custom slide end event.
|
|
*/
|
|
slideend(event: SliderSlideEndEvent): void;
|
|
}
|
|
|
|
/**
|
|
* **PrimeVue - Slider**
|
|
*
|
|
* _Slider is a component to provide input with a drag handle._
|
|
*
|
|
* [Live Demo](https://www.primevue.org/slider/)
|
|
* --- ---
|
|
* 
|
|
*
|
|
* @group Component
|
|
*
|
|
*/
|
|
declare class Slider extends ClassComponent<SliderProps, SliderSlots, SliderEmits> {}
|
|
|
|
declare module '@vue/runtime-core' {
|
|
interface GlobalComponents {
|
|
Slider: GlobalComponentConstructor<Slider>;
|
|
}
|
|
}
|
|
|
|
export default Slider;
|