1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
/// <reference types="react" />
/** Properties for creating custom steps in a slider. These properties should be passed in as
* an object within an array to the slider component's customSteps property.
*/
export interface SliderStepObject {
/** Flag to hide the label. */
isLabelHidden?: boolean;
/** The display label for the step value. This is also used for the aria-valuetext attribute. */
label: string;
/** Value of the step. This value is a percentage of the slider where the tick is drawn. */
value: number;
}
export type SliderOnChangeEvent = React.MouseEvent | React.KeyboardEvent | React.FormEvent<HTMLInputElement> | React.TouchEvent | React.FocusEvent<HTMLInputElement>;
/** The main slider component. */
export interface SliderProps extends Omit<React.HTMLProps<HTMLDivElement>, 'onChange'> {
/** Flag indicating if the slider is discrete for custom steps. This will cause the slider
* to snap to the closest value.
*/
areCustomStepsContinuous?: boolean;
/** One or more id's to use for the slider thumb's accessible description. */
'aria-describedby'?: string;
/** One or more id's to use for the slider thumb's accessible label. */
'aria-labelledby'?: string;
/** Additional classes added to the slider. */
className?: string;
/** Array of custom slider step objects (value and label of each step) for the slider. */
customSteps?: SliderStepObject[];
hasTooltipOverThumb?: boolean;
/** Accessible label for the input field. */
inputAriaLabel?: string;
/** Text label that is place after the input field. */
inputLabel?: string | number;
/** Position of the input. Note "right" is deprecated. Use "end" instead*/
inputPosition?: 'aboveThumb' | 'right' | 'end';
/** Value displayed in the input field. */
inputValue?: number;
/** Adds disabled styling, and disables the slider and the input component if present. */
isDisabled?: boolean;
/** Flag to show value input field. */
isInputVisible?: boolean;
/** @deprecated Use startActions instead. Actions placed at the start of the slider. */
leftActions?: React.ReactNode;
/** Actions placed at the start of the slider. */
startActions?: React.ReactNode;
/** The maximum permitted value. */
max?: number;
/** The minimum permitted value. */
min?: number;
/** Value change callback. This is called when the slider value changes. */
onChange?: (event: SliderOnChangeEvent, value: number, inputValue?: number, setLocalInputValue?: React.Dispatch<React.SetStateAction<number>>) => void;
/** @deprecated Use endActions instead. Actions placed to the right of the slider. */
rightActions?: React.ReactNode;
/** Actions placed at the end of the slider. */
endActions?: React.ReactNode;
/** Flag to indicate if boundaries should be shown for slider that does not have custom steps. */
showBoundaries?: boolean;
/** Flag to indicate if ticks should be shown for slider that does not have custom steps. */
showTicks?: boolean;
/** The step interval. */
step?: number;
thumbAriaLabel?: string;
/** Current value of the slider. */
value?: number;
}
export declare const Slider: React.FunctionComponent<SliderProps>;
//# sourceMappingURL=Slider.d.ts.map
|
