x4js 2.0.35 → 2.1.0-manual

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/README.md +21 -21
  2. package/package.json +39 -26
  3. package/src/components/base.scss +25 -89
  4. package/src/components/boxes/boxes.module.scss +54 -54
  5. package/src/components/boxes/boxes.ts +513 -513
  6. package/src/components/breadcrumb/breadcrumb.scss +56 -56
  7. package/src/components/breadcrumb/breadcrumb.ts +93 -93
  8. package/src/components/btngroup/btngroup.module.scss +40 -40
  9. package/src/components/btngroup/btngroup.ts +152 -152
  10. package/src/components/button/button.module.scss +172 -172
  11. package/src/components/button/button.ts +232 -232
  12. package/src/components/calendar/calendar.module.scss +162 -162
  13. package/src/components/calendar/calendar.ts +326 -326
  14. package/src/components/canvas/canvas.module.scss +24 -24
  15. package/src/components/canvas/canvas.ts +195 -195
  16. package/src/components/canvas/canvas_ex.ts +275 -275
  17. package/src/components/checkbox/check.svg +3 -3
  18. package/src/components/checkbox/checkbox.module.scss +141 -141
  19. package/src/components/checkbox/checkbox.ts +139 -139
  20. package/src/components/colorinput/colorinput.module.scss +64 -64
  21. package/src/components/colorinput/colorinput.ts +90 -90
  22. package/src/components/colorpicker/colorpicker.module.scss +132 -132
  23. package/src/components/colorpicker/colorpicker.ts +481 -481
  24. package/src/components/combobox/combobox.module.scss +145 -145
  25. package/src/components/combobox/combobox.ts +282 -282
  26. package/src/components/combobox/updown.svg +3 -3
  27. package/src/components/components.ts +45 -44
  28. package/src/components/dialog/dialog.module.scss +103 -105
  29. package/src/components/dialog/dialog.ts +233 -233
  30. package/src/components/filedrop/filedrop.module.scss +69 -69
  31. package/src/components/filedrop/filedrop.ts +130 -130
  32. package/src/components/form/form.module.scss +38 -38
  33. package/src/components/form/form.ts +172 -172
  34. package/src/components/gridview/gridview.module.scss +323 -337
  35. package/src/components/gridview/gridview.ts +1276 -1316
  36. package/src/components/header/header.module.scss +40 -40
  37. package/src/components/header/header.ts +141 -141
  38. package/src/components/icon/icon.module.scss +32 -32
  39. package/src/components/icon/icon.ts +165 -165
  40. package/src/components/image/image.module.scss +27 -27
  41. package/src/components/image/image.ts +168 -168
  42. package/src/components/input/input.module.scss +74 -74
  43. package/src/components/input/input.ts +537 -537
  44. package/src/components/keyboard/keyboard.module.scss +136 -136
  45. package/src/components/keyboard/keyboard.ts +549 -549
  46. package/src/components/label/label.module.scss +90 -91
  47. package/src/components/label/label.ts +101 -101
  48. package/src/components/link/link.module.scss +44 -44
  49. package/src/components/link/link.ts +87 -87
  50. package/src/components/listbox/listbox.module.scss +179 -179
  51. package/src/components/listbox/listbox.ts +596 -596
  52. package/src/components/menu/menu.module.scss +128 -128
  53. package/src/components/menu/menu.ts +174 -174
  54. package/src/components/messages/messages.module.scss +92 -146
  55. package/src/components/messages/messages.ts +237 -303
  56. package/src/components/normalize.scss +391 -391
  57. package/src/components/notification/notification.module.scss +83 -83
  58. package/src/components/notification/notification.ts +107 -107
  59. package/src/components/panel/panel.module.scss +66 -71
  60. package/src/components/panel/panel.ts +57 -57
  61. package/src/components/popup/popup.module.scss +51 -51
  62. package/src/components/popup/popup.ts +457 -457
  63. package/src/components/progress/progress.module.scss +56 -56
  64. package/src/components/progress/progress.ts +43 -43
  65. package/src/components/propgrid/progrid.module.scss +111 -111
  66. package/src/components/propgrid/propgrid.ts +300 -300
  67. package/src/components/propgrid/updown.svg +3 -3
  68. package/src/components/radio/radio.module.scss +163 -163
  69. package/src/components/radio/radio.svg +3 -3
  70. package/src/components/radio/radio.ts +141 -141
  71. package/src/components/rating/rating.module.scss +22 -22
  72. package/src/components/rating/rating.ts +131 -131
  73. package/src/components/select/select.module.scss +8 -8
  74. package/src/components/select/select.ts +134 -134
  75. package/src/components/shared.scss +141 -71
  76. package/src/components/sizers/sizer.module.scss +90 -112
  77. package/src/components/sizers/sizer.ts +131 -155
  78. package/src/components/slider/slider.module.scss +117 -117
  79. package/src/components/slider/slider.ts +197 -197
  80. package/src/components/spreadsheet/spreadsheet.module.scss +307 -307
  81. package/src/components/spreadsheet/spreadsheet.ts +1223 -1223
  82. package/src/components/switch/switch.module.scss +126 -126
  83. package/src/components/switch/switch.ts +61 -61
  84. package/src/components/tabs/tabs.module.scss +46 -67
  85. package/src/components/tabs/tabs.ts +229 -234
  86. package/src/components/textarea/textarea.module.scss +63 -63
  87. package/src/components/textarea/textarea.ts +131 -131
  88. package/src/components/textedit/textedit.module.scss +115 -115
  89. package/src/components/textedit/textedit.ts +122 -122
  90. package/src/components/themes.scss +90 -90
  91. package/src/components/tickline/tickline.module.scss +25 -25
  92. package/src/components/tickline/tickline.ts +81 -81
  93. package/src/components/tooltips/tooltips.scss +71 -71
  94. package/src/components/tooltips/tooltips.ts +120 -120
  95. package/src/components/treeview/treeview.module.scss +192 -192
  96. package/src/components/treeview/treeview.ts +484 -484
  97. package/src/components/viewport/viewport.module.scss +31 -31
  98. package/src/components/viewport/viewport.ts +41 -41
  99. package/src/core/component.ts +1299 -1299
  100. package/src/core/core_application.ts +361 -361
  101. package/src/core/core_colors.ts +512 -512
  102. package/src/core/core_data.ts +1297 -1310
  103. package/src/core/core_dom.ts +481 -481
  104. package/src/core/core_dragdrop.ts +225 -225
  105. package/src/core/core_element.ts +221 -221
  106. package/src/core/core_events.ts +214 -214
  107. package/src/core/core_i18n.ts +395 -395
  108. package/src/core/core_pdf.ts +454 -454
  109. package/src/core/core_react.ts +78 -78
  110. package/src/core/core_router.ts +296 -296
  111. package/src/core/core_state.ts +62 -62
  112. package/src/core/core_styles.ts +213 -213
  113. package/src/core/core_svg.ts +1042 -1042
  114. package/src/core/core_tools.ts +996 -996
  115. package/src/types/scss.d.ts +4 -4
  116. package/src/types/x4react.d.ts +8 -8
  117. package/src/x4.scss +19 -19
  118. package/src/x4.ts +36 -36
  119. package/src/x4tsx.d.ts +26 -26
  120. package/.vscode/launch.json +0 -14
  121. package/.vscode/settings.json +0 -2
  122. package/demo/assets/house-light.svg +0 -1
  123. package/demo/assets/radio.svg +0 -4
  124. package/demo/index.html +0 -12
  125. package/demo/main.scss +0 -23
  126. package/demo/main.ts +0 -324
  127. package/demo/package.json +0 -26
  128. package/demo/scss.d.ts +0 -4
  129. package/demo/svg.d.ts +0 -1
  130. package/demo/tsconfig.json +0 -14
  131. package/src/components/gridview/folder-open.svg +0 -1
  132. package/src/components/messages/spinner.svg +0 -1
  133. package/src/x4.d.ts +0 -10
  134. package/tsconfig.json +0 -11
@@ -1,596 +1,596 @@
1
- /**
2
- * ___ ___ __
3
- * \ \/ / / _
4
- * \ / /_| |_
5
- * / \____ _|
6
- * /__/\__\ |_|
7
- *
8
- * @file listbox.ts
9
- * @author Etienne Cochard
10
- *
11
- * @copyright (c) 2024 R-libre ingenierie
12
- *
13
- * Use of this source code is governed by an MIT-style license
14
- * that can be found in the LICENSE file or at https://opensource.org/licenses/MIT.
15
- **/
16
-
17
- import { Component, ComponentEvent, ComponentEvents, componentFromDOM, ComponentProps, EvChange, EvClick, EvContextMenu, EvDblClick, EvSelectionChange } from '../../core/component';
18
- import { EventCallback } from '../../core/core_events';
19
- import { kbNav, class_ns, isArray, UnsafeHtml, asap } from '../../core/core_tools';
20
-
21
- import { ScrollView, Viewport } from '../viewport/viewport';
22
- import { Header } from '../header/header';
23
-
24
- import { HBox } from '../boxes/boxes';
25
- import { Label } from '../label/label';
26
-
27
- import "./listbox.module.scss"
28
-
29
- export type ListboxID = number | string;
30
-
31
- export interface ListItem {
32
- id: ListboxID;
33
- text: string | UnsafeHtml;
34
-
35
- iconId?: string;
36
- data?: any;
37
- cls?: string;
38
- checked?: boolean;
39
- }
40
-
41
- /**
42
- *
43
- */
44
-
45
- export interface ListboxEvents extends ComponentEvents {
46
- click?: EvClick;
47
- dblClick?: EvDblClick;
48
- contextMenu?: EvContextMenu;
49
- selectionChange?: EvSelectionChange;
50
- }
51
-
52
- /**
53
- *
54
- */
55
-
56
- export interface ListboxProps extends Omit<ComponentProps,'content'> {
57
- items?: ListItem[];
58
- renderer?: ( item: ListItem ) => Component;
59
- title?: string;
60
- icon?: string;
61
- header?: Header;
62
- footer?: Component,
63
- checkable?: true,
64
- multisel?: true,
65
-
66
- dblClick?: EventCallback<EvDblClick>;
67
- selectionChange?: EventCallback<EvSelectionChange>;
68
- contextMenu?: EventCallback<EvContextMenu>;
69
- }
70
-
71
- /**
72
- *
73
- */
74
-
75
- @class_ns( "x4" )
76
- export class Listbox extends Component<ListboxProps,ListboxEvents> {
77
-
78
- private _view: Viewport;
79
- //private _selection: ListboxID;
80
- //private _selitem: Component;
81
-
82
- private _lastsel: ListboxID;
83
-
84
- private _multisel: Set<ListboxID>;
85
- private _items: ListItem[];
86
-
87
- preventFocus = false;
88
-
89
- constructor( props: ListboxProps ) {
90
- super( { ...props } );
91
-
92
- this.setAttribute( "tabindex", 0 );
93
- this.mapPropEvents( props, "dblClick", "selectionChange", "contextMenu" );
94
-
95
- const scroller = new ScrollView( { cls: "body" } );
96
- this._view = scroller.getViewport( );
97
- this._multisel = new Set( );
98
- this._items = [];
99
-
100
- if( props.footer ) {
101
- props.footer.setAttribute( "id", "footer" );
102
- }
103
-
104
- if( props.header ) {
105
- props.header.setAttribute( "id", "header" );
106
- }
107
-
108
- this.setContent( [
109
- (props.title || props.icon) ? new Label( { cls: 'title', text: props.title, icon: props.icon }) : null,
110
- props.header ? props.header : null,
111
- scroller,
112
- props.footer,
113
- ] );
114
-
115
- this.setDOMEvents( {
116
- click: (ev) => this._on_click( ev ),
117
- keydown: ( ev ) => this._on_key( ev ),
118
- dblclick: (e) => this._on_click(e),
119
- contextmenu: (e) => this._on_ctx_menu(e),
120
- } );
121
-
122
- if( props.items ) {
123
- this.setItems( props.items, false );
124
- }
125
- }
126
-
127
- /**
128
- *
129
- */
130
-
131
- private _on_key( ev: KeyboardEvent ) {
132
- if( this.isDisabled() ) {
133
- return;
134
- }
135
-
136
- switch( ev.key ) {
137
- case "ArrowDown": {
138
- this.navigate( kbNav.next );
139
- break;
140
- }
141
-
142
- case "ArrowUp": {
143
- this.navigate( kbNav.prev );
144
- break;
145
- }
146
-
147
- case "Home": {
148
- this.navigate( kbNav.first );
149
- break;
150
- }
151
-
152
- case "End": {
153
- this.navigate( kbNav.last );
154
- break;
155
- }
156
-
157
- default:
158
- return;
159
- }
160
-
161
- ev.preventDefault( );
162
- ev.stopPropagation( );
163
- }
164
-
165
- /**
166
- *
167
- */
168
-
169
- navigate( sens: kbNav ) {
170
-
171
- if( !this._lastsel ) {
172
- if( sens==kbNav.next ) sens = kbNav.first;
173
- else sens = kbNav.last;
174
- }
175
-
176
- const next_visible = ( el: Component, down: boolean ) => {
177
-
178
- while( el && !el.isVisible() ) {
179
- el = down ? el.nextElement() : el.prevElement();
180
- }
181
-
182
- return el;
183
- }
184
-
185
- if( sens==kbNav.first || sens==kbNav.last ) {
186
- let fel = sens==kbNav.first ? this._view.firstChild() : this._view.lastChild( );
187
- fel = next_visible( fel, sens==kbNav.first );
188
-
189
- if( fel ) {
190
- const id = fel.getInternalData( "id" );
191
- this._selectItem( id, fel, 'single' );
192
- return true;
193
- }
194
- }
195
- else {
196
- const selitem = this._itemWithID( this._lastsel );
197
-
198
- let nel;
199
- if( selitem ) {
200
- nel = sens==kbNav.next ? selitem.nextElement() : selitem.prevElement();
201
- nel = next_visible( nel, sens==kbNav.next );
202
- }
203
- else {
204
- nel = sens==kbNav.next ? this._view.firstChild() : this._view.lastChild( );
205
- }
206
-
207
- if( nel ) {
208
- const id = nel.getInternalData( "id" );
209
- this._selectItem( id, nel, 'single' );
210
- return true;
211
- }
212
- }
213
-
214
- return false;
215
- }
216
-
217
- /**
218
- *
219
- */
220
-
221
- private _itemWithID( id: ListboxID ) {
222
- //const itm = this.query( `[data-id="${id}"]` );
223
- const all = this._view.enumChildComponents( false );
224
- return all.find( x => x.getInternalData("id")===id )
225
- }
226
-
227
- /**
228
- *
229
- */
230
-
231
- private _on_click( ev: MouseEvent ) {
232
- let target = ev.target as HTMLElement;
233
-
234
- while( target && target!=this.dom ) {
235
- const c = componentFromDOM( target );
236
-
237
- // avoid trapping child ckick
238
- if( c.dom.tagName==='INPUT' ) {
239
- return;
240
- }
241
-
242
- if( c && c.hasClass("x4item") ) {
243
- const id = c.getInternalData( "id" );
244
- const fev: ComponentEvent = { context:id };
245
- if (ev.type == 'click') {
246
- this.fire('click', fev );
247
- }
248
- else {
249
- this.fire('dblClick', fev );
250
- }
251
-
252
- if (!fev.defaultPrevented) {
253
- this._selectItem( id, c, ev.ctrlKey ? 'toggle' : 'single' );
254
- }
255
-
256
- return;
257
- }
258
-
259
- target = target.parentElement;
260
- }
261
-
262
- this.clearSelection( );
263
-
264
- ev.stopImmediatePropagation();
265
- ev.preventDefault( );
266
- }
267
-
268
- /**
269
- *
270
- */
271
-
272
- private _on_ctx_menu(ev: MouseEvent) {
273
-
274
- ev.preventDefault();
275
-
276
- let target = ev.target as HTMLElement;
277
- while( target && target!=this.dom ) {
278
- const c = componentFromDOM( target );
279
- if( c && c.hasClass("x4item") ) {
280
- const id = c.getInternalData( "id" );
281
-
282
- this._selectItem(id, c, 'single' );
283
- this.fire('contextMenu', {uievent: ev, context: id } );
284
-
285
- return;
286
- }
287
-
288
- target = target.parentElement;
289
- }
290
-
291
- this.fire('contextMenu', { uievent:ev, context: null } );
292
- }
293
-
294
- /**
295
- *
296
- */
297
-
298
- private _selectItem( id: ListboxID, item: Component, mode: "single" | "toggle" ) {
299
-
300
- if( !this.props.multisel ) {
301
- mode = 'single';
302
- }
303
-
304
- this._lastsel = id;
305
-
306
- if( mode=='single' ) {
307
- if( this._multisel.has(id) ) {
308
- return;
309
- }
310
-
311
- this._clearSelection( );
312
- if( item ) {
313
- this._multisel.add( id );
314
- item.addClass( "selected" );
315
- }
316
- }
317
- else { // toggle
318
- if( item ) {
319
- if( this._multisel.has(id) ) {
320
- item.removeClass( "selected" );
321
- this._multisel.delete( id );
322
- }
323
- else {
324
- this._multisel.add( id );
325
- item.addClass( "selected" );
326
- }
327
- }
328
- }
329
-
330
- if( item ) {
331
- item.scrollIntoView( {
332
- behavior: "smooth",
333
- block: "nearest"
334
- } );
335
- }
336
-
337
- this.fire( "selectionChange", { selection: this.getSelection(), empty: this._multisel.size==0 } );
338
- }
339
-
340
- /**
341
- *
342
- */
343
-
344
- getItem( id: ListboxID ): ListItem {
345
- return this._items.find( x => x.id===id );
346
- }
347
-
348
- /**
349
- * select an item by it's id
350
- */
351
-
352
- select( ids: ListboxID | ListboxID[], notify = true ) {
353
-
354
- if( !isArray(ids) ) {
355
- ids = [ids];
356
- }
357
-
358
- if( !ids.length ) {
359
- if( this._multisel.size ) {
360
- if( notify ) {
361
- this.clearSelection( );
362
- }
363
- else {
364
- this._clearSelection( );
365
- }
366
- }
367
-
368
- return;
369
- }
370
-
371
- // if one of new selection not in old selection...
372
- if( ids.some( x => !this._multisel.has(x)) ) {
373
- this._clearSelection( );
374
- const all = this._view.enumChildComponents( false );
375
-
376
- ids.forEach( id => {
377
- const itm = all.find( x => x.getInternalData("id")===id ); //this.query( `[data-id="${id}"]` );
378
- if( itm ) {
379
- this._multisel.add( id );
380
- itm.addClass( "selected" );
381
- }
382
- });
383
-
384
- if( notify ) {
385
- this.fire( "selectionChange", { selection: this.getSelection(), empty: this._multisel.size==0 } );
386
- }
387
- }
388
- }
389
-
390
- /**
391
- *
392
- */
393
-
394
- private _findItemIndex( id: ListboxID ) {
395
- return this._items.findIndex( x => x.id==id );
396
- }
397
-
398
- /**
399
- *
400
- */
401
-
402
- private _clearSelection( ) {
403
-
404
- const all = this._view.enumChildComponents( false );
405
-
406
- if( this._multisel.size ) {
407
- const ids = Array.from( this._multisel );
408
- ids.forEach( id => {
409
- const itm = all.find( x => x.getInternalData("id")===id ); //this.query( `[data-id="${id}"]` );
410
- if( itm ) {
411
- itm.removeClass( "selected" );
412
- }
413
- } );
414
- }
415
-
416
- this._multisel.clear( );
417
- }
418
-
419
- clearSelection( fireEvent = true ) {
420
- if( this._multisel.size ) {
421
- this._clearSelection( );
422
- if( fireEvent ) {
423
- this.fire( "selectionChange", { selection: [], empty: true } );
424
- }
425
- }
426
- }
427
-
428
- /**
429
- *
430
- */
431
-
432
- setItems( items: ListItem[], keepSel = false ) {
433
-
434
- const oldSel = this.getSelection( );
435
-
436
- this.clearSelection( );
437
- this._view.clearContent( );
438
- this._items = items ?? [];
439
-
440
- let update_sel = false;
441
-
442
- if( this._items.length ) {
443
- const content = items.map( x => this.renderItem(x) );
444
- this._view.setContent( content );
445
-
446
- if( keepSel && oldSel.length>0 ) {
447
- this.select( oldSel );
448
- }
449
- }
450
- else {
451
- update_sel = oldSel.length>0;
452
- }
453
-
454
- if( update_sel ) {
455
- this.setTimeout( "sel", 100, ( ) => {
456
- this.fire( "selectionChange", { selection: [], empty: true } );
457
- } );
458
- }
459
- }
460
-
461
- /**
462
- *
463
- */
464
-
465
- renderItem( item: ListItem ) {
466
- const renderer = this.props.renderer ?? this.defaultRenderer;
467
- const line = renderer( item );
468
-
469
- line.addClass( "x4item" );
470
- line.setInternalData( "id", item.id );
471
-
472
- return line;
473
- }
474
-
475
- /**
476
- *
477
- */
478
-
479
- defaultRenderer( item: ListItem ): Component {
480
- return new HBox( {
481
- cls: item.cls,
482
- content: new Label( { icon: item.iconId, text: item.text })
483
- } )
484
- }
485
-
486
- /**
487
- *
488
- */
489
-
490
- filter( filter: string | RegExp ) {
491
- const childs = this._view.enumChildComponents( false );
492
-
493
- if( !filter ) {
494
- childs.forEach( x => x.show( true ) );
495
- }
496
- else {
497
- // get list of visible items
498
- let filtred: Set<ListboxID>;
499
-
500
- if( filter instanceof RegExp ) {
501
- const f = filter as RegExp;
502
- filtred = new Set( this._items
503
- .filter( x => f.test(x.text as string) )
504
- .map( x => x.id ) );
505
- }
506
- else {
507
- const f = filter.toUpperCase( );
508
- filtred = new Set( this._items
509
- .filter( x => x.text.toUpperCase().includes(f) )
510
- .map( x => x.id ) );
511
- }
512
-
513
- // now hide all elements not in list
514
- childs.forEach( x => {
515
- x.show( filtred.has( x.getInternalData( "id" ) ) );
516
- });
517
- }
518
- }
519
-
520
- /**
521
- * append or prepend a new item
522
- * @param item
523
- * @param prepend
524
- * @param select
525
- */
526
-
527
- appendItem( item: ListItem, prepend = false, select = true ) {
528
-
529
- if( select ) {
530
- this._clearSelection( );
531
- }
532
-
533
- let el = this.renderItem( item );
534
-
535
- if( prepend ) {
536
- this._items.unshift( item );
537
- this._view.prependContent( el );
538
- }
539
- else {
540
- this._items.push( item );
541
- this._view.appendContent( el );
542
- }
543
-
544
- if( select ) {
545
- this._selectItem( item.id, el, 'single' );
546
- }
547
- }
548
-
549
- /**
550
- * update an item
551
- */
552
-
553
- updateItem( id: any, item: ListItem ) {
554
-
555
- // find item
556
- const idx = this._findItemIndex( id );
557
- if( idx<0 ) {
558
- return;
559
- }
560
-
561
- // take care of selection
562
- let was_sel = false;
563
- if( this._multisel.has(id) ) {
564
- was_sel = true;
565
- }
566
-
567
- // replace it in the list
568
- this._items[idx] = item;
569
-
570
- // rebuild & replace it's line
571
- const old = this._itemWithID( item.id );
572
- if( old?.dom ) {
573
- const _new = this.renderItem( item );
574
- if( was_sel ) {
575
- _new.addClass( "selected" );
576
- }
577
-
578
- this._view.dom.replaceChild( _new.dom, old.dom );
579
- }
580
- }
581
-
582
- getSelection( ) {
583
- return Array.from( this._multisel );
584
- }
585
-
586
- ensureSelectionVisible( ) {
587
- const sels = Array.from( this._multisel.values() );
588
- if( sels.length) {
589
- const item = this._itemWithID( sels[0] );
590
- item?.scrollIntoView( {
591
- behavior: "instant",
592
- block: "nearest"
593
- } )
594
- }
595
- }
596
- }
1
+ /**
2
+ * ___ ___ __
3
+ * \ \/ / / _
4
+ * \ / /_| |_
5
+ * / \____ _|
6
+ * /__/\__\ |_|
7
+ *
8
+ * @file listbox.ts
9
+ * @author Etienne Cochard
10
+ *
11
+ * @copyright (c) 2024 R-libre ingenierie
12
+ *
13
+ * Use of this source code is governed by an MIT-style license
14
+ * that can be found in the LICENSE file or at https://opensource.org/licenses/MIT.
15
+ **/
16
+
17
+ import { Component, ComponentEvent, ComponentEvents, componentFromDOM, ComponentProps, EvChange, EvClick, EvContextMenu, EvDblClick, EvSelectionChange } from '../../core/component';
18
+ import { EventCallback } from '../../core/core_events';
19
+ import { kbNav, class_ns, isArray, UnsafeHtml, asap } from '../../core/core_tools';
20
+
21
+ import { ScrollView, Viewport } from '../viewport/viewport';
22
+ import { Header } from '../header/header';
23
+
24
+ import { HBox } from '../boxes/boxes';
25
+ import { Label } from '../label/label';
26
+
27
+ import "./listbox.module.scss"
28
+
29
+ export type ListboxID = number | string;
30
+
31
+ export interface ListItem {
32
+ id: ListboxID;
33
+ text: string | UnsafeHtml;
34
+
35
+ iconId?: string;
36
+ data?: any;
37
+ cls?: string;
38
+ checked?: boolean;
39
+ }
40
+
41
+ /**
42
+ *
43
+ */
44
+
45
+ export interface ListboxEvents extends ComponentEvents {
46
+ click?: EvClick;
47
+ dblClick?: EvDblClick;
48
+ contextMenu?: EvContextMenu;
49
+ selectionChange?: EvSelectionChange;
50
+ }
51
+
52
+ /**
53
+ *
54
+ */
55
+
56
+ export interface ListboxProps extends Omit<ComponentProps,'content'> {
57
+ items?: ListItem[];
58
+ renderer?: ( item: ListItem ) => Component;
59
+ title?: string;
60
+ icon?: string;
61
+ header?: Header;
62
+ footer?: Component,
63
+ checkable?: true,
64
+ multisel?: true,
65
+
66
+ dblClick?: EventCallback<EvDblClick>;
67
+ selectionChange?: EventCallback<EvSelectionChange>;
68
+ contextMenu?: EventCallback<EvContextMenu>;
69
+ }
70
+
71
+ /**
72
+ *
73
+ */
74
+
75
+ @class_ns( "x4" )
76
+ export class Listbox extends Component<ListboxProps,ListboxEvents> {
77
+
78
+ private _view: Viewport;
79
+ //private _selection: ListboxID;
80
+ //private _selitem: Component;
81
+
82
+ private _lastsel: ListboxID;
83
+
84
+ private _multisel: Set<ListboxID>;
85
+ private _items: ListItem[];
86
+
87
+ preventFocus = false;
88
+
89
+ constructor( props: ListboxProps ) {
90
+ super( { ...props } );
91
+
92
+ this.setAttribute( "tabindex", 0 );
93
+ this.mapPropEvents( props, "dblClick", "selectionChange", "contextMenu" );
94
+
95
+ const scroller = new ScrollView( { cls: "body" } );
96
+ this._view = scroller.getViewport( );
97
+ this._multisel = new Set( );
98
+ this._items = [];
99
+
100
+ if( props.footer ) {
101
+ props.footer.setAttribute( "id", "footer" );
102
+ }
103
+
104
+ if( props.header ) {
105
+ props.header.setAttribute( "id", "header" );
106
+ }
107
+
108
+ this.setContent( [
109
+ (props.title || props.icon) ? new Label( { cls: 'title', text: props.title, icon: props.icon }) : null,
110
+ props.header ? props.header : null,
111
+ scroller,
112
+ props.footer,
113
+ ] );
114
+
115
+ this.setDOMEvents( {
116
+ click: (ev) => this._on_click( ev ),
117
+ keydown: ( ev ) => this._on_key( ev ),
118
+ dblclick: (e) => this._on_click(e),
119
+ contextmenu: (e) => this._on_ctx_menu(e),
120
+ } );
121
+
122
+ if( props.items ) {
123
+ this.setItems( props.items, false );
124
+ }
125
+ }
126
+
127
+ /**
128
+ *
129
+ */
130
+
131
+ private _on_key( ev: KeyboardEvent ) {
132
+ if( this.isDisabled() ) {
133
+ return;
134
+ }
135
+
136
+ switch( ev.key ) {
137
+ case "ArrowDown": {
138
+ this.navigate( kbNav.next );
139
+ break;
140
+ }
141
+
142
+ case "ArrowUp": {
143
+ this.navigate( kbNav.prev );
144
+ break;
145
+ }
146
+
147
+ case "Home": {
148
+ this.navigate( kbNav.first );
149
+ break;
150
+ }
151
+
152
+ case "End": {
153
+ this.navigate( kbNav.last );
154
+ break;
155
+ }
156
+
157
+ default:
158
+ return;
159
+ }
160
+
161
+ ev.preventDefault( );
162
+ ev.stopPropagation( );
163
+ }
164
+
165
+ /**
166
+ *
167
+ */
168
+
169
+ navigate( sens: kbNav ) {
170
+
171
+ if( !this._lastsel ) {
172
+ if( sens==kbNav.next ) sens = kbNav.first;
173
+ else sens = kbNav.last;
174
+ }
175
+
176
+ const next_visible = ( el: Component, down: boolean ) => {
177
+
178
+ while( el && !el.isVisible() ) {
179
+ el = down ? el.nextElement() : el.prevElement();
180
+ }
181
+
182
+ return el;
183
+ }
184
+
185
+ if( sens==kbNav.first || sens==kbNav.last ) {
186
+ let fel = sens==kbNav.first ? this._view.firstChild() : this._view.lastChild( );
187
+ fel = next_visible( fel, sens==kbNav.first );
188
+
189
+ if( fel ) {
190
+ const id = fel.getInternalData( "id" );
191
+ this._selectItem( id, fel, 'single' );
192
+ return true;
193
+ }
194
+ }
195
+ else {
196
+ const selitem = this._itemWithID( this._lastsel );
197
+
198
+ let nel;
199
+ if( selitem ) {
200
+ nel = sens==kbNav.next ? selitem.nextElement() : selitem.prevElement();
201
+ nel = next_visible( nel, sens==kbNav.next );
202
+ }
203
+ else {
204
+ nel = sens==kbNav.next ? this._view.firstChild() : this._view.lastChild( );
205
+ }
206
+
207
+ if( nel ) {
208
+ const id = nel.getInternalData( "id" );
209
+ this._selectItem( id, nel, 'single' );
210
+ return true;
211
+ }
212
+ }
213
+
214
+ return false;
215
+ }
216
+
217
+ /**
218
+ *
219
+ */
220
+
221
+ private _itemWithID( id: ListboxID ) {
222
+ //const itm = this.query( `[data-id="${id}"]` );
223
+ const all = this._view.enumChildComponents( false );
224
+ return all.find( x => x.getInternalData("id")===id )
225
+ }
226
+
227
+ /**
228
+ *
229
+ */
230
+
231
+ private _on_click( ev: MouseEvent ) {
232
+ let target = ev.target as HTMLElement;
233
+
234
+ while( target && target!=this.dom ) {
235
+ const c = componentFromDOM( target );
236
+
237
+ // avoid trapping child ckick
238
+ if( c.dom.tagName==='INPUT' ) {
239
+ return;
240
+ }
241
+
242
+ if( c && c.hasClass("x4item") ) {
243
+ const id = c.getInternalData( "id" );
244
+ const fev: ComponentEvent = { context:id };
245
+ if (ev.type == 'click') {
246
+ this.fire('click', fev );
247
+ }
248
+ else {
249
+ this.fire('dblClick', fev );
250
+ }
251
+
252
+ if (!fev.defaultPrevented) {
253
+ this._selectItem( id, c, ev.ctrlKey ? 'toggle' : 'single' );
254
+ }
255
+
256
+ return;
257
+ }
258
+
259
+ target = target.parentElement;
260
+ }
261
+
262
+ this.clearSelection( );
263
+
264
+ ev.stopImmediatePropagation();
265
+ ev.preventDefault( );
266
+ }
267
+
268
+ /**
269
+ *
270
+ */
271
+
272
+ private _on_ctx_menu(ev: MouseEvent) {
273
+
274
+ ev.preventDefault();
275
+
276
+ let target = ev.target as HTMLElement;
277
+ while( target && target!=this.dom ) {
278
+ const c = componentFromDOM( target );
279
+ if( c && c.hasClass("x4item") ) {
280
+ const id = c.getInternalData( "id" );
281
+
282
+ this._selectItem(id, c, 'single' );
283
+ this.fire('contextMenu', {uievent: ev, context: id } );
284
+
285
+ return;
286
+ }
287
+
288
+ target = target.parentElement;
289
+ }
290
+
291
+ this.fire('contextMenu', { uievent:ev, context: null } );
292
+ }
293
+
294
+ /**
295
+ *
296
+ */
297
+
298
+ private _selectItem( id: ListboxID, item: Component, mode: "single" | "toggle" ) {
299
+
300
+ if( !this.props.multisel ) {
301
+ mode = 'single';
302
+ }
303
+
304
+ this._lastsel = id;
305
+
306
+ if( mode=='single' ) {
307
+ if( this._multisel.has(id) ) {
308
+ return;
309
+ }
310
+
311
+ this._clearSelection( );
312
+ if( item ) {
313
+ this._multisel.add( id );
314
+ item.addClass( "selected" );
315
+ }
316
+ }
317
+ else { // toggle
318
+ if( item ) {
319
+ if( this._multisel.has(id) ) {
320
+ item.removeClass( "selected" );
321
+ this._multisel.delete( id );
322
+ }
323
+ else {
324
+ this._multisel.add( id );
325
+ item.addClass( "selected" );
326
+ }
327
+ }
328
+ }
329
+
330
+ if( item ) {
331
+ item.scrollIntoView( {
332
+ behavior: "smooth",
333
+ block: "nearest"
334
+ } );
335
+ }
336
+
337
+ this.fire( "selectionChange", { selection: this.getSelection(), empty: this._multisel.size==0 } );
338
+ }
339
+
340
+ /**
341
+ *
342
+ */
343
+
344
+ getItem( id: ListboxID ): ListItem {
345
+ return this._items.find( x => x.id===id );
346
+ }
347
+
348
+ /**
349
+ * select an item by it's id
350
+ */
351
+
352
+ select( ids: ListboxID | ListboxID[], notify = true ) {
353
+
354
+ if( !isArray(ids) ) {
355
+ ids = [ids];
356
+ }
357
+
358
+ if( !ids.length ) {
359
+ if( this._multisel.size ) {
360
+ if( notify ) {
361
+ this.clearSelection( );
362
+ }
363
+ else {
364
+ this._clearSelection( );
365
+ }
366
+ }
367
+
368
+ return;
369
+ }
370
+
371
+ // if one of new selection not in old selection...
372
+ if( ids.some( x => !this._multisel.has(x)) ) {
373
+ this._clearSelection( );
374
+ const all = this._view.enumChildComponents( false );
375
+
376
+ ids.forEach( id => {
377
+ const itm = all.find( x => x.getInternalData("id")===id ); //this.query( `[data-id="${id}"]` );
378
+ if( itm ) {
379
+ this._multisel.add( id );
380
+ itm.addClass( "selected" );
381
+ }
382
+ });
383
+
384
+ if( notify ) {
385
+ this.fire( "selectionChange", { selection: this.getSelection(), empty: this._multisel.size==0 } );
386
+ }
387
+ }
388
+ }
389
+
390
+ /**
391
+ *
392
+ */
393
+
394
+ private _findItemIndex( id: ListboxID ) {
395
+ return this._items.findIndex( x => x.id==id );
396
+ }
397
+
398
+ /**
399
+ *
400
+ */
401
+
402
+ private _clearSelection( ) {
403
+
404
+ const all = this._view.enumChildComponents( false );
405
+
406
+ if( this._multisel.size ) {
407
+ const ids = Array.from( this._multisel );
408
+ ids.forEach( id => {
409
+ const itm = all.find( x => x.getInternalData("id")===id ); //this.query( `[data-id="${id}"]` );
410
+ if( itm ) {
411
+ itm.removeClass( "selected" );
412
+ }
413
+ } );
414
+ }
415
+
416
+ this._multisel.clear( );
417
+ }
418
+
419
+ clearSelection( fireEvent = true ) {
420
+ if( this._multisel.size ) {
421
+ this._clearSelection( );
422
+ if( fireEvent ) {
423
+ this.fire( "selectionChange", { selection: [], empty: true } );
424
+ }
425
+ }
426
+ }
427
+
428
+ /**
429
+ *
430
+ */
431
+
432
+ setItems( items: ListItem[], keepSel = false ) {
433
+
434
+ const oldSel = this.getSelection( );
435
+
436
+ this.clearSelection( );
437
+ this._view.clearContent( );
438
+ this._items = items ?? [];
439
+
440
+ let update_sel = false;
441
+
442
+ if( this._items.length ) {
443
+ const content = items.map( x => this.renderItem(x) );
444
+ this._view.setContent( content );
445
+
446
+ if( keepSel && oldSel.length>0 ) {
447
+ this.select( oldSel );
448
+ }
449
+ }
450
+ else {
451
+ update_sel = oldSel.length>0;
452
+ }
453
+
454
+ if( update_sel ) {
455
+ this.setTimeout( "sel", 100, ( ) => {
456
+ this.fire( "selectionChange", { selection: [], empty: true } );
457
+ } );
458
+ }
459
+ }
460
+
461
+ /**
462
+ *
463
+ */
464
+
465
+ renderItem( item: ListItem ) {
466
+ const renderer = this.props.renderer ?? this.defaultRenderer;
467
+ const line = renderer( item );
468
+
469
+ line.addClass( "x4item" );
470
+ line.setInternalData( "id", item.id );
471
+
472
+ return line;
473
+ }
474
+
475
+ /**
476
+ *
477
+ */
478
+
479
+ defaultRenderer( item: ListItem ): Component {
480
+ return new HBox( {
481
+ cls: item.cls,
482
+ content: new Label( { icon: item.iconId, text: item.text })
483
+ } )
484
+ }
485
+
486
+ /**
487
+ *
488
+ */
489
+
490
+ filter( filter: string | RegExp ) {
491
+ const childs = this._view.enumChildComponents( false );
492
+
493
+ if( !filter ) {
494
+ childs.forEach( x => x.show( true ) );
495
+ }
496
+ else {
497
+ // get list of visible items
498
+ let filtred: Set<ListboxID>;
499
+
500
+ if( filter instanceof RegExp ) {
501
+ const f = filter as RegExp;
502
+ filtred = new Set( this._items
503
+ .filter( x => f.test(x.text as string) )
504
+ .map( x => x.id ) );
505
+ }
506
+ else {
507
+ const f = filter.toUpperCase( );
508
+ filtred = new Set( this._items
509
+ .filter( x => x.text.toUpperCase().includes(f) )
510
+ .map( x => x.id ) );
511
+ }
512
+
513
+ // now hide all elements not in list
514
+ childs.forEach( x => {
515
+ x.show( filtred.has( x.getInternalData( "id" ) ) );
516
+ });
517
+ }
518
+ }
519
+
520
+ /**
521
+ * append or prepend a new item
522
+ * @param item
523
+ * @param prepend
524
+ * @param select
525
+ */
526
+
527
+ appendItem( item: ListItem, prepend = false, select = true ) {
528
+
529
+ if( select ) {
530
+ this._clearSelection( );
531
+ }
532
+
533
+ let el = this.renderItem( item );
534
+
535
+ if( prepend ) {
536
+ this._items.unshift( item );
537
+ this._view.prependContent( el );
538
+ }
539
+ else {
540
+ this._items.push( item );
541
+ this._view.appendContent( el );
542
+ }
543
+
544
+ if( select ) {
545
+ this._selectItem( item.id, el, 'single' );
546
+ }
547
+ }
548
+
549
+ /**
550
+ * update an item
551
+ */
552
+
553
+ updateItem( id: any, item: ListItem ) {
554
+
555
+ // find item
556
+ const idx = this._findItemIndex( id );
557
+ if( idx<0 ) {
558
+ return;
559
+ }
560
+
561
+ // take care of selection
562
+ let was_sel = false;
563
+ if( this._multisel.has(id) ) {
564
+ was_sel = true;
565
+ }
566
+
567
+ // replace it in the list
568
+ this._items[idx] = item;
569
+
570
+ // rebuild & replace it's line
571
+ const old = this._itemWithID( item.id );
572
+ if( old?.dom ) {
573
+ const _new = this.renderItem( item );
574
+ if( was_sel ) {
575
+ _new.addClass( "selected" );
576
+ }
577
+
578
+ this._view.dom.replaceChild( _new.dom, old.dom );
579
+ }
580
+ }
581
+
582
+ getSelection( ) {
583
+ return Array.from( this._multisel );
584
+ }
585
+
586
+ ensureSelectionVisible( ) {
587
+ const sels = Array.from( this._multisel.values() );
588
+ if( sels.length) {
589
+ const item = this._itemWithID( sels[0] );
590
+ item?.scrollIntoView( {
591
+ behavior: "instant",
592
+ block: "nearest"
593
+ } )
594
+ }
595
+ }
596
+ }