forked from leongersen/noUiSlider
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathnouislider.d.ts
198 lines (198 loc) · 5.92 KB
/
nouislider.d.ts
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
interface CssClasses {
target: string;
base: string;
origin: string;
handle: string;
handleLower: string;
handleUpper: string;
touchArea: string;
horizontal: string;
vertical: string;
background: string;
connect: string;
connects: string;
ltr: string;
rtl: string;
textDirectionLtr: string;
textDirectionRtl: string;
draggable: string;
drag: string;
tap: string;
active: string;
tooltip: string;
pips: string;
pipsHorizontal: string;
pipsVertical: string;
marker: string;
markerHorizontal: string;
markerVertical: string;
markerNormal: string;
markerLarge: string;
markerSub: string;
value: string;
valueHorizontal: string;
valueVertical: string;
valueNormal: string;
valueLarge: string;
valueSub: string;
}
export interface PartialFormatter {
to: (value: number) => string | number;
from?: (value: string) => number | false;
}
export interface Formatter extends PartialFormatter {
from: (value: string) => number | false;
}
export declare enum PipsMode {
Range = "range",
Steps = "steps",
Positions = "positions",
Count = "count",
Values = "values"
}
export declare enum PipsType {
None = -1,
NoValue = 0,
LargeValue = 1,
SmallValue = 2
}
declare type WrappedSubRange = [number] | [number, number];
declare type SubRange = number | WrappedSubRange;
interface Range {
min: SubRange;
max: SubRange;
[key: `${number}%`]: SubRange;
}
interface BasePips {
mode: PipsMode;
density?: number;
filter?: PipsFilter;
format?: PartialFormatter;
}
interface PositionsPips extends BasePips {
mode: PipsMode.Positions;
values: number[];
stepped?: boolean;
}
interface ValuesPips extends BasePips {
mode: PipsMode.Values;
values: number[];
stepped?: boolean;
}
interface CountPips extends BasePips {
mode: PipsMode.Count;
values: number;
stepped?: boolean;
}
interface StepsPips extends BasePips {
mode: PipsMode.Steps;
}
interface RangePips extends BasePips {
mode: PipsMode.Range;
}
declare type Pips = PositionsPips | ValuesPips | CountPips | StepsPips | RangePips;
declare type ValueArgument = number | string | null;
declare type StartValues = ValueArgument | ValueArgument[];
declare type HandleAttributes = {
[key: string]: string;
};
interface UpdatableOptions {
range?: Range;
start?: StartValues;
margin?: number;
limit?: number;
padding?: number | number[];
snap?: boolean;
step?: number;
pips?: Pips;
format?: Formatter;
tooltips?: boolean | PartialFormatter | (boolean | PartialFormatter)[];
animate?: boolean;
connect?: "lower" | "upper" | boolean | boolean[];
}
export interface Options extends UpdatableOptions {
range: Range;
orientation?: "vertical" | "horizontal";
direction?: "ltr" | "rtl";
behaviour?: string;
keyboardSupport?: boolean;
keyboardPageMultiplier?: number;
keyboardMultiplier?: number;
keyboardDefaultStep?: number;
documentElement?: HTMLElement;
cssPrefix?: string;
cssClasses?: CssClasses;
ariaFormat?: PartialFormatter;
animationDuration?: number;
handleAttributes?: HandleAttributes[];
}
export interface API {
destroy: () => void;
steps: () => NextStepsForHandle[];
on: (eventName: string, callback: EventCallback) => void;
off: (eventName: string) => void;
get: (unencoded?: boolean) => GetResult;
set: (input: ValueArgument | ValueArgument[], fireSetEvent?: boolean, exactInput?: boolean) => void;
setHandle: (handleNumber: number, value: ValueArgument, fireSetEvent?: boolean, exactInput?: boolean) => void;
reset: (fireSetEvent?: boolean) => void;
disable: (handleNumber?: number) => void;
enable: (handleNumber?: number) => void;
options: Options;
updateOptions: (optionsToUpdate: UpdatableOptions, fireSetEvent: boolean) => void;
target: HTMLElement;
removePips: () => void;
removeTooltips: () => void;
getPositions: () => number[];
getTooltips: () => (HTMLElement | false)[] | null;
getOrigins: () => HTMLElement[];
pips: (grid: Pips) => HTMLElement;
}
interface TargetElement extends HTMLElement {
noUiSlider?: API;
}
interface NearByStep {
startValue: number;
step: number | false;
highestStep: number;
}
interface NearBySteps {
stepBefore: NearByStep;
thisStep: NearByStep;
stepAfter: NearByStep;
}
declare type GetResult = number | string | (string | number)[];
declare type NextStepsForHandle = [number | false | null, number | false | null];
declare type PipsFilter = (value: number, type: PipsType) => PipsType;
declare type EventCallback = (this: API, values: (number | string)[], handleNumber: number, unencoded: number[], tap: boolean, locations: number[], slider: API) => void;
declare class Spectrum {
xPct: number[];
xVal: number[];
xSteps: (number | false)[];
xNumSteps: (number | false)[];
protected xHighestCompleteStep: number[];
protected snap: boolean;
constructor(entry: Range, snap: boolean, singleStep: number);
getDistance(value: number): number[];
getAbsoluteDistance(value: number, distances: number[] | null, direction: boolean): number;
toStepping(value: number): number;
fromStepping(value: number): number;
getStep(value: number): number;
getDefaultStep(value: number, isDown: boolean, size: number): number;
getNearbySteps(value: number): NearBySteps;
countStepDecimals(): number;
hasNoSize(): boolean;
convert(value: number): number;
private handleEntryPoint;
private handleStepPoint;
}
declare const cssClasses: CssClasses;
declare function initialize(target: TargetElement, originalOptions: Options): API;
export { TargetElement as target };
export { initialize as create };
export { cssClasses };
declare const _default: {
__spectrum: typeof Spectrum;
cssClasses: CssClasses;
create: typeof initialize;
};
export default _default;