/
inputdialog.ts
608 lines (546 loc) · 14.4 KB
/
inputdialog.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
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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
import { Message } from '@lumino/messaging';
import { Widget } from '@lumino/widgets';
import { Dialog, showDialog } from './dialog';
const INPUT_DIALOG_CLASS = 'jp-Input-Dialog';
const INPUT_BOOLEAN_DIALOG_CLASS = 'jp-Input-Boolean-Dialog';
/**
* Namespace for input dialogs
*/
export namespace InputDialog {
/**
* Common constructor options for input dialogs
*/
export interface IOptions extends IBaseOptions {
/**
* The top level text for the dialog. Defaults to an empty string.
*/
title: Dialog.Header;
/**
* The host element for the dialog. Defaults to `document.body`.
*/
host?: HTMLElement;
/**
* An optional renderer for dialog items. Defaults to a shared
* default renderer.
*/
renderer?: Dialog.IRenderer;
/**
* Label for ok button.
*/
okLabel?: string;
/**
* Label for cancel button.
*/
cancelLabel?: string;
/**
* The checkbox to display in the footer. Defaults no checkbox.
*/
checkbox?: Partial<Dialog.ICheckbox> | null;
/**
* The index of the default button. Defaults to the last button.
*/
defaultButton?: number;
}
/**
* Constructor options for boolean input dialogs
*/
export interface IBooleanOptions extends IOptions {
/**
* Default value
*/
value?: boolean;
}
/**
* Create and show a input dialog for a boolean.
*
* @param options - The dialog setup options.
*
* @returns A promise that resolves with whether the dialog was accepted
*/
export function getBoolean(
options: IBooleanOptions
): Promise<Dialog.IResult<boolean>> {
return showDialog({
...options,
body: new InputBooleanDialog(options),
buttons: [
Dialog.cancelButton({ label: options.cancelLabel }),
Dialog.okButton({ label: options.okLabel })
],
focusNodeSelector: 'input'
});
}
/**
* Constructor options for number input dialogs
*/
export interface INumberOptions extends IOptions {
/**
* Default value
*/
value?: number;
}
/**
* Create and show a input dialog for a number.
*
* @param options - The dialog setup options.
*
* @returns A promise that resolves with whether the dialog was accepted
*/
export function getNumber(
options: INumberOptions
): Promise<Dialog.IResult<number>> {
return showDialog({
...options,
body: new InputNumberDialog(options),
buttons: [
Dialog.cancelButton({ label: options.cancelLabel }),
Dialog.okButton({ label: options.okLabel })
],
focusNodeSelector: 'input'
});
}
/**
* Constructor options for item selection input dialogs
*/
export interface IItemOptions extends IOptions {
/**
* List of choices
*/
items: Array<string>;
/**
* Default choice
*
* If the list is editable a string with a default value can be provided
* otherwise the index of the default choice should be given.
*/
current?: number | string;
/**
* Is the item editable?
*/
editable?: boolean;
/**
* Placeholder text for editable input
*/
placeholder?: string;
}
/**
* Create and show a input dialog for a choice.
*
* @param options - The dialog setup options.
*
* @returns A promise that resolves with whether the dialog was accepted
*/
export function getItem(
options: IItemOptions
): Promise<Dialog.IResult<string>> {
return showDialog({
...options,
body: new InputItemsDialog(options),
buttons: [
Dialog.cancelButton({ label: options.cancelLabel }),
Dialog.okButton({ label: options.okLabel })
],
focusNodeSelector: options.editable ? 'input' : 'select'
});
}
/**
* Constructor options for item selection input dialogs
*/
export interface IMultipleItemsOptions extends IOptions {
/**
* List of choices
*/
items: Array<string>;
/**
* Default choices
*/
defaults?: string[];
}
/**
* Create and show a input dialog for a choice.
*
* @param options - The dialog setup options.
*
* @returns A promise that resolves with whether the dialog was accepted
*/
export function getMultipleItems(
options: IMultipleItemsOptions
): Promise<Dialog.IResult<string[]>> {
return showDialog({
...options,
body: new InputMultipleItemsDialog(options),
buttons: [
Dialog.cancelButton({ label: options.cancelLabel }),
Dialog.okButton({ label: options.okLabel })
]
});
}
/**
* Constructor options for text input dialogs
*/
export interface ITextOptions extends IOptions {
/**
* Default input text
*/
text?: string;
/**
* Placeholder text
*/
placeholder?: string;
/**
* Selection range
*
* Number of characters to pre-select when dialog opens.
* Default is to select the whole input text if present.
*/
selectionRange?: number;
/**
* Pattern used by the browser to validate the input value.
*/
pattern?: string;
/**
* Whether the input is required (has to be non-empty).
*/
required?: boolean;
}
/**
* Create and show a input dialog for a text.
*
* @param options - The dialog setup options.
*
* @returns A promise that resolves with whether the dialog was accepted
*/
export function getText(
options: ITextOptions
): Promise<Dialog.IResult<string>> {
return showDialog({
...options,
body: new InputTextDialog(options),
buttons: [
Dialog.cancelButton({ label: options.cancelLabel }),
Dialog.okButton({ label: options.okLabel })
],
focusNodeSelector: 'input'
});
}
/**
* Create and show a input dialog for a password.
*
* @param options - The dialog setup options.
*
* @returns A promise that resolves with whether the dialog was accepted
*/
export function getPassword(
options: Omit<ITextOptions, 'selectionRange'>
): Promise<Dialog.IResult<string>> {
return showDialog({
...options,
body: new InputPasswordDialog(options),
buttons: [
Dialog.cancelButton({ label: options.cancelLabel }),
Dialog.okButton({ label: options.okLabel })
],
focusNodeSelector: 'input'
});
}
}
/**
* Constructor options for base input dialog body.
*/
interface IBaseOptions {
/**
* Label of the requested input
*/
label?: string;
/**
* Additional prefix string preceding the input (e.g. £).
*/
prefix?: string;
/**
* Additional suffix string following the input (e.g. $).
*/
suffix?: string;
}
/**
* Base widget for input dialog body
*/
class InputDialogBase<T> extends Widget implements Dialog.IBodyWidget<T> {
/**
* InputDialog constructor
*
* @param label Input field label
*/
constructor(options: IBaseOptions) {
super();
this.addClass(INPUT_DIALOG_CLASS);
this._input = document.createElement('input');
this._input.classList.add('jp-mod-styled');
this._input.id = 'jp-dialog-input-id';
if (options.label !== undefined) {
const labelElement = document.createElement('label');
labelElement.textContent = options.label;
labelElement.htmlFor = this._input.id;
// Initialize the node
this.node.appendChild(labelElement);
}
const wrapper = document.createElement('div');
wrapper.className = 'jp-InputDialog-inputWrapper';
if (options.prefix) {
const prefix = document.createElement('span');
prefix.className = 'jp-InputDialog-inputPrefix';
prefix.textContent = options.prefix;
// Both US WDS (https://designsystem.digital.gov/components/input-prefix-suffix/)
// and UK DS (https://design-system.service.gov.uk/components/text-input/) recommend
// hiding prefixes and suffixes from screen readers.
prefix.ariaHidden = 'true';
wrapper.appendChild(prefix);
}
wrapper.appendChild(this._input);
if (options.suffix) {
const suffix = document.createElement('span');
suffix.className = 'jp-InputDialog-inputSuffix';
suffix.textContent = options.suffix;
suffix.ariaHidden = 'true';
wrapper.appendChild(suffix);
}
this.node.appendChild(wrapper);
}
/** Input HTML node */
protected _input: HTMLInputElement;
}
/**
* Widget body for input boolean dialog
*/
class InputBooleanDialog extends InputDialogBase<boolean> {
/**
* InputBooleanDialog constructor
*
* @param options Constructor options
*/
constructor(options: InputDialog.IBooleanOptions) {
super(options);
this.addClass(INPUT_BOOLEAN_DIALOG_CLASS);
this._input.type = 'checkbox';
this._input.checked = options.value ? true : false;
}
/**
* Get the text specified by the user
*/
getValue(): boolean {
return this._input.checked;
}
}
/**
* Widget body for input number dialog
*/
class InputNumberDialog extends InputDialogBase<number> {
/**
* InputNumberDialog constructor
*
* @param options Constructor options
*/
constructor(options: InputDialog.INumberOptions) {
super(options);
this._input.type = 'number';
this._input.value = options.value ? options.value.toString() : '0';
}
/**
* Get the number specified by the user.
*/
getValue(): number {
if (this._input.value) {
return Number(this._input.value);
} else {
return Number.NaN;
}
}
}
/**
* Base widget body for input text/password/email dialog
*/
class InputDialogTextBase extends InputDialogBase<string> {
/**
* InputDialogTextBase constructor
*
* @param options Constructor options
*/
constructor(options: Omit<InputDialog.ITextOptions, 'selectionRange'>) {
super(options);
this._input.value = options.text ? options.text : '';
if (options.placeholder) {
this._input.placeholder = options.placeholder;
}
if (options.pattern) {
this._input.pattern = options.pattern;
}
if (options.required) {
this._input.required = options.required;
}
}
/**
* Get the text specified by the user
*/
getValue(): string {
return this._input.value;
}
}
/**
* Widget body for input text dialog
*/
class InputTextDialog extends InputDialogTextBase {
/**
* InputTextDialog constructor
*
* @param options Constructor options
*/
constructor(options: InputDialog.ITextOptions) {
super(options);
this._input.type = 'text';
this._initialSelectionRange = Math.min(
this._input.value.length,
Math.max(0, options.selectionRange ?? this._input.value.length)
);
}
/**
* A message handler invoked on an `'after-attach'` message.
*/
protected onAfterAttach(msg: Message): void {
super.onAfterAttach(msg);
if (this._initialSelectionRange > 0 && this._input.value) {
this._input.setSelectionRange(0, this._initialSelectionRange);
}
}
private _initialSelectionRange: number;
}
/**
* Widget body for input password dialog
*/
class InputPasswordDialog extends InputDialogTextBase {
/**
* InputPasswordDialog constructor
*
* @param options Constructor options
*/
constructor(options: InputDialog.ITextOptions) {
super(options);
this._input.type = 'password';
}
/**
* A message handler invoked on an `'after-attach'` message.
*/
protected onAfterAttach(msg: Message): void {
super.onAfterAttach(msg);
if (this._input.value) {
this._input.select();
}
}
}
/**
* Widget body for input list dialog
*/
class InputItemsDialog extends InputDialogBase<string> {
/**
* InputItemsDialog constructor
*
* @param options Constructor options
*/
constructor(options: InputDialog.IItemOptions) {
super(options);
this._editable = options.editable || false;
let current = options.current || 0;
let defaultIndex: number;
if (typeof current === 'number') {
defaultIndex = Math.max(0, Math.min(current, options.items.length - 1));
current = '';
}
this._list = document.createElement('select');
options.items.forEach((item, index) => {
const option = document.createElement('option');
if (index === defaultIndex) {
option.selected = true;
current = item;
}
option.value = item;
option.textContent = item;
this._list.appendChild(option);
});
if (options.editable) {
/* Use of list and datalist */
const data = document.createElement('datalist');
data.id = 'input-dialog-items';
data.appendChild(this._list);
this._input.type = 'list';
this._input.value = current;
this._input.setAttribute('list', data.id);
if (options.placeholder) {
this._input.placeholder = options.placeholder;
}
this.node.appendChild(data);
} else {
/* Use select directly */
this._input.parentElement!.replaceChild(this._list, this._input);
}
}
/**
* Get the user choice
*/
getValue(): string {
if (this._editable) {
return this._input.value;
} else {
return this._list.value;
}
}
private _list: HTMLSelectElement;
private _editable: boolean;
}
/**
* Widget body for input list dialog
*/
class InputMultipleItemsDialog extends InputDialogBase<string> {
/**
* InputMultipleItemsDialog constructor
*
* @param options Constructor options
*/
constructor(options: InputDialog.IMultipleItemsOptions) {
super(options);
let defaults = options.defaults || [];
this._list = document.createElement('select');
this._list.setAttribute('multiple', '');
options.items.forEach(item => {
const option = document.createElement('option');
option.value = item;
option.textContent = item;
this._list.appendChild(option);
});
// use the select
this._input.remove();
this.node.appendChild(this._list);
// select the current ones
const htmlOptions = this._list.options;
for (let i: number = 0; i < htmlOptions.length; i++) {
const option = htmlOptions[i];
if (defaults.includes(option.value)) {
option.selected = true;
} else {
option.selected = false;
}
}
}
/**
* Get the user choices
*/
getValue(): string[] {
let result = [];
for (let opt of this._list.options) {
if (opt.selected && !opt.classList.contains('hidden')) {
result.push(opt.value || opt.text);
}
}
return result;
}
private _list: HTMLSelectElement;
}