-
-
Notifications
You must be signed in to change notification settings - Fork 300
/
useRangeSlider.ts
239 lines (220 loc) · 5.98 KB
/
useRangeSlider.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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
import { useCallback, useMemo, useRef, useState } from "react";
import { nearest } from "@react-md/utils";
import {
DEFAULT_SLIDER_MAX,
DEFAULT_SLIDER_MIN,
DEFAULT_SLIDER_STEP,
} from "./constants";
import {
DefinedSliderValueOptions,
RangeSliderControls,
RangeSliderDefaultValue,
RangeSliderValue,
SliderStepOptions,
ThumbIndex,
} from "./types";
import { getJumpValue, getSteps } from "./utils";
const noop = (): void => {
// do nothing
};
/**
* @internal
* @remarks \@since 2.5.0
*/
interface UpdateOptions {
/**
* The thumb index that is being updated.
*/
index: ThumbIndex;
type:
| "increment"
| "decrement"
| "min"
| "max"
| "increment-jump"
| "decrement-jump";
}
/**
* @remarks \@since 2.5.0
*/
export interface UseRangeSliderOptions extends SliderStepOptions {
/**
* An optional callback that will be triggered when the value has changed when
* the `updateOn` behavior is set to `"blur"`. When the `updateOn` behavior is
* set to `"change"` (default), this will do nothing since the return value
* from the hook will always be the latest value.
*/
onChange?(value: RangeSliderValue): void;
}
/**
* @remarks \@since 2.5.0
*/
export interface RangeSliderRequiredProps
extends RangeSliderControls,
DefinedSliderValueOptions {
/**
* The current value of the slider.
*/
value: RangeSliderValue;
}
/**
* @remarks \@since 2.5.0
*/
export type RangeSliderValueReturnType = readonly [
RangeSliderValue,
RangeSliderRequiredProps
];
/**
* This hook is used to control the value and behavior of the `RangeSlider`
* component. The first argument will contain the current slider value while the
* second argument will be all the props required to control the `RangeSlider`
* component.
*
* @param defaultValue - An optional default value to use. When omitted, this
* will be the `[min, max]` values
* @param options - An object containing the `min` and `max` values allowed for
* the slider as well as a `step` to indicate valid values between the `min` and
* `max`.
* @returns an ordered list containing the current value followed by the
* `RangeSlider` props
* @remarks \@since 2.5.0
*/
export function useRangeSlider(
defaultValue?: RangeSliderDefaultValue,
{
min = DEFAULT_SLIDER_MIN,
max = DEFAULT_SLIDER_MAX,
step = DEFAULT_SLIDER_STEP,
jump: propJump,
updateOn = "change",
onChange = noop,
}: UseRangeSliderOptions = {}
): RangeSliderValueReturnType {
const jump = useMemo(
() => getJumpValue(min, max, step, propJump),
[min, max, step, propJump]
);
// since the `currentValue` is a ref, this state is used to force a re-render
// to get the updated value from the ref.
const [, hack] = useState([]);
const [value, setValue] = useState<RangeSliderValue>(
defaultValue ?? [min, max]
);
const currentValue = useRef(value);
const update = useCallback(
({ index, type }: UpdateOptions) => {
/* istanbul ignore next */
if (process.env.NODE_ENV !== "production") {
if (index !== 0 && index !== 1) {
throw new TypeError("Thumb index must be 0 or 1.");
}
}
setValue(([thumb1Value, thumb2Value]) => {
let value: number;
let minValue = min;
let maxValue = max;
if (index === 0) {
value = thumb1Value;
maxValue = thumb2Value - step;
} else {
value = thumb2Value;
minValue = thumb1Value + step;
}
switch (type) {
case "min":
value = minValue;
break;
case "max":
value = maxValue;
break;
case "increment":
value += step;
break;
case "decrement":
value -= step;
break;
case "increment-jump":
value += jump;
break;
case "decrement-jump":
value -= jump;
break;
}
value = Math.max(minValue, Math.min(maxValue, value));
return index === 0 ? [value, thumb2Value] : [thumb1Value, value];
});
},
[jump, max, min, step]
);
const increment = useCallback(
(index: ThumbIndex) => update({ index, type: "increment" }),
[update]
);
const incrementJump = useCallback(
(index: ThumbIndex) => update({ index, type: "increment-jump" }),
[update]
);
const decrement = useCallback(
(index: ThumbIndex) => update({ index, type: "decrement" }),
[update]
);
const decrementJump = useCallback(
(index: ThumbIndex) => update({ index, type: "decrement-jump" }),
[update]
);
const minimum = useCallback(
(index: ThumbIndex) => update({ index, type: "min" }),
[update]
);
const maximum = useCallback(
(index: ThumbIndex) => update({ index, type: "max" }),
[update]
);
const persist = useCallback(() => {
const [prev1, prev2] = currentValue.current;
if (prev1 === value[0] && prev2 === value[1]) {
return;
}
onChange(value);
currentValue.current = value;
hack([]);
}, [onChange, value]);
const prev = useRef({ min, max, step });
if (
prev.current.min !== min ||
prev.current.max !== max ||
prev.current.step !== step
) {
// ensure that if the `min`, `max`, or `step` value changes that the value
// is updated as well. Without this, there will be a runtime error if the
// value is not within the new range.
prev.current = { min, max, step };
const steps = getSteps(min, max, step);
const nextValue: RangeSliderValue = [
nearest(value[0], min, max, steps),
nearest(value[1], min, max, steps),
];
currentValue.current = nextValue;
setValue(nextValue);
}
if (updateOn === "change" && currentValue.current !== value) {
currentValue.current = value;
}
return [
currentValue.current,
{
min,
max,
step,
value,
minimum,
maximum,
increment,
incrementJump,
decrement,
decrementJump,
persist,
setValue,
},
];
}