@zeyos/zx 4.3.0 → 4.4.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 +266 -1
- package/README.md +7 -3
- package/dist/types/components/activity-item/activity-item.d.ts +351 -0
- package/dist/types/components/activity-list/activity-list.d.ts +195 -0
- package/dist/types/components/app-sidebar/app-sidebar.d.ts +28 -0
- package/dist/types/components/button/button.d.ts +8 -0
- package/dist/types/components/calendar/calendar-model.d.ts +22 -0
- package/dist/types/components/calendar/calendar.d.ts +19 -0
- package/dist/types/components/card/card.d.ts +7 -0
- package/dist/types/components/card-view/card-view.d.ts +12 -4
- package/dist/types/components/card-view/record-card.d.ts +53 -5
- package/dist/types/components/code-editor/code-editor.d.ts +160 -0
- package/dist/types/components/code-editor/field-adapter.d.ts +5 -0
- package/dist/types/components/context-menu/context-menu.d.ts +18 -2
- package/dist/types/components/date-picker/date-picker.d.ts +8 -0
- package/dist/types/components/date-picker/time-picker.d.ts +7 -0
- package/dist/types/components/dialog/dialog.d.ts +29 -0
- package/dist/types/components/entity-ref/entity-ref.d.ts +331 -0
- package/dist/types/components/file-item/file-item.d.ts +234 -0
- package/dist/types/components/file-list/file-list.d.ts +171 -0
- package/dist/types/components/filter/filter.d.ts +91 -36
- package/dist/types/components/filter-panel/filter-panel.d.ts +449 -0
- package/dist/types/components/kanban-view/kanban-card.d.ts +138 -0
- package/dist/types/components/kanban-view/kanban-policy.d.ts +268 -0
- package/dist/types/components/kanban-view/kanban-view.d.ts +837 -26
- package/dist/types/components/launcher/launcher.d.ts +19 -12
- package/dist/types/components/list-toolbar/list-toolbar.d.ts +599 -0
- package/dist/types/components/menu-button/menu-button.d.ts +4 -37
- package/dist/types/components/message/message.d.ts +7 -0
- package/dist/types/components/modal/modal.d.ts +48 -0
- package/dist/types/components/navigation-bar/navigation-bar.d.ts +105 -21
- package/dist/types/components/panel/panel.d.ts +7 -0
- package/dist/types/components/search/search.d.ts +7 -0
- package/dist/types/components/select/select.d.ts +4 -0
- package/dist/types/components/sort-control/sort-control.d.ts +105 -0
- package/dist/types/components/stat-tile/stat-tile.d.ts +277 -0
- package/dist/types/components/tabbox/tabbox.d.ts +7 -0
- package/dist/types/components/table/table.d.ts +144 -0
- package/dist/types/components/table-view/table-view.d.ts +11 -5
- package/dist/types/components/timebox/timebox.d.ts +7 -0
- package/dist/types/components/value-list/value-list.d.ts +8 -0
- package/dist/types/components/view/record-view.d.ts +96 -5
- package/dist/types/core/component.d.ts +6 -1
- package/dist/types/core/icons.d.ts +17 -0
- package/dist/types/index.d.ts +13 -1
- package/dist/types/internal/app-rail.d.ts +10 -0
- package/dist/types/internal/menu-items.d.ts +134 -0
- package/dist/zx-zeyos.esm.js +651 -88
- package/dist/zx-zeyos.esm.min.js +8 -1
- package/dist/zx.css +6266 -3900
- package/dist/zx.esm.js +8487 -1805
- package/dist/zx.esm.min.js +10 -3
- package/dist/zx.global.js +8487 -1805
- package/dist/zx.global.min.js +10 -3
- package/dist/zx.min.css +1 -1
- package/docs/api.json +1811 -247
- package/docs/llms.md +345 -40
- package/docs/llms.txt +11 -7
- package/package.json +1 -2
- package/src/components/activity-item/activity-item.css +137 -0
- package/src/components/activity-item/activity-item.js +599 -0
- package/src/components/activity-list/activity-list.css +64 -0
- package/src/components/activity-list/activity-list.js +375 -0
- package/src/components/app-rail/app-rail.css +227 -19
- package/src/components/app-sidebar/app-sidebar.css +414 -24
- package/src/components/app-sidebar/app-sidebar.js +65 -5
- package/src/components/button/button.css +8 -0
- package/src/components/button/button.js +6 -1
- package/src/components/calendar/calendar-model.js +45 -0
- package/src/components/calendar/calendar.css +30 -10
- package/src/components/calendar/calendar.js +41 -13
- package/src/components/card/card.js +12 -1
- package/src/components/card-view/card-view.css +212 -9
- package/src/components/card-view/card-view.js +32 -16
- package/src/components/card-view/record-card.js +98 -21
- package/src/components/code-editor/code-editor.css +67 -0
- package/src/components/code-editor/code-editor.js +288 -0
- package/src/components/code-editor/field-adapter.js +34 -0
- package/src/components/context-menu/context-menu.css +80 -3
- package/src/components/context-menu/context-menu.js +22 -30
- package/src/components/date-picker/date-picker.js +22 -8
- package/src/components/date-picker/month-picker.js +3 -3
- package/src/components/date-picker/time-picker.js +20 -8
- package/src/components/dialog/dialog.js +88 -66
- package/src/components/dropdown/dropdown.js +2 -2
- package/src/components/entity-ref/entity-ref.css +182 -0
- package/src/components/entity-ref/entity-ref.js +496 -0
- package/src/components/file-item/file-item.css +88 -0
- package/src/components/file-item/file-item.js +371 -0
- package/src/components/file-list/file-list.css +51 -0
- package/src/components/file-list/file-list.js +320 -0
- package/src/components/filter/filter.css +27 -1
- package/src/components/filter/filter.js +199 -45
- package/src/components/filter-panel/filter-panel.css +104 -0
- package/src/components/filter-panel/filter-panel.js +964 -0
- package/src/components/kanban-view/kanban-card.js +239 -0
- package/src/components/kanban-view/kanban-policy.js +412 -0
- package/src/components/kanban-view/kanban-view.css +674 -36
- package/src/components/kanban-view/kanban-view.js +1762 -240
- package/src/components/launcher/launcher.js +59 -27
- package/src/components/list-toolbar/list-toolbar.css +189 -0
- package/src/components/list-toolbar/list-toolbar.js +851 -0
- package/src/components/menu-button/menu-button.css +80 -3
- package/src/components/menu-button/menu-button.js +21 -37
- package/src/components/message/message.css +14 -12
- package/src/components/message/message.js +13 -2
- package/src/components/modal/modal.css +15 -0
- package/src/components/modal/modal.js +141 -0
- package/src/components/navigation-bar/navigation-bar.css +77 -2
- package/src/components/navigation-bar/navigation-bar.js +171 -4
- package/src/components/panel/panel.js +13 -2
- package/src/components/search/search.js +17 -5
- package/src/components/select/field-adapter.js +4 -1
- package/src/components/select/select.js +3 -0
- package/src/components/sort-control/sort-control.css +17 -0
- package/src/components/sort-control/sort-control.js +140 -0
- package/src/components/stat-tile/stat-tile.css +213 -0
- package/src/components/stat-tile/stat-tile.js +590 -0
- package/src/components/tabbox/tabbox.js +12 -1
- package/src/components/table/table.css +51 -2
- package/src/components/table/table.js +298 -19
- package/src/components/table-view/table-view.css +8 -2
- package/src/components/table-view/table-view.js +21 -6
- package/src/components/tag-picker/tag-picker.css +3 -1
- package/src/components/timebox/timebox.js +18 -5
- package/src/components/value-list/value-list.js +22 -6
- package/src/components/view/record-view.css +5 -0
- package/src/components/view/record-view.js +100 -7
- package/src/core/component.js +8 -3
- package/src/core/icons.js +74 -5
- package/src/index.js +33 -3
- package/src/internal/app-rail.js +19 -1
- package/src/internal/menu-items.js +142 -0
- package/styles/print.css +192 -0
- package/styles/zx.css +11 -0
- package/DESIGN-SYSTEM.md +0 -182
package/docs/api.json
CHANGED
|
@@ -106,6 +106,248 @@
|
|
|
106
106
|
}
|
|
107
107
|
]
|
|
108
108
|
},
|
|
109
|
+
"ActivityItem": {
|
|
110
|
+
"options": [
|
|
111
|
+
{
|
|
112
|
+
"name": "id",
|
|
113
|
+
"type": "unknown",
|
|
114
|
+
"default": "null",
|
|
115
|
+
"description": "Host-owned activity identifier."
|
|
116
|
+
},
|
|
117
|
+
{
|
|
118
|
+
"name": "actor",
|
|
119
|
+
"type": "ActivityContent",
|
|
120
|
+
"default": "''",
|
|
121
|
+
"description": "Actor identity text or presentation slot."
|
|
122
|
+
},
|
|
123
|
+
{
|
|
124
|
+
"name": "avatar",
|
|
125
|
+
"type": "ActivityAvatar",
|
|
126
|
+
"default": "null",
|
|
127
|
+
"description": "Avatar descriptor or host-owned avatar element."
|
|
128
|
+
},
|
|
129
|
+
{
|
|
130
|
+
"name": "title",
|
|
131
|
+
"type": "ActivityContent",
|
|
132
|
+
"default": "''",
|
|
133
|
+
"description": "Activity summary."
|
|
134
|
+
},
|
|
135
|
+
{
|
|
136
|
+
"name": "content",
|
|
137
|
+
"type": "ActivityContent",
|
|
138
|
+
"default": "null",
|
|
139
|
+
"description": "Optional body slot."
|
|
140
|
+
},
|
|
141
|
+
{
|
|
142
|
+
"name": "timestamp",
|
|
143
|
+
"type": "Date|string|number|null",
|
|
144
|
+
"default": "null",
|
|
145
|
+
"description": "Date, parseable date string, or epoch milliseconds."
|
|
146
|
+
},
|
|
147
|
+
{
|
|
148
|
+
"name": "timeLabel",
|
|
149
|
+
"type": "string|null",
|
|
150
|
+
"default": "null",
|
|
151
|
+
"description": "Explicit human-readable timestamp."
|
|
152
|
+
},
|
|
153
|
+
{
|
|
154
|
+
"name": "metadata",
|
|
155
|
+
"type": "ActivityContent[]",
|
|
156
|
+
"default": "[]",
|
|
157
|
+
"description": "Compact metadata slots."
|
|
158
|
+
},
|
|
159
|
+
{
|
|
160
|
+
"name": "attachments",
|
|
161
|
+
"type": "ActivityContent[]",
|
|
162
|
+
"default": "[]",
|
|
163
|
+
"description": "Attachment presentation slots, commonly FileItem elements."
|
|
164
|
+
},
|
|
165
|
+
{
|
|
166
|
+
"name": "actions",
|
|
167
|
+
"type": "ActivityActionSlot[]",
|
|
168
|
+
"default": "[]",
|
|
169
|
+
"description": "Native action descriptors or host-owned controls."
|
|
170
|
+
},
|
|
171
|
+
{
|
|
172
|
+
"name": "kind",
|
|
173
|
+
"type": "string",
|
|
174
|
+
"default": "'default'",
|
|
175
|
+
"description": "Product-neutral activity kind exposed as `data-kind`."
|
|
176
|
+
},
|
|
177
|
+
{
|
|
178
|
+
"name": "state",
|
|
179
|
+
"type": "ActivityState",
|
|
180
|
+
"default": "'default'",
|
|
181
|
+
"description": "Delivery state exposed as `data-state`."
|
|
182
|
+
},
|
|
183
|
+
{
|
|
184
|
+
"name": "stateLabel",
|
|
185
|
+
"type": "string|null",
|
|
186
|
+
"default": "null",
|
|
187
|
+
"description": "Word shown in the state badge instead of the built-in one."
|
|
188
|
+
},
|
|
189
|
+
{
|
|
190
|
+
"name": "headingLevel",
|
|
191
|
+
"type": "1|2|3|4|5|6",
|
|
192
|
+
"default": "3",
|
|
193
|
+
"description": "Semantic heading level for the activity summary."
|
|
194
|
+
}
|
|
195
|
+
],
|
|
196
|
+
"events": [
|
|
197
|
+
{
|
|
198
|
+
"name": "action",
|
|
199
|
+
"payload": "{id:string,action:NormalizedActivityAction,event:MouseEvent}",
|
|
200
|
+
"description": ""
|
|
201
|
+
}
|
|
202
|
+
],
|
|
203
|
+
"methods": [
|
|
204
|
+
{
|
|
205
|
+
"name": "setActivity",
|
|
206
|
+
"signature": "setActivity(values)",
|
|
207
|
+
"returns": "this",
|
|
208
|
+
"description": "Replaces any subset of the activity presentation."
|
|
209
|
+
},
|
|
210
|
+
{
|
|
211
|
+
"name": "getActivity",
|
|
212
|
+
"signature": "getActivity()",
|
|
213
|
+
"returns": "ActivityItemOptions",
|
|
214
|
+
"description": "Returns a shallow, host-safe copy of the current descriptor."
|
|
215
|
+
},
|
|
216
|
+
{
|
|
217
|
+
"name": "destroy",
|
|
218
|
+
"signature": "destroy()",
|
|
219
|
+
"returns": "void",
|
|
220
|
+
"description": "Restores an enhanced target exactly, or removes an owned item."
|
|
221
|
+
}
|
|
222
|
+
]
|
|
223
|
+
},
|
|
224
|
+
"ActivityList": {
|
|
225
|
+
"options": [
|
|
226
|
+
{
|
|
227
|
+
"name": "items",
|
|
228
|
+
"type": "ActivityItemOptions[]",
|
|
229
|
+
"default": "[]",
|
|
230
|
+
"description": "Initial activities in host-supplied chronological order."
|
|
231
|
+
},
|
|
232
|
+
{
|
|
233
|
+
"name": "groupBy",
|
|
234
|
+
"type": "ActivityGroupReader",
|
|
235
|
+
"default": "null",
|
|
236
|
+
"description": "Property or resolver used for stable grouping."
|
|
237
|
+
},
|
|
238
|
+
{
|
|
239
|
+
"name": "groupLabel",
|
|
240
|
+
"type": "ActivityGroupLabel|null",
|
|
241
|
+
"default": "null",
|
|
242
|
+
"description": "Group-heading renderer."
|
|
243
|
+
},
|
|
244
|
+
{
|
|
245
|
+
"name": "label",
|
|
246
|
+
"type": "string",
|
|
247
|
+
"default": "'Activity'",
|
|
248
|
+
"description": "Accessible collection name."
|
|
249
|
+
},
|
|
250
|
+
{
|
|
251
|
+
"name": "loading",
|
|
252
|
+
"type": "boolean",
|
|
253
|
+
"default": "false",
|
|
254
|
+
"description": "Whether initial or incremental activity is loading."
|
|
255
|
+
},
|
|
256
|
+
{
|
|
257
|
+
"name": "loadingCount",
|
|
258
|
+
"type": "number",
|
|
259
|
+
"default": "3",
|
|
260
|
+
"description": "Placeholder rows shown for an empty loading list."
|
|
261
|
+
},
|
|
262
|
+
{
|
|
263
|
+
"name": "loadingText",
|
|
264
|
+
"type": "string",
|
|
265
|
+
"default": "'Loading activity'",
|
|
266
|
+
"description": "Loading status text."
|
|
267
|
+
},
|
|
268
|
+
{
|
|
269
|
+
"name": "emptyText",
|
|
270
|
+
"type": "ActivityListContent",
|
|
271
|
+
"default": "'No activity yet'",
|
|
272
|
+
"description": "Empty-state content."
|
|
273
|
+
},
|
|
274
|
+
{
|
|
275
|
+
"name": "groupHeadingLevel",
|
|
276
|
+
"type": "1|2|3|4|5|6",
|
|
277
|
+
"default": "2",
|
|
278
|
+
"description": "Semantic group-heading level."
|
|
279
|
+
},
|
|
280
|
+
{
|
|
281
|
+
"name": "itemHeadingLevel",
|
|
282
|
+
"type": "1|2|3|4|5|6",
|
|
283
|
+
"default": "3",
|
|
284
|
+
"description": "Default item-heading level."
|
|
285
|
+
}
|
|
286
|
+
],
|
|
287
|
+
"events": [
|
|
288
|
+
{
|
|
289
|
+
"name": "datachange",
|
|
290
|
+
"payload": "{items:ActivityItemOptions[]}",
|
|
291
|
+
"description": ""
|
|
292
|
+
}
|
|
293
|
+
],
|
|
294
|
+
"methods": [
|
|
295
|
+
{
|
|
296
|
+
"name": "setItems",
|
|
297
|
+
"signature": "setItems(items, [options])",
|
|
298
|
+
"returns": "this",
|
|
299
|
+
"description": "Replaces all activities."
|
|
300
|
+
},
|
|
301
|
+
{
|
|
302
|
+
"name": "getItems",
|
|
303
|
+
"signature": "getItems()",
|
|
304
|
+
"returns": "ActivityItemOptions[]",
|
|
305
|
+
"description": "Returns shallow descriptor copies in current display order."
|
|
306
|
+
},
|
|
307
|
+
{
|
|
308
|
+
"name": "getItem",
|
|
309
|
+
"signature": "getItem(id)",
|
|
310
|
+
"returns": "ActivityItemOptions|null",
|
|
311
|
+
"description": "Returns a shallow descriptor copy by stable host ID."
|
|
312
|
+
},
|
|
313
|
+
{
|
|
314
|
+
"name": "appendItems",
|
|
315
|
+
"signature": "appendItems(items, [options])",
|
|
316
|
+
"returns": "this",
|
|
317
|
+
"description": "Adds activities after the current source order for older-page or forward-stream updates."
|
|
318
|
+
},
|
|
319
|
+
{
|
|
320
|
+
"name": "prependItems",
|
|
321
|
+
"signature": "prependItems(items, [options])",
|
|
322
|
+
"returns": "this",
|
|
323
|
+
"description": "Adds activities before the current source order for newest-first live updates."
|
|
324
|
+
},
|
|
325
|
+
{
|
|
326
|
+
"name": "updateItem",
|
|
327
|
+
"signature": "updateItem(id, values, [options])",
|
|
328
|
+
"returns": "this",
|
|
329
|
+
"description": "Patches the first activity whose ID is `Object.is`-equal to the requested ID."
|
|
330
|
+
},
|
|
331
|
+
{
|
|
332
|
+
"name": "removeItem",
|
|
333
|
+
"signature": "removeItem(id, [options])",
|
|
334
|
+
"returns": "this",
|
|
335
|
+
"description": "Removes the first activity whose ID is `Object.is`-equal to the requested ID."
|
|
336
|
+
},
|
|
337
|
+
{
|
|
338
|
+
"name": "setLoading",
|
|
339
|
+
"signature": "setLoading(loading)",
|
|
340
|
+
"returns": "this",
|
|
341
|
+
"description": "Sets initial/incremental loading presentation."
|
|
342
|
+
},
|
|
343
|
+
{
|
|
344
|
+
"name": "destroy",
|
|
345
|
+
"signature": "destroy()",
|
|
346
|
+
"returns": "void",
|
|
347
|
+
"description": "Restores an enhanced target exactly, or removes an owned list."
|
|
348
|
+
}
|
|
349
|
+
]
|
|
350
|
+
},
|
|
109
351
|
"Alert": {
|
|
110
352
|
"options": [
|
|
111
353
|
{
|
|
@@ -817,6 +1059,12 @@
|
|
|
817
1059
|
"type": "string",
|
|
818
1060
|
"default": null,
|
|
819
1061
|
"description": "Native title text."
|
|
1062
|
+
},
|
|
1063
|
+
{
|
|
1064
|
+
"name": "shortcut",
|
|
1065
|
+
"type": "ButtonShortcut",
|
|
1066
|
+
"default": null,
|
|
1067
|
+
"description": "Keyboard hint; does not register a keyboard handler."
|
|
820
1068
|
}
|
|
821
1069
|
],
|
|
822
1070
|
"events": [
|
|
@@ -1387,6 +1635,12 @@
|
|
|
1387
1635
|
"default": "false",
|
|
1388
1636
|
"description": "Record selection behavior."
|
|
1389
1637
|
},
|
|
1638
|
+
{
|
|
1639
|
+
"name": "selectionTrigger",
|
|
1640
|
+
"type": "'checkbox'|'card'",
|
|
1641
|
+
"default": "'checkbox'",
|
|
1642
|
+
"description": "Select through a checkbox or the non-interactive card surface."
|
|
1643
|
+
},
|
|
1390
1644
|
{
|
|
1391
1645
|
"name": "selection",
|
|
1392
1646
|
"type": "unknown[]",
|
|
@@ -1407,9 +1661,9 @@
|
|
|
1407
1661
|
},
|
|
1408
1662
|
{
|
|
1409
1663
|
"name": "fieldControls",
|
|
1410
|
-
"type": "boolean",
|
|
1664
|
+
"type": "boolean|import('../view/record-view.js').ViewFieldControlsConfig",
|
|
1411
1665
|
"default": "true",
|
|
1412
|
-
"description": "Whether to expose shared field controls."
|
|
1666
|
+
"description": "Whether to expose shared field controls. `true` renders the chooser in the card toolbar and `false` omits it; an object customises its `label` and mounts it into `target`."
|
|
1413
1667
|
},
|
|
1414
1668
|
{
|
|
1415
1669
|
"name": "emptyText",
|
|
@@ -1468,7 +1722,7 @@
|
|
|
1468
1722
|
{
|
|
1469
1723
|
"name": "minCardWidth",
|
|
1470
1724
|
"type": "number|string",
|
|
1471
|
-
"default": "'
|
|
1725
|
+
"default": "'15rem'",
|
|
1472
1726
|
"description": "Responsive minimum card width."
|
|
1473
1727
|
},
|
|
1474
1728
|
{
|
|
@@ -1901,6 +2155,102 @@
|
|
|
1901
2155
|
}
|
|
1902
2156
|
]
|
|
1903
2157
|
},
|
|
2158
|
+
"CodeEditor": {
|
|
2159
|
+
"options": [
|
|
2160
|
+
{
|
|
2161
|
+
"name": "value",
|
|
2162
|
+
"type": "unknown",
|
|
2163
|
+
"default": "''",
|
|
2164
|
+
"description": "Initial text."
|
|
2165
|
+
},
|
|
2166
|
+
{
|
|
2167
|
+
"name": "name",
|
|
2168
|
+
"type": "string",
|
|
2169
|
+
"default": "''",
|
|
2170
|
+
"description": "Form field name."
|
|
2171
|
+
},
|
|
2172
|
+
{
|
|
2173
|
+
"name": "language",
|
|
2174
|
+
"type": "string",
|
|
2175
|
+
"default": "'text'",
|
|
2176
|
+
"description": "Language identifier shown to the user and exposed as data."
|
|
2177
|
+
},
|
|
2178
|
+
{
|
|
2179
|
+
"name": "label",
|
|
2180
|
+
"type": "string",
|
|
2181
|
+
"default": "'Code editor'",
|
|
2182
|
+
"description": "Accessible editor label."
|
|
2183
|
+
},
|
|
2184
|
+
{
|
|
2185
|
+
"name": "placeholder",
|
|
2186
|
+
"type": "string",
|
|
2187
|
+
"default": "''",
|
|
2188
|
+
"description": "Placeholder text."
|
|
2189
|
+
},
|
|
2190
|
+
{
|
|
2191
|
+
"name": "rows",
|
|
2192
|
+
"type": "number",
|
|
2193
|
+
"default": "12",
|
|
2194
|
+
"description": "Visible textarea rows."
|
|
2195
|
+
},
|
|
2196
|
+
{
|
|
2197
|
+
"name": "indent",
|
|
2198
|
+
"type": "string",
|
|
2199
|
+
"default": "'\\t'",
|
|
2200
|
+
"description": "Text inserted by Tab and removed by Shift+Tab."
|
|
2201
|
+
},
|
|
2202
|
+
{
|
|
2203
|
+
"name": "wrap",
|
|
2204
|
+
"type": "'off'|'soft'|'hard'",
|
|
2205
|
+
"default": "'off'",
|
|
2206
|
+
"description": "Textarea wrapping behavior."
|
|
2207
|
+
},
|
|
2208
|
+
{
|
|
2209
|
+
"name": "spellcheck",
|
|
2210
|
+
"type": "boolean",
|
|
2211
|
+
"default": "false",
|
|
2212
|
+
"description": "Whether browser spellcheck is enabled."
|
|
2213
|
+
},
|
|
2214
|
+
{
|
|
2215
|
+
"name": "readOnly",
|
|
2216
|
+
"type": "boolean",
|
|
2217
|
+
"default": "false",
|
|
2218
|
+
"description": "Whether content can be selected but not changed."
|
|
2219
|
+
},
|
|
2220
|
+
{
|
|
2221
|
+
"name": "disabled",
|
|
2222
|
+
"type": "boolean",
|
|
2223
|
+
"default": "false",
|
|
2224
|
+
"description": "Whether the editor is disabled."
|
|
2225
|
+
},
|
|
2226
|
+
{
|
|
2227
|
+
"name": "status",
|
|
2228
|
+
"type": "boolean",
|
|
2229
|
+
"default": "true",
|
|
2230
|
+
"description": "Whether the line/column status is visible."
|
|
2231
|
+
}
|
|
2232
|
+
],
|
|
2233
|
+
"events": [
|
|
2234
|
+
{
|
|
2235
|
+
"name": "input",
|
|
2236
|
+
"payload": "{value:string}",
|
|
2237
|
+
"description": "Input listener."
|
|
2238
|
+
},
|
|
2239
|
+
{
|
|
2240
|
+
"name": "change",
|
|
2241
|
+
"payload": "{value:string}",
|
|
2242
|
+
"description": "Change listener."
|
|
2243
|
+
}
|
|
2244
|
+
],
|
|
2245
|
+
"methods": [
|
|
2246
|
+
{
|
|
2247
|
+
"name": "setValue",
|
|
2248
|
+
"signature": "setValue(value, [options])",
|
|
2249
|
+
"returns": "this",
|
|
2250
|
+
"description": "Replaces the editor text."
|
|
2251
|
+
}
|
|
2252
|
+
]
|
|
2253
|
+
},
|
|
1904
2254
|
"Confirm": {
|
|
1905
2255
|
"options": [
|
|
1906
2256
|
{
|
|
@@ -3195,29 +3545,149 @@
|
|
|
3195
3545
|
"events": [],
|
|
3196
3546
|
"methods": []
|
|
3197
3547
|
},
|
|
3198
|
-
"
|
|
3548
|
+
"EntityRef": {
|
|
3199
3549
|
"options": [
|
|
3200
3550
|
{
|
|
3201
|
-
"name": "
|
|
3202
|
-
"type": "
|
|
3203
|
-
"default": "
|
|
3204
|
-
"description": "
|
|
3551
|
+
"name": "id",
|
|
3552
|
+
"type": "unknown",
|
|
3553
|
+
"default": "null",
|
|
3554
|
+
"description": "Application-owned entity identifier included in events."
|
|
3205
3555
|
},
|
|
3206
3556
|
{
|
|
3207
|
-
"name": "
|
|
3557
|
+
"name": "title",
|
|
3208
3558
|
"type": "string",
|
|
3209
|
-
"default": "'
|
|
3210
|
-
"description": "
|
|
3559
|
+
"default": "''",
|
|
3560
|
+
"description": "Primary identity text."
|
|
3211
3561
|
},
|
|
3212
3562
|
{
|
|
3213
|
-
"name": "
|
|
3214
|
-
"type": "
|
|
3215
|
-
"default": "
|
|
3216
|
-
"description": "
|
|
3563
|
+
"name": "subtitle",
|
|
3564
|
+
"type": "EntityRefContent",
|
|
3565
|
+
"default": "null",
|
|
3566
|
+
"description": "Secondary identity text or safe caller-supplied content."
|
|
3217
3567
|
},
|
|
3218
3568
|
{
|
|
3219
|
-
"name": "
|
|
3220
|
-
"type": "
|
|
3569
|
+
"name": "icon",
|
|
3570
|
+
"type": "EntityRefIcon",
|
|
3571
|
+
"default": "null",
|
|
3572
|
+
"description": "Icon name, node, component, or lazy renderer."
|
|
3573
|
+
},
|
|
3574
|
+
{
|
|
3575
|
+
"name": "metadata",
|
|
3576
|
+
"type": "EntityRefMetadata[]",
|
|
3577
|
+
"default": "[]",
|
|
3578
|
+
"description": "Labelled dense metadata."
|
|
3579
|
+
},
|
|
3580
|
+
{
|
|
3581
|
+
"name": "link",
|
|
3582
|
+
"type": "EntityRefLinkValue",
|
|
3583
|
+
"default": "null",
|
|
3584
|
+
"description": "Optional native primary link."
|
|
3585
|
+
},
|
|
3586
|
+
{
|
|
3587
|
+
"name": "actions",
|
|
3588
|
+
"type": "EntityRefActionEntry[]",
|
|
3589
|
+
"default": "[]",
|
|
3590
|
+
"description": "Secondary controls; element actions keep their own behavior."
|
|
3591
|
+
},
|
|
3592
|
+
{
|
|
3593
|
+
"name": "size",
|
|
3594
|
+
"type": "'sm'|'md'|'lg'",
|
|
3595
|
+
"default": "'md'",
|
|
3596
|
+
"description": "Density-independent identity size."
|
|
3597
|
+
},
|
|
3598
|
+
{
|
|
3599
|
+
"name": "wrap",
|
|
3600
|
+
"type": "boolean",
|
|
3601
|
+
"default": "false",
|
|
3602
|
+
"description": "Whether long identity text may wrap instead of truncating."
|
|
3603
|
+
},
|
|
3604
|
+
{
|
|
3605
|
+
"name": "actionsLabel",
|
|
3606
|
+
"type": "string",
|
|
3607
|
+
"default": "'Entity actions'",
|
|
3608
|
+
"description": "Accessible name for secondary actions."
|
|
3609
|
+
}
|
|
3610
|
+
],
|
|
3611
|
+
"events": [
|
|
3612
|
+
{
|
|
3613
|
+
"name": "activate",
|
|
3614
|
+
"payload": "{id: unknown, entity: Readonly<EntityRefState>, href: string, event: MouseEvent}",
|
|
3615
|
+
"description": "Preventable primary-link listener."
|
|
3616
|
+
},
|
|
3617
|
+
{
|
|
3618
|
+
"name": "action",
|
|
3619
|
+
"payload": "{id: string, action: Readonly<EntityRefAction>, entity: Readonly<EntityRefState>, event: MouseEvent}",
|
|
3620
|
+
"description": "Preventable delegated-action listener."
|
|
3621
|
+
}
|
|
3622
|
+
],
|
|
3623
|
+
"methods": [
|
|
3624
|
+
{
|
|
3625
|
+
"name": "set",
|
|
3626
|
+
"signature": "set(values)",
|
|
3627
|
+
"returns": "this",
|
|
3628
|
+
"description": "Updates any subset of the identity without replacing the root."
|
|
3629
|
+
},
|
|
3630
|
+
{
|
|
3631
|
+
"name": "setMetadata",
|
|
3632
|
+
"signature": "setMetadata(metadata)",
|
|
3633
|
+
"returns": "this",
|
|
3634
|
+
"description": "Replaces the metadata collection."
|
|
3635
|
+
},
|
|
3636
|
+
{
|
|
3637
|
+
"name": "setActions",
|
|
3638
|
+
"signature": "setActions(actions)",
|
|
3639
|
+
"returns": "this",
|
|
3640
|
+
"description": "Replaces the secondary action controls."
|
|
3641
|
+
},
|
|
3642
|
+
{
|
|
3643
|
+
"name": "setLink",
|
|
3644
|
+
"signature": "setLink(link)",
|
|
3645
|
+
"returns": "this",
|
|
3646
|
+
"description": "Sets or clears the primary link."
|
|
3647
|
+
},
|
|
3648
|
+
{
|
|
3649
|
+
"name": "getEntity",
|
|
3650
|
+
"signature": "getEntity()",
|
|
3651
|
+
"returns": "Readonly<EntityRefState>",
|
|
3652
|
+
"description": "Returns a defensive presentation snapshot. Caller-supplied Nodes and Components retain their identity; arrays and descriptors are copied."
|
|
3653
|
+
},
|
|
3654
|
+
{
|
|
3655
|
+
"name": "focus",
|
|
3656
|
+
"signature": "focus()",
|
|
3657
|
+
"returns": "this",
|
|
3658
|
+
"description": "Focuses the primary link or the first enabled action."
|
|
3659
|
+
},
|
|
3660
|
+
{
|
|
3661
|
+
"name": "destroy",
|
|
3662
|
+
"signature": "destroy()",
|
|
3663
|
+
"returns": "void",
|
|
3664
|
+
"description": "Restores an enhanced target exactly, or removes an owned reference."
|
|
3665
|
+
}
|
|
3666
|
+
]
|
|
3667
|
+
},
|
|
3668
|
+
"EntitySelect": {
|
|
3669
|
+
"options": [
|
|
3670
|
+
{
|
|
3671
|
+
"name": "recent",
|
|
3672
|
+
"type": "SelectItem[]",
|
|
3673
|
+
"default": "[]",
|
|
3674
|
+
"description": "Choices pinned above ordinary results."
|
|
3675
|
+
},
|
|
3676
|
+
{
|
|
3677
|
+
"name": "recentLabel",
|
|
3678
|
+
"type": "string",
|
|
3679
|
+
"default": "'Recent'",
|
|
3680
|
+
"description": "Heading above recent choices."
|
|
3681
|
+
},
|
|
3682
|
+
{
|
|
3683
|
+
"name": "create",
|
|
3684
|
+
"type": "boolean|SelectAction",
|
|
3685
|
+
"default": "false",
|
|
3686
|
+
"description": "Optional create command at the bottom."
|
|
3687
|
+
},
|
|
3688
|
+
{
|
|
3689
|
+
"name": "iconKey",
|
|
3690
|
+
"type": "string|((item: SelectItem)=>unknown)",
|
|
3221
3691
|
"default": "'icon'",
|
|
3222
3692
|
"description": "Item icon reader."
|
|
3223
3693
|
},
|
|
@@ -3619,177 +4089,566 @@
|
|
|
3619
4089
|
}
|
|
3620
4090
|
]
|
|
3621
4091
|
},
|
|
3622
|
-
"
|
|
4092
|
+
"FileItem": {
|
|
3623
4093
|
"options": [
|
|
3624
4094
|
{
|
|
3625
|
-
"name": "
|
|
3626
|
-
"type": "
|
|
3627
|
-
"default": null,
|
|
3628
|
-
"description": "
|
|
4095
|
+
"name": "id",
|
|
4096
|
+
"type": "unknown",
|
|
4097
|
+
"default": "null",
|
|
4098
|
+
"description": "Application-owned file identifier included in events."
|
|
3629
4099
|
},
|
|
3630
4100
|
{
|
|
3631
|
-
"name": "
|
|
3632
|
-
"type": "
|
|
3633
|
-
"default":
|
|
3634
|
-
"description": "
|
|
4101
|
+
"name": "name",
|
|
4102
|
+
"type": "string",
|
|
4103
|
+
"default": "''",
|
|
4104
|
+
"description": "File name."
|
|
3635
4105
|
},
|
|
3636
4106
|
{
|
|
3637
|
-
"name": "
|
|
3638
|
-
"type": "
|
|
3639
|
-
"default": null,
|
|
3640
|
-
"description": "
|
|
4107
|
+
"name": "size",
|
|
4108
|
+
"type": "number|string|null",
|
|
4109
|
+
"default": "null",
|
|
4110
|
+
"description": "Byte count; invalid and negative values are omitted."
|
|
3641
4111
|
},
|
|
3642
4112
|
{
|
|
3643
|
-
"name": "
|
|
3644
|
-
"type": "
|
|
3645
|
-
"default": "
|
|
3646
|
-
"description": "
|
|
4113
|
+
"name": "mime",
|
|
4114
|
+
"type": "string",
|
|
4115
|
+
"default": "''",
|
|
4116
|
+
"description": "MIME type."
|
|
3647
4117
|
},
|
|
3648
4118
|
{
|
|
3649
|
-
"name": "
|
|
3650
|
-
"type": "
|
|
3651
|
-
"default": "
|
|
3652
|
-
"description": "
|
|
4119
|
+
"name": "subtitle",
|
|
4120
|
+
"type": "EntityRefContent",
|
|
4121
|
+
"default": "null",
|
|
4122
|
+
"description": "Optional supporting text before generated metadata."
|
|
3653
4123
|
},
|
|
3654
4124
|
{
|
|
3655
|
-
"name": "
|
|
3656
|
-
"type": "
|
|
3657
|
-
"default": "
|
|
3658
|
-
"description": "
|
|
4125
|
+
"name": "icon",
|
|
4126
|
+
"type": "EntityRefIcon",
|
|
4127
|
+
"default": "'file'",
|
|
4128
|
+
"description": "File icon name, node, component, or lazy renderer."
|
|
3659
4129
|
},
|
|
3660
4130
|
{
|
|
3661
|
-
"name": "
|
|
3662
|
-
"type": "
|
|
3663
|
-
"default": "
|
|
3664
|
-
"description": "
|
|
4131
|
+
"name": "metadata",
|
|
4132
|
+
"type": "EntityRefMetadata[]",
|
|
4133
|
+
"default": "[]",
|
|
4134
|
+
"description": "Additional labelled metadata."
|
|
3665
4135
|
},
|
|
3666
4136
|
{
|
|
3667
|
-
"name": "
|
|
3668
|
-
"type": "
|
|
3669
|
-
"default": "
|
|
3670
|
-
"description": "
|
|
4137
|
+
"name": "link",
|
|
4138
|
+
"type": "EntityRefLinkValue",
|
|
4139
|
+
"default": "null",
|
|
4140
|
+
"description": "Optional safe native file/download link."
|
|
3671
4141
|
},
|
|
3672
4142
|
{
|
|
3673
|
-
"name": "
|
|
3674
|
-
"type": "
|
|
3675
|
-
"default": "
|
|
3676
|
-
"description": "
|
|
4143
|
+
"name": "actions",
|
|
4144
|
+
"type": "EntityRefActionEntry[]",
|
|
4145
|
+
"default": "[]",
|
|
4146
|
+
"description": "File actions; application policy stays external."
|
|
3677
4147
|
},
|
|
3678
4148
|
{
|
|
3679
|
-
"name": "
|
|
3680
|
-
"type": "
|
|
3681
|
-
"default": "'
|
|
3682
|
-
"description": "
|
|
4149
|
+
"name": "status",
|
|
4150
|
+
"type": "FileStatus",
|
|
4151
|
+
"default": "'ready'",
|
|
4152
|
+
"description": "Durable or transient presentation state."
|
|
3683
4153
|
},
|
|
3684
4154
|
{
|
|
3685
|
-
"name": "
|
|
3686
|
-
"type": "string",
|
|
3687
|
-
"default": "
|
|
3688
|
-
"description": "
|
|
3689
|
-
}
|
|
3690
|
-
],
|
|
3691
|
-
"events": [
|
|
4155
|
+
"name": "statusLabel",
|
|
4156
|
+
"type": "string|null",
|
|
4157
|
+
"default": "null",
|
|
4158
|
+
"description": "Overrides the generated state label; an empty string hides it."
|
|
4159
|
+
},
|
|
3692
4160
|
{
|
|
3693
|
-
"name": "
|
|
3694
|
-
"
|
|
3695
|
-
"
|
|
4161
|
+
"name": "progress",
|
|
4162
|
+
"type": "number|null",
|
|
4163
|
+
"default": "null",
|
|
4164
|
+
"description": "Completed percentage, clamped to 0–100."
|
|
3696
4165
|
},
|
|
3697
4166
|
{
|
|
3698
|
-
"name": "
|
|
3699
|
-
"
|
|
3700
|
-
"
|
|
4167
|
+
"name": "indeterminate",
|
|
4168
|
+
"type": "boolean",
|
|
4169
|
+
"default": "false",
|
|
4170
|
+
"description": "Whether active progress has no known amount."
|
|
3701
4171
|
},
|
|
3702
4172
|
{
|
|
3703
|
-
"name": "
|
|
3704
|
-
"
|
|
3705
|
-
"
|
|
4173
|
+
"name": "density",
|
|
4174
|
+
"type": "'sm'|'md'|'lg'",
|
|
4175
|
+
"default": "'md'",
|
|
4176
|
+
"description": "File-identity presentation size."
|
|
3706
4177
|
},
|
|
3707
4178
|
{
|
|
3708
|
-
"name": "
|
|
3709
|
-
"
|
|
3710
|
-
"
|
|
4179
|
+
"name": "wrap",
|
|
4180
|
+
"type": "boolean",
|
|
4181
|
+
"default": "false",
|
|
4182
|
+
"description": "Whether long identity text may wrap."
|
|
3711
4183
|
},
|
|
3712
4184
|
{
|
|
3713
|
-
"name": "
|
|
3714
|
-
"
|
|
3715
|
-
"
|
|
4185
|
+
"name": "actionsLabel",
|
|
4186
|
+
"type": "string",
|
|
4187
|
+
"default": "'File actions'",
|
|
4188
|
+
"description": "Accessible name for secondary actions."
|
|
3716
4189
|
},
|
|
3717
4190
|
{
|
|
3718
|
-
"name": "
|
|
3719
|
-
"
|
|
3720
|
-
"
|
|
4191
|
+
"name": "locale",
|
|
4192
|
+
"type": "string",
|
|
4193
|
+
"default": null,
|
|
4194
|
+
"description": "Locale passed to `formatFileSize`."
|
|
3721
4195
|
}
|
|
3722
4196
|
],
|
|
3723
|
-
"
|
|
3724
|
-
{
|
|
3725
|
-
"name": "getValue",
|
|
3726
|
-
"signature": "getValue()",
|
|
3727
|
-
"returns": "FilterAst",
|
|
3728
|
-
"description": "Returns a defensive AST copy."
|
|
3729
|
-
},
|
|
3730
|
-
{
|
|
3731
|
-
"name": "setValue",
|
|
3732
|
-
"signature": "setValue(value, [options])",
|
|
3733
|
-
"returns": "this",
|
|
3734
|
-
"description": "Atomically replaces the AST."
|
|
3735
|
-
},
|
|
4197
|
+
"events": [
|
|
3736
4198
|
{
|
|
3737
|
-
"name": "
|
|
3738
|
-
"
|
|
3739
|
-
"
|
|
3740
|
-
"description": "Adds a condition to a group."
|
|
4199
|
+
"name": "activate",
|
|
4200
|
+
"payload": "{id: unknown, file: Readonly<FileItemState>, href: string, event: MouseEvent}",
|
|
4201
|
+
"description": "Preventable native-link listener."
|
|
3741
4202
|
},
|
|
3742
4203
|
{
|
|
3743
|
-
"name": "
|
|
3744
|
-
"
|
|
3745
|
-
"
|
|
3746
|
-
|
|
3747
|
-
|
|
4204
|
+
"name": "action",
|
|
4205
|
+
"payload": "{id: string, fileId: unknown, action: object, file: Readonly<FileItemState>, event: MouseEvent}",
|
|
4206
|
+
"description": "Preventable file-action listener."
|
|
4207
|
+
}
|
|
4208
|
+
],
|
|
4209
|
+
"methods": [
|
|
3748
4210
|
{
|
|
3749
|
-
"name": "
|
|
3750
|
-
"signature": "
|
|
4211
|
+
"name": "set",
|
|
4212
|
+
"signature": "set(values)",
|
|
3751
4213
|
"returns": "this",
|
|
3752
|
-
"description": "Updates
|
|
4214
|
+
"description": "Updates any subset of the file without replacing the row root."
|
|
3753
4215
|
},
|
|
3754
4216
|
{
|
|
3755
|
-
"name": "
|
|
3756
|
-
"signature": "
|
|
4217
|
+
"name": "setStatus",
|
|
4218
|
+
"signature": "setStatus(status, [statusLabel])",
|
|
3757
4219
|
"returns": "this",
|
|
3758
|
-
"description": "
|
|
4220
|
+
"description": "Updates the file lifecycle state and, optionally, its visible label."
|
|
3759
4221
|
},
|
|
3760
4222
|
{
|
|
3761
|
-
"name": "
|
|
3762
|
-
"signature": "
|
|
4223
|
+
"name": "setProgress",
|
|
4224
|
+
"signature": "setProgress(progress, [options])",
|
|
3763
4225
|
"returns": "this",
|
|
3764
|
-
"description": "
|
|
3765
|
-
},
|
|
3766
|
-
{
|
|
3767
|
-
"name": "validate",
|
|
3768
|
-
"signature": "validate()",
|
|
3769
|
-
"returns": "{valid:boolean,errors:Array<Record<string,string>>}",
|
|
3770
|
-
"description": "Returns semantic validity and errors."
|
|
4226
|
+
"description": "Updates the progress meter."
|
|
3771
4227
|
},
|
|
3772
4228
|
{
|
|
3773
|
-
"name": "
|
|
3774
|
-
"signature": "
|
|
3775
|
-
"returns": "
|
|
3776
|
-
"description": "
|
|
4229
|
+
"name": "getFile",
|
|
4230
|
+
"signature": "getFile()",
|
|
4231
|
+
"returns": "Readonly<FileItemState>",
|
|
4232
|
+
"description": "Returns a defensive file snapshot."
|
|
3777
4233
|
},
|
|
3778
4234
|
{
|
|
3779
|
-
"name": "
|
|
3780
|
-
"signature": "
|
|
4235
|
+
"name": "focus",
|
|
4236
|
+
"signature": "focus()",
|
|
3781
4237
|
"returns": "this",
|
|
3782
|
-
"description": "
|
|
4238
|
+
"description": "Focuses the native destination or first enabled action."
|
|
3783
4239
|
},
|
|
3784
4240
|
{
|
|
3785
|
-
"name": "
|
|
3786
|
-
"signature": "
|
|
3787
|
-
"returns": "
|
|
3788
|
-
"description": "
|
|
4241
|
+
"name": "destroy",
|
|
4242
|
+
"signature": "destroy()",
|
|
4243
|
+
"returns": "void",
|
|
4244
|
+
"description": "Restores an enhanced target exactly, or removes an owned row."
|
|
3789
4245
|
}
|
|
3790
4246
|
]
|
|
3791
4247
|
},
|
|
3792
|
-
"
|
|
4248
|
+
"FileList": {
|
|
4249
|
+
"options": [
|
|
4250
|
+
{
|
|
4251
|
+
"name": "items",
|
|
4252
|
+
"type": "FileItemOptions[]",
|
|
4253
|
+
"default": "[]",
|
|
4254
|
+
"description": "Initial files in host-supplied order."
|
|
4255
|
+
},
|
|
4256
|
+
{
|
|
4257
|
+
"name": "label",
|
|
4258
|
+
"type": "string",
|
|
4259
|
+
"default": "'Files'",
|
|
4260
|
+
"description": "Accessible collection name."
|
|
4261
|
+
},
|
|
4262
|
+
{
|
|
4263
|
+
"name": "loading",
|
|
4264
|
+
"type": "boolean",
|
|
4265
|
+
"default": "false",
|
|
4266
|
+
"description": "Whether initial or incremental files are loading."
|
|
4267
|
+
},
|
|
4268
|
+
{
|
|
4269
|
+
"name": "loadingCount",
|
|
4270
|
+
"type": "number",
|
|
4271
|
+
"default": "3",
|
|
4272
|
+
"description": "Placeholder rows shown for an empty loading list."
|
|
4273
|
+
},
|
|
4274
|
+
{
|
|
4275
|
+
"name": "loadingText",
|
|
4276
|
+
"type": "string",
|
|
4277
|
+
"default": "'Loading files'",
|
|
4278
|
+
"description": "Loading status text."
|
|
4279
|
+
},
|
|
4280
|
+
{
|
|
4281
|
+
"name": "emptyText",
|
|
4282
|
+
"type": "string|number|Node|Component|null",
|
|
4283
|
+
"default": "'No files'",
|
|
4284
|
+
"description": "Empty-state content."
|
|
4285
|
+
}
|
|
4286
|
+
],
|
|
4287
|
+
"events": [
|
|
4288
|
+
{
|
|
4289
|
+
"name": "activate",
|
|
4290
|
+
"payload": "{id: unknown, index: number, file: Readonly<FileItemState>, href: string, event: MouseEvent}",
|
|
4291
|
+
"description": "Preventable native-file-link listener."
|
|
4292
|
+
},
|
|
4293
|
+
{
|
|
4294
|
+
"name": "action",
|
|
4295
|
+
"payload": "{id: string, fileId: unknown, index: number, action: object, file: Readonly<FileItemState>, event: MouseEvent}",
|
|
4296
|
+
"description": "Preventable file-action listener."
|
|
4297
|
+
},
|
|
4298
|
+
{
|
|
4299
|
+
"name": "datachange",
|
|
4300
|
+
"payload": "{items: Readonly<FileItemState>[]}",
|
|
4301
|
+
"description": "Collection mutation listener."
|
|
4302
|
+
}
|
|
4303
|
+
],
|
|
4304
|
+
"methods": [
|
|
4305
|
+
{
|
|
4306
|
+
"name": "setItems",
|
|
4307
|
+
"signature": "setItems(items, [options])",
|
|
4308
|
+
"returns": "this",
|
|
4309
|
+
"description": "Replaces every file."
|
|
4310
|
+
},
|
|
4311
|
+
{
|
|
4312
|
+
"name": "getItems",
|
|
4313
|
+
"signature": "getItems()",
|
|
4314
|
+
"returns": "Readonly<FileItemState>[]",
|
|
4315
|
+
"description": "Returns defensive snapshots in display order."
|
|
4316
|
+
},
|
|
4317
|
+
{
|
|
4318
|
+
"name": "getItem",
|
|
4319
|
+
"signature": "getItem(id)",
|
|
4320
|
+
"returns": "Readonly<FileItemState>|null",
|
|
4321
|
+
"description": "Returns a defensive snapshot by stable ID."
|
|
4322
|
+
},
|
|
4323
|
+
{
|
|
4324
|
+
"name": "addItem",
|
|
4325
|
+
"signature": "addItem(item, [index], [options])",
|
|
4326
|
+
"returns": "this",
|
|
4327
|
+
"description": "Adds one file at a bounded index."
|
|
4328
|
+
},
|
|
4329
|
+
{
|
|
4330
|
+
"name": "updateItem",
|
|
4331
|
+
"signature": "updateItem(id, values, [options])",
|
|
4332
|
+
"returns": "this",
|
|
4333
|
+
"description": "Patches the first file whose ID is `Object.is`-equal to `id`."
|
|
4334
|
+
},
|
|
4335
|
+
{
|
|
4336
|
+
"name": "removeItem",
|
|
4337
|
+
"signature": "removeItem(id, [options])",
|
|
4338
|
+
"returns": "this",
|
|
4339
|
+
"description": "Removes the first file whose ID is `Object.is`-equal to `id`."
|
|
4340
|
+
},
|
|
4341
|
+
{
|
|
4342
|
+
"name": "setLoading",
|
|
4343
|
+
"signature": "setLoading(loading)",
|
|
4344
|
+
"returns": "this",
|
|
4345
|
+
"description": "Sets initial/incremental loading presentation."
|
|
4346
|
+
},
|
|
4347
|
+
{
|
|
4348
|
+
"name": "destroy",
|
|
4349
|
+
"signature": "destroy()",
|
|
4350
|
+
"returns": "void",
|
|
4351
|
+
"description": "Restores an enhanced target exactly, or removes an owned collection."
|
|
4352
|
+
}
|
|
4353
|
+
]
|
|
4354
|
+
},
|
|
4355
|
+
"Filter": {
|
|
4356
|
+
"options": [
|
|
4357
|
+
{
|
|
4358
|
+
"name": "fields",
|
|
4359
|
+
"type": "FilterField[]",
|
|
4360
|
+
"default": null,
|
|
4361
|
+
"description": "Field definitions."
|
|
4362
|
+
},
|
|
4363
|
+
{
|
|
4364
|
+
"name": "value",
|
|
4365
|
+
"type": "FilterAst",
|
|
4366
|
+
"default": null,
|
|
4367
|
+
"description": "Initial expression."
|
|
4368
|
+
},
|
|
4369
|
+
{
|
|
4370
|
+
"name": "operators",
|
|
4371
|
+
"type": "Array<{id:string,label:string,arity:'none'|'single'|'pair'|'many',types:string[]}>",
|
|
4372
|
+
"default": null,
|
|
4373
|
+
"description": "Additional/overridden operators."
|
|
4374
|
+
},
|
|
4375
|
+
{
|
|
4376
|
+
"name": "allowGroups",
|
|
4377
|
+
"type": "boolean",
|
|
4378
|
+
"default": "true",
|
|
4379
|
+
"description": "Whether nested groups may be authored."
|
|
4380
|
+
},
|
|
4381
|
+
{
|
|
4382
|
+
"name": "maxDepth",
|
|
4383
|
+
"type": "number",
|
|
4384
|
+
"default": "3",
|
|
4385
|
+
"description": "Maximum nested group depth."
|
|
4386
|
+
},
|
|
4387
|
+
{
|
|
4388
|
+
"name": "maxConditions",
|
|
4389
|
+
"type": "number",
|
|
4390
|
+
"default": "50",
|
|
4391
|
+
"description": "Maximum condition count."
|
|
4392
|
+
},
|
|
4393
|
+
{
|
|
4394
|
+
"name": "searchable",
|
|
4395
|
+
"type": "boolean",
|
|
4396
|
+
"default": "false",
|
|
4397
|
+
"description": "Searchable field, operator and single-choice controls."
|
|
4398
|
+
},
|
|
4399
|
+
{
|
|
4400
|
+
"name": "layout",
|
|
4401
|
+
"type": "'standard'|'compact'",
|
|
4402
|
+
"default": "'standard'",
|
|
4403
|
+
"description": "Condition layout; compact rows adapt to container width."
|
|
4404
|
+
},
|
|
4405
|
+
{
|
|
4406
|
+
"name": "rootLogic",
|
|
4407
|
+
"type": "'and'|'or'|null",
|
|
4408
|
+
"default": "null",
|
|
4409
|
+
"description": "Restrict root logic without rewriting incompatible saved expressions."
|
|
4410
|
+
},
|
|
4411
|
+
{
|
|
4412
|
+
"name": "showApply",
|
|
4413
|
+
"type": "boolean",
|
|
4414
|
+
"default": "true",
|
|
4415
|
+
"description": "Show the internal Apply button."
|
|
4416
|
+
},
|
|
4417
|
+
{
|
|
4418
|
+
"name": "showRootActions",
|
|
4419
|
+
"type": "boolean",
|
|
4420
|
+
"default": "true",
|
|
4421
|
+
"description": "Show Add controls inside the root group as well as the footer."
|
|
4422
|
+
},
|
|
4423
|
+
{
|
|
4424
|
+
"name": "autoApply",
|
|
4425
|
+
"type": "boolean",
|
|
4426
|
+
"default": "false",
|
|
4427
|
+
"description": "Emit apply after every valid mutation."
|
|
4428
|
+
},
|
|
4429
|
+
{
|
|
4430
|
+
"name": "readonly",
|
|
4431
|
+
"type": "boolean",
|
|
4432
|
+
"default": "false",
|
|
4433
|
+
"description": "Prevent mutations while keeping values readable."
|
|
4434
|
+
},
|
|
4435
|
+
{
|
|
4436
|
+
"name": "disabled",
|
|
4437
|
+
"type": "boolean",
|
|
4438
|
+
"default": "false",
|
|
4439
|
+
"description": "Disable all controls."
|
|
4440
|
+
},
|
|
4441
|
+
{
|
|
4442
|
+
"name": "applyLabel",
|
|
4443
|
+
"type": "string",
|
|
4444
|
+
"default": null,
|
|
4445
|
+
"description": "Apply button label. Omitted resolves `filter.apply`, English `Apply filters`."
|
|
4446
|
+
},
|
|
4447
|
+
{
|
|
4448
|
+
"name": "clearLabel",
|
|
4449
|
+
"type": "string",
|
|
4450
|
+
"default": null,
|
|
4451
|
+
"description": "Clear button label. Omitted resolves `filter.clear`, English `Clear`."
|
|
4452
|
+
}
|
|
4453
|
+
],
|
|
4454
|
+
"events": [
|
|
4455
|
+
{
|
|
4456
|
+
"name": "change",
|
|
4457
|
+
"payload": "Record<string,unknown>",
|
|
4458
|
+
"description": "Draft-change listener."
|
|
4459
|
+
},
|
|
4460
|
+
{
|
|
4461
|
+
"name": "apply",
|
|
4462
|
+
"payload": "Record<string,unknown>",
|
|
4463
|
+
"description": "Valid-apply listener."
|
|
4464
|
+
},
|
|
4465
|
+
{
|
|
4466
|
+
"name": "invalid",
|
|
4467
|
+
"payload": "Record<string,unknown>",
|
|
4468
|
+
"description": "Invalid-apply listener."
|
|
4469
|
+
},
|
|
4470
|
+
{
|
|
4471
|
+
"name": "query",
|
|
4472
|
+
"payload": "Record<string,unknown>",
|
|
4473
|
+
"description": "Async query listener."
|
|
4474
|
+
},
|
|
4475
|
+
{
|
|
4476
|
+
"name": "loaded",
|
|
4477
|
+
"payload": "Record<string,unknown>",
|
|
4478
|
+
"description": "Async loaded listener."
|
|
4479
|
+
},
|
|
4480
|
+
{
|
|
4481
|
+
"name": "error",
|
|
4482
|
+
"payload": "Record<string,unknown>",
|
|
4483
|
+
"description": "Async failure listener."
|
|
4484
|
+
}
|
|
4485
|
+
],
|
|
4486
|
+
"methods": [
|
|
4487
|
+
{
|
|
4488
|
+
"name": "getValue",
|
|
4489
|
+
"signature": "getValue()",
|
|
4490
|
+
"returns": "FilterAst",
|
|
4491
|
+
"description": "Returns a defensive AST copy."
|
|
4492
|
+
},
|
|
4493
|
+
{
|
|
4494
|
+
"name": "setValue",
|
|
4495
|
+
"signature": "setValue(value, [options])",
|
|
4496
|
+
"returns": "this",
|
|
4497
|
+
"description": "Atomically replaces the AST."
|
|
4498
|
+
},
|
|
4499
|
+
{
|
|
4500
|
+
"name": "addCondition",
|
|
4501
|
+
"signature": "addCondition([parentId], [initial])",
|
|
4502
|
+
"returns": "string|null",
|
|
4503
|
+
"description": "Adds a condition to a group."
|
|
4504
|
+
},
|
|
4505
|
+
{
|
|
4506
|
+
"name": "addGroup",
|
|
4507
|
+
"signature": "addGroup([parentId], [logic])",
|
|
4508
|
+
"returns": "string|null",
|
|
4509
|
+
"description": "Adds a nested group."
|
|
4510
|
+
},
|
|
4511
|
+
{
|
|
4512
|
+
"name": "update",
|
|
4513
|
+
"signature": "update(id, patch)",
|
|
4514
|
+
"returns": "this",
|
|
4515
|
+
"description": "Updates a node by stable ID."
|
|
4516
|
+
},
|
|
4517
|
+
{
|
|
4518
|
+
"name": "remove",
|
|
4519
|
+
"signature": "remove(id)",
|
|
4520
|
+
"returns": "this",
|
|
4521
|
+
"description": "Removes a non-root node."
|
|
4522
|
+
},
|
|
4523
|
+
{
|
|
4524
|
+
"name": "move",
|
|
4525
|
+
"signature": "move(id, parentId, index)",
|
|
4526
|
+
"returns": "this",
|
|
4527
|
+
"description": "Moves a node into a group while preserving its identity."
|
|
4528
|
+
},
|
|
4529
|
+
{
|
|
4530
|
+
"name": "validate",
|
|
4531
|
+
"signature": "validate()",
|
|
4532
|
+
"returns": "{valid:boolean,errors:Array<Record<string,string>>}",
|
|
4533
|
+
"description": "Returns semantic validity and errors."
|
|
4534
|
+
},
|
|
4535
|
+
{
|
|
4536
|
+
"name": "apply",
|
|
4537
|
+
"signature": "apply()",
|
|
4538
|
+
"returns": "FilterAst|null",
|
|
4539
|
+
"description": "Applies only a valid AST."
|
|
4540
|
+
},
|
|
4541
|
+
{
|
|
4542
|
+
"name": "clear",
|
|
4543
|
+
"signature": "clear([options])",
|
|
4544
|
+
"returns": "this",
|
|
4545
|
+
"description": "Clears all conditions."
|
|
4546
|
+
},
|
|
4547
|
+
{
|
|
4548
|
+
"name": "focus",
|
|
4549
|
+
"signature": "focus([id])",
|
|
4550
|
+
"returns": "this",
|
|
4551
|
+
"description": "Focuses a condition's field or the Add button."
|
|
4552
|
+
}
|
|
4553
|
+
]
|
|
4554
|
+
},
|
|
4555
|
+
"FilterPanel": {
|
|
4556
|
+
"options": [
|
|
4557
|
+
{
|
|
4558
|
+
"name": "fields",
|
|
4559
|
+
"type": "Record<string, FilterPanelField>",
|
|
4560
|
+
"default": "{}",
|
|
4561
|
+
"description": "Field metadata exactly as a list response publishes it. An empty map is the ordinary case, not an error: it renders `emptyText`."
|
|
4562
|
+
},
|
|
4563
|
+
{
|
|
4564
|
+
"name": "order",
|
|
4565
|
+
"type": "string[]|null",
|
|
4566
|
+
"default": "null",
|
|
4567
|
+
"description": "Display order by field key; omitted keeps object order. Keys the map does not declare are ignored, and fields the order omits follow in map order."
|
|
4568
|
+
},
|
|
4569
|
+
{
|
|
4570
|
+
"name": "value",
|
|
4571
|
+
"type": "Record<string, unknown>",
|
|
4572
|
+
"default": "{}",
|
|
4573
|
+
"description": "Applied filters. The draft starts as a copy."
|
|
4574
|
+
},
|
|
4575
|
+
{
|
|
4576
|
+
"name": "mode",
|
|
4577
|
+
"type": "FilterPanelMode",
|
|
4578
|
+
"default": "'draft'",
|
|
4579
|
+
"description": "`'draft'` collects edits until `apply()`; `'live'` applies every committed edit."
|
|
4580
|
+
},
|
|
4581
|
+
{
|
|
4582
|
+
"name": "serialize",
|
|
4583
|
+
"type": "FilterPanelSerialize",
|
|
4584
|
+
"default": "'seconds'",
|
|
4585
|
+
"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."
|
|
4586
|
+
},
|
|
4587
|
+
{
|
|
4588
|
+
"name": "emptyText",
|
|
4589
|
+
"type": "string|null",
|
|
4590
|
+
"default": "null",
|
|
4591
|
+
"description": "Text shown when `fields` is empty; null resolves `filterPanel.empty`."
|
|
4592
|
+
},
|
|
4593
|
+
{
|
|
4594
|
+
"name": "msg",
|
|
4595
|
+
"type": "Record<string, string>|Record<string, Record<string, string>>",
|
|
4596
|
+
"default": null,
|
|
4597
|
+
"description": "Localized messages."
|
|
4598
|
+
}
|
|
4599
|
+
],
|
|
4600
|
+
"events": [
|
|
4601
|
+
{
|
|
4602
|
+
"name": "apply",
|
|
4603
|
+
"payload": "{value}",
|
|
4604
|
+
"description": "Apply listener."
|
|
4605
|
+
},
|
|
4606
|
+
{
|
|
4607
|
+
"name": "change",
|
|
4608
|
+
"payload": "{value, field}",
|
|
4609
|
+
"description": "Change listener."
|
|
4610
|
+
}
|
|
4611
|
+
],
|
|
4612
|
+
"methods": [
|
|
4613
|
+
{
|
|
4614
|
+
"name": "getValue",
|
|
4615
|
+
"signature": "getValue()",
|
|
4616
|
+
"returns": "Record<string, unknown>",
|
|
4617
|
+
"description": "Returns the applied value: only the constraints that are set, with dates serialized through `serialize`. Unknown field types are never part of it."
|
|
4618
|
+
},
|
|
4619
|
+
{
|
|
4620
|
+
"name": "setValue",
|
|
4621
|
+
"signature": "setValue(value)",
|
|
4622
|
+
"returns": "this",
|
|
4623
|
+
"description": "Replaces both the applied value and the draft the controls show. Accepts what `getValue()` returns as well as raw input values, so a value that survived a URL round-trip goes back in."
|
|
4624
|
+
},
|
|
4625
|
+
{
|
|
4626
|
+
"name": "apply",
|
|
4627
|
+
"signature": "apply()",
|
|
4628
|
+
"returns": "this",
|
|
4629
|
+
"description": "Commits the draft. In live mode every committed edit already does this; calling it directly is how a host forces a reload with the values that are on screen."
|
|
4630
|
+
},
|
|
4631
|
+
{
|
|
4632
|
+
"name": "reset",
|
|
4633
|
+
"signature": "reset()",
|
|
4634
|
+
"returns": "this",
|
|
4635
|
+
"description": "Restores the controls to the `value` the panel was constructed with **without committing**, so the filters in force stay in force. This is the Cancel half of a sheet: the panel goes back to showing what is being filtered by. Contrast `clear()`, which commits. In live mode there is no uncommitted draft to hold back, so there it applies like any other edit."
|
|
4636
|
+
},
|
|
4637
|
+
{
|
|
4638
|
+
"name": "clear",
|
|
4639
|
+
"signature": "clear()",
|
|
4640
|
+
"returns": "this",
|
|
4641
|
+
"description": "Empties every control **and commits**, in both modes. \"Clear the filters\" has one meaning, and leaving a list filtered behind a panel showing no filters is not it — the records look missing and nothing on screen explains why. Contrast `reset()`, which restores the controls without committing. The price is one unfiltered load at the moment the button is pressed, which is also the feedback that says the filters are gone."
|
|
4642
|
+
},
|
|
4643
|
+
{
|
|
4644
|
+
"name": "destroy",
|
|
4645
|
+
"signature": "destroy()",
|
|
4646
|
+
"returns": "void",
|
|
4647
|
+
"description": "Destroys the composed controls and puts an enhanced target back as found."
|
|
4648
|
+
}
|
|
4649
|
+
]
|
|
4650
|
+
},
|
|
4651
|
+
"Finder": {
|
|
3793
4652
|
"options": [
|
|
3794
4653
|
{
|
|
3795
4654
|
"name": "items",
|
|
@@ -4234,6 +5093,12 @@
|
|
|
4234
5093
|
"default": "false",
|
|
4235
5094
|
"description": "Shared selection mode."
|
|
4236
5095
|
},
|
|
5096
|
+
{
|
|
5097
|
+
"name": "selectionTrigger",
|
|
5098
|
+
"type": "'checkbox'|'card'",
|
|
5099
|
+
"default": "'checkbox'",
|
|
5100
|
+
"description": "Select through a checkbox or the non-interactive card surface."
|
|
5101
|
+
},
|
|
4237
5102
|
{
|
|
4238
5103
|
"name": "selection",
|
|
4239
5104
|
"type": "unknown[]",
|
|
@@ -4254,9 +5119,9 @@
|
|
|
4254
5119
|
},
|
|
4255
5120
|
{
|
|
4256
5121
|
"name": "fieldControls",
|
|
4257
|
-
"type": "boolean",
|
|
5122
|
+
"type": "boolean|import('../view/record-view.js').ViewFieldControlsConfig",
|
|
4258
5123
|
"default": "true",
|
|
4259
|
-
"description": "Show shared field controls."
|
|
5124
|
+
"description": "Show shared field controls. Redeclared narrower than `RecordViewOptions` it fails declaration emit, because the two option types are intersected."
|
|
4260
5125
|
},
|
|
4261
5126
|
{
|
|
4262
5127
|
"name": "emptyText",
|
|
@@ -4271,64 +5136,256 @@
|
|
|
4271
5136
|
"description": "Column accessor."
|
|
4272
5137
|
},
|
|
4273
5138
|
{
|
|
4274
|
-
"name": "columns",
|
|
4275
|
-
"type": "KanbanColumn[]|null",
|
|
4276
|
-
"default": "null",
|
|
4277
|
-
"description": "Explicit columns, or null to derive them."
|
|
5139
|
+
"name": "columns",
|
|
5140
|
+
"type": "KanbanColumn[]|null",
|
|
5141
|
+
"default": "null",
|
|
5142
|
+
"description": "Explicit columns, or null to derive them."
|
|
5143
|
+
},
|
|
5144
|
+
{
|
|
5145
|
+
"name": "swimlaneBy",
|
|
5146
|
+
"type": "KanbanAccessor",
|
|
5147
|
+
"default": "null",
|
|
5148
|
+
"description": "Optional swim-lane accessor."
|
|
5149
|
+
},
|
|
5150
|
+
{
|
|
5151
|
+
"name": "swimlanes",
|
|
5152
|
+
"type": "KanbanSwimlane[]|null",
|
|
5153
|
+
"default": "null",
|
|
5154
|
+
"description": "Explicit lanes, or null to derive them."
|
|
5155
|
+
},
|
|
5156
|
+
{
|
|
5157
|
+
"name": "titleField",
|
|
5158
|
+
"type": "KanbanCardField",
|
|
5159
|
+
"default": "null",
|
|
5160
|
+
"description": "Card title field or reader."
|
|
5161
|
+
},
|
|
5162
|
+
{
|
|
5163
|
+
"name": "subtitleField",
|
|
5164
|
+
"type": "KanbanCardField",
|
|
5165
|
+
"default": "null",
|
|
5166
|
+
"description": "Card subtitle field or reader."
|
|
5167
|
+
},
|
|
5168
|
+
{
|
|
5169
|
+
"name": "preview",
|
|
5170
|
+
"type": "string|((record:KanbanRecord,index:number)=>RecordCardPreview)|null",
|
|
5171
|
+
"default": "null",
|
|
5172
|
+
"description": "Preview field or reader."
|
|
5173
|
+
},
|
|
5174
|
+
{
|
|
5175
|
+
"name": "previewAlt",
|
|
5176
|
+
"type": "KanbanCardField",
|
|
5177
|
+
"default": "null",
|
|
5178
|
+
"description": "Preview alternative-text field or reader."
|
|
5179
|
+
},
|
|
5180
|
+
{
|
|
5181
|
+
"name": "link",
|
|
5182
|
+
"type": "RecordCardLink|((record:KanbanRecord,index:number)=>RecordCardLink)|null",
|
|
5183
|
+
"default": "null",
|
|
5184
|
+
"description": "Record-card primary link descriptor or reader."
|
|
5185
|
+
},
|
|
5186
|
+
{
|
|
5187
|
+
"name": "actions",
|
|
5188
|
+
"type": "RecordCardAction[]|((record:KanbanRecord,index:number)=>RecordCardAction[])",
|
|
5189
|
+
"default": "[]",
|
|
5190
|
+
"description": "Card actions."
|
|
5191
|
+
},
|
|
5192
|
+
{
|
|
5193
|
+
"name": "moveMode",
|
|
5194
|
+
"type": "'local'|'external'",
|
|
5195
|
+
"default": "'local'",
|
|
5196
|
+
"description": "Whether accepted moves update local data."
|
|
5197
|
+
},
|
|
5198
|
+
{
|
|
5199
|
+
"name": "dragFrom",
|
|
5200
|
+
"type": "'card'|'handle'",
|
|
5201
|
+
"default": "'card'",
|
|
5202
|
+
"description": "Whether the whole card or only its handle starts a pointer drag. Touch drags from the card body require a long press so the board still scrolls."
|
|
5203
|
+
},
|
|
5204
|
+
{
|
|
5205
|
+
"name": "moveHandle",
|
|
5206
|
+
"type": "'keyboard'|'always'",
|
|
5207
|
+
"default": "'keyboard'",
|
|
5208
|
+
"description": "Move-handle presentation. `keyboard` keeps it announced and tabbable but out of sight until it takes focus, because the card itself is already the pointer drag source; `always` shows it alongside the card's other controls. `dragFrom:'handle'` overrides this — a drag source a pointer user cannot see is not a control."
|
|
5209
|
+
},
|
|
5210
|
+
{
|
|
5211
|
+
"name": "entityIcon",
|
|
5212
|
+
"type": "string|((record:KanbanRecord,index:number)=>string|null)|null",
|
|
5213
|
+
"default": "null",
|
|
5214
|
+
"description": "Icon naming what the record is, drawn before the identifier."
|
|
5215
|
+
},
|
|
5216
|
+
{
|
|
5217
|
+
"name": "identifier",
|
|
5218
|
+
"type": "KanbanCardField",
|
|
5219
|
+
"default": "null",
|
|
5220
|
+
"description": "Stable record key shown on the card head."
|
|
5221
|
+
},
|
|
5222
|
+
{
|
|
5223
|
+
"name": "status",
|
|
5224
|
+
"type": "KanbanIndicatorSource",
|
|
5225
|
+
"default": "null",
|
|
5226
|
+
"description": "Status indicator source."
|
|
5227
|
+
},
|
|
5228
|
+
{
|
|
5229
|
+
"name": "statusTones",
|
|
5230
|
+
"type": "Record<string,string>",
|
|
5231
|
+
"default": "{}",
|
|
5232
|
+
"description": "Maps a status value to a semantic tone."
|
|
5233
|
+
},
|
|
5234
|
+
{
|
|
5235
|
+
"name": "priority",
|
|
5236
|
+
"type": "KanbanIndicatorSource",
|
|
5237
|
+
"default": "null",
|
|
5238
|
+
"description": "Priority indicator source."
|
|
5239
|
+
},
|
|
5240
|
+
{
|
|
5241
|
+
"name": "priorityTones",
|
|
5242
|
+
"type": "Record<string,string>",
|
|
5243
|
+
"default": "{}",
|
|
5244
|
+
"description": "Maps a priority value to a semantic tone."
|
|
5245
|
+
},
|
|
5246
|
+
{
|
|
5247
|
+
"name": "progress",
|
|
5248
|
+
"type": "KanbanCardField",
|
|
5249
|
+
"default": "null",
|
|
5250
|
+
"description": "Completion source; a number or `{value,max,label}`."
|
|
5251
|
+
},
|
|
5252
|
+
{
|
|
5253
|
+
"name": "progressMax",
|
|
5254
|
+
"type": "number",
|
|
5255
|
+
"default": "100",
|
|
5256
|
+
"description": "Amount that counts as finished."
|
|
5257
|
+
},
|
|
5258
|
+
{
|
|
5259
|
+
"name": "assignees",
|
|
5260
|
+
"type": "KanbanCardField",
|
|
5261
|
+
"default": "null",
|
|
5262
|
+
"description": "Responsible people; a name, a list, or descriptors."
|
|
5263
|
+
},
|
|
5264
|
+
{
|
|
5265
|
+
"name": "maxAvatars",
|
|
5266
|
+
"type": "number",
|
|
5267
|
+
"default": "3",
|
|
5268
|
+
"description": "Faces drawn before the overflow chip."
|
|
5269
|
+
},
|
|
5270
|
+
{
|
|
5271
|
+
"name": "multiMove",
|
|
5272
|
+
"type": "boolean",
|
|
5273
|
+
"default": "true",
|
|
5274
|
+
"description": "Move the whole selection when a selected card is picked up."
|
|
5275
|
+
},
|
|
5276
|
+
{
|
|
5277
|
+
"name": "autoScroll",
|
|
5278
|
+
"type": "boolean",
|
|
5279
|
+
"default": "true",
|
|
5280
|
+
"description": "Scroll the board and columns while dragging near an edge."
|
|
5281
|
+
},
|
|
5282
|
+
{
|
|
5283
|
+
"name": "wipPolicy",
|
|
5284
|
+
"type": "'warn'|'block'",
|
|
5285
|
+
"default": "'warn'",
|
|
5286
|
+
"description": "Whether exceeding a limit warns or refuses."
|
|
5287
|
+
},
|
|
5288
|
+
{
|
|
5289
|
+
"name": "rules",
|
|
5290
|
+
"type": "KanbanRule[]",
|
|
5291
|
+
"default": "[]",
|
|
5292
|
+
"description": "Ordered visual card rules."
|
|
5293
|
+
},
|
|
5294
|
+
{
|
|
5295
|
+
"name": "search",
|
|
5296
|
+
"type": "string",
|
|
5297
|
+
"default": "''",
|
|
5298
|
+
"description": "Board search text."
|
|
5299
|
+
},
|
|
5300
|
+
{
|
|
5301
|
+
"name": "searchFields",
|
|
5302
|
+
"type": "string[]|null",
|
|
5303
|
+
"default": "null",
|
|
5304
|
+
"description": "Field ids searched; null searches visible fields plus the title and subtitle sources."
|
|
5305
|
+
},
|
|
5306
|
+
{
|
|
5307
|
+
"name": "filter",
|
|
5308
|
+
"type": "((record:KanbanRecord,index:number)=>boolean)|null",
|
|
5309
|
+
"default": "null",
|
|
5310
|
+
"description": "Extra card predicate."
|
|
5311
|
+
},
|
|
5312
|
+
{
|
|
5313
|
+
"name": "searchControl",
|
|
5314
|
+
"type": "boolean",
|
|
5315
|
+
"default": "false",
|
|
5316
|
+
"description": "Render the built-in board search control."
|
|
5317
|
+
},
|
|
5318
|
+
{
|
|
5319
|
+
"name": "history",
|
|
5320
|
+
"type": "boolean",
|
|
5321
|
+
"default": "true",
|
|
5322
|
+
"description": "Record committed local moves for undo and redo."
|
|
5323
|
+
},
|
|
5324
|
+
{
|
|
5325
|
+
"name": "historyLimit",
|
|
5326
|
+
"type": "number",
|
|
5327
|
+
"default": "50",
|
|
5328
|
+
"description": "Maximum remembered move steps."
|
|
5329
|
+
},
|
|
5330
|
+
{
|
|
5331
|
+
"name": "historyControls",
|
|
5332
|
+
"type": "boolean",
|
|
5333
|
+
"default": "false",
|
|
5334
|
+
"description": "Render built-in undo and redo controls."
|
|
4278
5335
|
},
|
|
4279
5336
|
{
|
|
4280
|
-
"name": "
|
|
4281
|
-
"type": "
|
|
5337
|
+
"name": "columnHeight",
|
|
5338
|
+
"type": "string|null",
|
|
4282
5339
|
"default": "null",
|
|
4283
|
-
"description": "
|
|
5340
|
+
"description": "CSS length turning each column into a scroll region."
|
|
4284
5341
|
},
|
|
4285
5342
|
{
|
|
4286
|
-
"name": "
|
|
4287
|
-
"type": "KanbanSwimlane
|
|
4288
|
-
"default": "
|
|
4289
|
-
"description": "
|
|
5343
|
+
"name": "allowAdd",
|
|
5344
|
+
"type": "boolean|((column:KanbanColumn,swimlane:KanbanSwimlane|null)=>boolean)",
|
|
5345
|
+
"default": "false",
|
|
5346
|
+
"description": "Render a per-column add control that emits `recordadd`."
|
|
4290
5347
|
},
|
|
4291
5348
|
{
|
|
4292
|
-
"name": "
|
|
4293
|
-
"type": "
|
|
4294
|
-
"default": "
|
|
4295
|
-
"description": "Card
|
|
5349
|
+
"name": "contextMenu",
|
|
5350
|
+
"type": "boolean|MenuItem[]|((context:KanbanCardContext)=>MenuItem[])",
|
|
5351
|
+
"default": "false",
|
|
5352
|
+
"description": "Card context menu. `true` offers move commands; an array or function appends application items."
|
|
4296
5353
|
},
|
|
4297
5354
|
{
|
|
4298
|
-
"name": "
|
|
4299
|
-
"type": "
|
|
5355
|
+
"name": "renderCard",
|
|
5356
|
+
"type": "((context:KanbanCardContext)=>Node|null|undefined)|null",
|
|
4300
5357
|
"default": "null",
|
|
4301
|
-
"description": "
|
|
5358
|
+
"description": "Replaces the shared record-card content — eyebrow, titles, and metadata. The preview, selection control, action group, move handle, rule badges, and any configured card head and footer still render, because each of those answers to its own option; clear those options to remove them."
|
|
4302
5359
|
},
|
|
4303
5360
|
{
|
|
4304
|
-
"name": "
|
|
4305
|
-
"type": "
|
|
5361
|
+
"name": "renderColumnHeader",
|
|
5362
|
+
"type": "((context:KanbanHeaderContext)=>Node|null|undefined)|null",
|
|
4306
5363
|
"default": "null",
|
|
4307
|
-
"description": "
|
|
5364
|
+
"description": "Replaces column header content."
|
|
4308
5365
|
},
|
|
4309
5366
|
{
|
|
4310
|
-
"name": "
|
|
4311
|
-
"type": "
|
|
5367
|
+
"name": "renderSwimlaneHeader",
|
|
5368
|
+
"type": "((context:KanbanHeaderContext)=>Node|null|undefined)|null",
|
|
4312
5369
|
"default": "null",
|
|
4313
|
-
"description": "
|
|
5370
|
+
"description": "Replaces lane header content."
|
|
4314
5371
|
},
|
|
4315
5372
|
{
|
|
4316
|
-
"name": "
|
|
4317
|
-
"type": "
|
|
5373
|
+
"name": "renderColumnEmpty",
|
|
5374
|
+
"type": "((context:KanbanHeaderContext)=>Node|null|undefined)|null",
|
|
4318
5375
|
"default": "null",
|
|
4319
|
-
"description": "
|
|
5376
|
+
"description": "Empty-column placeholder."
|
|
4320
5377
|
},
|
|
4321
5378
|
{
|
|
4322
|
-
"name": "
|
|
4323
|
-
"type": "
|
|
4324
|
-
"default": "
|
|
4325
|
-
"description": "
|
|
5379
|
+
"name": "renderDragPreview",
|
|
5380
|
+
"type": "((context:{records:KanbanRecord[],ids:unknown[],count:number})=>Node|null|undefined)|null",
|
|
5381
|
+
"default": "null",
|
|
5382
|
+
"description": "Replaces the floating drag preview."
|
|
4326
5383
|
},
|
|
4327
5384
|
{
|
|
4328
|
-
"name": "
|
|
4329
|
-
"type": "
|
|
4330
|
-
"default": "
|
|
4331
|
-
"description": "
|
|
5385
|
+
"name": "labels",
|
|
5386
|
+
"type": "Record<string,string>",
|
|
5387
|
+
"default": "{}",
|
|
5388
|
+
"description": "Overrides for every visible and announced string."
|
|
4332
5389
|
},
|
|
4333
5390
|
{
|
|
4334
5391
|
"name": "columnOrder",
|
|
@@ -4385,10 +5442,30 @@
|
|
|
4385
5442
|
"payload": "Record<string,unknown>",
|
|
4386
5443
|
"description": ""
|
|
4387
5444
|
},
|
|
5445
|
+
{
|
|
5446
|
+
"name": "movereject",
|
|
5447
|
+
"payload": "Record<string,unknown>",
|
|
5448
|
+
"description": ""
|
|
5449
|
+
},
|
|
4388
5450
|
{
|
|
4389
5451
|
"name": "recordaction",
|
|
4390
5452
|
"payload": "Record<string,unknown>",
|
|
4391
5453
|
"description": ""
|
|
5454
|
+
},
|
|
5455
|
+
{
|
|
5456
|
+
"name": "recordadd",
|
|
5457
|
+
"payload": "Record<string,unknown>",
|
|
5458
|
+
"description": ""
|
|
5459
|
+
},
|
|
5460
|
+
{
|
|
5461
|
+
"name": "searchchange",
|
|
5462
|
+
"payload": "{search:string}",
|
|
5463
|
+
"description": ""
|
|
5464
|
+
},
|
|
5465
|
+
{
|
|
5466
|
+
"name": "historychange",
|
|
5467
|
+
"payload": "{canUndo:boolean,canRedo:boolean,depth:{undo:number,redo:number}}",
|
|
5468
|
+
"description": ""
|
|
4392
5469
|
}
|
|
4393
5470
|
],
|
|
4394
5471
|
"methods": [
|
|
@@ -4492,7 +5569,73 @@
|
|
|
4492
5569
|
"name": "moveRecord",
|
|
4493
5570
|
"signature": "moveRecord(id, destination)",
|
|
4494
5571
|
"returns": "this",
|
|
4495
|
-
"description": "Proposes and, in local mode, commits a record move.
|
|
5572
|
+
"description": "Proposes and, in local mode, commits a record move. Equivalent to `moveRecords([id], …)`."
|
|
5573
|
+
},
|
|
5574
|
+
{
|
|
5575
|
+
"name": "moveRecords",
|
|
5576
|
+
"signature": "moveRecords(ids, destination)",
|
|
5577
|
+
"returns": "this",
|
|
5578
|
+
"description": "Proposes and, in local mode, commits an atomic move of one or more records. Destination eligibility, transition rules, and work-in-progress policy are all checked before a single cancelable `recordmove` event; the move commits completely or not at all, and the moving records keep their relative order at the destination."
|
|
5579
|
+
},
|
|
5580
|
+
{
|
|
5581
|
+
"name": "canUndo",
|
|
5582
|
+
"signature": "canUndo()",
|
|
5583
|
+
"returns": "boolean",
|
|
5584
|
+
"description": "Whether a committed local move can be reverted."
|
|
5585
|
+
},
|
|
5586
|
+
{
|
|
5587
|
+
"name": "canRedo",
|
|
5588
|
+
"signature": "canRedo()",
|
|
5589
|
+
"returns": "boolean",
|
|
5590
|
+
"description": "Whether a reverted local move can be reapplied."
|
|
5591
|
+
},
|
|
5592
|
+
{
|
|
5593
|
+
"name": "undo",
|
|
5594
|
+
"signature": "undo()",
|
|
5595
|
+
"returns": "this",
|
|
5596
|
+
"description": "Reverts the last committed local move, restoring the exact record order and selection."
|
|
5597
|
+
},
|
|
5598
|
+
{
|
|
5599
|
+
"name": "redo",
|
|
5600
|
+
"signature": "redo()",
|
|
5601
|
+
"returns": "this",
|
|
5602
|
+
"description": "Reapplies the last reverted local move."
|
|
5603
|
+
},
|
|
5604
|
+
{
|
|
5605
|
+
"name": "clearHistory",
|
|
5606
|
+
"signature": "clearHistory()",
|
|
5607
|
+
"returns": "this",
|
|
5608
|
+
"description": "Empties both history stacks."
|
|
5609
|
+
},
|
|
5610
|
+
{
|
|
5611
|
+
"name": "getSearch",
|
|
5612
|
+
"signature": "getSearch()",
|
|
5613
|
+
"returns": "string",
|
|
5614
|
+
"description": "Returns the current board search text."
|
|
5615
|
+
},
|
|
5616
|
+
{
|
|
5617
|
+
"name": "setSearch",
|
|
5618
|
+
"signature": "setSearch(search, [options])",
|
|
5619
|
+
"returns": "this",
|
|
5620
|
+
"description": "Narrows visible cards to those matching a search. Hidden records keep their position in the data, so a card dropped between two visible cards still lands between them."
|
|
5621
|
+
},
|
|
5622
|
+
{
|
|
5623
|
+
"name": "setFilter",
|
|
5624
|
+
"signature": "setFilter(filter)",
|
|
5625
|
+
"returns": "this",
|
|
5626
|
+
"description": "Replaces the extra card predicate. Pass null to clear it."
|
|
5627
|
+
},
|
|
5628
|
+
{
|
|
5629
|
+
"name": "getVisibleRecords",
|
|
5630
|
+
"signature": "getVisibleRecords()",
|
|
5631
|
+
"returns": "KanbanRecord[]",
|
|
5632
|
+
"description": "Returns the records currently rendered, in board order."
|
|
5633
|
+
},
|
|
5634
|
+
{
|
|
5635
|
+
"name": "setData",
|
|
5636
|
+
"signature": "setData(records)",
|
|
5637
|
+
"returns": "this",
|
|
5638
|
+
"description": "Replaces every record. History is dropped because its snapshots describe records the host has just replaced, and reinstating them would resurrect data the application no longer owns."
|
|
4496
5639
|
},
|
|
4497
5640
|
{
|
|
4498
5641
|
"name": "getViewState",
|
|
@@ -4555,38 +5698,38 @@
|
|
|
4555
5698
|
{
|
|
4556
5699
|
"name": "placeholder",
|
|
4557
5700
|
"type": "string",
|
|
4558
|
-
"default":
|
|
4559
|
-
"description": "Search-field placeholder."
|
|
5701
|
+
"default": null,
|
|
5702
|
+
"description": "Search-field placeholder. Omitted resolves `launcher.placeholder`, English `Search applications and records`."
|
|
4560
5703
|
},
|
|
4561
5704
|
{
|
|
4562
5705
|
"name": "label",
|
|
4563
5706
|
"type": "string",
|
|
4564
|
-
"default":
|
|
4565
|
-
"description": "Dialog and field label."
|
|
5707
|
+
"default": null,
|
|
5708
|
+
"description": "Dialog and field label. Omitted resolves `launcher.label`, English `Launcher`."
|
|
4566
5709
|
},
|
|
4567
5710
|
{
|
|
4568
5711
|
"name": "closeLabel",
|
|
4569
5712
|
"type": "string",
|
|
4570
|
-
"default":
|
|
4571
|
-
"description": "Close-button accessible label."
|
|
5713
|
+
"default": null,
|
|
5714
|
+
"description": "Close-button accessible label. Omitted resolves `launcher.close`, English `Close launcher`."
|
|
4572
5715
|
},
|
|
4573
5716
|
{
|
|
4574
5717
|
"name": "resultsLabel",
|
|
4575
5718
|
"type": "string",
|
|
4576
|
-
"default":
|
|
4577
|
-
"description": "Results-region accessible label."
|
|
5719
|
+
"default": null,
|
|
5720
|
+
"description": "Results-region accessible label. Omitted resolves `launcher.results`, English `Launcher results`."
|
|
4578
5721
|
},
|
|
4579
5722
|
{
|
|
4580
5723
|
"name": "emptyText",
|
|
4581
5724
|
"type": "string",
|
|
4582
|
-
"default":
|
|
4583
|
-
"description": "Empty-state text."
|
|
5725
|
+
"default": null,
|
|
5726
|
+
"description": "Empty-state text. Omitted resolves `launcher.empty`, English `No results`."
|
|
4584
5727
|
},
|
|
4585
5728
|
{
|
|
4586
5729
|
"name": "loadingText",
|
|
4587
5730
|
"type": "string",
|
|
4588
|
-
"default":
|
|
4589
|
-
"description": "Loading-state text."
|
|
5731
|
+
"default": null,
|
|
5732
|
+
"description": "Loading-state text. Omitted resolves `launcher.loading`, English `Searching…`."
|
|
4590
5733
|
},
|
|
4591
5734
|
{
|
|
4592
5735
|
"name": "shortcut",
|
|
@@ -4648,96 +5791,269 @@
|
|
|
4648
5791
|
"description": "Closes the launcher."
|
|
4649
5792
|
},
|
|
4650
5793
|
{
|
|
4651
|
-
"name": "toggle",
|
|
4652
|
-
"signature": "toggle()",
|
|
5794
|
+
"name": "toggle",
|
|
5795
|
+
"signature": "toggle()",
|
|
5796
|
+
"returns": "this",
|
|
5797
|
+
"description": "Toggles the launcher."
|
|
5798
|
+
},
|
|
5799
|
+
{
|
|
5800
|
+
"name": "isOpen",
|
|
5801
|
+
"signature": "isOpen()",
|
|
5802
|
+
"returns": "boolean",
|
|
5803
|
+
"description": "Reports whether the launcher is open."
|
|
5804
|
+
},
|
|
5805
|
+
{
|
|
5806
|
+
"name": "focus",
|
|
5807
|
+
"signature": "focus()",
|
|
5808
|
+
"returns": "this",
|
|
5809
|
+
"description": "Focuses and selects the query field."
|
|
5810
|
+
},
|
|
5811
|
+
{
|
|
5812
|
+
"name": "setQuery",
|
|
5813
|
+
"signature": "setQuery(query)",
|
|
5814
|
+
"returns": "this",
|
|
5815
|
+
"description": "Replaces the query and refreshes local and remote results."
|
|
5816
|
+
},
|
|
5817
|
+
{
|
|
5818
|
+
"name": "getQuery",
|
|
5819
|
+
"signature": "getQuery()",
|
|
5820
|
+
"returns": "string",
|
|
5821
|
+
"description": "Returns the untrimmed query."
|
|
5822
|
+
},
|
|
5823
|
+
{
|
|
5824
|
+
"name": "setItems",
|
|
5825
|
+
"signature": "setItems(items)",
|
|
5826
|
+
"returns": "this",
|
|
5827
|
+
"description": "Replaces local catalogue items."
|
|
5828
|
+
},
|
|
5829
|
+
{
|
|
5830
|
+
"name": "setCurrent",
|
|
5831
|
+
"signature": "setCurrent(id)",
|
|
5832
|
+
"returns": "this",
|
|
5833
|
+
"description": "Marks one local item as the current destination."
|
|
5834
|
+
},
|
|
5835
|
+
{
|
|
5836
|
+
"name": "setSources",
|
|
5837
|
+
"signature": "setSources(sources)",
|
|
5838
|
+
"returns": "this",
|
|
5839
|
+
"description": "Replaces asynchronous sources and aborts work from the old set."
|
|
5840
|
+
},
|
|
5841
|
+
{
|
|
5842
|
+
"name": "destroy",
|
|
5843
|
+
"signature": "destroy()",
|
|
5844
|
+
"returns": "void",
|
|
5845
|
+
"description": "Aborts sources and removes the owned dialog."
|
|
5846
|
+
}
|
|
5847
|
+
]
|
|
5848
|
+
},
|
|
5849
|
+
"LayoutGrid": {
|
|
5850
|
+
"options": [
|
|
5851
|
+
{
|
|
5852
|
+
"name": "columns",
|
|
5853
|
+
"type": "number|null",
|
|
5854
|
+
"default": "null",
|
|
5855
|
+
"description": "Column count at full width. Null fills the row with as many tracks of `min` width as fit."
|
|
5856
|
+
},
|
|
5857
|
+
{
|
|
5858
|
+
"name": "min",
|
|
5859
|
+
"type": "number|string",
|
|
5860
|
+
"default": "'16rem'",
|
|
5861
|
+
"description": "Narrowest a track may get before the grid drops a column. A number is read as pixels."
|
|
5862
|
+
},
|
|
5863
|
+
{
|
|
5864
|
+
"name": "gap",
|
|
5865
|
+
"type": "number|string",
|
|
5866
|
+
"default": "4",
|
|
5867
|
+
"description": "Space between cells, as in `stack`."
|
|
5868
|
+
},
|
|
5869
|
+
{
|
|
5870
|
+
"name": "align",
|
|
5871
|
+
"type": "'start'|'center'|'end'|'stretch'",
|
|
5872
|
+
"default": null,
|
|
5873
|
+
"description": "Block-axis alignment of each cell."
|
|
5874
|
+
},
|
|
5875
|
+
{
|
|
5876
|
+
"name": "class",
|
|
5877
|
+
"type": "string",
|
|
5878
|
+
"default": "''",
|
|
5879
|
+
"description": "Extra class names."
|
|
5880
|
+
}
|
|
5881
|
+
],
|
|
5882
|
+
"events": [],
|
|
5883
|
+
"methods": []
|
|
5884
|
+
},
|
|
5885
|
+
"ListToolbar": {
|
|
5886
|
+
"options": [
|
|
5887
|
+
{
|
|
5888
|
+
"name": "search",
|
|
5889
|
+
"type": "ListToolbarSearch|boolean",
|
|
5890
|
+
"default": "{}",
|
|
5891
|
+
"description": "Search field configuration; `false` omits it."
|
|
5892
|
+
},
|
|
5893
|
+
{
|
|
5894
|
+
"name": "count",
|
|
5895
|
+
"type": "number|null",
|
|
5896
|
+
"default": "null",
|
|
5897
|
+
"description": "Initial result count shown in the live status line."
|
|
5898
|
+
},
|
|
5899
|
+
{
|
|
5900
|
+
"name": "countText",
|
|
5901
|
+
"type": "((count: number) => string)|null",
|
|
5902
|
+
"default": "null",
|
|
5903
|
+
"description": "Formats the count line; omitted uses the `listToolbar.results` message (`'%1 results'`)."
|
|
5904
|
+
},
|
|
5905
|
+
{
|
|
5906
|
+
"name": "views",
|
|
5907
|
+
"type": "Array<string|ListToolbarView>",
|
|
5908
|
+
"default": "[]",
|
|
5909
|
+
"description": "Shape switch entries; `[]` omits the switch."
|
|
5910
|
+
},
|
|
5911
|
+
{
|
|
5912
|
+
"name": "view",
|
|
5913
|
+
"type": "string|null",
|
|
5914
|
+
"default": "null",
|
|
5915
|
+
"description": "Initially selected shape; omitted selects the first entry."
|
|
5916
|
+
},
|
|
5917
|
+
{
|
|
5918
|
+
"name": "tools",
|
|
5919
|
+
"type": "ListToolbarTool[]",
|
|
5920
|
+
"default": "[]",
|
|
5921
|
+
"description": "Tool buttons, in display order."
|
|
5922
|
+
},
|
|
5923
|
+
{
|
|
5924
|
+
"name": "label",
|
|
5925
|
+
"type": "string|null",
|
|
5926
|
+
"default": "null",
|
|
5927
|
+
"description": "Accessible name of the bar; omitted uses the `listToolbar.label` message."
|
|
5928
|
+
},
|
|
5929
|
+
{
|
|
5930
|
+
"name": "msg",
|
|
5931
|
+
"type": "Record<string, string>|Record<string, Record<string, string>>",
|
|
5932
|
+
"default": null,
|
|
5933
|
+
"description": "Localized messages."
|
|
5934
|
+
}
|
|
5935
|
+
],
|
|
5936
|
+
"events": [
|
|
5937
|
+
{
|
|
5938
|
+
"name": "search",
|
|
5939
|
+
"payload": "{value: string}",
|
|
5940
|
+
"description": "Search listener."
|
|
5941
|
+
},
|
|
5942
|
+
{
|
|
5943
|
+
"name": "viewchange",
|
|
5944
|
+
"payload": "{view: string, previous: string|null}",
|
|
5945
|
+
"description": "Shape listener."
|
|
5946
|
+
},
|
|
5947
|
+
{
|
|
5948
|
+
"name": "action",
|
|
5949
|
+
"payload": "{id: string, pressed: boolean|null, tool: Element}",
|
|
5950
|
+
"description": "Tool listener."
|
|
5951
|
+
}
|
|
5952
|
+
],
|
|
5953
|
+
"methods": [
|
|
5954
|
+
{
|
|
5955
|
+
"name": "setCount",
|
|
5956
|
+
"signature": "setCount(count)",
|
|
5957
|
+
"returns": "this",
|
|
5958
|
+
"description": "Replaces the count line. `null` clears it, which is the right answer while a request is in flight: the number on screen describes the filters the reader has just changed."
|
|
5959
|
+
},
|
|
5960
|
+
{
|
|
5961
|
+
"name": "getCount",
|
|
5962
|
+
"signature": "getCount()",
|
|
5963
|
+
"returns": "number|null",
|
|
5964
|
+
"description": "Returns the count currently shown, or null when the line is empty."
|
|
5965
|
+
},
|
|
5966
|
+
{
|
|
5967
|
+
"name": "setBadge",
|
|
5968
|
+
"signature": "setBadge(id, value)",
|
|
5969
|
+
"returns": "this",
|
|
5970
|
+
"description": "Replaces a tool's badge and its accessible name with it. `null` removes the badge."
|
|
5971
|
+
},
|
|
5972
|
+
{
|
|
5973
|
+
"name": "setPressed",
|
|
5974
|
+
"signature": "setPressed(id, [pressed])",
|
|
4653
5975
|
"returns": "this",
|
|
4654
|
-
"description": "
|
|
5976
|
+
"description": "Sets the pressed state of a toggle tool. A tool declared without `pressed` is a plain button and is left alone."
|
|
4655
5977
|
},
|
|
4656
5978
|
{
|
|
4657
|
-
"name": "
|
|
4658
|
-
"signature": "
|
|
4659
|
-
"returns": "
|
|
4660
|
-
"description": "
|
|
5979
|
+
"name": "setToolDisabled",
|
|
5980
|
+
"signature": "setToolDisabled(id, [disabled])",
|
|
5981
|
+
"returns": "this",
|
|
5982
|
+
"description": "Enables or disables a tool, for instance while its panel is loading."
|
|
4661
5983
|
},
|
|
4662
5984
|
{
|
|
4663
|
-
"name": "
|
|
4664
|
-
"signature": "
|
|
5985
|
+
"name": "setTools",
|
|
5986
|
+
"signature": "setTools(tools)",
|
|
4665
5987
|
"returns": "this",
|
|
4666
|
-
"description": "
|
|
5988
|
+
"description": "Replaces every tool. Elements adopted with `addTool()` and a chooser mounted by `bind()` stay where they are."
|
|
4667
5989
|
},
|
|
4668
5990
|
{
|
|
4669
|
-
"name": "
|
|
4670
|
-
"signature": "
|
|
4671
|
-
"returns": "
|
|
4672
|
-
"description": "
|
|
5991
|
+
"name": "getTool",
|
|
5992
|
+
"signature": "getTool(id)",
|
|
5993
|
+
"returns": "HTMLButtonElement|null",
|
|
5994
|
+
"description": "Returns a tool's button element."
|
|
4673
5995
|
},
|
|
4674
5996
|
{
|
|
4675
|
-
"name": "
|
|
4676
|
-
"signature": "
|
|
4677
|
-
"returns": "
|
|
4678
|
-
"description": "
|
|
5997
|
+
"name": "getToolsElement",
|
|
5998
|
+
"signature": "getToolsElement()",
|
|
5999
|
+
"returns": "HTMLElement",
|
|
6000
|
+
"description": "The element tools are mounted into. Hand it to a view as `fieldControls: {target}` to place that view's field chooser in this bar without calling `bind()`. A control mounted here by somebody else stays theirs: the toolbar puts back what it adopted through `addTool()` or `bind()`, and everything else goes wherever this slot goes. Use `addTool()` instead to hand the toolbar an element it should return on `destroy()`."
|
|
4679
6001
|
},
|
|
4680
6002
|
{
|
|
4681
|
-
"name": "
|
|
4682
|
-
"signature": "
|
|
6003
|
+
"name": "addTool",
|
|
6004
|
+
"signature": "addTool(element)",
|
|
4683
6005
|
"returns": "this",
|
|
4684
|
-
"description": "
|
|
6006
|
+
"description": "Adopts a ready-made control into the tools slot. The element's original position is recorded, and `destroy()` puts it back."
|
|
4685
6007
|
},
|
|
4686
6008
|
{
|
|
4687
|
-
"name": "
|
|
4688
|
-
"signature": "
|
|
6009
|
+
"name": "setView",
|
|
6010
|
+
"signature": "setView(view, [options])",
|
|
4689
6011
|
"returns": "this",
|
|
4690
|
-
"description": "
|
|
6012
|
+
"description": "Selects a view shape. A value outside `views` is ignored, so the switch can only ever report one of the shapes it was configured with."
|
|
4691
6013
|
},
|
|
4692
6014
|
{
|
|
4693
|
-
"name": "
|
|
4694
|
-
"signature": "
|
|
4695
|
-
"returns": "
|
|
4696
|
-
"description": "
|
|
6015
|
+
"name": "getView",
|
|
6016
|
+
"signature": "getView()",
|
|
6017
|
+
"returns": "string|null",
|
|
6018
|
+
"description": "Returns the selected view shape, or null when no shape switch is configured."
|
|
4697
6019
|
},
|
|
4698
6020
|
{
|
|
4699
|
-
"name": "
|
|
4700
|
-
"signature": "
|
|
4701
|
-
"returns": "
|
|
4702
|
-
"description": "
|
|
4703
|
-
}
|
|
4704
|
-
]
|
|
4705
|
-
},
|
|
4706
|
-
"LayoutGrid": {
|
|
4707
|
-
"options": [
|
|
6021
|
+
"name": "getSearch",
|
|
6022
|
+
"signature": "getSearch()",
|
|
6023
|
+
"returns": "string",
|
|
6024
|
+
"description": "Returns the current query, or an empty string when the field is omitted."
|
|
6025
|
+
},
|
|
4708
6026
|
{
|
|
4709
|
-
"name": "
|
|
4710
|
-
"
|
|
4711
|
-
"
|
|
4712
|
-
"description": "
|
|
6027
|
+
"name": "setSearch",
|
|
6028
|
+
"signature": "setSearch(value, [options])",
|
|
6029
|
+
"returns": "this",
|
|
6030
|
+
"description": "Sets the query."
|
|
4713
6031
|
},
|
|
4714
6032
|
{
|
|
4715
|
-
"name": "
|
|
4716
|
-
"
|
|
4717
|
-
"
|
|
4718
|
-
"description": "
|
|
6033
|
+
"name": "focusSearch",
|
|
6034
|
+
"signature": "focusSearch()",
|
|
6035
|
+
"returns": "this",
|
|
6036
|
+
"description": "Focuses the search field, for a host that binds a \"/\" shortcut."
|
|
4719
6037
|
},
|
|
4720
6038
|
{
|
|
4721
|
-
"name": "
|
|
4722
|
-
"
|
|
4723
|
-
"
|
|
4724
|
-
"description": "
|
|
6039
|
+
"name": "bind",
|
|
6040
|
+
"signature": "bind(view)",
|
|
6041
|
+
"returns": "this",
|
|
6042
|
+
"description": "Optional sugar for a `TableView` or `CardView`: it wires the shape switch to the view and mounts the view's field chooser into this bar. 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."
|
|
4725
6043
|
},
|
|
4726
6044
|
{
|
|
4727
|
-
"name": "
|
|
4728
|
-
"
|
|
4729
|
-
"
|
|
4730
|
-
"description": "
|
|
6045
|
+
"name": "unbind",
|
|
6046
|
+
"signature": "unbind()",
|
|
6047
|
+
"returns": "this",
|
|
6048
|
+
"description": "Releases a bound view and returns its field chooser to where it was found."
|
|
4731
6049
|
},
|
|
4732
6050
|
{
|
|
4733
|
-
"name": "
|
|
4734
|
-
"
|
|
4735
|
-
"
|
|
4736
|
-
"description": "
|
|
6051
|
+
"name": "destroy",
|
|
6052
|
+
"signature": "destroy()",
|
|
6053
|
+
"returns": "void",
|
|
6054
|
+
"description": "Destroys the search field, returns every adopted control to where it came from, and restores an enhanced target to the markup it had before the takeover."
|
|
4737
6055
|
}
|
|
4738
|
-
]
|
|
4739
|
-
"events": [],
|
|
4740
|
-
"methods": []
|
|
6056
|
+
]
|
|
4741
6057
|
},
|
|
4742
6058
|
"MasterPanel": {
|
|
4743
6059
|
"options": [
|
|
@@ -5210,6 +6526,24 @@
|
|
|
5210
6526
|
"type": "NavigationAction[]",
|
|
5211
6527
|
"default": "[]",
|
|
5212
6528
|
"description": "Right-aligned action elements or descriptors."
|
|
6529
|
+
},
|
|
6530
|
+
{
|
|
6531
|
+
"name": "overflow",
|
|
6532
|
+
"type": "boolean",
|
|
6533
|
+
"default": "true",
|
|
6534
|
+
"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."
|
|
6535
|
+
},
|
|
6536
|
+
{
|
|
6537
|
+
"name": "overflowBelow",
|
|
6538
|
+
"type": "string|number|false",
|
|
6539
|
+
"default": "'44rem'",
|
|
6540
|
+
"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`."
|
|
6541
|
+
},
|
|
6542
|
+
{
|
|
6543
|
+
"name": "minVisible",
|
|
6544
|
+
"type": "number",
|
|
6545
|
+
"default": "0",
|
|
6546
|
+
"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."
|
|
5213
6547
|
}
|
|
5214
6548
|
],
|
|
5215
6549
|
"events": [
|
|
@@ -6289,6 +7623,12 @@
|
|
|
6289
7623
|
"default": "false",
|
|
6290
7624
|
"description": "Selection presentation."
|
|
6291
7625
|
},
|
|
7626
|
+
{
|
|
7627
|
+
"name": "selectionTrigger",
|
|
7628
|
+
"type": "'checkbox'|'card'",
|
|
7629
|
+
"default": "'checkbox'",
|
|
7630
|
+
"description": "Selection affordance for owning views."
|
|
7631
|
+
},
|
|
6292
7632
|
{
|
|
6293
7633
|
"name": "selected",
|
|
6294
7634
|
"type": "boolean",
|
|
@@ -6375,9 +7715,9 @@
|
|
|
6375
7715
|
},
|
|
6376
7716
|
{
|
|
6377
7717
|
"name": "fieldControls",
|
|
6378
|
-
"type": "boolean",
|
|
7718
|
+
"type": "boolean|ViewFieldControlsConfig",
|
|
6379
7719
|
"default": "true",
|
|
6380
|
-
"description": "Whether concrete views show the shared field chooser."
|
|
7720
|
+
"description": "Whether concrete views show the shared field chooser. `true` renders it in the view's own toolbar and `false` omits it; a `ViewFieldControlsConfig` object renders the same control with a translated `label` and, with `target`, mounts it into a host element such as a list toolbar."
|
|
6381
7721
|
},
|
|
6382
7722
|
{
|
|
6383
7723
|
"name": "emptyText",
|
|
@@ -6744,6 +8084,12 @@
|
|
|
6744
8084
|
"default": "''",
|
|
6745
8085
|
"description": "Empty control text."
|
|
6746
8086
|
},
|
|
8087
|
+
{
|
|
8088
|
+
"name": "label",
|
|
8089
|
+
"type": "string",
|
|
8090
|
+
"default": "''",
|
|
8091
|
+
"description": "Accessible combobox name; falls back to the placeholder."
|
|
8092
|
+
},
|
|
6747
8093
|
{
|
|
6748
8094
|
"name": "clearable",
|
|
6749
8095
|
"type": "boolean",
|
|
@@ -7473,6 +8819,85 @@
|
|
|
7473
8819
|
}
|
|
7474
8820
|
]
|
|
7475
8821
|
},
|
|
8822
|
+
"SortControl": {
|
|
8823
|
+
"options": [
|
|
8824
|
+
{
|
|
8825
|
+
"name": "fields",
|
|
8826
|
+
"type": "SortField[]",
|
|
8827
|
+
"default": "[]",
|
|
8828
|
+
"description": "Available sort fields, in display order."
|
|
8829
|
+
},
|
|
8830
|
+
{
|
|
8831
|
+
"name": "value",
|
|
8832
|
+
"type": "SortValue|null",
|
|
8833
|
+
"default": "null",
|
|
8834
|
+
"description": "Initial sort; null chooses the first field ascending."
|
|
8835
|
+
},
|
|
8836
|
+
{
|
|
8837
|
+
"name": "label",
|
|
8838
|
+
"type": "string",
|
|
8839
|
+
"default": "'Sort by'",
|
|
8840
|
+
"description": "Accessible field label and direction-name prefix."
|
|
8841
|
+
},
|
|
8842
|
+
{
|
|
8843
|
+
"name": "labels",
|
|
8844
|
+
"type": "{asc?:string,desc?:string}",
|
|
8845
|
+
"default": "{}",
|
|
8846
|
+
"description": "Current/next direction labels, defaulting to Ascending/Descending."
|
|
8847
|
+
},
|
|
8848
|
+
{
|
|
8849
|
+
"name": "disabled",
|
|
8850
|
+
"type": "boolean",
|
|
8851
|
+
"default": "false",
|
|
8852
|
+
"description": "Whether interaction is disabled."
|
|
8853
|
+
}
|
|
8854
|
+
],
|
|
8855
|
+
"events": [
|
|
8856
|
+
{
|
|
8857
|
+
"name": "change",
|
|
8858
|
+
"payload": "{value:SortValue}",
|
|
8859
|
+
"description": "Atomic field/direction change."
|
|
8860
|
+
}
|
|
8861
|
+
],
|
|
8862
|
+
"methods": [
|
|
8863
|
+
{
|
|
8864
|
+
"name": "getValue",
|
|
8865
|
+
"signature": "getValue()",
|
|
8866
|
+
"returns": "SortValue|null",
|
|
8867
|
+
"description": "Returns a defensive copy of the current sort."
|
|
8868
|
+
},
|
|
8869
|
+
{
|
|
8870
|
+
"name": "setValue",
|
|
8871
|
+
"signature": "setValue(value, [options])",
|
|
8872
|
+
"returns": "this",
|
|
8873
|
+
"description": "Replaces the field and direction atomically; rejects unavailable fields and directions."
|
|
8874
|
+
},
|
|
8875
|
+
{
|
|
8876
|
+
"name": "enable",
|
|
8877
|
+
"signature": "enable()",
|
|
8878
|
+
"returns": "this",
|
|
8879
|
+
"description": "Enables both controls when fields are available."
|
|
8880
|
+
},
|
|
8881
|
+
{
|
|
8882
|
+
"name": "disable",
|
|
8883
|
+
"signature": "disable()",
|
|
8884
|
+
"returns": "this",
|
|
8885
|
+
"description": "Disables both controls and closes the option panel."
|
|
8886
|
+
},
|
|
8887
|
+
{
|
|
8888
|
+
"name": "focus",
|
|
8889
|
+
"signature": "focus()",
|
|
8890
|
+
"returns": "this",
|
|
8891
|
+
"description": "Focuses the searchable control."
|
|
8892
|
+
},
|
|
8893
|
+
{
|
|
8894
|
+
"name": "destroy",
|
|
8895
|
+
"signature": "destroy()",
|
|
8896
|
+
"returns": "void",
|
|
8897
|
+
"description": "Releases the owned Select and restores an enhanced target."
|
|
8898
|
+
}
|
|
8899
|
+
]
|
|
8900
|
+
},
|
|
7476
8901
|
"Spinner": {
|
|
7477
8902
|
"options": [
|
|
7478
8903
|
{
|
|
@@ -7723,6 +9148,133 @@
|
|
|
7723
9148
|
"events": [],
|
|
7724
9149
|
"methods": []
|
|
7725
9150
|
},
|
|
9151
|
+
"StatTile": {
|
|
9152
|
+
"options": [
|
|
9153
|
+
{
|
|
9154
|
+
"name": "label",
|
|
9155
|
+
"type": "string",
|
|
9156
|
+
"default": "''",
|
|
9157
|
+
"description": "The metric's name, set small above the value."
|
|
9158
|
+
},
|
|
9159
|
+
{
|
|
9160
|
+
"name": "value",
|
|
9161
|
+
"type": "number|string|null",
|
|
9162
|
+
"default": "null",
|
|
9163
|
+
"description": "The metric. A string is rendered as given."
|
|
9164
|
+
},
|
|
9165
|
+
{
|
|
9166
|
+
"name": "format",
|
|
9167
|
+
"type": "StatTileFormat",
|
|
9168
|
+
"default": "'number'",
|
|
9169
|
+
"description": "How a numeric value is rendered: a named mode, a callback receiving the raw value, or null to print the value unformatted."
|
|
9170
|
+
},
|
|
9171
|
+
{
|
|
9172
|
+
"name": "currency",
|
|
9173
|
+
"type": "string|null",
|
|
9174
|
+
"default": "null",
|
|
9175
|
+
"description": "ISO 4217 code used by `format: 'currency'`."
|
|
9176
|
+
},
|
|
9177
|
+
{
|
|
9178
|
+
"name": "locale",
|
|
9179
|
+
"type": "string",
|
|
9180
|
+
"default": null,
|
|
9181
|
+
"description": "BCP 47 tag for every formatter; defaults to the active language."
|
|
9182
|
+
},
|
|
9183
|
+
{
|
|
9184
|
+
"name": "delta",
|
|
9185
|
+
"type": "number|string|null",
|
|
9186
|
+
"default": "null",
|
|
9187
|
+
"description": "Change against the previous period. Rendered with its own sign and an arrow, never with colour alone."
|
|
9188
|
+
},
|
|
9189
|
+
{
|
|
9190
|
+
"name": "deltaKind",
|
|
9191
|
+
"type": "StatTileDeltaKind",
|
|
9192
|
+
"default": "'neutral'",
|
|
9193
|
+
"description": "Whether the change is good, bad, or merely a change. This — not the sign's direction — picks the delta colour: a rising ticket count is not a success, so \"up is good\" is never assumed."
|
|
9194
|
+
},
|
|
9195
|
+
{
|
|
9196
|
+
"name": "deltaFormat",
|
|
9197
|
+
"type": "StatTileFormat",
|
|
9198
|
+
"default": null,
|
|
9199
|
+
"description": "How the delta is rendered; defaults to `format`."
|
|
9200
|
+
},
|
|
9201
|
+
{
|
|
9202
|
+
"name": "deltaLabel",
|
|
9203
|
+
"type": "string",
|
|
9204
|
+
"default": "''",
|
|
9205
|
+
"description": "What the change is measured against, e.g. `'vs. last week'`."
|
|
9206
|
+
},
|
|
9207
|
+
{
|
|
9208
|
+
"name": "trend",
|
|
9209
|
+
"type": "number[]",
|
|
9210
|
+
"default": "[]",
|
|
9211
|
+
"description": "Values for a decorative sparkline. Fewer than two usable numbers render nothing."
|
|
9212
|
+
},
|
|
9213
|
+
{
|
|
9214
|
+
"name": "icon",
|
|
9215
|
+
"type": "string|null",
|
|
9216
|
+
"default": "null",
|
|
9217
|
+
"description": "Icon name from `icons.js`, shown beside the label."
|
|
9218
|
+
},
|
|
9219
|
+
{
|
|
9220
|
+
"name": "kind",
|
|
9221
|
+
"type": "StatTileKind",
|
|
9222
|
+
"default": "'neutral'",
|
|
9223
|
+
"description": "Semantic intent. It tints the icon and the sparkline and never the value, which stays at full text contrast whatever intent a record carries."
|
|
9224
|
+
},
|
|
9225
|
+
{
|
|
9226
|
+
"name": "href",
|
|
9227
|
+
"type": "string|null",
|
|
9228
|
+
"default": "null",
|
|
9229
|
+
"description": "Destination. A tile with an href is an `<a>`."
|
|
9230
|
+
},
|
|
9231
|
+
{
|
|
9232
|
+
"name": "clickable",
|
|
9233
|
+
"type": "boolean",
|
|
9234
|
+
"default": "false",
|
|
9235
|
+
"description": "Renders a `<button>` without an href. Passing `onclick` sets this implicitly; set it directly to subscribe with `on('click', …)` instead."
|
|
9236
|
+
},
|
|
9237
|
+
{
|
|
9238
|
+
"name": "loading",
|
|
9239
|
+
"type": "boolean",
|
|
9240
|
+
"default": "false",
|
|
9241
|
+
"description": "Renders a skeleton shaped like the tile."
|
|
9242
|
+
},
|
|
9243
|
+
{
|
|
9244
|
+
"name": "msg",
|
|
9245
|
+
"type": "Record<string, unknown>",
|
|
9246
|
+
"default": null,
|
|
9247
|
+
"description": "Message overrides, keyed as `statTile.*`."
|
|
9248
|
+
}
|
|
9249
|
+
],
|
|
9250
|
+
"events": [
|
|
9251
|
+
{
|
|
9252
|
+
"name": "click",
|
|
9253
|
+
"payload": "{event: MouseEvent}",
|
|
9254
|
+
"description": "Activation listener; its presence is what turns a tile with no href into a button. It is the tile's `click` event, as every Zx component's `on*` option is, so it receives the `CustomEvent` carrying the native event in `detail.event`."
|
|
9255
|
+
}
|
|
9256
|
+
],
|
|
9257
|
+
"methods": [
|
|
9258
|
+
{
|
|
9259
|
+
"name": "update",
|
|
9260
|
+
"signature": "update(options)",
|
|
9261
|
+
"returns": "this",
|
|
9262
|
+
"description": "Replaces any subset of the tile's content and redraws it. This is how a tile leaves `loading: true` behind once the server answers."
|
|
9263
|
+
},
|
|
9264
|
+
{
|
|
9265
|
+
"name": "getAccessibleName",
|
|
9266
|
+
"signature": "getAccessibleName()",
|
|
9267
|
+
"returns": "string",
|
|
9268
|
+
"description": "Reports the tile's own accessible name, which is what assistive technology announces."
|
|
9269
|
+
},
|
|
9270
|
+
{
|
|
9271
|
+
"name": "destroy",
|
|
9272
|
+
"signature": "destroy()",
|
|
9273
|
+
"returns": "void",
|
|
9274
|
+
"description": "Aborts listeners and restores an adopted target to the state it was found in."
|
|
9275
|
+
}
|
|
9276
|
+
]
|
|
9277
|
+
},
|
|
7726
9278
|
"Stepper": {
|
|
7727
9279
|
"options": [
|
|
7728
9280
|
{
|
|
@@ -8032,6 +9584,18 @@
|
|
|
8032
9584
|
"default": "null",
|
|
8033
9585
|
"description": "Additional row class callback."
|
|
8034
9586
|
},
|
|
9587
|
+
{
|
|
9588
|
+
"name": "rowKind",
|
|
9589
|
+
"type": "string|((row: TableRow) => unknown)|null",
|
|
9590
|
+
"default": "null",
|
|
9591
|
+
"description": "Row property or callback naming each row's kind — the `type` on a ZeyOS transaction line, where one value is a position carrying quantities and amounts and another is a section heading that groups the positions under it. `null`, the default, renders every row exactly as before."
|
|
9592
|
+
},
|
|
9593
|
+
{
|
|
9594
|
+
"name": "rowKinds",
|
|
9595
|
+
"type": "Record<string, TableRowKind>|null",
|
|
9596
|
+
"default": "null",
|
|
9597
|
+
"description": "Presentation per kind, keyed by the resolved kind coerced to a string. A kind with no entry here renders as an ordinary row. While any row in the current data resolves to a `span` kind the header sort controls are withheld and `setSort()` is inert: sorting a grouped table scatters the positions out of their sections, and doing that silently is worse than not offering it. `sortMode: 'server'` still owns its own order."
|
|
9598
|
+
},
|
|
8035
9599
|
{
|
|
8036
9600
|
"name": "zebra",
|
|
8037
9601
|
"type": "boolean",
|
|
@@ -8271,7 +9835,7 @@
|
|
|
8271
9835
|
"name": "setSort",
|
|
8272
9836
|
"signature": "setSort(id, [dir], [options])",
|
|
8273
9837
|
"returns": "this",
|
|
8274
|
-
"description": "Activates a column sort. Local mode stably reorders data; server mode only updates the header state and emits the request event."
|
|
9838
|
+
"description": "Activates a column sort. Local mode stably reorders data; server mode only updates the header state and emits the request event. Inert while the data holds a spanning row: a sort would scatter the positions out of the sections that group them, in either sort mode. The header withholds its controls for the same reason, so nothing on screen invites the call."
|
|
8275
9839
|
},
|
|
8276
9840
|
{
|
|
8277
9841
|
"name": "getSort",
|
|
@@ -8483,9 +10047,9 @@
|
|
|
8483
10047
|
},
|
|
8484
10048
|
{
|
|
8485
10049
|
"name": "fieldControls",
|
|
8486
|
-
"type": "boolean",
|
|
10050
|
+
"type": "boolean|import('../view/record-view.js').ViewFieldControlsConfig",
|
|
8487
10051
|
"default": "true",
|
|
8488
|
-
"description": "Show the accessible visibility and reorder disclosure."
|
|
10052
|
+
"description": "Show the accessible visibility and reorder disclosure. `true` keeps the composed Table's own column chooser and `false` omits it; an object renders the shared record-view chooser instead, with a translated `label` and, with `target`, mounted into a host element."
|
|
8489
10053
|
},
|
|
8490
10054
|
{
|
|
8491
10055
|
"name": "emptyText",
|