-
Notifications
You must be signed in to change notification settings - Fork 2.5k
/
select-component.tsx
355 lines (328 loc) · 13.3 KB
/
select-component.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
// *****************************************************************************
// Copyright (C) 2022 TypeFox and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// http://www.eclipse.org/legal/epl-2.0.
//
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License v. 2.0 are satisfied: GNU General Public License, version 2
// with the GNU Classpath Exception which is available at
// https://www.gnu.org/software/classpath/license.html.
//
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
// *****************************************************************************
import * as React from 'react';
import * as ReactDOM from 'react-dom';
import * as DOMPurify from 'dompurify';
import { codicon } from './widget';
import { measureTextHeight, measureTextWidth } from '../browser';
import '../../../src/browser/style/select-component.css';
export interface SelectOption {
value?: string
label?: string
separator?: boolean
disabled?: boolean
detail?: string
description?: string
markdown?: boolean
userData?: string
}
export interface SelectComponentProps {
options: SelectOption[]
defaultValue?: string | number
onChange?: (option: SelectOption, index: number) => void,
onBlur?: () => void,
onFocus?: () => void
}
export interface SelectComponentState {
dimensions?: DOMRect
selected: number
original: number
hover: number
}
export const SELECT_COMPONENT_CONTAINER = 'select-component-container';
export class SelectComponent extends React.Component<SelectComponentProps, SelectComponentState> {
protected dropdownElement: HTMLElement;
protected fieldRef = React.createRef<HTMLDivElement>();
protected mountedListeners: Map<string, EventListenerOrEventListenerObject> = new Map();
protected optimalWidth = 0;
protected optimalHeight = 0;
constructor(props: SelectComponentProps) {
super(props);
let selected = 0;
if (typeof props.defaultValue === 'number') {
selected = props.defaultValue;
} else if (typeof props.defaultValue === 'string') {
selected = Math.max(props.options.findIndex(e => e.value === props.defaultValue), 0);
}
this.state = {
selected,
original: selected,
hover: selected
};
let list = document.getElementById(SELECT_COMPONENT_CONTAINER);
if (!list) {
list = document.createElement('div');
list.id = SELECT_COMPONENT_CONTAINER;
document.body.appendChild(list);
}
this.dropdownElement = list;
}
get options(): SelectOption[] {
return this.props.options;
}
get value(): string | number | undefined {
return this.props.options[this.state.selected].value ?? this.state.selected;
}
set value(value: string | number | undefined) {
let index = -1;
if (typeof value === 'number') {
index = value;
} else if (typeof value === 'string') {
index = this.props.options.findIndex(e => e.value === value);
}
if (index >= 0) {
this.setState({
selected: index,
original: index,
hover: index
});
}
}
protected getOptimalWidth(): number {
const textWidth = measureTextWidth(this.props.options.map(e => e.label || e.value || '' + (e.detail || '')));
return Math.ceil(textWidth + 16);
}
protected getOptimalHeight(maxWidth?: number): number {
const firstLine = this.props.options.find(e => e.label || e.value || e.detail);
if (!firstLine) {
return 0;
}
if (maxWidth) {
maxWidth = Math.ceil(maxWidth) + 10; // Increase width by 10 due to side padding
}
const descriptionHeight = measureTextHeight(this.props.options.map(e => e.description || ''), { maxWidth: `${maxWidth}px` }) + 18;
const singleLineHeight = measureTextHeight(firstLine.label || firstLine.value || firstLine.detail || '') + 6;
const optimal = descriptionHeight + singleLineHeight * this.props.options.length;
return optimal + 20; // Just to be safe, add another 20 pixels here
}
protected attachListeners(): void {
const hide = () => {
this.hide();
};
this.mountedListeners.set('scroll', hide);
this.mountedListeners.set('wheel', hide);
let parent = this.fieldRef.current?.parentElement;
while (parent) {
// Workaround for perfect scrollbar, since using `overflow: hidden`
// neither triggers the `scroll`, `wheel` nor `blur` event
if (parent.classList.contains('ps')) {
parent.addEventListener('ps-scroll-y', hide);
}
parent = parent.parentElement;
}
for (const [key, listener] of this.mountedListeners.entries()) {
window.addEventListener(key, listener);
}
}
override componentWillUnmount(): void {
if (this.mountedListeners.size > 0) {
const eventListener = this.mountedListeners.get('scroll')!;
let parent = this.fieldRef.current?.parentElement;
while (parent) {
parent.removeEventListener('ps-scroll-y', eventListener);
parent = parent.parentElement;
}
for (const [key, listener] of this.mountedListeners.entries()) {
window.removeEventListener(key, listener);
}
}
}
override render(): React.ReactNode {
const { options } = this.props;
let { selected } = this.state;
if (options[selected]?.separator) {
selected = this.nextNotSeparator('forwards');
}
const selectedItemLabel = options[selected].label ?? options[selected].value;
return <>
<div
key="select-component"
ref={this.fieldRef}
tabIndex={0}
className="theia-select-component"
onClick={e => this.handleClickEvent(e)}
onBlur={
() => {
this.hide();
this.props.onBlur?.();
}
}
onFocus={() => this.props.onFocus?.()}
onKeyDown={e => this.handleKeypress(e)}
>
<div key="label" className="theia-select-component-label">{selectedItemLabel}</div>
<div key="icon" className={`theia-select-component-chevron ${codicon('chevron-down')}`} />
</div>
{ReactDOM.createPortal(this.renderDropdown(), this.dropdownElement)}
</>;
}
protected nextNotSeparator(direction: 'forwards' | 'backwards'): number {
const { options } = this.props;
const step = direction === 'forwards' ? 1 : -1;
const length = this.props.options.length;
let selected = this.state.selected;
let count = 0;
do {
selected = (selected + step) % length;
if (selected < 0) {
selected = length - 1;
}
count++;
}
while (options[selected]?.separator && count < length);
return selected;
}
protected handleKeypress(ev: React.KeyboardEvent<HTMLDivElement>): void {
if (!this.fieldRef.current) {
return;
}
if (ev.key === 'ArrowUp') {
const selected = this.nextNotSeparator('backwards');
this.setState({
selected,
hover: selected
});
} else if (ev.key === 'ArrowDown') {
if (this.state.dimensions) {
const selected = this.nextNotSeparator('forwards');
this.setState({
selected,
hover: selected
});
} else {
this.toggleVisibility();
this.setState({
selected: 0,
hover: 0,
});
}
} else if (ev.key === 'Enter') {
if (!this.state.dimensions) {
this.toggleVisibility();
} else {
const selected = this.state.selected;
this.selectOption(selected, this.props.options[selected]);
}
} else if (ev.key === 'Escape' || ev.key === 'Tab') {
this.hide();
}
ev.stopPropagation();
ev.nativeEvent.stopImmediatePropagation();
}
protected handleClickEvent(event: React.MouseEvent<HTMLElement>): void {
this.toggleVisibility();
event.stopPropagation();
event.nativeEvent.stopImmediatePropagation();
}
protected toggleVisibility(): void {
if (!this.fieldRef.current) {
return;
}
if (!this.state.dimensions) {
const rect = this.fieldRef.current.getBoundingClientRect();
this.setState({ dimensions: rect });
} else {
this.hide();
}
}
protected hide(index?: number): void {
const selectedIndex = index === undefined ? this.state.original : index;
this.setState({
dimensions: undefined,
selected: selectedIndex,
original: selectedIndex,
hover: selectedIndex
});
}
protected renderDropdown(): React.ReactNode {
if (!this.state.dimensions) {
return;
}
if (this.mountedListeners.size === 0) {
// Only attach our listeners once we render our dropdown menu
this.attachListeners();
// We can now also calculate the optimal width
this.optimalWidth = this.getOptimalWidth();
this.optimalHeight = this.getOptimalHeight(Math.max(this.state.dimensions.width, this.optimalWidth));
}
const clientRect = document.getElementById('theia-app-shell')!.getBoundingClientRect();
const availableTop = this.state.dimensions.top - clientRect.top;
const availableBottom = clientRect.top + clientRect.height - this.state.dimensions.bottom;
// prefer rendering to the bottom unless there is not enough space and more content can be shown to the top
const invert = availableBottom < this.optimalHeight && (availableBottom - this.optimalHeight) < (availableTop - this.optimalHeight);
const { options } = this.props;
const { hover } = this.state;
const description = options[hover].description;
const markdown = options[hover].markdown;
const items = options.map((item, i) => this.renderOption(i, item));
if (description) {
let descriptionNode: React.ReactNode | undefined;
const className = 'theia-select-component-description';
if (markdown) {
descriptionNode = <div key="description" className={className}
dangerouslySetInnerHTML={{ __html: DOMPurify.sanitize(description) }} />; // eslint-disable-line react/no-danger
} else {
descriptionNode = <div key="description" className={className}>
{description}
</div>;
}
if (invert) {
items.unshift(descriptionNode);
} else {
items.push(descriptionNode);
}
}
const calculatedWidth = Math.max(this.state.dimensions.width, this.optimalWidth);
const maxWidth = clientRect.width - this.state.dimensions.left;
return <div key="dropdown" className="theia-select-component-dropdown" style={{
top: invert ? 'none' : this.state.dimensions.bottom,
bottom: invert ? clientRect.top + clientRect.height - this.state.dimensions.top : 'none',
left: this.state.dimensions.left,
width: Math.min(calculatedWidth, maxWidth),
maxHeight: clientRect.height - (invert ? clientRect.height - this.state.dimensions.bottom : this.state.dimensions.top) - this.state.dimensions.height,
position: 'absolute'
}}>
{items}
</div>;
}
protected renderOption(index: number, option: SelectOption): React.ReactNode {
if (option.separator) {
return <div key={index} className="theia-select-component-separator" />;
}
const selected = this.state.hover;
return (
<div
key={index}
className={`theia-select-component-option${index === selected ? ' selected' : ''}`}
onMouseOver={() => {
this.setState({
hover: index
});
}}
onMouseDown={() => {
this.selectOption(index, option);
}}
>
<div key="value" className="theia-select-component-option-value">{option.label ?? option.value}</div>
{option.detail && <div key="detail" className="theia-select-component-option-detail">{option.detail}</div>}
</div>
);
}
protected selectOption(index: number, option: SelectOption): void {
this.props.onChange?.(option, index);
this.hide(index);
}
}