@zeyos/zx 5.7.0 → 5.8.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 +330 -0
- package/README.md +47 -9
- package/dist/types/components/activity-item/activity-item.d.ts +14 -3
- package/dist/types/components/agent-avatar/agent-avatar.d.ts +165 -0
- package/dist/types/components/agent-avatar/agent-face.d.ts +93 -0
- package/dist/types/components/agent-thread/ag-ui.d.ts +21 -9
- package/dist/types/components/agent-thread/agent-thread.d.ts +26 -0
- package/dist/types/components/agent-thread/ui-message-stream.d.ts +3 -1
- package/dist/types/components/approval-card/approval-card.d.ts +31 -2
- package/dist/types/components/aurora/aurora.d.ts +31 -5
- package/dist/types/components/calendar/calendar.d.ts +39 -26
- package/dist/types/components/chart/chart.d.ts +250 -20
- package/dist/types/components/chart/color.d.ts +66 -0
- package/dist/types/components/chart/svg-adapter.d.ts +103 -0
- package/dist/types/components/chart/svg-geometry.d.ts +203 -0
- package/dist/types/components/check-button/check-button.d.ts +1 -4
- package/dist/types/components/checklist/checklist.d.ts +48 -5
- package/dist/types/components/code-editor/code-editor.d.ts +55 -1
- package/dist/types/components/composer/composer.d.ts +41 -6
- package/dist/types/components/context-menu/context-menu.d.ts +36 -8
- package/dist/types/components/copy/copy-button.d.ts +6 -0
- package/dist/types/components/copy/copy-input.d.ts +1 -0
- package/dist/types/components/date-picker/date-picker.d.ts +14 -0
- package/dist/types/components/date-picker/time-picker.d.ts +26 -17
- package/dist/types/components/datebox/datebox.d.ts +8 -4
- package/dist/types/components/dialog/dialog.d.ts +15 -4
- package/dist/types/components/empty-state/empty-state.d.ts +10 -1
- package/dist/types/components/field/field.d.ts +4 -2
- package/dist/types/components/form/form.d.ts +2 -1
- package/dist/types/components/kanban-view/kanban-card.d.ts +7 -0
- package/dist/types/components/kanban-view/kanban-view.d.ts +15 -3
- package/dist/types/components/launcher/launcher.d.ts +26 -0
- package/dist/types/components/master-panel/master-panel.d.ts +9 -4
- package/dist/types/components/menu-button/menu-button.d.ts +29 -5
- package/dist/types/components/message/message.d.ts +308 -5
- package/dist/types/components/modal/modal.d.ts +45 -8
- package/dist/types/components/modal/native-dialog.d.ts +40 -0
- package/dist/types/components/module-bar/module-bar.d.ts +9 -2
- package/dist/types/components/multi-value-editor/multi-value-editor.d.ts +5 -4
- package/dist/types/components/number-field/number-field.d.ts +31 -1
- package/dist/types/components/pagination/pagination.d.ts +341 -19
- package/dist/types/components/run-status/run-status.d.ts +26 -0
- package/dist/types/components/run-trace/run-trace.d.ts +10 -6
- package/dist/types/components/search/search.d.ts +16 -4
- package/dist/types/components/select/select.d.ts +19 -1
- package/dist/types/components/sheet/sheet.d.ts +20 -6
- package/dist/types/components/slider/slider.d.ts +2 -1
- package/dist/types/components/stat-tile/stat-tile.d.ts +20 -3
- package/dist/types/components/stepper/stepper.d.ts +17 -4
- package/dist/types/components/surface/catalog.d.ts +61 -17
- package/dist/types/components/surface/surface.d.ts +6 -4
- package/dist/types/components/table/table.d.ts +207 -5
- package/dist/types/components/table/window.d.ts +25 -1
- package/dist/types/components/toggle/toggle.d.ts +38 -6
- package/dist/types/components/tooltip/tooltip.d.ts +5 -4
- package/dist/types/components/tree/tree.d.ts +43 -6
- package/dist/types/components/truncate/truncate.d.ts +4 -2
- package/dist/types/components/value-list/value-list.d.ts +9 -2
- package/dist/types/core/date.d.ts +2 -1
- package/dist/types/core/dom.d.ts +14 -0
- package/dist/types/core/drag-axis.d.ts +10 -5
- package/dist/types/core/export.d.ts +2 -2
- package/dist/types/core/format.d.ts +3 -1
- package/dist/types/core/icons.d.ts +36 -3
- package/dist/types/core/keyboard.d.ts +7 -3
- package/dist/types/core/messages.d.ts +3 -0
- package/dist/types/core/storage.d.ts +4 -3
- package/dist/types/core/util.d.ts +3 -1
- package/dist/types/elements/define.d.ts +5 -2
- package/dist/types/index.d.ts +6 -4
- package/dist/types/internal/agent-model.d.ts +99 -0
- package/dist/types/internal/app-rail.d.ts +37 -2
- package/dist/types/internal/collections.d.ts +18 -0
- package/dist/types/internal/menu-items.d.ts +27 -0
- package/dist/types/internal/overlay-content.d.ts +23 -0
- package/dist/types/internal/presence-loop.d.ts +5 -2
- package/dist/types/locales/index.d.ts +3 -0
- package/dist/types/zeyos/calendar.d.ts +43 -7
- package/dist/types/zeyos/connect.d.ts +4 -0
- package/dist/types/zeyos/form.d.ts +13 -5
- package/dist/types/zeyos/select.d.ts +5 -2
- package/dist/types/zeyos/table.d.ts +16 -8
- package/dist/types/zeyos/view.d.ts +2 -1
- package/dist/zx-zeyos.esm.js +3161 -515
- package/dist/zx-zeyos.esm.min.js +4 -4
- package/dist/zx.core.css +4 -0
- package/dist/zx.core.min.css +1 -1
- package/dist/zx.css +970 -57
- package/dist/zx.esm.js +6405 -2249
- package/dist/zx.esm.min.js +26 -26
- package/dist/zx.global.js +6405 -2249
- package/dist/zx.global.min.js +26 -26
- package/dist/zx.layered.css +972 -57
- package/dist/zx.layered.min.css +1 -1
- package/dist/zx.min.css +1 -1
- package/docs/agent-catalog.json +159 -1
- package/docs/agent-surfaces.md +21 -21
- package/docs/api.json +3154 -518
- package/docs/components/account-menu.md +24 -0
- package/docs/components/activity-item.md +23 -0
- package/docs/components/activity-list.md +28 -0
- package/docs/components/agent-avatar.md +59 -0
- package/docs/components/agent-thread.md +275 -0
- package/docs/components/app-icon.md +36 -0
- package/docs/components/app-sidebar.md +92 -0
- package/docs/components/approval-card.md +71 -0
- package/docs/components/aurora.md +34 -0
- package/docs/components/avatar.md +37 -0
- package/docs/components/badge.md +36 -0
- package/docs/components/block-view.md +34 -0
- package/docs/components/breadcrumb.md +20 -0
- package/docs/components/button.md +23 -0
- package/docs/components/calendar.md +68 -0
- package/docs/components/card-view.md +73 -0
- package/docs/components/card.md +25 -0
- package/docs/components/chart.md +109 -0
- package/docs/components/check-button.md +16 -0
- package/docs/components/checklist.md +19 -0
- package/docs/components/code-editor.md +38 -0
- package/docs/components/composer.md +107 -0
- package/docs/components/context-menu.md +32 -0
- package/docs/components/copy.md +37 -0
- package/docs/components/data-filter.md +16 -0
- package/docs/components/date-picker.md +31 -0
- package/docs/components/date-range.md +21 -0
- package/docs/components/datebox.md +31 -0
- package/docs/components/dialog.md +25 -0
- package/docs/components/dock.md +57 -0
- package/docs/components/dropdown.md +39 -0
- package/docs/components/elements.md +63 -0
- package/docs/components/empty-state.md +17 -0
- package/docs/components/entity-ref.md +26 -0
- package/docs/components/field-upload.md +18 -0
- package/docs/components/file-item.md +27 -0
- package/docs/components/file-list.md +23 -0
- package/docs/components/filter-panel.md +45 -0
- package/docs/components/filter.md +47 -0
- package/docs/components/finder.md +25 -0
- package/docs/components/form-widgets.md +42 -0
- package/docs/components/form.md +80 -0
- package/docs/components/grid.md +26 -0
- package/docs/components/groupbox.md +11 -0
- package/docs/components/helpers.md +359 -0
- package/docs/components/icons.md +87 -0
- package/docs/components/index.md +99 -0
- package/docs/components/kanban-view.md +42 -0
- package/docs/components/kbd.md +23 -0
- package/docs/components/kernel.md +41 -0
- package/docs/components/launcher.md +66 -0
- package/docs/components/layout.md +33 -0
- package/docs/components/list-toolbar.md +38 -0
- package/docs/components/loading.md +48 -0
- package/docs/components/menu-button.md +47 -0
- package/docs/components/message.md +76 -0
- package/docs/components/modal.md +27 -0
- package/docs/components/module-bar.md +71 -0
- package/docs/components/multi-value-editor.md +16 -0
- package/docs/components/navigation-bar.md +22 -0
- package/docs/components/number-field.md +34 -0
- package/docs/components/pagination.md +73 -0
- package/docs/components/panel.md +28 -0
- package/docs/components/prompt-starters.md +40 -0
- package/docs/components/prose.md +38 -0
- package/docs/components/questionnaire.md +115 -0
- package/docs/components/rating.md +19 -0
- package/docs/components/run-status.md +50 -0
- package/docs/components/run-trace.md +72 -0
- package/docs/components/search.md +11 -0
- package/docs/components/select.md +129 -0
- package/docs/components/sheet-stack.md +39 -0
- package/docs/components/sheet.md +77 -0
- package/docs/components/skeleton.md +27 -0
- package/docs/components/slider.md +29 -0
- package/docs/components/sort-control.md +21 -0
- package/docs/components/source-list.md +30 -0
- package/docs/components/split-view.md +12 -0
- package/docs/components/stat-tile.md +49 -0
- package/docs/components/stepper.md +27 -0
- package/docs/components/surface.md +152 -0
- package/docs/components/tabbox.md +33 -0
- package/docs/components/table-view.md +43 -0
- package/docs/components/table.md +232 -0
- package/docs/components/tag-picker.md +39 -0
- package/docs/components/timebox.md +16 -0
- package/docs/components/toggle.md +21 -0
- package/docs/components/tokens.md +82 -0
- package/docs/components/toolbar.md +26 -0
- package/docs/components/tooltip.md +16 -0
- package/docs/components/tree.md +48 -0
- package/docs/components/truncate.md +21 -0
- package/docs/components/value-list.md +14 -0
- package/docs/components/view-settings.md +56 -0
- package/docs/components/workspace-switcher.md +42 -0
- package/docs/components/zeyos.md +196 -0
- package/docs/llms-small.txt +299 -0
- package/docs/llms.md +725 -109
- package/docs/llms.txt +46 -19
- package/package.json +9 -4
- package/src/components/activity-item/activity-item.js +21 -2
- package/src/components/agent-avatar/agent-avatar.css +195 -0
- package/src/components/agent-avatar/agent-avatar.js +333 -0
- package/src/components/agent-avatar/agent-face.js +292 -0
- package/src/components/agent-thread/ag-ui.js +44 -11
- package/src/components/agent-thread/agent-thread.js +103 -11
- package/src/components/agent-thread/ui-message-stream.js +3 -1
- package/src/components/app-rail/app-rail.css +5 -0
- package/src/components/app-sidebar/app-sidebar.css +3 -0
- package/src/components/app-sidebar/app-sidebar.js +4 -3
- package/src/components/approval-card/approval-card.css +6 -0
- package/src/components/approval-card/approval-card.js +55 -7
- package/src/components/aurora/aurora.css +149 -14
- package/src/components/aurora/aurora.js +49 -6
- package/src/components/button/button.css +24 -11
- package/src/components/calendar/calendar.css +6 -2
- package/src/components/calendar/calendar.js +127 -47
- package/src/components/card-view/card-view.js +5 -6
- package/src/components/chart/chart.css +159 -1
- package/src/components/chart/chart.js +450 -62
- package/src/components/chart/color.js +297 -0
- package/src/components/chart/svg-adapter.js +576 -0
- package/src/components/chart/svg-geometry.js +323 -0
- package/src/components/check-button/check-button.js +3 -18
- package/src/components/checklist/checklist.css +9 -1
- package/src/components/checklist/checklist.js +105 -20
- package/src/components/checklist/field-adapter.js +6 -12
- package/src/components/code-editor/code-editor.css +33 -0
- package/src/components/code-editor/code-editor.js +97 -8
- package/src/components/code-editor/field-adapter.js +3 -0
- package/src/components/composer/composer.css +3 -0
- package/src/components/composer/composer.js +100 -22
- package/src/components/context-menu/context-menu.js +41 -5
- package/src/components/copy/copy-button.js +9 -1
- package/src/components/copy/copy-input.js +5 -0
- package/src/components/data-filter/filter-core.js +0 -1
- package/src/components/date-picker/date-picker.css +8 -0
- package/src/components/date-picker/date-picker.js +47 -8
- package/src/components/date-picker/date-range-picker.js +1 -1
- package/src/components/date-picker/month-picker.js +19 -3
- package/src/components/date-picker/time-picker.js +54 -19
- package/src/components/datebox/date-range-box.js +7 -3
- package/src/components/datebox/datebox.js +32 -6
- package/src/components/dialog/dialog.css +6 -0
- package/src/components/dialog/dialog.js +24 -33
- package/src/components/dropdown/dropdown.js +1 -18
- package/src/components/empty-state/empty-state.js +21 -2
- package/src/components/field/field.js +19 -3
- package/src/components/fieldset/fieldset.js +3 -1
- package/src/components/filter/filter.js +9 -0
- package/src/components/form/form.js +19 -2
- package/src/components/kanban-view/kanban-card.js +15 -2
- package/src/components/kanban-view/kanban-view.css +21 -0
- package/src/components/kanban-view/kanban-view.js +29 -16
- package/src/components/launcher/launcher.css +14 -0
- package/src/components/launcher/launcher.js +54 -9
- package/src/components/master-panel/master-panel.js +24 -22
- package/src/components/menu-button/menu-button.js +26 -4
- package/src/components/message/message.css +228 -29
- package/src/components/message/message.js +664 -30
- package/src/components/modal/modal.js +129 -30
- package/src/components/modal/native-dialog.js +91 -0
- package/src/components/module-bar/module-bar.css +3 -0
- package/src/components/module-bar/module-bar.js +17 -4
- package/src/components/multi-value-editor/multi-value-editor.css +7 -2
- package/src/components/multi-value-editor/multi-value-editor.js +3 -2
- package/src/components/navigation-bar/navigation-bar.js +13 -1
- package/src/components/number-field/field-adapter.js +3 -0
- package/src/components/number-field/number-field.js +70 -16
- package/src/components/pagination/pagination.css +26 -2
- package/src/components/pagination/pagination.js +551 -65
- package/src/components/prose/prose.js +7 -1
- package/src/components/rating/field-adapter.js +3 -0
- package/src/components/run-status/run-status.js +43 -3
- package/src/components/run-trace/run-trace.js +15 -7
- package/src/components/search/search.js +3 -18
- package/src/components/select/field-adapter.js +8 -1
- package/src/components/select/select.js +68 -13
- package/src/components/sheet/sheet.js +39 -13
- package/src/components/slider/field-adapter.js +3 -0
- package/src/components/slider/slider.js +4 -6
- package/src/components/stat-tile/stat-tile.js +24 -9
- package/src/components/stepper/stepper.css +15 -0
- package/src/components/stepper/stepper.js +34 -2
- package/src/components/surface/catalog.js +185 -28
- package/src/components/surface/surface.js +10 -5
- package/src/components/tabbox/tabbox.js +13 -1
- package/src/components/table/table.css +160 -2
- package/src/components/table/table.js +479 -52
- package/src/components/table/window.js +46 -4
- package/src/components/table-view/table-view.js +1 -10
- package/src/components/tag-picker/field-adapter.js +3 -0
- package/src/components/tag-picker/tag-picker.js +2 -0
- package/src/components/timebox/field-adapter.js +3 -0
- package/src/components/toggle/toggle.js +51 -27
- package/src/components/tooltip/tooltip.js +21 -14
- package/src/components/tree/tree.js +87 -14
- package/src/components/truncate/truncate.js +21 -5
- package/src/components/value-list/value-list.js +37 -9
- package/src/components/view-settings/view-settings.js +1 -5
- package/src/core/component.js +34 -2
- package/src/core/date.js +5 -4
- package/src/core/dom.js +45 -2
- package/src/core/drag-axis.js +24 -7
- package/src/core/export.js +4 -4
- package/src/core/fontawesome.js +34 -3
- package/src/core/format.js +3 -1
- package/src/core/http.js +23 -11
- package/src/core/icons.js +60 -8
- package/src/core/keyboard.js +83 -9
- package/src/core/messages.js +3 -0
- package/src/core/position.js +4 -3
- package/src/core/storage.js +80 -31
- package/src/core/util.js +16 -5
- package/src/elements/define.js +82 -47
- package/src/elements/kit.js +46 -35
- package/src/index.js +8 -4
- package/src/internal/agent-model.js +152 -0
- package/src/internal/app-rail.js +53 -2
- package/src/internal/collections.js +25 -0
- package/src/internal/menu-items.js +59 -0
- package/src/internal/overlay-content.js +35 -0
- package/src/internal/presence-loop.js +61 -14
- package/src/locales/de.js +3 -0
- package/src/zeyos/calendar.js +81 -19
- package/src/zeyos/connect.js +5 -1
- package/src/zeyos/form.js +29 -10
- package/src/zeyos/select.js +36 -12
- package/src/zeyos/table.js +43 -11
- package/src/zeyos/view.js +2 -1
- package/styles/tokens/semantic.css +7 -1
- package/styles/zx.css +1 -0
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
import { Component } from '../../core/component.js';
|
|
2
|
+
import { AgentAvatar } from '../agent-avatar/agent-avatar.js';
|
|
2
3
|
import { Avatar } from '../avatar/avatar.js';
|
|
3
4
|
export type TraceStep = import('../../internal/agent-model.js').TraceStep;
|
|
4
5
|
export type Author = import('../../internal/agent-model.js').Author;
|
|
6
|
+
export type AuthorFace = import('../../internal/agent-model.js').AuthorFace;
|
|
5
7
|
export type ItemRef = import('../../internal/agent-model.js').ItemRef;
|
|
6
8
|
export type RunState = import('../../internal/agent-model.js').RunState;
|
|
7
9
|
export type AvatarTone = import('../avatar/avatar.js').AvatarTone;
|
|
@@ -154,7 +156,7 @@ export type StepEntry = {
|
|
|
154
156
|
/**
|
|
155
157
|
* Avatars the row owns.
|
|
156
158
|
*/
|
|
157
|
-
avatars: Avatar
|
|
159
|
+
avatars: Array<Avatar | AgentAvatar>;
|
|
158
160
|
/**
|
|
159
161
|
* The top-level step a retry is drawn under; null for a top-level step.
|
|
160
162
|
*/
|
|
@@ -182,6 +184,7 @@ export type TraceLabel = {
|
|
|
182
184
|
};
|
|
183
185
|
/** @typedef {import('../../internal/agent-model.js').TraceStep} TraceStep */
|
|
184
186
|
/** @typedef {import('../../internal/agent-model.js').Author} Author */
|
|
187
|
+
/** @typedef {import('../../internal/agent-model.js').AuthorFace} AuthorFace */
|
|
185
188
|
/** @typedef {import('../../internal/agent-model.js').ItemRef} ItemRef */
|
|
186
189
|
/** @typedef {import('../../internal/agent-model.js').RunState} RunState */
|
|
187
190
|
/** @typedef {import('../avatar/avatar.js').AvatarTone} AvatarTone */
|
|
@@ -255,7 +258,7 @@ export type TraceLabel = {
|
|
|
255
258
|
* @property {HTMLElement|null} refs The step's links, after its row.
|
|
256
259
|
* @property {HTMLElement|null} body The disclosure's content, when the step has any.
|
|
257
260
|
* @property {HTMLElement|null} retries The nested list of the steps that repeat this one.
|
|
258
|
-
* @property {Avatar
|
|
261
|
+
* @property {Array<Avatar|AgentAvatar>} avatars Avatars the row owns.
|
|
259
262
|
* @property {string|null} rootId The top-level step a retry is drawn under; null for a top-level step.
|
|
260
263
|
* @property {string|null} bodyId Id of the disclosure content.
|
|
261
264
|
*/
|
|
@@ -509,15 +512,16 @@ export declare class RunTrace extends Component<RunTraceOptions> {
|
|
|
509
512
|
/**
|
|
510
513
|
* @private
|
|
511
514
|
* @param {unknown} key
|
|
512
|
-
* @returns {{name: string, initials: string, tone: AvatarTone|null, person: boolean}}
|
|
515
|
+
* @returns {{name: string, initials: string, tone: AvatarTone|null, person: boolean, face: AuthorFace|null}}
|
|
513
516
|
*/
|
|
514
517
|
private _author;
|
|
515
518
|
/**
|
|
516
|
-
* A hand-off avatar,
|
|
517
|
-
* rounded square for an agent or
|
|
519
|
+
* A hand-off avatar, drawn like the author's avatar everywhere else: an agent with a `face` as its
|
|
520
|
+
* AgentAvatar, still; otherwise initials, round for a person and a rounded square for an agent or
|
|
521
|
+
* a model.
|
|
518
522
|
* @private
|
|
519
523
|
* @param {unknown} key
|
|
520
|
-
* @returns {Avatar}
|
|
524
|
+
* @returns {Avatar|AgentAvatar}
|
|
521
525
|
*/
|
|
522
526
|
private _avatar;
|
|
523
527
|
/** @private @param {StepEntry} entry @returns {void} */
|
|
@@ -52,10 +52,7 @@ export type SearchOptions = {
|
|
|
52
52
|
*/
|
|
53
53
|
export declare class Search extends Component<SearchOptions> {
|
|
54
54
|
_createdRoot: boolean;
|
|
55
|
-
_original:
|
|
56
|
-
attributes: [string, string][];
|
|
57
|
-
children: Node[];
|
|
58
|
-
};
|
|
55
|
+
_original: import("../../core/dom.js").TargetSnapshot;
|
|
59
56
|
_inputTimer: number;
|
|
60
57
|
_cleaned: boolean;
|
|
61
58
|
static cssName: string;
|
|
@@ -103,3 +100,18 @@ export declare class Search extends Component<SearchOptions> {
|
|
|
103
100
|
*/
|
|
104
101
|
_message(key: string, fallback: string): string;
|
|
105
102
|
}
|
|
103
|
+
/**
|
|
104
|
+
* Debounced query update.
|
|
105
|
+
* @event Search#input
|
|
106
|
+
* @type {CustomEvent<{value: string}>}
|
|
107
|
+
*/
|
|
108
|
+
/**
|
|
109
|
+
* Search submission.
|
|
110
|
+
* @event Search#submit
|
|
111
|
+
* @type {CustomEvent<{value: string}>}
|
|
112
|
+
*/
|
|
113
|
+
/**
|
|
114
|
+
* Explicit clear action.
|
|
115
|
+
* @event Search#clear
|
|
116
|
+
* @type {CustomEvent<Record<string, never>>}
|
|
117
|
+
*/
|
|
@@ -241,7 +241,9 @@ export declare class Select extends Component<SelectOptions> {
|
|
|
241
241
|
/** Selected item, or null. @returns {SelectItem|null} */
|
|
242
242
|
get selected(): SelectItem | null;
|
|
243
243
|
/**
|
|
244
|
-
* Selects an item or item ID.
|
|
244
|
+
* Selects an item or item ID. An ID none of the items carries selects nothing; a whole item
|
|
245
|
+
* that is not among them — the current record of an async-filtered Select, whose results have
|
|
246
|
+
* not been loaded — is selected as given.
|
|
245
247
|
* @param {unknown} idOrItem Item ID, item, or null.
|
|
246
248
|
* @param {SelectSetOptions} [options={}] Update behavior.
|
|
247
249
|
* @returns {this}
|
|
@@ -260,6 +262,22 @@ export declare class Select extends Component<SelectOptions> {
|
|
|
260
262
|
* @returns {this}
|
|
261
263
|
*/
|
|
262
264
|
setFixedItems(items: SelectItem[]): this;
|
|
265
|
+
/**
|
|
266
|
+
* What the reader has typed into the open list, or null when the input just shows the
|
|
267
|
+
* selection (or the list is closed, or the Select does not filter).
|
|
268
|
+
* @returns {string|null}
|
|
269
|
+
*/
|
|
270
|
+
_typedQuery(): string | null;
|
|
271
|
+
/**
|
|
272
|
+
* Redraws after the items were replaced. A query the reader typed into the open list stays in
|
|
273
|
+
* the input and narrows the new items — locally filtered items by matching, pinned choices
|
|
274
|
+
* always — instead of the full list replacing what they typed.
|
|
275
|
+
* @param {string|null} query Typed query from before the change (see `_typedQuery()`).
|
|
276
|
+
* @returns {void}
|
|
277
|
+
*/
|
|
278
|
+
_refreshAfterItemChange(query: string | null): void;
|
|
279
|
+
/** The text the input shows for the selection: '' when nothing is selected. @returns {string} */
|
|
280
|
+
_selectedLabel(): string;
|
|
263
281
|
/** Replaces command rows without changing the selected value. @param {SelectAction[]} actions @returns {this} */
|
|
264
282
|
setActions(actions: SelectAction[]): this;
|
|
265
283
|
/**
|
|
@@ -27,7 +27,8 @@ export type SheetOptions = {
|
|
|
27
27
|
size?: string | number | null;
|
|
28
28
|
/**
|
|
29
29
|
* Whether the header shows its close control. Independent of
|
|
30
|
-
* `closable`, so a sheet can offer Escape without an ✕, or the reverse.
|
|
30
|
+
* `closable`, so a sheet can offer Escape without an ✕, or the reverse. When false the control is
|
|
31
|
+
* not displayed, not focusable, and closes nothing.
|
|
31
32
|
*/
|
|
32
33
|
closeButton?: boolean;
|
|
33
34
|
/**
|
|
@@ -97,7 +98,7 @@ export type SheetOptions = {
|
|
|
97
98
|
/**
|
|
98
99
|
* Cancel event listener.
|
|
99
100
|
*/
|
|
100
|
-
oncancel?: (event: CustomEvent<
|
|
101
|
+
oncancel?: (event: CustomEvent<import('../modal/modal.js').ModalCancelDetail>) => void;
|
|
101
102
|
/**
|
|
102
103
|
* Resize listener.
|
|
103
104
|
*/
|
|
@@ -126,7 +127,8 @@ export type SheetOptions = {
|
|
|
126
127
|
* `start`/`end`, height for `top`/`bottom`. A number is pixels, a string is any CSS length. Null
|
|
127
128
|
* keeps the per-side default.
|
|
128
129
|
* @property {boolean} [closeButton=true] Whether the header shows its close control. Independent of
|
|
129
|
-
* `closable`, so a sheet can offer Escape without an ✕, or the reverse.
|
|
130
|
+
* `closable`, so a sheet can offer Escape without an ✕, or the reverse. When false the control is
|
|
131
|
+
* not displayed, not focusable, and closes nothing.
|
|
130
132
|
* @property {boolean} [resizable=false] Whether the inner edge may be dragged to resize the sheet.
|
|
131
133
|
* @property {number} [min=160] Smallest the sheet may be dragged to, in pixels.
|
|
132
134
|
* @property {number|null} [max=null] Largest it may be dragged to; null means the viewport.
|
|
@@ -145,7 +147,7 @@ export type SheetOptions = {
|
|
|
145
147
|
* @property {Element|string|null} [scope=null] Element whose nearest Zx theme scope owns a floating sheet; defaults to the opener.
|
|
146
148
|
* @property {(event: CustomEvent<Record<string, never>>) => void} [onopen] Open event listener.
|
|
147
149
|
* @property {(event: CustomEvent<{result: unknown}>) => void} [onclose] Close event listener.
|
|
148
|
-
* @property {(event: CustomEvent<
|
|
150
|
+
* @property {(event: CustomEvent<import('../modal/modal.js').ModalCancelDetail>) => void} [oncancel] Cancel event listener.
|
|
149
151
|
* @property {(event: CustomEvent<{size: number, ratio: number}>) => void} [onresize] Resize listener.
|
|
150
152
|
* @property {(event: CustomEvent<{docked: boolean, dock: import('../dock/dock.js').Dock|null}>) => void} [ondockchange] Dock-state listener.
|
|
151
153
|
*/
|
|
@@ -175,8 +177,14 @@ export declare class Sheet extends Dialog {
|
|
|
175
177
|
/** @type {Element|null} The element focus was on when the current `open()` began. */
|
|
176
178
|
_openedFrom: Element | null;
|
|
177
179
|
static cssName: string;
|
|
178
|
-
/**
|
|
179
|
-
|
|
180
|
+
/**
|
|
181
|
+
* A sheet's `size` is any CSS length along its axis, wider than Dialog's presets, so the static
|
|
182
|
+
* side is typed loosely there to stay assignable to Dialog's.
|
|
183
|
+
* @type {Readonly<SheetOptions & {size?: any}>}
|
|
184
|
+
*/
|
|
185
|
+
static defaults: Readonly<SheetOptions & {
|
|
186
|
+
size?: any;
|
|
187
|
+
}>;
|
|
180
188
|
/**
|
|
181
189
|
* Creates an edge-anchored sheet.
|
|
182
190
|
* @param {Element|string|null} [_target=null] Ignored; Sheet always owns its root.
|
|
@@ -195,6 +203,12 @@ export declare class Sheet extends Dialog {
|
|
|
195
203
|
* @returns {number}
|
|
196
204
|
*/
|
|
197
205
|
getSize(): number;
|
|
206
|
+
/**
|
|
207
|
+
* A sheet's header button follows `closeButton`, not `closable`: Escape and the ✕ are separate.
|
|
208
|
+
* @returns {boolean}
|
|
209
|
+
* @protected
|
|
210
|
+
*/
|
|
211
|
+
protected _hasCloseButton(): boolean;
|
|
198
212
|
/**
|
|
199
213
|
* Resolves a translated string, falling back to English when no translator knows the key.
|
|
200
214
|
* @param {string} key Message key.
|
|
@@ -210,7 +210,8 @@ export declare class Slider extends Component<SliderOptions> {
|
|
|
210
210
|
destroy(): void;
|
|
211
211
|
}
|
|
212
212
|
/**
|
|
213
|
-
* Decimal places a step carries, so a 0.1 step snaps to 0.3 rather than 0.30000000000000004
|
|
213
|
+
* Decimal places a step carries, so a 0.1 step snaps to 0.3 rather than 0.30000000000000004 —
|
|
214
|
+
* exponent form included (`1.5e-7` carries 8).
|
|
214
215
|
* @param {number} step Step size.
|
|
215
216
|
* @returns {number}
|
|
216
217
|
*/
|
|
@@ -124,8 +124,11 @@ export type StatTileOptions = {
|
|
|
124
124
|
*/
|
|
125
125
|
href?: string | null;
|
|
126
126
|
/**
|
|
127
|
-
* Renders a `<button>` without an href. Passing
|
|
128
|
-
* sets this implicitly; set it
|
|
127
|
+
* Renders a `<button>` without an href. Passing a function
|
|
128
|
+
* as `onclick` sets this implicitly; set it to `true` to subscribe with `on('click', …)` instead.
|
|
129
|
+
* An explicit `false` wins over `onclick`: the tile stays a `<div>` and the handler is never
|
|
130
|
+
* called — for a caller that always passes a handler and decides per tile whether it applies.
|
|
131
|
+
* It does not turn a tile with an `href` into anything but a link.
|
|
129
132
|
*/
|
|
130
133
|
clickable?: boolean;
|
|
131
134
|
/**
|
|
@@ -138,7 +141,9 @@ export type StatTileOptions = {
|
|
|
138
141
|
msg?: Record<string, unknown>;
|
|
139
142
|
/**
|
|
140
143
|
* Activation listener; its
|
|
141
|
-
* presence is what turns a tile with no href into a button
|
|
144
|
+
* presence is what turns a tile with no href into a button, unless `clickable` is `false`. Leave
|
|
145
|
+
* it out — rather than passing an empty function — for a tile that does nothing. It is the
|
|
146
|
+
* tile's `click` event, as
|
|
142
147
|
* every Zx component's `on*` option is, so it receives the `CustomEvent` carrying the native
|
|
143
148
|
* event in `detail.event`.
|
|
144
149
|
*/
|
|
@@ -274,6 +279,18 @@ export declare function statTileTag(options?: {
|
|
|
274
279
|
clickable?: boolean;
|
|
275
280
|
onclick?: unknown;
|
|
276
281
|
}): 'a' | 'button' | 'div';
|
|
282
|
+
/**
|
|
283
|
+
* Whether a tile without a destination is an action. `clickable` decides when it is given as a
|
|
284
|
+
* boolean; left out (or nullish), a function-valued `onclick` does. So an explicit
|
|
285
|
+
* `clickable: false` wins over a handler, and a handler that is not a function is not behaviour.
|
|
286
|
+
* @param {{clickable?: boolean|null, onclick?: unknown}} [options={}] The options that carry
|
|
287
|
+
* behaviour.
|
|
288
|
+
* @returns {boolean}
|
|
289
|
+
*/
|
|
290
|
+
export declare function statTileClickable(options?: {
|
|
291
|
+
clickable?: boolean | null;
|
|
292
|
+
onclick?: unknown;
|
|
293
|
+
}): boolean;
|
|
277
294
|
/**
|
|
278
295
|
* Composes the tile's accessible name: label, then value with its caption, then how it changed.
|
|
279
296
|
*
|
|
@@ -15,7 +15,8 @@ export type StepperOptions = {
|
|
|
15
15
|
active?: string | null;
|
|
16
16
|
/**
|
|
17
17
|
* `horizontal` lays the rail out above the
|
|
18
|
-
* stage, `vertical` puts it beside the stage.
|
|
18
|
+
* stage, `vertical` puts it beside the stage. A horizontal rail too wide for its container wraps
|
|
19
|
+
* onto further rows; each row's connectors end at its last step.
|
|
19
20
|
*/
|
|
20
21
|
orientation?: StepperOrientation;
|
|
21
22
|
/**
|
|
@@ -78,7 +79,8 @@ export type StepRecord = {
|
|
|
78
79
|
*/
|
|
79
80
|
step: NormalizedStep;
|
|
80
81
|
/**
|
|
81
|
-
* List item carrying `data-state` and `aria-current
|
|
82
|
+
* List item carrying `data-state` and `aria-current`, and
|
|
83
|
+
* `data-row-end` while it is the last step of a row in a wrapped horizontal rail.
|
|
82
84
|
*/
|
|
83
85
|
item: HTMLLIElement;
|
|
84
86
|
/**
|
|
@@ -99,7 +101,8 @@ export type StepRecord = {
|
|
|
99
101
|
* @property {StepDefinition[]} [steps=[]] Ordered step definitions.
|
|
100
102
|
* @property {string|null} [active=null] Initially active step name; defaults to the first enabled step.
|
|
101
103
|
* @property {StepperOrientation} [orientation='horizontal'] `horizontal` lays the rail out above the
|
|
102
|
-
* stage, `vertical` puts it beside the stage.
|
|
104
|
+
* stage, `vertical` puts it beside the stage. A horizontal rail too wide for its container wraps
|
|
105
|
+
* onto further rows; each row's connectors end at its last step.
|
|
103
106
|
* @property {StepperClickable} [clickable='completed'] Which steps are activated by a click:
|
|
104
107
|
* `completed` (go back only), `all`, or `false` for a display-only rail.
|
|
105
108
|
* @property {boolean} [showNumbers=true] Whether upcoming and active markers show their number.
|
|
@@ -123,7 +126,8 @@ export type StepRecord = {
|
|
|
123
126
|
/**
|
|
124
127
|
* @typedef {Object} StepRecord
|
|
125
128
|
* @property {NormalizedStep} step Normalized definition.
|
|
126
|
-
* @property {HTMLLIElement} item List item carrying `data-state` and `aria-current
|
|
129
|
+
* @property {HTMLLIElement} item List item carrying `data-state` and `aria-current`, and
|
|
130
|
+
* `data-row-end` while it is the last step of a row in a wrapped horizontal rail.
|
|
127
131
|
* @property {HTMLElement} control Button (clickable rails) or span (display-only rails).
|
|
128
132
|
* @property {HTMLElement} marker Number / check / warning bubble.
|
|
129
133
|
* @property {HTMLElement} status Visually hidden state text for assistive technology.
|
|
@@ -151,6 +155,8 @@ export declare class Stepper extends Component<StepperOptions> {
|
|
|
151
155
|
_completed: Set<string>;
|
|
152
156
|
/** @type {Set<string>} */
|
|
153
157
|
_errored: Set<string>;
|
|
158
|
+
/** @type {ResizeObserver|null} */
|
|
159
|
+
_rowObserver: ResizeObserver | null;
|
|
154
160
|
static cssName: string;
|
|
155
161
|
/** @type {Readonly<StepperOptions>} */
|
|
156
162
|
static defaults: Readonly<StepperOptions>;
|
|
@@ -250,6 +256,13 @@ export declare class Stepper extends Component<StepperOptions> {
|
|
|
250
256
|
* @fires Stepper#change
|
|
251
257
|
*/
|
|
252
258
|
_activate(index: number): this;
|
|
259
|
+
/**
|
|
260
|
+
* Marks the last step of every row but the final one with `data-row-end`, which is what hides
|
|
261
|
+
* its connector. The mark changes no size — the connector keeps its box — so the row breaks it
|
|
262
|
+
* was measured from stay where they are and one pass settles.
|
|
263
|
+
* @returns {void}
|
|
264
|
+
*/
|
|
265
|
+
_markRows(): void;
|
|
253
266
|
/**
|
|
254
267
|
* Builds one step's elements. The control's tag depends only on the `clickable` option, never on
|
|
255
268
|
* the step's state, so state changes never have to swap an element out from under the focus.
|
|
@@ -107,6 +107,16 @@ export type CatalogNode = {
|
|
|
107
107
|
* The one intent the node may appear in.
|
|
108
108
|
*/
|
|
109
109
|
intentOnly?: SurfaceIntent;
|
|
110
|
+
/**
|
|
111
|
+
* One sentence, for the model: when to pick the node.
|
|
112
|
+
*/
|
|
113
|
+
use: string;
|
|
114
|
+
/**
|
|
115
|
+
* One sentence, for the model: when not to, naming the node or intent to
|
|
116
|
+
* use instead in backticks. The guide leaves it out when that node or intent is not in the
|
|
117
|
+
* catalog it is written for.
|
|
118
|
+
*/
|
|
119
|
+
avoid: string;
|
|
110
120
|
/**
|
|
111
121
|
* Whether it lays out `children`.
|
|
112
122
|
*/
|
|
@@ -153,35 +163,62 @@ export type SurfaceCatalog = {
|
|
|
153
163
|
*/
|
|
154
164
|
nodes: Readonly<Record<string, CatalogNode>>;
|
|
155
165
|
};
|
|
166
|
+
export type CatalogProfile = 'answer' | 'ask' | 'review' | 'full';
|
|
167
|
+
export type CatalogNarrowing = {
|
|
168
|
+
/**
|
|
169
|
+
* A named set to start from; the whole catalog when left out.
|
|
170
|
+
*/
|
|
171
|
+
profile?: CatalogProfile;
|
|
172
|
+
/**
|
|
173
|
+
* The intents to keep, within the profile; all when left out.
|
|
174
|
+
*/
|
|
175
|
+
intents?: SurfaceIntent[];
|
|
176
|
+
/**
|
|
177
|
+
* The node types to keep, within the profile; all when left out.
|
|
178
|
+
*/
|
|
179
|
+
nodes?: string[];
|
|
180
|
+
};
|
|
181
|
+
export type ProfileChoice = {
|
|
182
|
+
/**
|
|
183
|
+
* Narrows the catalog to a profile first; the catalog as
|
|
184
|
+
* given when left out.
|
|
185
|
+
*/
|
|
186
|
+
profile?: CatalogProfile;
|
|
187
|
+
};
|
|
156
188
|
/**
|
|
157
189
|
* The full catalog. Frozen; narrow it with `narrowCatalog()`.
|
|
158
190
|
* @type {SurfaceCatalog}
|
|
159
191
|
*/
|
|
160
192
|
export declare const CATALOG: SurfaceCatalog;
|
|
193
|
+
/** The profile names, from the smallest catalog to the whole one. */
|
|
194
|
+
export declare const PROFILES: readonly CatalogProfile[];
|
|
161
195
|
/**
|
|
162
196
|
* Returns a catalog limited to some intents and node types. It can only narrow: a name the
|
|
163
197
|
* catalog does not have is refused, and so is an intent whose required node would be removed
|
|
164
198
|
* (`ask` without `fields`, `choose` without `choice`, `review` without `diff` or `table`,
|
|
165
199
|
* `questionnaire` without `questionnaire`). A node that belongs to one intent leaves with it.
|
|
200
|
+
*
|
|
201
|
+
* A `profile` names a set to start from — `answer` (a `show` surface of prose, figures, tables,
|
|
202
|
+
* charts, records, links and layout), `ask` (adds the `ask`, `choose` and `confirm` intents with
|
|
203
|
+
* `fields` and `choice`), `review` (adds the `review` intent with `diff`) or `full` — and keeps
|
|
204
|
+
* what the catalog and the profile both have. `intents` and `nodes` then narrow within it.
|
|
166
205
|
* @param {SurfaceCatalog} catalog The catalog to narrow: `CATALOG` or an already narrowed one.
|
|
167
|
-
* @param {
|
|
206
|
+
* @param {CatalogNarrowing} [options] What to keep; all when left out.
|
|
168
207
|
* @returns {SurfaceCatalog} A new frozen catalog.
|
|
169
|
-
* @throws {TypeError} For an unknown name,
|
|
170
|
-
* catalog that is not the library's.
|
|
208
|
+
* @throws {TypeError} For an unknown profile or name, a name outside the profile, an intent left
|
|
209
|
+
* without its required node, or a catalog that is not the library's.
|
|
171
210
|
*/
|
|
172
|
-
export declare function narrowCatalog(catalog: SurfaceCatalog, options?:
|
|
173
|
-
intents?: SurfaceIntent[];
|
|
174
|
-
nodes?: string[];
|
|
175
|
-
}): SurfaceCatalog;
|
|
211
|
+
export declare function narrowCatalog(catalog: SurfaceCatalog, options?: CatalogNarrowing): SurfaceCatalog;
|
|
176
212
|
/**
|
|
177
213
|
* Throws unless the catalog is the library's, or narrowed from it: every intent and node entry
|
|
178
214
|
* must be the library's own frozen entry, so a catalog cannot be widened by building one by hand.
|
|
215
|
+
* Every node must say when to use it and when not to (`use` and `avoid`).
|
|
179
216
|
* @param {unknown} catalog
|
|
180
217
|
* @returns {asserts catalog is SurfaceCatalog}
|
|
181
|
-
* @throws {TypeError} When the catalog is not the library's
|
|
218
|
+
* @throws {TypeError} When the catalog is not the library's, or a node lacks `use` or `avoid`.
|
|
182
219
|
*/
|
|
183
220
|
export declare function assertCatalog(catalog: unknown): asserts catalog is SurfaceCatalog;
|
|
184
|
-
export type
|
|
221
|
+
export type SchemaVariant = 'full' | 'strict';
|
|
185
222
|
export type JsonSchema = Record<string, any>;
|
|
186
223
|
/**
|
|
187
224
|
* The JSON Schema (2020-12) of the format for a catalog: one operation line, and a whole document.
|
|
@@ -189,9 +226,11 @@ export type JsonSchema = Record<string, any>;
|
|
|
189
226
|
* inputs a condition may name, or the application's entities, and it leaves out the repairs the
|
|
190
227
|
* validator makes.
|
|
191
228
|
* @param {SurfaceCatalog} [catalog=CATALOG]
|
|
229
|
+
* @param {ProfileChoice} [options] `profile` narrows the catalog first.
|
|
192
230
|
* @returns {{line: JsonSchema, document: JsonSchema}}
|
|
231
|
+
* @throws {TypeError} For an unknown profile or a catalog that is not the library's.
|
|
193
232
|
*/
|
|
194
|
-
export declare function surfaceSchema(catalog?: SurfaceCatalog): {
|
|
233
|
+
export declare function surfaceSchema(catalog?: SurfaceCatalog, options?: ProfileChoice): {
|
|
195
234
|
line: JsonSchema;
|
|
196
235
|
document: JsonSchema;
|
|
197
236
|
};
|
|
@@ -221,12 +260,15 @@ export type SurfaceTool = {
|
|
|
221
260
|
/**
|
|
222
261
|
* The tool definitions a model calls to put a surface in front of the person: `show_surface`
|
|
223
262
|
* (any intent, a whole document) and `ask_user` (an `ask` surface; left out when the catalog has
|
|
224
|
-
* no `ask`). The person's reply is each call's result. Arguments follow the strict
|
|
263
|
+
* no `ask`). The person's reply is each call's result. Arguments follow the strict variant: every
|
|
225
264
|
* key present, `null` for one that does not apply, schema properties and table rows as lists.
|
|
226
265
|
* @param {SurfaceCatalog} [catalog=CATALOG]
|
|
266
|
+
* @param {ProfileChoice} [options] `profile` narrows the catalog first; `answer` is the smallest
|
|
267
|
+
* set, a `show_surface` without `ask_user`.
|
|
227
268
|
* @returns {SurfaceTool[]}
|
|
269
|
+
* @throws {TypeError} For an unknown profile or a catalog that is not the library's.
|
|
228
270
|
*/
|
|
229
|
-
export declare function surfaceTools(catalog?: SurfaceCatalog): SurfaceTool[];
|
|
271
|
+
export declare function surfaceTools(catalog?: SurfaceCatalog, options?: ProfileChoice): SurfaceTool[];
|
|
230
272
|
export type WorkedExample = {
|
|
231
273
|
title: string;
|
|
232
274
|
intro: string;
|
|
@@ -245,16 +287,18 @@ export type WorkedExample = {
|
|
|
245
287
|
export declare function workedExamples(catalog?: SurfaceCatalog, count?: number): WorkedExample[];
|
|
246
288
|
/**
|
|
247
289
|
* The model-facing guide to composing surfaces for a catalog, as one Markdown string: the
|
|
248
|
-
* delivery, the intents, a node reference generated from the catalog
|
|
249
|
-
* examples written for the delivery `mode`
|
|
250
|
-
*
|
|
290
|
+
* delivery, the intents, a node reference generated from the catalog — what each node is, when to
|
|
291
|
+
* use it and when not to — the rules, and two worked examples written for the delivery `mode`
|
|
292
|
+
* picks. `rules` are the application's own lines, appended after the library's. `profile`
|
|
293
|
+
* narrows the catalog first. The guide only informs; validation and the application's policy
|
|
251
294
|
* enforce.
|
|
252
295
|
* @param {SurfaceCatalog} [catalog=CATALOG]
|
|
253
|
-
* @param {{mode?: 'tool'|'inline', rules?: string[]}} [options]
|
|
296
|
+
* @param {{mode?: 'tool'|'inline', rules?: string[], profile?: CatalogProfile}} [options]
|
|
254
297
|
* @returns {string}
|
|
255
|
-
* @throws {TypeError} For an unknown mode or a catalog that is not the library's.
|
|
298
|
+
* @throws {TypeError} For an unknown mode or profile, or a catalog that is not the library's.
|
|
256
299
|
*/
|
|
257
300
|
export declare function surfacePrompt(catalog?: SurfaceCatalog, options?: {
|
|
258
301
|
mode?: 'tool' | 'inline';
|
|
259
302
|
rules?: string[];
|
|
303
|
+
profile?: CatalogProfile;
|
|
260
304
|
}): string;
|
|
@@ -111,8 +111,10 @@ export type SurfaceOptions = {
|
|
|
111
111
|
*/
|
|
112
112
|
labelledBy?: string | null;
|
|
113
113
|
/**
|
|
114
|
-
* The engine that draws `chart` nodes
|
|
115
|
-
*
|
|
114
|
+
* The engine that draws `chart` nodes: a shared
|
|
115
|
+
* `SvgChartAdapter` by default, which needs no library; another adapter, such as a
|
|
116
|
+
* `ChartJsAdapter`, to draw with that engine; null to draw none, so that each chart shows its
|
|
117
|
+
* data table instead.
|
|
116
118
|
*/
|
|
117
119
|
chartAdapter?: ChartAdapter | null;
|
|
118
120
|
/**
|
|
@@ -462,8 +464,8 @@ export declare class Surface extends Component<SurfaceOptions> {
|
|
|
462
464
|
*/
|
|
463
465
|
private _link;
|
|
464
466
|
/**
|
|
465
|
-
* A chart; its data table is shown when there is no engine, and offered
|
|
466
|
-
* there is.
|
|
467
|
+
* A chart; its data table is shown when there is no engine (`chartAdapter: null`), and offered
|
|
468
|
+
* behind a toggle when there is.
|
|
467
469
|
* @private
|
|
468
470
|
* @param {NodeView} view @param {Record<string, any>} props
|
|
469
471
|
* @returns {NodeView}
|