/
OptionList.tsx
372 lines (328 loc) · 10.3 KB
/
OptionList.tsx
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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
import * as React from 'react';
import KeyCode from 'rc-util/lib/KeyCode';
import pickAttrs from 'rc-util/lib/pickAttrs';
import useMemo from 'rc-util/lib/hooks/useMemo';
import classNames from 'classnames';
import List, { ListRef } from 'rc-virtual-list';
import TransBtn from './TransBtn';
import {
OptionsType as SelectOptionsType,
FlattenOptionData as SelectFlattenOptionData,
OptionData,
RenderNode,
OnActiveValue,
} from './interface';
import { RawValueType, FlattenOptionsType } from './interface/generator';
export interface OptionListProps<OptionsType extends object[]> {
prefixCls: string;
id: string;
options: OptionsType;
flattenOptions: FlattenOptionsType<OptionsType>;
height: number;
itemHeight: number;
values: Set<RawValueType>;
multiple: boolean;
open: boolean;
defaultActiveFirstOption?: boolean;
notFoundContent?: React.ReactNode;
menuItemSelectedIcon?: RenderNode;
childrenAsData: boolean;
searchValue: string;
virtual: boolean;
onSelect: (value: RawValueType, option: { selected: boolean }) => void;
onToggleOpen: (open?: boolean) => void;
/** Tell Select that some value is now active to make accessibility work */
onActiveValue: OnActiveValue;
onScroll: React.UIEventHandler<HTMLDivElement>;
/** Tell Select that mouse enter the popup to force re-render */
onMouseEnter?: React.MouseEventHandler;
}
export interface RefOptionListProps {
onKeyDown: React.KeyboardEventHandler;
onKeyUp: React.KeyboardEventHandler;
scrollTo?: (index: number) => void;
}
/**
* Using virtual list of option display.
* Will fallback to dom if use customize render.
*/
const OptionList: React.RefForwardingComponent<
RefOptionListProps,
OptionListProps<SelectOptionsType>
> = (
{
prefixCls,
id,
flattenOptions,
childrenAsData,
values,
searchValue,
multiple,
defaultActiveFirstOption,
height,
itemHeight,
notFoundContent,
open,
menuItemSelectedIcon,
virtual,
onSelect,
onToggleOpen,
onActiveValue,
onScroll,
onMouseEnter,
},
ref,
) => {
const itemPrefixCls = `${prefixCls}-item`;
const memoFlattenOptions = useMemo(
() => flattenOptions,
[open, flattenOptions],
(prev, next) => next[0] && prev[1] !== next[1],
);
// =========================== List ===========================
const listRef = React.useRef<ListRef>(null);
const onListMouseDown: React.MouseEventHandler<HTMLDivElement> = event => {
event.preventDefault();
};
const scrollIntoView = (index: number) => {
if (listRef.current) {
listRef.current.scrollTo({ index });
}
};
// ========================== Active ==========================
const getEnabledActiveIndex = (index: number, offset: number = 1): number => {
const len = memoFlattenOptions.length;
for (let i = 0; i < len; i += 1) {
const current = (index + i * offset + len) % len;
const { group, data } = memoFlattenOptions[current];
if (!group && !(data as OptionData).disabled) {
return current;
}
}
return -1;
};
const [activeIndex, setActiveIndex] = React.useState(() => getEnabledActiveIndex(0));
const setActive = (index: number, fromKeyboard = false) => {
setActiveIndex(index);
const info = { source: fromKeyboard ? ('keyboard' as const) : ('mouse' as const) };
// Trigger active event
const flattenItem = memoFlattenOptions[index];
if (!flattenItem) {
onActiveValue(null, -1, info);
return;
}
onActiveValue((flattenItem.data as OptionData).value, index, info);
};
// Auto active first item when list length or searchValue changed
React.useEffect(() => {
setActive(defaultActiveFirstOption !== false ? getEnabledActiveIndex(0) : -1);
}, [memoFlattenOptions.length, searchValue]);
// Auto scroll to item position in single mode
React.useEffect(() => {
/**
* React will skip `onChange` when component update.
* `setActive` function will call root accessibility state update which makes re-render.
* So we need to delay to let Input component trigger onChange first.
*/
const timeoutId = setTimeout(() => {
if (!multiple && open && values.size === 1) {
const value: RawValueType = Array.from(values)[0];
const index = memoFlattenOptions.findIndex(
({ data }) => (data as OptionData).value === value,
);
setActive(index);
scrollIntoView(index);
}
});
return () => clearTimeout(timeoutId);
}, [open]);
// ========================== Values ==========================
const onSelectValue = (value: RawValueType) => {
if (value !== undefined) {
onSelect(value, { selected: !values.has(value) });
}
// Single mode should always close by select
if (!multiple) {
onToggleOpen(false);
}
};
// ========================= Keyboard =========================
React.useImperativeHandle(ref, () => ({
onKeyDown: event => {
const { which } = event;
switch (which) {
// >>> Arrow keys
case KeyCode.UP:
case KeyCode.DOWN: {
let offset = 0;
if (which === KeyCode.UP) {
offset = -1;
} else if (which === KeyCode.DOWN) {
offset = 1;
}
if (offset !== 0) {
const nextActiveIndex = getEnabledActiveIndex(activeIndex + offset, offset);
scrollIntoView(nextActiveIndex);
setActive(nextActiveIndex, true);
}
break;
}
// >>> Select
case KeyCode.ENTER: {
// value
const item = memoFlattenOptions[activeIndex];
if (item && !(item.data as OptionData).disabled) {
onSelectValue((item.data as OptionData).value);
} else {
onSelectValue(undefined);
}
if (open) {
event.preventDefault();
}
break;
}
// >>> Close
case KeyCode.ESC: {
onToggleOpen(false);
}
}
},
onKeyUp: () => {},
scrollTo: index => {
scrollIntoView(index);
},
}));
// ========================== Render ==========================
if (memoFlattenOptions.length === 0) {
return (
<div
role="listbox"
id={`${id}_list`}
className={`${itemPrefixCls}-empty`}
onMouseDown={onListMouseDown}
>
{notFoundContent}
</div>
);
}
function renderItem(index: number) {
const item = memoFlattenOptions[index];
if (!item) return null;
const itemData = (item.data || {}) as OptionData;
const { value, label, children } = itemData;
const attrs = pickAttrs(itemData, true);
const mergedLabel = childrenAsData ? children : label;
return item ? (
<div
aria-label={typeof mergedLabel === 'string' ? mergedLabel : null}
{...attrs}
key={index}
role="option"
id={`${id}_list_${index}`}
aria-selected={values.has(value)}
>
{value}
</div>
) : null;
}
return (
<>
<div role="listbox" id={`${id}_list`} style={{ height: 0, width: 0, overflow: 'hidden' }}>
{renderItem(activeIndex - 1)}
{renderItem(activeIndex)}
{renderItem(activeIndex + 1)}
</div>
<List<SelectFlattenOptionData>
itemKey="key"
ref={listRef}
data={memoFlattenOptions}
height={height}
itemHeight={itemHeight}
fullHeight={false}
onMouseDown={onListMouseDown}
onScroll={onScroll}
virtual={virtual}
onMouseEnter={onMouseEnter}
>
{({ group, groupOption, data }, itemIndex) => {
const { label, key } = data;
// Group
if (group) {
return (
<div className={classNames(itemPrefixCls, `${itemPrefixCls}-group`)}>
{label !== undefined ? label : key}
</div>
);
}
const {
disabled,
value,
title,
children,
style,
className,
...otherProps
} = data as OptionData;
// Option
const selected = values.has(value);
const optionPrefixCls = `${itemPrefixCls}-option`;
const optionClassName = classNames(itemPrefixCls, optionPrefixCls, className, {
[`${optionPrefixCls}-grouped`]: groupOption,
[`${optionPrefixCls}-active`]: activeIndex === itemIndex && !disabled,
[`${optionPrefixCls}-disabled`]: disabled,
[`${optionPrefixCls}-selected`]: selected,
});
const mergedLabel = childrenAsData ? children : label;
const iconVisible =
!menuItemSelectedIcon || typeof menuItemSelectedIcon === 'function' || selected;
const content = mergedLabel || value;
// https://github.com/ant-design/ant-design/issues/26717
let optionTitle =
typeof content === 'string' || typeof content === 'number'
? content.toString()
: undefined;
if (title !== undefined) {
optionTitle = title;
}
return (
<div
{...otherProps}
aria-selected={selected}
className={optionClassName}
title={optionTitle}
onMouseMove={() => {
if (activeIndex === itemIndex || disabled) {
return;
}
setActive(itemIndex);
}}
onClick={() => {
if (!disabled) {
onSelectValue(value);
}
}}
style={style}
>
<div className={`${optionPrefixCls}-content`}>{content}</div>
{React.isValidElement(menuItemSelectedIcon) || selected}
{iconVisible && (
<TransBtn
className={`${itemPrefixCls}-option-state`}
customizeIcon={menuItemSelectedIcon}
customizeIconProps={{ isSelected: selected }}
>
{selected ? '✓' : null}
</TransBtn>
)}
</div>
);
}}
</List>
</>
);
};
const RefOptionList = React.forwardRef<RefOptionListProps, OptionListProps<SelectOptionsType>>(
OptionList,
);
RefOptionList.displayName = 'OptionList';
export default RefOptionList;