@zeyos/zx 5.0.0 → 5.3.0
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.
- package/CHANGELOG.md +198 -0
- package/README.md +2 -1
- package/dist/types/components/account-menu/account-menu.d.ts +8 -0
- package/dist/types/components/activity-list/activity-list.d.ts +9 -1
- package/dist/types/components/app-icon/app-icon.d.ts +14 -2
- package/dist/types/components/app-sidebar/app-sidebar.d.ts +288 -14
- package/dist/types/components/calendar/calendar.d.ts +67 -5
- package/dist/types/components/card-view/card-view.d.ts +243 -4
- package/dist/types/components/card-view/record-card.d.ts +11 -0
- package/dist/types/components/context-menu/context-menu.d.ts +6 -2
- package/dist/types/components/data-filter/data-filter.d.ts +4 -4
- package/dist/types/components/dropdown/dropdown.d.ts +22 -7
- package/dist/types/components/field/field.d.ts +30 -0
- package/dist/types/components/fieldset/external-adapter.d.ts +83 -0
- package/dist/types/components/fieldset/fieldset.d.ts +7 -0
- package/dist/types/components/file-list/file-list.d.ts +35 -3
- package/dist/types/components/filter/filter.d.ts +127 -3
- package/dist/types/components/filter-panel/filter-panel.d.ts +36 -7
- package/dist/types/components/launcher/launcher.d.ts +8 -0
- package/dist/types/components/list-toolbar/list-toolbar.d.ts +15 -6
- package/dist/types/components/menu-button/menu-button.d.ts +6 -0
- package/dist/types/components/message/message.d.ts +14 -1
- package/dist/types/components/modal/modal.d.ts +30 -0
- package/dist/types/components/module-bar/module-bar.d.ts +395 -0
- package/dist/types/components/pagination/pagination.d.ts +17 -3
- package/dist/types/components/select/select.d.ts +6 -0
- package/dist/types/components/sheet/sheet.d.ts +15 -0
- package/dist/types/components/table/table.d.ts +265 -17
- package/dist/types/components/view/record-view.d.ts +59 -2
- package/dist/types/components/view-settings/view-settings.d.ts +879 -0
- package/dist/types/components/workspace-switcher/workspace-switcher.d.ts +327 -0
- package/dist/types/core/component.d.ts +12 -2
- package/dist/types/core/i18n.d.ts +27 -3
- package/dist/types/core/keyboard.d.ts +98 -1
- package/dist/types/core/messages.d.ts +382 -0
- package/dist/types/core/overlay-host.d.ts +28 -1
- package/dist/types/core/overlay-stack.d.ts +260 -0
- package/dist/types/index.d.ts +5 -2
- package/dist/types/internal/app-rail.d.ts +38 -0
- package/dist/types/internal/menu-items.d.ts +71 -3
- package/dist/types/zeyos/index.d.ts +1 -0
- package/dist/types/zeyos/launcher.d.ts +9 -0
- package/dist/types/zeyos/module-bar.d.ts +176 -0
- package/dist/types/zeyos/query.d.ts +31 -5
- package/dist/types/zeyos/table.d.ts +245 -8
- package/dist/types/zeyos/view.d.ts +16 -2
- package/dist/zx-zeyos.esm.js +4422 -430
- package/dist/zx-zeyos.esm.min.js +5 -5
- package/dist/zx.css +1472 -133
- package/dist/zx.esm.js +7433 -854
- package/dist/zx.esm.min.js +8 -8
- package/dist/zx.global.js +7433 -854
- package/dist/zx.global.min.js +8 -8
- package/dist/zx.min.css +1 -1
- package/docs/api.json +937 -119
- package/docs/llms.md +531 -63
- package/docs/llms.txt +6 -2
- package/package.json +1 -1
- package/src/components/account-menu/account-menu.js +12 -0
- package/src/components/activity-list/activity-list.js +27 -1
- package/src/components/app-icon/app-icon.css +13 -2
- package/src/components/app-icon/app-icon.js +11 -1
- package/src/components/app-rail/app-rail.css +19 -0
- package/src/components/app-sidebar/app-sidebar.css +204 -3
- package/src/components/app-sidebar/app-sidebar.js +646 -40
- package/src/components/breadcrumb/breadcrumb.css +1 -1
- package/src/components/calendar/calendar.css +1 -1
- package/src/components/calendar/calendar.js +26 -52
- package/src/components/card/card.css +2 -2
- package/src/components/card-view/card-view.css +76 -5
- package/src/components/card-view/card-view.js +514 -20
- package/src/components/card-view/record-card.js +14 -3
- package/src/components/code-editor/code-editor.css +1 -1
- package/src/components/code-editor/field-adapter.js +9 -2
- package/src/components/context-menu/context-menu.js +8 -2
- package/src/components/copy/copy-input.css +1 -1
- package/src/components/data-filter/data-filter.js +2 -2
- package/src/components/date-picker/time-picker.css +2 -2
- package/src/components/dock/dock.css +5 -4
- package/src/components/dropdown/dropdown.js +157 -72
- package/src/components/field/field.js +33 -3
- package/src/components/fieldset/external-adapter.js +363 -0
- package/src/components/fieldset/fieldset.js +10 -59
- package/src/components/file-list/file-list.js +144 -21
- package/src/components/filter/filter.css +86 -2
- package/src/components/filter/filter.js +300 -8
- package/src/components/filter-panel/filter-panel.js +149 -32
- package/src/components/finder/finder.css +1 -1
- package/src/components/kanban-view/kanban-view.css +3 -3
- package/src/components/kanban-view/kanban-view.js +5 -2
- package/src/components/launcher/launcher.css +1 -1
- package/src/components/launcher/launcher.js +29 -3
- package/src/components/list-toolbar/list-toolbar.js +39 -13
- package/src/components/master-panel/master-panel.js +0 -1
- package/src/components/menu-button/menu-button.css +63 -0
- package/src/components/menu-button/menu-button.js +97 -11
- package/src/components/message/message.js +60 -20
- package/src/components/modal/modal.css +1 -1
- package/src/components/modal/modal.js +66 -13
- package/src/components/module-bar/module-bar.css +486 -0
- package/src/components/module-bar/module-bar.js +1074 -0
- package/src/components/multi-value-editor/multi-value-editor.css +1 -1
- package/src/components/number-field/field-adapter.js +2 -1
- package/src/components/pagination/pagination.css +5 -5
- package/src/components/pagination/pagination.js +20 -4
- package/src/components/panel/panel.css +3 -2
- package/src/components/questionnaire/questionnaire.css +4 -4
- package/src/components/rating/field-adapter.js +2 -1
- package/src/components/rating/rating.css +1 -1
- package/src/components/search/search.css +6 -1
- package/src/components/select/select.js +9 -0
- package/src/components/sheet/sheet.css +1 -1
- package/src/components/sheet/sheet.js +74 -32
- package/src/components/slider/field-adapter.js +6 -1
- package/src/components/slider/slider.css +2 -2
- package/src/components/split-view/split-view.css +1 -1
- package/src/components/stat-tile/stat-tile.css +1 -1
- package/src/components/stepper/stepper.css +1 -1
- package/src/components/tabbox/tabbox.css +9 -5
- package/src/components/table/table.css +86 -11
- package/src/components/table/table.js +628 -57
- package/src/components/tag-picker/field-adapter.js +2 -1
- package/src/components/tooltip/tooltip.js +35 -17
- package/src/components/tree/tree.css +1 -1
- package/src/components/view/record-view.css +1 -1
- package/src/components/view/record-view.js +178 -18
- package/src/components/view-settings/view-settings.css +285 -0
- package/src/components/view-settings/view-settings.js +1830 -0
- package/src/components/workspace-switcher/workspace-switcher.css +188 -0
- package/src/components/workspace-switcher/workspace-switcher.js +463 -0
- package/src/core/component.js +88 -17
- package/src/core/fontawesome.js +5 -1
- package/src/core/i18n.js +47 -4
- package/src/core/icons.js +12 -2
- package/src/core/keyboard.js +206 -11
- package/src/core/messages.js +427 -0
- package/src/core/overlay-host.js +64 -9
- package/src/core/overlay-stack.js +487 -0
- package/src/core/position.js +22 -3
- package/src/index.js +5 -2
- package/src/internal/app-rail.js +134 -53
- package/src/internal/menu-items.js +61 -3
- package/src/zeyos/form.js +5 -3
- package/src/zeyos/index.js +3 -0
- package/src/zeyos/launcher.js +8 -3
- package/src/zeyos/module-bar.js +181 -0
- package/src/zeyos/query.js +44 -13
- package/src/zeyos/table.js +220 -80
- package/src/zeyos/view.js +43 -93
- package/styles/base.css +16 -1
- package/styles/print.css +1 -1
- package/styles/tokens/dark.css +4 -0
- package/styles/tokens/semantic.css +56 -28
- package/styles/zx.css +3 -0
package/docs/api.json
CHANGED
|
@@ -80,6 +80,12 @@
|
|
|
80
80
|
"returns": "this",
|
|
81
81
|
"description": "Replaces account presentation without touching session state."
|
|
82
82
|
},
|
|
83
|
+
{
|
|
84
|
+
"name": "setCompact",
|
|
85
|
+
"signature": "setCompact(compact)",
|
|
86
|
+
"returns": "this",
|
|
87
|
+
"description": "Shows the avatar alone or the avatar with the name and secondary line — for a navigation column that narrows to icons and widens again. The trigger keeps its full accessible name either way."
|
|
88
|
+
},
|
|
83
89
|
{
|
|
84
90
|
"name": "setItems",
|
|
85
91
|
"signature": "setItems(items)",
|
|
@@ -390,7 +396,13 @@
|
|
|
390
396
|
"name": "color",
|
|
391
397
|
"type": "string|null",
|
|
392
398
|
"default": "null",
|
|
393
|
-
"description": "Identity colour
|
|
399
|
+
"description": "Identity colour, any CSS colour; takes precedence over `tone`."
|
|
400
|
+
},
|
|
401
|
+
{
|
|
402
|
+
"name": "tone",
|
|
403
|
+
"type": "AppIconTone|null",
|
|
404
|
+
"default": "null",
|
|
405
|
+
"description": "Categorical identity colour from the theme's tone palette, drawn with its `--zx-color-tone-<tone>-solid` fill. Without `color` or `tone` the icon takes the accent."
|
|
394
406
|
},
|
|
395
407
|
{
|
|
396
408
|
"name": "size",
|
|
@@ -461,9 +473,9 @@
|
|
|
461
473
|
"options": [
|
|
462
474
|
{
|
|
463
475
|
"name": "items",
|
|
464
|
-
"type": "AppNavItem[]",
|
|
476
|
+
"type": "AppNavItem[]|AppSidebarModule[]",
|
|
465
477
|
"default": "[]",
|
|
466
|
-
"description": "Application navigation tree."
|
|
478
|
+
"description": "Application navigation tree; in the modules layout its top level is the modules."
|
|
467
479
|
},
|
|
468
480
|
{
|
|
469
481
|
"name": "active",
|
|
@@ -501,6 +513,42 @@
|
|
|
501
513
|
"default": "'left'",
|
|
502
514
|
"description": "Workspace edge occupied by navigation."
|
|
503
515
|
},
|
|
516
|
+
{
|
|
517
|
+
"name": "layout",
|
|
518
|
+
"type": "'tree'|'modules'",
|
|
519
|
+
"default": "'tree'",
|
|
520
|
+
"description": "`'modules'` draws the top level as a module strip beside a panel showing one module's menu; minimized, the strip remains and menus open as flyouts."
|
|
521
|
+
},
|
|
522
|
+
{
|
|
523
|
+
"name": "module",
|
|
524
|
+
"type": "string|number|null",
|
|
525
|
+
"default": "null",
|
|
526
|
+
"description": "Modules layout: the module the panel shows first. Defaults to the module containing `active`, else the first module with a panel."
|
|
527
|
+
},
|
|
528
|
+
{
|
|
529
|
+
"name": "moduleBar",
|
|
530
|
+
"type": "AppSidebarModuleBarOptions",
|
|
531
|
+
"default": "{}",
|
|
532
|
+
"description": "Modules layout: strip presentation."
|
|
533
|
+
},
|
|
534
|
+
{
|
|
535
|
+
"name": "presentation",
|
|
536
|
+
"type": "'expanded'|'compact'|'collapsed'|null",
|
|
537
|
+
"default": "null",
|
|
538
|
+
"description": "Modules layout: how much of the navigation shows — both menus expanded (module names beside the side menu), the module menu collapsed to icons beside the side menu, or both collapsed to the icon strip. Defaults to `collapsed` ? `'collapsed'` : `'expanded'`."
|
|
539
|
+
},
|
|
540
|
+
{
|
|
541
|
+
"name": "presentations",
|
|
542
|
+
"type": "Array<'expanded'|'compact'|'collapsed'>",
|
|
543
|
+
"default": "['expanded','compact','collapsed']",
|
|
544
|
+
"description": "Modules layout: the presentations offered, widest first."
|
|
545
|
+
},
|
|
546
|
+
{
|
|
547
|
+
"name": "presentationSwitch",
|
|
548
|
+
"type": "boolean",
|
|
549
|
+
"default": "true",
|
|
550
|
+
"description": "Modules layout: whether the strip's foot carries the switch between presentations. Turn it off when the choice lives elsewhere — an account menu, through `presentationChoice()`."
|
|
551
|
+
},
|
|
504
552
|
{
|
|
505
553
|
"name": "label",
|
|
506
554
|
"type": "string",
|
|
@@ -511,7 +559,7 @@
|
|
|
511
559
|
"name": "header",
|
|
512
560
|
"type": "Node|string|number|{toElement: () => Node|null}|null",
|
|
513
561
|
"default": "null",
|
|
514
|
-
"description": "Expanded header content."
|
|
562
|
+
"description": "Expanded header content; in the modules layout, content above every module's menu."
|
|
515
563
|
},
|
|
516
564
|
{
|
|
517
565
|
"name": "footer",
|
|
@@ -523,13 +571,13 @@
|
|
|
523
571
|
"name": "railHeader",
|
|
524
572
|
"type": "Node|string|number|{toElement: () => Node|null}|null",
|
|
525
573
|
"default": "null",
|
|
526
|
-
"description": "Minimized leading content."
|
|
574
|
+
"description": "Minimized leading content; in the modules layout, the strip's leading content in both states."
|
|
527
575
|
},
|
|
528
576
|
{
|
|
529
577
|
"name": "railFooter",
|
|
530
578
|
"type": "Node|string|number|{toElement: () => Node|null}|null",
|
|
531
579
|
"default": "null",
|
|
532
|
-
"description": "Minimized trailing content."
|
|
580
|
+
"description": "Minimized trailing content; in the modules layout, the strip's trailing content in both states."
|
|
533
581
|
},
|
|
534
582
|
{
|
|
535
583
|
"name": "openDelay",
|
|
@@ -570,6 +618,16 @@
|
|
|
570
618
|
"name": "flyoutchange",
|
|
571
619
|
"payload": "{item: AppNavItem, id: string|number, open: boolean}",
|
|
572
620
|
"description": "Minimized flyout-state listener."
|
|
621
|
+
},
|
|
622
|
+
{
|
|
623
|
+
"name": "modulechange",
|
|
624
|
+
"payload": "{item: AppNavItem, id: string|number, previous: string|number|null}",
|
|
625
|
+
"description": "Preventable module-switch listener."
|
|
626
|
+
},
|
|
627
|
+
{
|
|
628
|
+
"name": "presentationchange",
|
|
629
|
+
"payload": "{presentation: 'expanded'|'compact'|'collapsed', previous: 'expanded'|'compact'|'collapsed'}",
|
|
630
|
+
"description": "Presentation listener."
|
|
573
631
|
}
|
|
574
632
|
],
|
|
575
633
|
"methods": [
|
|
@@ -589,7 +647,49 @@
|
|
|
589
647
|
"name": "setActive",
|
|
590
648
|
"signature": "setActive(id)",
|
|
591
649
|
"returns": "this",
|
|
592
|
-
"description": "Sets the active id without routing."
|
|
650
|
+
"description": "Sets the active id without routing. In the modules layout the panel follows the active route into its module."
|
|
651
|
+
},
|
|
652
|
+
{
|
|
653
|
+
"name": "setBadge",
|
|
654
|
+
"signature": "setBadge(id, badge)",
|
|
655
|
+
"returns": "this",
|
|
656
|
+
"description": "Updates one badge — a module's, or any destination's — without rebuilding the navigation."
|
|
657
|
+
},
|
|
658
|
+
{
|
|
659
|
+
"name": "setModule",
|
|
660
|
+
"signature": "setModule(id, [options])",
|
|
661
|
+
"returns": "this",
|
|
662
|
+
"description": "Modules layout: shows a module's menu in the panel. Fires a preventable `modulechange` unless silent."
|
|
663
|
+
},
|
|
664
|
+
{
|
|
665
|
+
"name": "getModule",
|
|
666
|
+
"signature": "getModule()",
|
|
667
|
+
"returns": "string|number|null",
|
|
668
|
+
"description": "Modules layout: the module whose menu the panel shows."
|
|
669
|
+
},
|
|
670
|
+
{
|
|
671
|
+
"name": "setModuleLabels",
|
|
672
|
+
"signature": "setModuleLabels(labels)",
|
|
673
|
+
"returns": "this",
|
|
674
|
+
"description": "Modules layout: whether the strip prints module names — `'auto'` (beside the tiles while expanded, none while collapsed), `'beside'`, `'below'`, or `'hidden'`. A narrow drawer that has no room for a labelled strip beside the panel sets `'hidden'`."
|
|
675
|
+
},
|
|
676
|
+
{
|
|
677
|
+
"name": "getPresentation",
|
|
678
|
+
"signature": "getPresentation()",
|
|
679
|
+
"returns": "'expanded'|'compact'|'collapsed'",
|
|
680
|
+
"description": "How much of the navigation shows: `'expanded'` (in the modules layout, both menus), `'compact'` (the module menu collapsed to icons beside the side menu), or `'collapsed'`."
|
|
681
|
+
},
|
|
682
|
+
{
|
|
683
|
+
"name": "setPresentation",
|
|
684
|
+
"signature": "setPresentation(presentation, [options])",
|
|
685
|
+
"returns": "this",
|
|
686
|
+
"description": "Shows the navigation as `'expanded'`, `'compact'` (modules layout), or `'collapsed'`."
|
|
687
|
+
},
|
|
688
|
+
{
|
|
689
|
+
"name": "togglePresentation",
|
|
690
|
+
"signature": "togglePresentation()",
|
|
691
|
+
"returns": "this",
|
|
692
|
+
"description": "Moves to the next presentation the strip's switch offers, wrapping (Mod+B in an application)."
|
|
593
693
|
},
|
|
594
694
|
{
|
|
595
695
|
"name": "setExpanded",
|
|
@@ -667,16 +767,52 @@
|
|
|
667
767
|
"name": "focus",
|
|
668
768
|
"signature": "focus()",
|
|
669
769
|
"returns": "this",
|
|
670
|
-
"description": "Focuses the first navigation action."
|
|
770
|
+
"description": "Focuses the first navigation action: the module strip's Tab stop in the modules layout."
|
|
671
771
|
},
|
|
672
772
|
{
|
|
673
773
|
"name": "destroy",
|
|
674
774
|
"signature": "destroy()",
|
|
675
775
|
"returns": "void",
|
|
676
776
|
"description": "Destroys flyouts and restores/removes the host."
|
|
777
|
+
},
|
|
778
|
+
{
|
|
779
|
+
"name": "presentationChoice",
|
|
780
|
+
"signature": "presentationChoice([options])",
|
|
781
|
+
"returns": "import('../../internal/menu-items.js').MenuChoice",
|
|
782
|
+
"description": "The choice between presentations as a menu entry, for an account or settings menu that holds it instead of the strip: `account.setItems([sidebar.presentationChoice(), …])`. It reads the current presentation when called, so rebuild it after `presentationchange`."
|
|
677
783
|
}
|
|
678
784
|
]
|
|
679
785
|
},
|
|
786
|
+
"AppSidebarModuleBar": {
|
|
787
|
+
"options": [
|
|
788
|
+
{
|
|
789
|
+
"name": "appearance",
|
|
790
|
+
"type": "'tint'|'solid'|'plain'",
|
|
791
|
+
"default": "'tint'",
|
|
792
|
+
"description": "Tile treatment."
|
|
793
|
+
},
|
|
794
|
+
{
|
|
795
|
+
"name": "labels",
|
|
796
|
+
"type": "'auto'|'beside'|'below'|'hidden'",
|
|
797
|
+
"default": "'auto'",
|
|
798
|
+
"description": "Module names on the strip: `'auto'` prints them beside the tiles while expanded and leaves the icons alone while collapsed; `'hidden'` keeps the icon strip beside the panel; `'below'` prints them under the tiles."
|
|
799
|
+
},
|
|
800
|
+
{
|
|
801
|
+
"name": "allModules",
|
|
802
|
+
"type": "'auto'|'always'|'never'",
|
|
803
|
+
"default": "'auto'",
|
|
804
|
+
"description": "The \"All modules\" button."
|
|
805
|
+
},
|
|
806
|
+
{
|
|
807
|
+
"name": "label",
|
|
808
|
+
"type": "string|null",
|
|
809
|
+
"default": "null",
|
|
810
|
+
"description": "Strip accessible label; omitted resolves `moduleBar.label`."
|
|
811
|
+
}
|
|
812
|
+
],
|
|
813
|
+
"events": [],
|
|
814
|
+
"methods": []
|
|
815
|
+
},
|
|
680
816
|
"Aspect": {
|
|
681
817
|
"options": [
|
|
682
818
|
{
|
|
@@ -1298,7 +1434,7 @@
|
|
|
1298
1434
|
"name": "msg",
|
|
1299
1435
|
"type": "Record<string, string>",
|
|
1300
1436
|
"default": null,
|
|
1301
|
-
"description": "
|
|
1437
|
+
"description": "Per-instance messages, keyed `calendar.*` (`calendar.today`, `calendar.next`, …). The bare keys of earlier versions (`today`, `next`) are still read, after the namespaced key, until the next major version."
|
|
1302
1438
|
},
|
|
1303
1439
|
{
|
|
1304
1440
|
"name": "renderEvent",
|
|
@@ -1775,9 +1911,33 @@
|
|
|
1775
1911
|
},
|
|
1776
1912
|
{
|
|
1777
1913
|
"name": "label",
|
|
1778
|
-
"type": "string",
|
|
1779
|
-
"default": "
|
|
1780
|
-
"description": "Accessible collection label."
|
|
1914
|
+
"type": "string|null",
|
|
1915
|
+
"default": "null",
|
|
1916
|
+
"description": "Accessible collection label; null resolves message `cardView.label`, \"Card view\"."
|
|
1917
|
+
},
|
|
1918
|
+
{
|
|
1919
|
+
"name": "keyboard",
|
|
1920
|
+
"type": "'tabs'|'roving'",
|
|
1921
|
+
"default": "'tabs'",
|
|
1922
|
+
"description": "Keyboard model. `'tabs'` makes every card, title link, checkbox, and action its own Tab stop. `'roving'` — recommended for lists — follows the APG Grid pattern with row focus: the collection is one Tab stop, the arrow keys, Home/End, and PageUp/PageDown move between cards, Enter activates, Space selects, and the controls inside a card stay pointer targets with `tabindex=\"-1\"`."
|
|
1923
|
+
},
|
|
1924
|
+
{
|
|
1925
|
+
"name": "collapsibleGroups",
|
|
1926
|
+
"type": "boolean",
|
|
1927
|
+
"default": "false",
|
|
1928
|
+
"description": "Whether group headings carry a toggle that hides and shows the group's cards."
|
|
1929
|
+
},
|
|
1930
|
+
{
|
|
1931
|
+
"name": "collapsedGroups",
|
|
1932
|
+
"type": "unknown[]",
|
|
1933
|
+
"default": "[]",
|
|
1934
|
+
"description": "Group ids that start collapsed."
|
|
1935
|
+
},
|
|
1936
|
+
{
|
|
1937
|
+
"name": "renderGroupHeading",
|
|
1938
|
+
"type": "((context:CardGroupHeadingContext)=>Node|string|null|undefined)|null",
|
|
1939
|
+
"default": "null",
|
|
1940
|
+
"description": "Content of a group heading in place of its label. With `collapsibleGroups` it is placed inside the toggle button, so it must not contain interactive elements."
|
|
1781
1941
|
}
|
|
1782
1942
|
],
|
|
1783
1943
|
"events": [
|
|
@@ -1785,6 +1945,11 @@
|
|
|
1785
1945
|
"name": "recordaction",
|
|
1786
1946
|
"payload": "Record<string,unknown>",
|
|
1787
1947
|
"description": ""
|
|
1948
|
+
},
|
|
1949
|
+
{
|
|
1950
|
+
"name": "groupcollapse",
|
|
1951
|
+
"payload": "{id:string,collapsed:boolean,collapsedGroups:string[]}",
|
|
1952
|
+
"description": ""
|
|
1788
1953
|
}
|
|
1789
1954
|
],
|
|
1790
1955
|
"methods": [
|
|
@@ -1800,6 +1965,18 @@
|
|
|
1800
1965
|
"returns": "this",
|
|
1801
1966
|
"description": "Restores shared and CardView configuration. Unknown shared fields reconcile in RecordView."
|
|
1802
1967
|
},
|
|
1968
|
+
{
|
|
1969
|
+
"name": "setGroupCollapsed",
|
|
1970
|
+
"signature": "setGroupCollapsed(id, [collapsed], [options])",
|
|
1971
|
+
"returns": "this",
|
|
1972
|
+
"description": "Collapses or expands one group. A collapsed group keeps its heading and hides its cards."
|
|
1973
|
+
},
|
|
1974
|
+
{
|
|
1975
|
+
"name": "getCollapsedGroups",
|
|
1976
|
+
"signature": "getCollapsedGroups()",
|
|
1977
|
+
"returns": "string[]",
|
|
1978
|
+
"description": "Returns the collapsed group ids."
|
|
1979
|
+
},
|
|
1803
1980
|
{
|
|
1804
1981
|
"name": "destroy",
|
|
1805
1982
|
"signature": "destroy()",
|
|
@@ -2551,7 +2728,7 @@
|
|
|
2551
2728
|
"name": "clearLabel",
|
|
2552
2729
|
"type": "string|null",
|
|
2553
2730
|
"default": "null",
|
|
2554
|
-
"description": "Clear button label; null resolves `dataFilter.clear
|
|
2731
|
+
"description": "Clear button label; null resolves message `dataFilter.clear`, \"Clear\"."
|
|
2555
2732
|
}
|
|
2556
2733
|
],
|
|
2557
2734
|
"events": [
|
|
@@ -3805,6 +3982,12 @@
|
|
|
3805
3982
|
"default": "false",
|
|
3806
3983
|
"description": "Whether the control is disabled."
|
|
3807
3984
|
},
|
|
3985
|
+
{
|
|
3986
|
+
"name": "readonly",
|
|
3987
|
+
"type": "boolean",
|
|
3988
|
+
"default": "false",
|
|
3989
|
+
"description": "Whether the value is read-only: shown and focusable, not editable. Types whose control has no read-only state (`checkbox`, `select`, `optionlist`, `zxselect`, `date`, `time`, …) ignore it."
|
|
3990
|
+
},
|
|
3808
3991
|
{
|
|
3809
3992
|
"name": "options",
|
|
3810
3993
|
"type": "string[]|Record<string, string>|null",
|
|
@@ -3885,6 +4068,12 @@
|
|
|
3885
4068
|
"returns": "this",
|
|
3886
4069
|
"description": "Enables or disables the adapter control."
|
|
3887
4070
|
},
|
|
4071
|
+
{
|
|
4072
|
+
"name": "setReadonly",
|
|
4073
|
+
"signature": "setReadonly(readonly)",
|
|
4074
|
+
"returns": "this",
|
|
4075
|
+
"description": "Makes the value read-only or editable again, where the control has a read-only state (see the `readonly` option); reflected as `data-readonly` on the root either way."
|
|
4076
|
+
},
|
|
3888
4077
|
{
|
|
3889
4078
|
"name": "setHighlight",
|
|
3890
4079
|
"signature": "setHighlight(message, [kind])",
|
|
@@ -4061,7 +4250,7 @@
|
|
|
4061
4250
|
"name": "addField",
|
|
4062
4251
|
"signature": "addField(id, field)",
|
|
4063
4252
|
"returns": "Field",
|
|
4064
|
-
"description": "Adds a field from options, an existing field, an element, or a component. The key becomes the field's `name` and its `data-field-id`; the control's DOM id is `<idPrefix>-<key>`, unless the field options give an `id` of their own that differs from the key."
|
|
4253
|
+
"description": "Adds a field from options, an existing field, an element, or a component. The key becomes the field's `name` and its `data-field-id`; the control's DOM id is `<idPrefix>-<key>`, unless the field options give an `id` of their own that differs from the key. An element or a component that is not a registered field type is wrapped in a `custom` field that reads and writes it through its own API — `getValue`/`setValue`, `get`/`set`, `getValues`/`setValues`, `isChecked`/`setChecked`, or a `value` property — disables it through `setDisabled(bool)` or `enable()`/`disable()`, and makes it read-only through `setReadonly(bool)`, falling back to the element's native properties only when the component has none of these. The component's own `change` becomes the field's `change`, once per edit."
|
|
4065
4254
|
},
|
|
4066
4255
|
{
|
|
4067
4256
|
"name": "getField",
|
|
@@ -4448,13 +4637,13 @@
|
|
|
4448
4637
|
"name": "searchable",
|
|
4449
4638
|
"type": "boolean",
|
|
4450
4639
|
"default": "false",
|
|
4451
|
-
"description": "Searchable field, operator and single-choice controls
|
|
4640
|
+
"description": "Searchable field, operator and single-choice controls; a many-valued operator on a field with static choices gets a `TagPicker`."
|
|
4452
4641
|
},
|
|
4453
4642
|
{
|
|
4454
4643
|
"name": "layout",
|
|
4455
4644
|
"type": "'standard'|'compact'",
|
|
4456
4645
|
"default": "'standard'",
|
|
4457
|
-
"description": "Condition layout; compact rows adapt to container width."
|
|
4646
|
+
"description": "Condition layout; compact rows adapt to container width and show the group's \"and\"/\"or\" between them, a click on it switching the group's logic."
|
|
4458
4647
|
},
|
|
4459
4648
|
{
|
|
4460
4649
|
"name": "rootLogic",
|
|
@@ -4638,6 +4827,12 @@
|
|
|
4638
4827
|
"default": "'seconds'",
|
|
4639
4828
|
"description": "How a date leaves the component. A range's lower bound takes the start of its day and its upper bound the end, so a one-day range matches."
|
|
4640
4829
|
},
|
|
4830
|
+
{
|
|
4831
|
+
"name": "timeZone",
|
|
4832
|
+
"type": "string|null",
|
|
4833
|
+
"default": "null",
|
|
4834
|
+
"description": "IANA zone the calendar days are counted in, such as the ZeyOS instance's `Europe/Vienna`. A day serializes as the first (or last) instant of that day in this zone, and an incoming instant shows as the day it falls on there — the same rule `zeyosForm()` and `zeyosTable()` apply to date-only fields. Null uses the runtime's own zone. An unknown zone throws a `RangeError`."
|
|
4835
|
+
},
|
|
4641
4836
|
{
|
|
4642
4837
|
"name": "emptyText",
|
|
4643
4838
|
"type": "string|null",
|
|
@@ -6128,7 +6323,7 @@
|
|
|
6128
6323
|
"name": "bind",
|
|
6129
6324
|
"signature": "bind(view)",
|
|
6130
6325
|
"returns": "this",
|
|
6131
|
-
"description": "Optional sugar for a `TableView` or `
|
|
6326
|
+
"description": "Optional sugar for a `TableView`, `CardView`, or `KanbanView`: it wires the shape switch to the view and mounts the view's field chooser into this bar — through the view's public `mountFieldControls()` when it has one, which every `RecordView` does. A `TableView` with the default `fieldControls: true` contributes its Table's column chooser. Nothing is imported and nothing is required — every capability is feature-detected, so a view that offers none of them still works and still gets `viewchange`, and the host swaps the view itself. See `recordViewCapabilities()` for what is looked for."
|
|
6132
6327
|
},
|
|
6133
6328
|
{
|
|
6134
6329
|
"name": "unbind",
|
|
@@ -6274,6 +6469,12 @@
|
|
|
6274
6469
|
"returns": "this",
|
|
6275
6470
|
"description": "Closes the menu."
|
|
6276
6471
|
},
|
|
6472
|
+
{
|
|
6473
|
+
"name": "toggle",
|
|
6474
|
+
"signature": "toggle()",
|
|
6475
|
+
"returns": "this",
|
|
6476
|
+
"description": "Opens the menu when it is closed, and closes it when it is open. Opening this way moves no focus; `focusFirst()` opens with focus on the first item."
|
|
6477
|
+
},
|
|
6277
6478
|
{
|
|
6278
6479
|
"name": "isOpen",
|
|
6279
6480
|
"signature": "isOpen()",
|
|
@@ -6522,141 +6723,361 @@
|
|
|
6522
6723
|
}
|
|
6523
6724
|
]
|
|
6524
6725
|
},
|
|
6525
|
-
"
|
|
6726
|
+
"ModuleBar": {
|
|
6526
6727
|
"options": [
|
|
6527
6728
|
{
|
|
6528
|
-
"name": "
|
|
6529
|
-
"type": "
|
|
6530
|
-
"default": "
|
|
6531
|
-
"description": "
|
|
6729
|
+
"name": "items",
|
|
6730
|
+
"type": "ModuleItem[]",
|
|
6731
|
+
"default": "[]",
|
|
6732
|
+
"description": "Modules, in bar order."
|
|
6532
6733
|
},
|
|
6533
6734
|
{
|
|
6534
|
-
"name": "
|
|
6535
|
-
"type": "
|
|
6735
|
+
"name": "active",
|
|
6736
|
+
"type": "string|number|null",
|
|
6536
6737
|
"default": "null",
|
|
6537
|
-
"description": "
|
|
6738
|
+
"description": "Active destination id: a module, or any item in a module's menu."
|
|
6538
6739
|
},
|
|
6539
6740
|
{
|
|
6540
|
-
"name": "
|
|
6541
|
-
"type": "
|
|
6542
|
-
"default": "
|
|
6543
|
-
"description": "
|
|
6544
|
-
}
|
|
6545
|
-
],
|
|
6546
|
-
"events": [
|
|
6741
|
+
"name": "orientation",
|
|
6742
|
+
"type": "'vertical'|'horizontal'",
|
|
6743
|
+
"default": "'vertical'",
|
|
6744
|
+
"description": "Bar flow."
|
|
6745
|
+
},
|
|
6547
6746
|
{
|
|
6548
|
-
"name": "
|
|
6549
|
-
"
|
|
6550
|
-
"
|
|
6551
|
-
|
|
6552
|
-
|
|
6553
|
-
"methods": [
|
|
6747
|
+
"name": "side",
|
|
6748
|
+
"type": "'left'|'right'|'top'|'bottom'",
|
|
6749
|
+
"default": "'left'",
|
|
6750
|
+
"description": "Workspace edge the bar occupies."
|
|
6751
|
+
},
|
|
6554
6752
|
{
|
|
6555
|
-
"name": "
|
|
6556
|
-
"
|
|
6557
|
-
"
|
|
6558
|
-
"description": "
|
|
6753
|
+
"name": "appearance",
|
|
6754
|
+
"type": "'tint'|'solid'|'plain'",
|
|
6755
|
+
"default": "'tint'",
|
|
6756
|
+
"description": "Tile treatment: the glyph in the module colour on a tint of it, the solid identity tile, or monochrome glyphs."
|
|
6559
6757
|
},
|
|
6560
6758
|
{
|
|
6561
|
-
"name": "
|
|
6562
|
-
"
|
|
6563
|
-
"
|
|
6564
|
-
"description": "
|
|
6565
|
-
}
|
|
6566
|
-
]
|
|
6567
|
-
},
|
|
6568
|
-
"MultiValueEditor": {
|
|
6569
|
-
"options": [
|
|
6759
|
+
"name": "labels",
|
|
6760
|
+
"type": "'hidden'|'below'|'beside'",
|
|
6761
|
+
"default": "'hidden'",
|
|
6762
|
+
"description": "Whether a vertical bar prints each module's name: under its tile (a narrow strip), beside it (a full navigation column, with the count at the end of the row), or not at all — the name then stays the accessible name and the tooltip. Horizontal bars never print names."
|
|
6763
|
+
},
|
|
6570
6764
|
{
|
|
6571
|
-
"name": "
|
|
6572
|
-
"type": "
|
|
6573
|
-
"default": "
|
|
6574
|
-
"description": "
|
|
6765
|
+
"name": "menus",
|
|
6766
|
+
"type": "'flyout'|'none'",
|
|
6767
|
+
"default": "'flyout'",
|
|
6768
|
+
"description": "How a module's children are presented: in a flyout, or by an adjacent panel the application owns, in which case activating the module emits `select`."
|
|
6575
6769
|
},
|
|
6576
6770
|
{
|
|
6577
|
-
"name": "
|
|
6578
|
-
"type": "
|
|
6771
|
+
"name": "expanded",
|
|
6772
|
+
"type": "string|number|null",
|
|
6579
6773
|
"default": "null",
|
|
6580
|
-
"description": "
|
|
6774
|
+
"description": "With `menus: 'none'`, the module whose menu the adjacent panel shows."
|
|
6581
6775
|
},
|
|
6582
6776
|
{
|
|
6583
|
-
"name": "
|
|
6584
|
-
"type": "string",
|
|
6585
|
-
"default": "
|
|
6586
|
-
"description": "
|
|
6777
|
+
"name": "controls",
|
|
6778
|
+
"type": "string|null",
|
|
6779
|
+
"default": "null",
|
|
6780
|
+
"description": "With `menus: 'none'`, the id of that panel."
|
|
6587
6781
|
},
|
|
6588
6782
|
{
|
|
6589
|
-
"name": "
|
|
6590
|
-
"type": "'
|
|
6591
|
-
"default": "'
|
|
6592
|
-
"description": "
|
|
6593
|
-
}
|
|
6594
|
-
],
|
|
6595
|
-
"events": [
|
|
6596
|
-
{
|
|
6597
|
-
"name": "change",
|
|
6598
|
-
"payload": "{values: string[]}",
|
|
6599
|
-
"description": "Values change listener."
|
|
6600
|
-
}
|
|
6601
|
-
],
|
|
6602
|
-
"methods": [
|
|
6603
|
-
{
|
|
6604
|
-
"name": "getValues",
|
|
6605
|
-
"signature": "getValues()",
|
|
6606
|
-
"returns": "string[]",
|
|
6607
|
-
"description": "Returns a copy of the ordered values."
|
|
6783
|
+
"name": "allModules",
|
|
6784
|
+
"type": "'auto'|'always'|'never'",
|
|
6785
|
+
"default": "'auto'",
|
|
6786
|
+
"description": "The \"All modules\" button: shown when a module does not fit or is unpinned, always, or never (the bar then scrolls)."
|
|
6608
6787
|
},
|
|
6609
6788
|
{
|
|
6610
|
-
"name": "
|
|
6611
|
-
"
|
|
6612
|
-
"
|
|
6613
|
-
"description": "
|
|
6614
|
-
}
|
|
6615
|
-
]
|
|
6616
|
-
},
|
|
6617
|
-
"NavigationBar": {
|
|
6618
|
-
"options": [
|
|
6619
|
-
{
|
|
6620
|
-
"name": "title",
|
|
6621
|
-
"type": "string",
|
|
6622
|
-
"default": "''",
|
|
6623
|
-
"description": "Brand or application title."
|
|
6789
|
+
"name": "header",
|
|
6790
|
+
"type": "Node|string|number|{toElement: () => Node|null}|null",
|
|
6791
|
+
"default": "null",
|
|
6792
|
+
"description": "Leading content, such as a product mark."
|
|
6624
6793
|
},
|
|
6625
6794
|
{
|
|
6626
|
-
"name": "
|
|
6627
|
-
"type": "
|
|
6628
|
-
"default": "
|
|
6629
|
-
"description": "
|
|
6795
|
+
"name": "footer",
|
|
6796
|
+
"type": "Node|string|number|{toElement: () => Node|null}|null",
|
|
6797
|
+
"default": "null",
|
|
6798
|
+
"description": "Trailing content, such as an account menu."
|
|
6630
6799
|
},
|
|
6631
6800
|
{
|
|
6632
|
-
"name": "
|
|
6801
|
+
"name": "label",
|
|
6633
6802
|
"type": "string|null",
|
|
6634
6803
|
"default": "null",
|
|
6635
|
-
"description": "
|
|
6636
|
-
},
|
|
6637
|
-
{
|
|
6638
|
-
"name": "actions",
|
|
6639
|
-
"type": "NavigationAction[]",
|
|
6640
|
-
"default": "[]",
|
|
6641
|
-
"description": "Right-aligned action elements or descriptors."
|
|
6804
|
+
"description": "Navigation accessible label. Omitted resolves `moduleBar.label`, English `Modules`."
|
|
6642
6805
|
},
|
|
6643
6806
|
{
|
|
6644
|
-
"name": "
|
|
6645
|
-
"type": "
|
|
6646
|
-
"default": "
|
|
6647
|
-
"description": "
|
|
6807
|
+
"name": "openDelay",
|
|
6808
|
+
"type": "number",
|
|
6809
|
+
"default": "80",
|
|
6810
|
+
"description": "Flyout hover-open delay in milliseconds."
|
|
6648
6811
|
},
|
|
6649
6812
|
{
|
|
6650
|
-
"name": "
|
|
6651
|
-
"type": "
|
|
6652
|
-
"default": "
|
|
6653
|
-
"description": "
|
|
6813
|
+
"name": "closeDelay",
|
|
6814
|
+
"type": "number",
|
|
6815
|
+
"default": "160",
|
|
6816
|
+
"description": "Flyout pointer and focus crossing grace in milliseconds."
|
|
6654
6817
|
},
|
|
6655
6818
|
{
|
|
6656
|
-
"name": "
|
|
6657
|
-
"type": "
|
|
6658
|
-
"default":
|
|
6659
|
-
"description": "
|
|
6819
|
+
"name": "renderIcon",
|
|
6820
|
+
"type": "(item: AppNavItem, context: Record<string, any>) => Node|null",
|
|
6821
|
+
"default": null,
|
|
6822
|
+
"description": "Optional host icon renderer."
|
|
6823
|
+
}
|
|
6824
|
+
],
|
|
6825
|
+
"events": [
|
|
6826
|
+
{
|
|
6827
|
+
"name": "select",
|
|
6828
|
+
"payload": "AppNavSelectDetail",
|
|
6829
|
+
"description": "Preventable activation listener."
|
|
6830
|
+
},
|
|
6831
|
+
{
|
|
6832
|
+
"name": "flyoutchange",
|
|
6833
|
+
"payload": "{item: AppNavItem, id: string|number, open: boolean}",
|
|
6834
|
+
"description": "Flyout-state listener."
|
|
6835
|
+
},
|
|
6836
|
+
{
|
|
6837
|
+
"name": "overflowchange",
|
|
6838
|
+
"payload": "{visible: Array<string|number>, overflow: Array<string|number>}",
|
|
6839
|
+
"description": "Overflow listener."
|
|
6840
|
+
},
|
|
6841
|
+
{
|
|
6842
|
+
"name": "allmodules",
|
|
6843
|
+
"payload": "{open: boolean}",
|
|
6844
|
+
"description": "\"All modules\" catalogue open-state listener."
|
|
6845
|
+
}
|
|
6846
|
+
],
|
|
6847
|
+
"methods": [
|
|
6848
|
+
{
|
|
6849
|
+
"name": "setItems",
|
|
6850
|
+
"signature": "setItems(items)",
|
|
6851
|
+
"returns": "this",
|
|
6852
|
+
"description": "Replaces the modules and rebuilds the bar."
|
|
6853
|
+
},
|
|
6854
|
+
{
|
|
6855
|
+
"name": "getItems",
|
|
6856
|
+
"signature": "getItems()",
|
|
6857
|
+
"returns": "ModuleItem[]",
|
|
6858
|
+
"description": "Returns a copy of the normalized modules."
|
|
6859
|
+
},
|
|
6860
|
+
{
|
|
6861
|
+
"name": "setActive",
|
|
6862
|
+
"signature": "setActive(id)",
|
|
6863
|
+
"returns": "this",
|
|
6864
|
+
"description": "Marks the active destination — a module, or anything in a module's menu — without routing. The module holding it becomes current and stays on the bar."
|
|
6865
|
+
},
|
|
6866
|
+
{
|
|
6867
|
+
"name": "openFlyout",
|
|
6868
|
+
"signature": "openFlyout(id, [options])",
|
|
6869
|
+
"returns": "this",
|
|
6870
|
+
"description": "Opens a module's menu flyout."
|
|
6871
|
+
},
|
|
6872
|
+
{
|
|
6873
|
+
"name": "closeFlyout",
|
|
6874
|
+
"signature": "closeFlyout(id)",
|
|
6875
|
+
"returns": "this",
|
|
6876
|
+
"description": "Closes a module's menu flyout."
|
|
6877
|
+
},
|
|
6878
|
+
{
|
|
6879
|
+
"name": "closeAllFlyouts",
|
|
6880
|
+
"signature": "closeAllFlyouts()",
|
|
6881
|
+
"returns": "this",
|
|
6882
|
+
"description": "Closes every menu flyout."
|
|
6883
|
+
},
|
|
6884
|
+
{
|
|
6885
|
+
"name": "isFlyoutOpen",
|
|
6886
|
+
"signature": "isFlyoutOpen(id)",
|
|
6887
|
+
"returns": "boolean",
|
|
6888
|
+
"description": "Reports whether a module's menu flyout is open."
|
|
6889
|
+
},
|
|
6890
|
+
{
|
|
6891
|
+
"name": "setExpanded",
|
|
6892
|
+
"signature": "setExpanded(id)",
|
|
6893
|
+
"returns": "this",
|
|
6894
|
+
"description": "With `menus: 'none'`, names the module whose menu the adjacent panel now shows."
|
|
6895
|
+
},
|
|
6896
|
+
{
|
|
6897
|
+
"name": "setBadge",
|
|
6898
|
+
"signature": "setBadge(id, badge)",
|
|
6899
|
+
"returns": "this",
|
|
6900
|
+
"description": "Updates one badge in place — on the tile, in a flyout, and in the catalogue — without rebuilding the bar. `null` removes it."
|
|
6901
|
+
},
|
|
6902
|
+
{
|
|
6903
|
+
"name": "setLayout",
|
|
6904
|
+
"signature": "setLayout(layout)",
|
|
6905
|
+
"returns": "this",
|
|
6906
|
+
"description": "Changes flow or edge, keeping items, the active destination, and the expanded module."
|
|
6907
|
+
},
|
|
6908
|
+
{
|
|
6909
|
+
"name": "setLabels",
|
|
6910
|
+
"signature": "setLabels(labels)",
|
|
6911
|
+
"returns": "this",
|
|
6912
|
+
"description": "Changes whether module names are printed — the expanded and collapsed states of a vertical navigation column — keeping items, the active destination, and the expanded module."
|
|
6913
|
+
},
|
|
6914
|
+
{
|
|
6915
|
+
"name": "openAllModules",
|
|
6916
|
+
"signature": "openAllModules()",
|
|
6917
|
+
"returns": "this",
|
|
6918
|
+
"description": "Opens the \"All modules\" catalogue and focuses its filter or first entry."
|
|
6919
|
+
},
|
|
6920
|
+
{
|
|
6921
|
+
"name": "closeAllModules",
|
|
6922
|
+
"signature": "closeAllModules()",
|
|
6923
|
+
"returns": "this",
|
|
6924
|
+
"description": "Closes the \"All modules\" catalogue."
|
|
6925
|
+
},
|
|
6926
|
+
{
|
|
6927
|
+
"name": "isAllModulesOpen",
|
|
6928
|
+
"signature": "isAllModulesOpen()",
|
|
6929
|
+
"returns": "boolean",
|
|
6930
|
+
"description": "Reports whether the \"All modules\" catalogue is open."
|
|
6931
|
+
},
|
|
6932
|
+
{
|
|
6933
|
+
"name": "focus",
|
|
6934
|
+
"signature": "focus()",
|
|
6935
|
+
"returns": "this",
|
|
6936
|
+
"description": "Focuses the bar's Tab stop: the current module, else the first tile."
|
|
6937
|
+
},
|
|
6938
|
+
{
|
|
6939
|
+
"name": "destroy",
|
|
6940
|
+
"signature": "destroy()",
|
|
6941
|
+
"returns": "void",
|
|
6942
|
+
"description": "Destroys flyouts, tooltips, and the catalogue, and restores or removes the root."
|
|
6943
|
+
}
|
|
6944
|
+
]
|
|
6945
|
+
},
|
|
6946
|
+
"MonthPicker": {
|
|
6947
|
+
"options": [
|
|
6948
|
+
{
|
|
6949
|
+
"name": "value",
|
|
6950
|
+
"type": "Date|null",
|
|
6951
|
+
"default": "null",
|
|
6952
|
+
"description": "Initially selected month."
|
|
6953
|
+
},
|
|
6954
|
+
{
|
|
6955
|
+
"name": "min",
|
|
6956
|
+
"type": "Date|null",
|
|
6957
|
+
"default": "null",
|
|
6958
|
+
"description": "Earliest selectable month."
|
|
6959
|
+
},
|
|
6960
|
+
{
|
|
6961
|
+
"name": "max",
|
|
6962
|
+
"type": "Date|null",
|
|
6963
|
+
"default": "null",
|
|
6964
|
+
"description": "Latest selectable month."
|
|
6965
|
+
}
|
|
6966
|
+
],
|
|
6967
|
+
"events": [
|
|
6968
|
+
{
|
|
6969
|
+
"name": "change",
|
|
6970
|
+
"payload": "{date: Date|null}",
|
|
6971
|
+
"description": "Change listener."
|
|
6972
|
+
}
|
|
6973
|
+
],
|
|
6974
|
+
"methods": [
|
|
6975
|
+
{
|
|
6976
|
+
"name": "set",
|
|
6977
|
+
"signature": "set(date, [options])",
|
|
6978
|
+
"returns": "this",
|
|
6979
|
+
"description": "Selects the first day of a month."
|
|
6980
|
+
},
|
|
6981
|
+
{
|
|
6982
|
+
"name": "destroy",
|
|
6983
|
+
"signature": "destroy()",
|
|
6984
|
+
"returns": "void",
|
|
6985
|
+
"description": "Removes generated content from an enhanced target."
|
|
6986
|
+
}
|
|
6987
|
+
]
|
|
6988
|
+
},
|
|
6989
|
+
"MultiValueEditor": {
|
|
6990
|
+
"options": [
|
|
6991
|
+
{
|
|
6992
|
+
"name": "values",
|
|
6993
|
+
"type": "unknown[]",
|
|
6994
|
+
"default": "[]",
|
|
6995
|
+
"description": "Initial ordered values."
|
|
6996
|
+
},
|
|
6997
|
+
{
|
|
6998
|
+
"name": "options",
|
|
6999
|
+
"type": "unknown[]|Record<string, string>|null",
|
|
7000
|
+
"default": "null",
|
|
7001
|
+
"description": "Allowed values; null uses text inputs."
|
|
7002
|
+
},
|
|
7003
|
+
{
|
|
7004
|
+
"name": "addLabel",
|
|
7005
|
+
"type": "string",
|
|
7006
|
+
"default": "'Add value'",
|
|
7007
|
+
"description": "Add-row button text."
|
|
7008
|
+
},
|
|
7009
|
+
{
|
|
7010
|
+
"name": "reorder",
|
|
7011
|
+
"type": "'both'|'buttons'|'drag'|'none'",
|
|
7012
|
+
"default": "'both'",
|
|
7013
|
+
"description": "Reordering affordances each row gets: a drag handle, the up/down buttons, both, or neither."
|
|
7014
|
+
}
|
|
7015
|
+
],
|
|
7016
|
+
"events": [
|
|
7017
|
+
{
|
|
7018
|
+
"name": "change",
|
|
7019
|
+
"payload": "{values: string[]}",
|
|
7020
|
+
"description": "Values change listener."
|
|
7021
|
+
}
|
|
7022
|
+
],
|
|
7023
|
+
"methods": [
|
|
7024
|
+
{
|
|
7025
|
+
"name": "getValues",
|
|
7026
|
+
"signature": "getValues()",
|
|
7027
|
+
"returns": "string[]",
|
|
7028
|
+
"description": "Returns a copy of the ordered values."
|
|
7029
|
+
},
|
|
7030
|
+
{
|
|
7031
|
+
"name": "setValues",
|
|
7032
|
+
"signature": "setValues(values, [options])",
|
|
7033
|
+
"returns": "this",
|
|
7034
|
+
"description": "Replaces all rows."
|
|
7035
|
+
}
|
|
7036
|
+
]
|
|
7037
|
+
},
|
|
7038
|
+
"NavigationBar": {
|
|
7039
|
+
"options": [
|
|
7040
|
+
{
|
|
7041
|
+
"name": "title",
|
|
7042
|
+
"type": "string",
|
|
7043
|
+
"default": "''",
|
|
7044
|
+
"description": "Brand or application title."
|
|
7045
|
+
},
|
|
7046
|
+
{
|
|
7047
|
+
"name": "items",
|
|
7048
|
+
"type": "NavigationItem[]",
|
|
7049
|
+
"default": "[]",
|
|
7050
|
+
"description": "Navigation items."
|
|
7051
|
+
},
|
|
7052
|
+
{
|
|
7053
|
+
"name": "active",
|
|
7054
|
+
"type": "string|null",
|
|
7055
|
+
"default": "null",
|
|
7056
|
+
"description": "Initially active item, or the first enabled item."
|
|
7057
|
+
},
|
|
7058
|
+
{
|
|
7059
|
+
"name": "actions",
|
|
7060
|
+
"type": "NavigationAction[]",
|
|
7061
|
+
"default": "[]",
|
|
7062
|
+
"description": "Right-aligned action elements or descriptors."
|
|
7063
|
+
},
|
|
7064
|
+
{
|
|
7065
|
+
"name": "overflow",
|
|
7066
|
+
"type": "boolean",
|
|
7067
|
+
"default": "true",
|
|
7068
|
+
"description": "Whether items collapse into the overflow menu at all. `false` keeps every item in the bar at every width and never shows the More button."
|
|
7069
|
+
},
|
|
7070
|
+
{
|
|
7071
|
+
"name": "overflowBelow",
|
|
7072
|
+
"type": "string|number|false",
|
|
7073
|
+
"default": "'44rem'",
|
|
7074
|
+
"description": "Container inline size at or below which items collapse, as a `px` or `rem` length (a number is read as `px`); `false` disables collapsing exactly as `overflow: false` does. The default is the threshold the stylesheet's own container query carries, and a bar that keeps it collapses in CSS without measuring itself; any other value is watched with a `ResizeObserver`."
|
|
7075
|
+
},
|
|
7076
|
+
{
|
|
7077
|
+
"name": "minVisible",
|
|
7078
|
+
"type": "number",
|
|
7079
|
+
"default": "0",
|
|
7080
|
+
"description": "How many items, counted from the start, never collapse. The default collapses all of them, which is right for a top app bar and wrong for a phone bottom bar — `minVisible: 4` is what makes that bar usable."
|
|
6660
7081
|
}
|
|
6661
7082
|
],
|
|
6662
7083
|
"events": [
|
|
@@ -7789,6 +8210,12 @@
|
|
|
7789
8210
|
"type": "Node[]",
|
|
7790
8211
|
"default": "[]",
|
|
7791
8212
|
"description": "Listener-free, owner-created controls such as a move handle."
|
|
8213
|
+
},
|
|
8214
|
+
{
|
|
8215
|
+
"name": "message",
|
|
8216
|
+
"type": "(key: string, ...args: unknown[]) => string",
|
|
8217
|
+
"default": null,
|
|
8218
|
+
"description": "Resolves the card's built-in strings (`recordCard.select`, `recordCard.actions`, `recordCard.untitled`, `recordCard.selected`, `recordCard.notSelected`). An owning component passes its own `msg()`; omitted, the host translator and then the default English catalogue answer."
|
|
7792
8219
|
}
|
|
7793
8220
|
],
|
|
7794
8221
|
"events": [],
|
|
@@ -7978,6 +8405,18 @@
|
|
|
7978
8405
|
"returns": "string[]",
|
|
7979
8406
|
"description": "Returns the complete field id order."
|
|
7980
8407
|
},
|
|
8408
|
+
{
|
|
8409
|
+
"name": "getFieldControls",
|
|
8410
|
+
"signature": "getFieldControls()",
|
|
8411
|
+
"returns": "HTMLElement|null",
|
|
8412
|
+
"description": "Returns the element that lets a reader show, hide, and reorder this view's fields: the shared field chooser, or — for a `TableView` with `fieldControls: true` — the column chooser of its composed `Table`. Null when the view renders none (`fieldControls: false`). The element stays owned by the view: move it with {@link RecordView#mountFieldControls} rather than appending it elsewhere yourself, so `destroy()` can still find and remove it."
|
|
8413
|
+
},
|
|
8414
|
+
{
|
|
8415
|
+
"name": "mountFieldControls",
|
|
8416
|
+
"signature": "mountFieldControls(target)",
|
|
8417
|
+
"returns": "HTMLElement|null",
|
|
8418
|
+
"description": "Moves the view's field chooser into a host element — a list toolbar, a pane header — or, with `null`, back to where the view first rendered it. It keeps driving this view wherever it sits, and `destroy()` removes it from the host. `ListToolbar.bind()` calls this for every record view, which is how its field chooser ends up in the bar."
|
|
8419
|
+
},
|
|
7981
8420
|
{
|
|
7982
8421
|
"name": "setFieldVisible",
|
|
7983
8422
|
"signature": "setFieldVisible(id, [visible], [options])",
|
|
@@ -8309,6 +8748,12 @@
|
|
|
8309
8748
|
}
|
|
8310
8749
|
],
|
|
8311
8750
|
"methods": [
|
|
8751
|
+
{
|
|
8752
|
+
"name": "get",
|
|
8753
|
+
"signature": "get()",
|
|
8754
|
+
"returns": "unknown",
|
|
8755
|
+
"description": "Returns the selected item ID, or null: the same as reading `value`, under the `get()`/`set()` pair the other value components share."
|
|
8756
|
+
},
|
|
8312
8757
|
{
|
|
8313
8758
|
"name": "set",
|
|
8314
8759
|
"signature": "set(idOrItem, [options])",
|
|
@@ -9822,6 +10267,24 @@
|
|
|
9822
10267
|
"type": "false|TableHierarchyOptions",
|
|
9823
10268
|
"default": "false",
|
|
9824
10269
|
"description": "Flat parent references projected as an expandable treegrid. Row data and mutation APIs remain flat."
|
|
10270
|
+
},
|
|
10271
|
+
{
|
|
10272
|
+
"name": "interactive",
|
|
10273
|
+
"type": "boolean",
|
|
10274
|
+
"default": "false",
|
|
10275
|
+
"description": "Makes the table an APG grid — row focus, Enter firing `rowclick` — even without selection, editing, or hierarchy, which already imply it. Attaching a `rowclick` or `rowdblclick` listener through `on()` or an `on…` option sets it too; pass it when the host listens for the bubbling `zx-rowclick` DOM event instead."
|
|
10276
|
+
},
|
|
10277
|
+
{
|
|
10278
|
+
"name": "label",
|
|
10279
|
+
"type": "string|null",
|
|
10280
|
+
"default": "null",
|
|
10281
|
+
"description": "Accessible name of the table. A grid must have one; null resolves the `table.label` message (English \"Table\") for a grid and leaves a plain table unnamed, so name it after what it lists."
|
|
10282
|
+
},
|
|
10283
|
+
{
|
|
10284
|
+
"name": "labelledBy",
|
|
10285
|
+
"type": "string|null",
|
|
10286
|
+
"default": "null",
|
|
10287
|
+
"description": "Id of an element that names the grid — the heading above it, say. Wins over `label`."
|
|
9825
10288
|
}
|
|
9826
10289
|
],
|
|
9827
10290
|
"events": [
|
|
@@ -10130,6 +10593,12 @@
|
|
|
10130
10593
|
"returns": "number",
|
|
10131
10594
|
"description": "How many rows are currently rendered."
|
|
10132
10595
|
},
|
|
10596
|
+
{
|
|
10597
|
+
"name": "addEventListener",
|
|
10598
|
+
"signature": "addEventListener(type, listener, [options])",
|
|
10599
|
+
"returns": "void",
|
|
10600
|
+
"description": "Registers a listener, and turns the table into a grid when the listener is for a row click: a host that reacts to the row needs the row reachable by keyboard."
|
|
10601
|
+
},
|
|
10133
10602
|
{
|
|
10134
10603
|
"name": "isStacked",
|
|
10135
10604
|
"signature": "isStacked()",
|
|
@@ -11420,5 +11889,354 @@
|
|
|
11420
11889
|
"description": "Disables editing, removal, and reordering."
|
|
11421
11890
|
}
|
|
11422
11891
|
]
|
|
11892
|
+
},
|
|
11893
|
+
"ViewSettings": {
|
|
11894
|
+
"options": [
|
|
11895
|
+
{
|
|
11896
|
+
"name": "fields",
|
|
11897
|
+
"type": "ViewSettingsField[]",
|
|
11898
|
+
"default": "[]",
|
|
11899
|
+
"description": "Field descriptors, in their default order. Bound to a view, a non-empty list is also the allow-list: the view's other fields are neither listed nor touched. An empty list takes every field the view has."
|
|
11900
|
+
},
|
|
11901
|
+
{
|
|
11902
|
+
"name": "fieldOrder",
|
|
11903
|
+
"type": "string[]",
|
|
11904
|
+
"default": "[]",
|
|
11905
|
+
"description": "Preferred field order; missing fields append."
|
|
11906
|
+
},
|
|
11907
|
+
{
|
|
11908
|
+
"name": "hiddenFields",
|
|
11909
|
+
"type": "string[]",
|
|
11910
|
+
"default": "[]",
|
|
11911
|
+
"description": "Hidden field ids. A field with `visible: false` starts hidden too; a locked field never does."
|
|
11912
|
+
},
|
|
11913
|
+
{
|
|
11914
|
+
"name": "groupBy",
|
|
11915
|
+
"type": "string|null",
|
|
11916
|
+
"default": "null",
|
|
11917
|
+
"description": "Initial grouping field."
|
|
11918
|
+
},
|
|
11919
|
+
{
|
|
11920
|
+
"name": "grouping",
|
|
11921
|
+
"type": "boolean|ViewSettingsGrouping",
|
|
11922
|
+
"default": "true",
|
|
11923
|
+
"description": "The Group section. `false` omits it; an object restricts the fields it offers."
|
|
11924
|
+
},
|
|
11925
|
+
{
|
|
11926
|
+
"name": "board",
|
|
11927
|
+
"type": "ViewSettingsBoardOptions|false",
|
|
11928
|
+
"default": "false",
|
|
11929
|
+
"description": "The Board section (column field, swim-lane field, show empty columns) with its initial values and, in `fields`, the fields it offers; `false` omits it."
|
|
11930
|
+
},
|
|
11931
|
+
{
|
|
11932
|
+
"name": "sections",
|
|
11933
|
+
"type": "ViewSettingsSection[]",
|
|
11934
|
+
"default": null,
|
|
11935
|
+
"description": "Order and presence of the sections. Defaults to `['fields', 'grouping', 'board']`; a section whose option is `false` is always left out."
|
|
11936
|
+
},
|
|
11937
|
+
{
|
|
11938
|
+
"name": "types",
|
|
11939
|
+
"type": "Record<string, {icon?: string, label?: string}>",
|
|
11940
|
+
"default": "{}",
|
|
11941
|
+
"description": "Extends or overrides the built-in type map, keyed by type name."
|
|
11942
|
+
},
|
|
11943
|
+
{
|
|
11944
|
+
"name": "searchThreshold",
|
|
11945
|
+
"type": "number",
|
|
11946
|
+
"default": "8",
|
|
11947
|
+
"description": "Field count above which the field search is shown."
|
|
11948
|
+
},
|
|
11949
|
+
{
|
|
11950
|
+
"name": "headingLevel",
|
|
11951
|
+
"type": "2|3|4|5|6",
|
|
11952
|
+
"default": "3",
|
|
11953
|
+
"description": "Heading level of the section headings."
|
|
11954
|
+
},
|
|
11955
|
+
{
|
|
11956
|
+
"name": "label",
|
|
11957
|
+
"type": "string|null",
|
|
11958
|
+
"default": "null",
|
|
11959
|
+
"description": "Accessible name of the region; omitted uses the `viewSettings.label` message (\"View settings\")."
|
|
11960
|
+
},
|
|
11961
|
+
{
|
|
11962
|
+
"name": "msg",
|
|
11963
|
+
"type": "Record<string, string>|Record<string, Record<string, string>>",
|
|
11964
|
+
"default": null,
|
|
11965
|
+
"description": "Localized messages."
|
|
11966
|
+
}
|
|
11967
|
+
],
|
|
11968
|
+
"events": [
|
|
11969
|
+
{
|
|
11970
|
+
"name": "change",
|
|
11971
|
+
"payload": "{state: ViewSettingsState, reason: ViewSettingsChangeReason}",
|
|
11972
|
+
"description": "Any change the reader made."
|
|
11973
|
+
},
|
|
11974
|
+
{
|
|
11975
|
+
"name": "fieldorderchange",
|
|
11976
|
+
"payload": "{order: string[]}",
|
|
11977
|
+
"description": "Field order changed."
|
|
11978
|
+
},
|
|
11979
|
+
{
|
|
11980
|
+
"name": "fieldvisibilitychange",
|
|
11981
|
+
"payload": "{visible: string[], hidden: string[]}",
|
|
11982
|
+
"description": "A field was added or hidden."
|
|
11983
|
+
},
|
|
11984
|
+
{
|
|
11985
|
+
"name": "groupchange",
|
|
11986
|
+
"payload": "{field: string|null}",
|
|
11987
|
+
"description": "Grouping field changed."
|
|
11988
|
+
},
|
|
11989
|
+
{
|
|
11990
|
+
"name": "boardchange",
|
|
11991
|
+
"payload": "{board: ViewSettingsBoard}",
|
|
11992
|
+
"description": "Board settings changed."
|
|
11993
|
+
}
|
|
11994
|
+
],
|
|
11995
|
+
"methods": [
|
|
11996
|
+
{
|
|
11997
|
+
"name": "getState",
|
|
11998
|
+
"signature": "getState()",
|
|
11999
|
+
"returns": "ViewSettingsState",
|
|
12000
|
+
"description": "Returns the current settings as a JSON-safe snapshot."
|
|
12001
|
+
},
|
|
12002
|
+
{
|
|
12003
|
+
"name": "setState",
|
|
12004
|
+
"signature": "setState(partial, [options])",
|
|
12005
|
+
"returns": "this",
|
|
12006
|
+
"description": "Applies part of a state. Unknown field ids are ignored, missing ones append, and a locked field stays shown. Each part that actually changes emits its own event unless `silent`. A keyboard pick-up or pointer drag in progress is canceled first."
|
|
12007
|
+
},
|
|
12008
|
+
{
|
|
12009
|
+
"name": "setFields",
|
|
12010
|
+
"signature": "setFields(fields)",
|
|
12011
|
+
"returns": "this",
|
|
12012
|
+
"description": "Replaces the field descriptors, keeping order, visibility, grouping, and board settings for every id that still exists. While a view is bound, the view owns the field list: change it with the view's own `setFields()` and the panel follows through `statechange`. A `setFields()` here is not pushed to the view and lasts only until the view's next change."
|
|
12013
|
+
},
|
|
12014
|
+
{
|
|
12015
|
+
"name": "getFields",
|
|
12016
|
+
"signature": "getFields()",
|
|
12017
|
+
"returns": "ViewSettingsField[]",
|
|
12018
|
+
"description": "Returns the field descriptors in their current order."
|
|
12019
|
+
},
|
|
12020
|
+
{
|
|
12021
|
+
"name": "showField",
|
|
12022
|
+
"signature": "showField(id)",
|
|
12023
|
+
"returns": "this",
|
|
12024
|
+
"description": "Shows a hidden field at the end of the shown list."
|
|
12025
|
+
},
|
|
12026
|
+
{
|
|
12027
|
+
"name": "hideField",
|
|
12028
|
+
"signature": "hideField(id)",
|
|
12029
|
+
"returns": "this",
|
|
12030
|
+
"description": "Hides a shown field. A locked field and the last shown field cannot be hidden."
|
|
12031
|
+
},
|
|
12032
|
+
{
|
|
12033
|
+
"name": "moveField",
|
|
12034
|
+
"signature": "moveField(id, index)",
|
|
12035
|
+
"returns": "this",
|
|
12036
|
+
"description": "Moves a shown field to a position among the movable shown fields (locked ones keep theirs)."
|
|
12037
|
+
},
|
|
12038
|
+
{
|
|
12039
|
+
"name": "bind",
|
|
12040
|
+
"signature": "bind(view, [options])",
|
|
12041
|
+
"returns": "this",
|
|
12042
|
+
"description": "Connects a record view (`TableView`, `CardView`, `KanbanView`, or anything exposing the `RecordView` state surface). The view's fields and state are read now; order and visibility changes made here are pushed through `setFieldOrder()` and `setFieldVisible()`; and the view's own `statechange` is followed, so a column hidden from a table header disappears here too. The view's labels and types win over the panel's own descriptors, which supply only what the view lacks (`locked`, `groupable`, a type the view leaves at its `'text'` default). While bound, the view owns the field list; see `setFields()`. Grouping and board settings are never applied to the view — they are emitted, and the host decides (a `CardView` is re-created or given a new `groupBy`, a `KanbanView` its axes). A view's own `groupBy`, `columnBy`, and `swimlaneBy` options are adopted when they name fields."
|
|
12043
|
+
},
|
|
12044
|
+
{
|
|
12045
|
+
"name": "unbind",
|
|
12046
|
+
"signature": "unbind()",
|
|
12047
|
+
"returns": "this",
|
|
12048
|
+
"description": "Releases a bound view. The settings keep their current state."
|
|
12049
|
+
},
|
|
12050
|
+
{
|
|
12051
|
+
"name": "focus",
|
|
12052
|
+
"signature": "focus()",
|
|
12053
|
+
"returns": "this",
|
|
12054
|
+
"description": "Focuses the field search, or the first control of the shown list when there is no search."
|
|
12055
|
+
},
|
|
12056
|
+
{
|
|
12057
|
+
"name": "destroy",
|
|
12058
|
+
"signature": "destroy()",
|
|
12059
|
+
"returns": "void",
|
|
12060
|
+
"description": "Destroys the nested controls, releases a bound view, and restores an enhanced target."
|
|
12061
|
+
}
|
|
12062
|
+
]
|
|
12063
|
+
},
|
|
12064
|
+
"ViewSettingsBoard": {
|
|
12065
|
+
"options": [
|
|
12066
|
+
{
|
|
12067
|
+
"name": "columnBy",
|
|
12068
|
+
"type": "string|null",
|
|
12069
|
+
"default": "null",
|
|
12070
|
+
"description": "Initial column field."
|
|
12071
|
+
},
|
|
12072
|
+
{
|
|
12073
|
+
"name": "swimlaneBy",
|
|
12074
|
+
"type": "string|null",
|
|
12075
|
+
"default": "null",
|
|
12076
|
+
"description": "Initial swim-lane field, or null for none."
|
|
12077
|
+
},
|
|
12078
|
+
{
|
|
12079
|
+
"name": "showEmptyColumns",
|
|
12080
|
+
"type": "boolean",
|
|
12081
|
+
"default": "true",
|
|
12082
|
+
"description": "Whether columns without cards stay visible."
|
|
12083
|
+
},
|
|
12084
|
+
{
|
|
12085
|
+
"name": "fields",
|
|
12086
|
+
"type": "string[]",
|
|
12087
|
+
"default": null,
|
|
12088
|
+
"description": "The field ids offered for columns and swim lanes, in this order. Omitted offers the same fields as the Group section."
|
|
12089
|
+
}
|
|
12090
|
+
],
|
|
12091
|
+
"events": [],
|
|
12092
|
+
"methods": []
|
|
12093
|
+
},
|
|
12094
|
+
"WorkspaceSwitcher": {
|
|
12095
|
+
"options": [
|
|
12096
|
+
{
|
|
12097
|
+
"name": "workspaces",
|
|
12098
|
+
"type": "WorkspaceItem[]",
|
|
12099
|
+
"default": "[]",
|
|
12100
|
+
"description": "Workspaces in menu order. Entries without an id are skipped, and a repeated id keeps its first entry."
|
|
12101
|
+
},
|
|
12102
|
+
{
|
|
12103
|
+
"name": "active",
|
|
12104
|
+
"type": "string|number|null",
|
|
12105
|
+
"default": "null",
|
|
12106
|
+
"description": "Active workspace id. Defaults to the first enabled workspace, which also stands in for an id that is not listed or is disabled."
|
|
12107
|
+
},
|
|
12108
|
+
{
|
|
12109
|
+
"name": "items",
|
|
12110
|
+
"type": "MenuButtonItem[]",
|
|
12111
|
+
"default": "[]",
|
|
12112
|
+
"description": "Extra actions listed after the workspaces — \"Create workspace\", \"Workspace settings\", `'-'` separators, \"Sign out\". A separator is inserted between the workspaces and the actions automatically."
|
|
12113
|
+
},
|
|
12114
|
+
{
|
|
12115
|
+
"name": "compact",
|
|
12116
|
+
"type": "boolean",
|
|
12117
|
+
"default": "false",
|
|
12118
|
+
"description": "Whether the trigger shows the tile alone."
|
|
12119
|
+
},
|
|
12120
|
+
{
|
|
12121
|
+
"name": "heading",
|
|
12122
|
+
"type": "string|null",
|
|
12123
|
+
"default": "null",
|
|
12124
|
+
"description": "Group label above the workspaces; null resolves message `workspaceSwitcher.heading` (\"Workspaces\"), and an empty string leaves the label out."
|
|
12125
|
+
},
|
|
12126
|
+
{
|
|
12127
|
+
"name": "label",
|
|
12128
|
+
"type": "string|null",
|
|
12129
|
+
"default": "null",
|
|
12130
|
+
"description": "Trigger accessible name, in which `%1` is the active workspace's name and is filled in again after every switch. Null resolves message `workspaceSwitcher.label` (\"Switch workspace: %1\"), or `workspaceSwitcher.labelEmpty` (\"Switch workspace\") while no workspace is active."
|
|
12131
|
+
},
|
|
12132
|
+
{
|
|
12133
|
+
"name": "placement",
|
|
12134
|
+
"type": "'bottom-start'|'bottom-end'|'top-start'|'top-end'|'bottom'|'top'|'right-start'|'right-end'|'left-start'|'left-end'|'right'|'left'",
|
|
12135
|
+
"default": "'bottom-start'",
|
|
12136
|
+
"description": "Popup placement."
|
|
12137
|
+
},
|
|
12138
|
+
{
|
|
12139
|
+
"name": "msg",
|
|
12140
|
+
"type": "Record<string, unknown>",
|
|
12141
|
+
"default": null,
|
|
12142
|
+
"description": "Component-local message overrides, by key: `workspaceSwitcher.heading` (\"Workspaces\"), `workspaceSwitcher.label` (\"Switch workspace: %1\", `%1` the active workspace's name), and `workspaceSwitcher.labelEmpty` (\"Switch workspace\", the trigger's name while no workspace is active)."
|
|
12143
|
+
}
|
|
12144
|
+
],
|
|
12145
|
+
"events": [
|
|
12146
|
+
{
|
|
12147
|
+
"name": "select",
|
|
12148
|
+
"payload": "{workspace, id, previous}",
|
|
12149
|
+
"description": "Preventable workspace switch; `preventDefault()` keeps the previous workspace active and the menu open."
|
|
12150
|
+
},
|
|
12151
|
+
{
|
|
12152
|
+
"name": "action",
|
|
12153
|
+
"payload": "{value: unknown, item: object}",
|
|
12154
|
+
"description": "Preventable extra action; `preventDefault()` skips the item's own callback and keeps the menu open."
|
|
12155
|
+
},
|
|
12156
|
+
{
|
|
12157
|
+
"name": "open",
|
|
12158
|
+
"payload": "Record<string, never>",
|
|
12159
|
+
"description": "Open listener."
|
|
12160
|
+
},
|
|
12161
|
+
{
|
|
12162
|
+
"name": "close",
|
|
12163
|
+
"payload": "Record<string, never>",
|
|
12164
|
+
"description": "Close listener."
|
|
12165
|
+
}
|
|
12166
|
+
],
|
|
12167
|
+
"methods": [
|
|
12168
|
+
{
|
|
12169
|
+
"name": "getActive",
|
|
12170
|
+
"signature": "getActive()",
|
|
12171
|
+
"returns": "WorkspaceItem|null",
|
|
12172
|
+
"description": "Returns the active workspace, or null when no workspace is enabled."
|
|
12173
|
+
},
|
|
12174
|
+
{
|
|
12175
|
+
"name": "setActive",
|
|
12176
|
+
"signature": "setActive(id, [options])",
|
|
12177
|
+
"returns": "this",
|
|
12178
|
+
"description": "Makes another workspace active. An unknown or disabled id changes nothing."
|
|
12179
|
+
},
|
|
12180
|
+
{
|
|
12181
|
+
"name": "setWorkspaces",
|
|
12182
|
+
"signature": "setWorkspaces(workspaces)",
|
|
12183
|
+
"returns": "this",
|
|
12184
|
+
"description": "Replaces the workspaces. The active workspace stays active while it is still listed and enabled; otherwise the first enabled workspace becomes active, silently."
|
|
12185
|
+
},
|
|
12186
|
+
{
|
|
12187
|
+
"name": "setItems",
|
|
12188
|
+
"signature": "setItems(items)",
|
|
12189
|
+
"returns": "this",
|
|
12190
|
+
"description": "Replaces the extra actions after the workspaces."
|
|
12191
|
+
},
|
|
12192
|
+
{
|
|
12193
|
+
"name": "setCompact",
|
|
12194
|
+
"signature": "setCompact(compact)",
|
|
12195
|
+
"returns": "this",
|
|
12196
|
+
"description": "Shows the tile alone, or the tile with the name, secondary line, and chevron — for a navigation column that narrows to icons and widens again. The trigger keeps its full accessible name and gains the workspace name as a tooltip while compact."
|
|
12197
|
+
},
|
|
12198
|
+
{
|
|
12199
|
+
"name": "open",
|
|
12200
|
+
"signature": "open()",
|
|
12201
|
+
"returns": "this",
|
|
12202
|
+
"description": "Opens the menu."
|
|
12203
|
+
},
|
|
12204
|
+
{
|
|
12205
|
+
"name": "close",
|
|
12206
|
+
"signature": "close()",
|
|
12207
|
+
"returns": "this",
|
|
12208
|
+
"description": "Closes the menu."
|
|
12209
|
+
},
|
|
12210
|
+
{
|
|
12211
|
+
"name": "toggle",
|
|
12212
|
+
"signature": "toggle()",
|
|
12213
|
+
"returns": "this",
|
|
12214
|
+
"description": "Toggles the menu."
|
|
12215
|
+
},
|
|
12216
|
+
{
|
|
12217
|
+
"name": "isOpen",
|
|
12218
|
+
"signature": "isOpen()",
|
|
12219
|
+
"returns": "boolean",
|
|
12220
|
+
"description": "Reports whether the menu is open."
|
|
12221
|
+
},
|
|
12222
|
+
{
|
|
12223
|
+
"name": "focus",
|
|
12224
|
+
"signature": "focus()",
|
|
12225
|
+
"returns": "this",
|
|
12226
|
+
"description": "Focuses the trigger."
|
|
12227
|
+
},
|
|
12228
|
+
{
|
|
12229
|
+
"name": "getPanel",
|
|
12230
|
+
"signature": "getPanel()",
|
|
12231
|
+
"returns": "HTMLElement",
|
|
12232
|
+
"description": "Returns the menu panel for shell hover and focus coordination."
|
|
12233
|
+
},
|
|
12234
|
+
{
|
|
12235
|
+
"name": "destroy",
|
|
12236
|
+
"signature": "destroy()",
|
|
12237
|
+
"returns": "void",
|
|
12238
|
+
"description": "Destroys the menu and restores or removes the host."
|
|
12239
|
+
}
|
|
12240
|
+
]
|
|
11423
12241
|
}
|
|
11424
12242
|
}
|