@kubex/zinc 1.1.135 → 1.1.137
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/dist/custom-elements.json +1005 -1005
- package/dist/vscode.html-custom-data.json +159 -159
- package/dist/web-types.json +365 -365
- package/dist/zn.min.js +5 -5
- package/package.json +1 -1
- package/src/components/button-menu/button-menu.scss +10 -0
- package/src/components/chip/chip.scss +1 -1
- package/src/components/page/page.scss +3 -1
|
@@ -2,6 +2,79 @@
|
|
|
2
2
|
"schemaVersion": "1.0.0",
|
|
3
3
|
"readme": "",
|
|
4
4
|
"modules": [
|
|
5
|
+
{
|
|
6
|
+
"kind": "javascript-module",
|
|
7
|
+
"path": "components/action-bar/action-bar.js",
|
|
8
|
+
"declarations": [
|
|
9
|
+
{
|
|
10
|
+
"kind": "class",
|
|
11
|
+
"description": "",
|
|
12
|
+
"name": "ZnActionBar",
|
|
13
|
+
"cssProperties": [
|
|
14
|
+
{
|
|
15
|
+
"description": "An example CSS custom property.",
|
|
16
|
+
"name": "--example"
|
|
17
|
+
}
|
|
18
|
+
],
|
|
19
|
+
"cssParts": [
|
|
20
|
+
{
|
|
21
|
+
"description": "The component's base wrapper.",
|
|
22
|
+
"name": "base"
|
|
23
|
+
}
|
|
24
|
+
],
|
|
25
|
+
"slots": [
|
|
26
|
+
{
|
|
27
|
+
"description": "The default slot.",
|
|
28
|
+
"name": ""
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
"description": "An example slot.",
|
|
32
|
+
"name": "example"
|
|
33
|
+
}
|
|
34
|
+
],
|
|
35
|
+
"members": [
|
|
36
|
+
{
|
|
37
|
+
"kind": "field",
|
|
38
|
+
"name": "localize",
|
|
39
|
+
"privacy": "private",
|
|
40
|
+
"readonly": true,
|
|
41
|
+
"default": "new LocalizeController(this)"
|
|
42
|
+
}
|
|
43
|
+
],
|
|
44
|
+
"events": [
|
|
45
|
+
{
|
|
46
|
+
"description": "Emitted as an example.",
|
|
47
|
+
"name": "zn-event-name"
|
|
48
|
+
}
|
|
49
|
+
],
|
|
50
|
+
"superclass": {
|
|
51
|
+
"name": "ZincElement",
|
|
52
|
+
"module": "/src/internal/zinc-element"
|
|
53
|
+
},
|
|
54
|
+
"summary": "Short summary of the component's intended use.",
|
|
55
|
+
"tagNameWithoutPrefix": "action-bar",
|
|
56
|
+
"tagName": "zn-action-bar",
|
|
57
|
+
"customElement": true,
|
|
58
|
+
"jsDoc": "/**\n * @summary Short summary of the component's intended use.\n * @documentation https://zinc.style/components/action-bar\n * @status experimental\n * @since 1.0\n *\n * @dependency zn-example\n *\n * @event zn-event-name - Emitted as an example.\n *\n * @slot - The default slot.\n * @slot example - An example slot.\n *\n * @csspart base - The component's base wrapper.\n *\n * @cssproperty --example - An example CSS custom property.\n */",
|
|
59
|
+
"documentation": "https://zinc.style/components/action-bar",
|
|
60
|
+
"status": "experimental",
|
|
61
|
+
"since": "1.0",
|
|
62
|
+
"dependencies": [
|
|
63
|
+
"zn-example"
|
|
64
|
+
]
|
|
65
|
+
}
|
|
66
|
+
],
|
|
67
|
+
"exports": [
|
|
68
|
+
{
|
|
69
|
+
"kind": "js",
|
|
70
|
+
"name": "default",
|
|
71
|
+
"declaration": {
|
|
72
|
+
"name": "ZnActionBar",
|
|
73
|
+
"module": "components/action-bar/action-bar.js"
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
]
|
|
77
|
+
},
|
|
5
78
|
{
|
|
6
79
|
"kind": "javascript-module",
|
|
7
80
|
"path": "components/absolute-container/absolute-container.js",
|
|
@@ -250,79 +323,6 @@
|
|
|
250
323
|
}
|
|
251
324
|
]
|
|
252
325
|
},
|
|
253
|
-
{
|
|
254
|
-
"kind": "javascript-module",
|
|
255
|
-
"path": "components/action-bar/action-bar.js",
|
|
256
|
-
"declarations": [
|
|
257
|
-
{
|
|
258
|
-
"kind": "class",
|
|
259
|
-
"description": "",
|
|
260
|
-
"name": "ZnActionBar",
|
|
261
|
-
"cssProperties": [
|
|
262
|
-
{
|
|
263
|
-
"description": "An example CSS custom property.",
|
|
264
|
-
"name": "--example"
|
|
265
|
-
}
|
|
266
|
-
],
|
|
267
|
-
"cssParts": [
|
|
268
|
-
{
|
|
269
|
-
"description": "The component's base wrapper.",
|
|
270
|
-
"name": "base"
|
|
271
|
-
}
|
|
272
|
-
],
|
|
273
|
-
"slots": [
|
|
274
|
-
{
|
|
275
|
-
"description": "The default slot.",
|
|
276
|
-
"name": ""
|
|
277
|
-
},
|
|
278
|
-
{
|
|
279
|
-
"description": "An example slot.",
|
|
280
|
-
"name": "example"
|
|
281
|
-
}
|
|
282
|
-
],
|
|
283
|
-
"members": [
|
|
284
|
-
{
|
|
285
|
-
"kind": "field",
|
|
286
|
-
"name": "localize",
|
|
287
|
-
"privacy": "private",
|
|
288
|
-
"readonly": true,
|
|
289
|
-
"default": "new LocalizeController(this)"
|
|
290
|
-
}
|
|
291
|
-
],
|
|
292
|
-
"events": [
|
|
293
|
-
{
|
|
294
|
-
"description": "Emitted as an example.",
|
|
295
|
-
"name": "zn-event-name"
|
|
296
|
-
}
|
|
297
|
-
],
|
|
298
|
-
"superclass": {
|
|
299
|
-
"name": "ZincElement",
|
|
300
|
-
"module": "/src/internal/zinc-element"
|
|
301
|
-
},
|
|
302
|
-
"summary": "Short summary of the component's intended use.",
|
|
303
|
-
"tagNameWithoutPrefix": "action-bar",
|
|
304
|
-
"tagName": "zn-action-bar",
|
|
305
|
-
"customElement": true,
|
|
306
|
-
"jsDoc": "/**\n * @summary Short summary of the component's intended use.\n * @documentation https://zinc.style/components/action-bar\n * @status experimental\n * @since 1.0\n *\n * @dependency zn-example\n *\n * @event zn-event-name - Emitted as an example.\n *\n * @slot - The default slot.\n * @slot example - An example slot.\n *\n * @csspart base - The component's base wrapper.\n *\n * @cssproperty --example - An example CSS custom property.\n */",
|
|
307
|
-
"documentation": "https://zinc.style/components/action-bar",
|
|
308
|
-
"status": "experimental",
|
|
309
|
-
"since": "1.0",
|
|
310
|
-
"dependencies": [
|
|
311
|
-
"zn-example"
|
|
312
|
-
]
|
|
313
|
-
}
|
|
314
|
-
],
|
|
315
|
-
"exports": [
|
|
316
|
-
{
|
|
317
|
-
"kind": "js",
|
|
318
|
-
"name": "default",
|
|
319
|
-
"declaration": {
|
|
320
|
-
"name": "ZnActionBar",
|
|
321
|
-
"module": "components/action-bar/action-bar.js"
|
|
322
|
-
}
|
|
323
|
-
}
|
|
324
|
-
]
|
|
325
|
-
},
|
|
326
326
|
{
|
|
327
327
|
"kind": "javascript-module",
|
|
328
328
|
"path": "components/animated-button/animated-button.js",
|
|
@@ -31410,502 +31410,535 @@
|
|
|
31410
31410
|
},
|
|
31411
31411
|
{
|
|
31412
31412
|
"kind": "javascript-module",
|
|
31413
|
-
"path": "components/
|
|
31413
|
+
"path": "components/popup/popup.js",
|
|
31414
31414
|
"declarations": [
|
|
31415
31415
|
{
|
|
31416
31416
|
"kind": "class",
|
|
31417
31417
|
"description": "",
|
|
31418
|
-
"name": "
|
|
31418
|
+
"name": "ZnPopup",
|
|
31419
31419
|
"cssProperties": [
|
|
31420
31420
|
{
|
|
31421
|
-
"description": "
|
|
31422
|
-
"name": "--
|
|
31423
|
-
},
|
|
31424
|
-
{
|
|
31425
|
-
"description": "Opacity of the backdrop dots (`backdrop=\"dots\"`). Defaults to 0.08.",
|
|
31426
|
-
"name": "--zn-preview-frame-dot-opacity"
|
|
31421
|
+
"description": "An example CSS custom property.",
|
|
31422
|
+
"name": "--example"
|
|
31427
31423
|
}
|
|
31428
31424
|
],
|
|
31429
31425
|
"cssParts": [
|
|
31430
31426
|
{
|
|
31431
31427
|
"description": "The component's base wrapper.",
|
|
31432
31428
|
"name": "base"
|
|
31433
|
-
}
|
|
31434
|
-
|
|
31435
|
-
|
|
31436
|
-
"name": "stage"
|
|
31437
|
-
},
|
|
31429
|
+
}
|
|
31430
|
+
],
|
|
31431
|
+
"slots": [
|
|
31438
31432
|
{
|
|
31439
|
-
"description": "The
|
|
31440
|
-
"name": "
|
|
31433
|
+
"description": "The default slot.",
|
|
31434
|
+
"name": ""
|
|
31441
31435
|
},
|
|
31442
31436
|
{
|
|
31443
|
-
"description": "
|
|
31444
|
-
"name": "
|
|
31437
|
+
"description": "An example slot.",
|
|
31438
|
+
"name": "example"
|
|
31445
31439
|
}
|
|
31446
31440
|
],
|
|
31447
31441
|
"members": [
|
|
31448
31442
|
{
|
|
31449
31443
|
"kind": "field",
|
|
31450
|
-
"name": "
|
|
31444
|
+
"name": "anchorEl",
|
|
31451
31445
|
"type": {
|
|
31452
|
-
"text": "
|
|
31446
|
+
"text": "Element | VirtualElement | null"
|
|
31453
31447
|
},
|
|
31454
|
-
"
|
|
31455
|
-
"description": "URL of the preview shell page (tokened embed URL).",
|
|
31456
|
-
"attribute": "src"
|
|
31448
|
+
"privacy": "private"
|
|
31457
31449
|
},
|
|
31458
31450
|
{
|
|
31459
31451
|
"kind": "field",
|
|
31460
|
-
"name": "
|
|
31452
|
+
"name": "cleanup",
|
|
31461
31453
|
"type": {
|
|
31462
|
-
"text": "
|
|
31454
|
+
"text": "ReturnType<typeof autoUpdate> | undefined"
|
|
31463
31455
|
},
|
|
31464
|
-
"
|
|
31465
|
-
"description": "Expected origin of the iframe; all postMessage traffic is checked against it.",
|
|
31466
|
-
"attribute": "frame-origin"
|
|
31456
|
+
"privacy": "private"
|
|
31467
31457
|
},
|
|
31468
31458
|
{
|
|
31469
31459
|
"kind": "field",
|
|
31470
|
-
"name": "
|
|
31460
|
+
"name": "popup",
|
|
31471
31461
|
"type": {
|
|
31472
|
-
"text": "
|
|
31462
|
+
"text": "HTMLElement"
|
|
31473
31463
|
},
|
|
31474
|
-
"
|
|
31475
|
-
"description": "Endpoint returning the hp-preview:config payload JSON. The console proxy rewrites this attribute to an app-prefixed path for proper fetch resolution.",
|
|
31476
|
-
"attribute": "data-uri"
|
|
31464
|
+
"description": "A reference to the internal popup container. Useful for animating and styling the popup with JavaScript."
|
|
31477
31465
|
},
|
|
31478
31466
|
{
|
|
31479
31467
|
"kind": "field",
|
|
31480
|
-
"name": "
|
|
31468
|
+
"name": "arrowEl",
|
|
31481
31469
|
"type": {
|
|
31482
|
-
"text": "
|
|
31470
|
+
"text": "HTMLElement"
|
|
31483
31471
|
},
|
|
31484
|
-
"
|
|
31485
|
-
"description": "Selector (resolved against the component's root node) for the forms to watch.\nDefaults to only forms explicitly opted in via a `data-auto-save` attribute —\nunmarked forms keep normal submit behavior and are never intercepted,\nauto-saved, or used to trigger a preview refresh. Override to widen the scope.",
|
|
31486
|
-
"attribute": "watch"
|
|
31472
|
+
"privacy": "private"
|
|
31487
31473
|
},
|
|
31488
31474
|
{
|
|
31489
31475
|
"kind": "field",
|
|
31490
|
-
"name": "
|
|
31476
|
+
"name": "anchor",
|
|
31491
31477
|
"type": {
|
|
31492
|
-
"text": "string"
|
|
31478
|
+
"text": "Element | string | VirtualElement"
|
|
31493
31479
|
},
|
|
31494
|
-
"
|
|
31495
|
-
"
|
|
31496
|
-
"attribute": "refresh-on"
|
|
31480
|
+
"description": "The element the popup will be anchored to. If the anchor lives outside of the popup, you can provide the anchor\nelement `id`, a DOM element reference, or a `VirtualElement`. If the anchor lives inside the popup, use the\n`anchor` slot instead.",
|
|
31481
|
+
"attribute": "anchor"
|
|
31497
31482
|
},
|
|
31498
31483
|
{
|
|
31499
31484
|
"kind": "field",
|
|
31500
|
-
"name": "
|
|
31485
|
+
"name": "active",
|
|
31501
31486
|
"type": {
|
|
31502
|
-
"text": "
|
|
31487
|
+
"text": "boolean"
|
|
31503
31488
|
},
|
|
31504
|
-
"default": "
|
|
31505
|
-
"description": "
|
|
31506
|
-
"attribute": "
|
|
31489
|
+
"default": "false",
|
|
31490
|
+
"description": "Activates the positioning logic and shows the popup. When this attribute is removed, the positioning logic is torn\ndown and the popup will be hidden.",
|
|
31491
|
+
"attribute": "active",
|
|
31492
|
+
"reflects": true
|
|
31507
31493
|
},
|
|
31508
31494
|
{
|
|
31509
31495
|
"kind": "field",
|
|
31510
|
-
"name": "
|
|
31496
|
+
"name": "placement",
|
|
31497
|
+
"type": {
|
|
31498
|
+
"text": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'left'\n | 'left-start'\n | 'left-end'"
|
|
31499
|
+
},
|
|
31500
|
+
"default": "'top'",
|
|
31501
|
+
"description": "The preferred placement of the popup. Note that the actual placement will vary as configured to keep the\npanel inside of the viewport.",
|
|
31502
|
+
"attribute": "placement",
|
|
31503
|
+
"reflects": true
|
|
31504
|
+
},
|
|
31505
|
+
{
|
|
31506
|
+
"kind": "field",
|
|
31507
|
+
"name": "strategy",
|
|
31508
|
+
"type": {
|
|
31509
|
+
"text": "'absolute' | 'fixed'"
|
|
31510
|
+
},
|
|
31511
|
+
"default": "'fixed'",
|
|
31512
|
+
"description": "Determines how the popup is positioned. The `absolute` strategy works well in most cases, but if overflow is\nclipped, using a `fixed` position strategy can often workaround it.",
|
|
31513
|
+
"attribute": "strategy",
|
|
31514
|
+
"reflects": true
|
|
31515
|
+
},
|
|
31516
|
+
{
|
|
31517
|
+
"kind": "field",
|
|
31518
|
+
"name": "distance",
|
|
31511
31519
|
"type": {
|
|
31512
31520
|
"text": "number"
|
|
31513
31521
|
},
|
|
31514
|
-
"default": "
|
|
31515
|
-
"description": "
|
|
31516
|
-
"attribute": "
|
|
31522
|
+
"default": "0",
|
|
31523
|
+
"description": "The distance in pixels from which to offset the panel away from its anchor.",
|
|
31524
|
+
"attribute": "distance"
|
|
31517
31525
|
},
|
|
31518
31526
|
{
|
|
31519
31527
|
"kind": "field",
|
|
31520
|
-
"name": "
|
|
31528
|
+
"name": "skidding",
|
|
31521
31529
|
"type": {
|
|
31522
31530
|
"text": "number"
|
|
31523
31531
|
},
|
|
31524
|
-
"default": "
|
|
31525
|
-
"description": "The
|
|
31526
|
-
"attribute": "
|
|
31532
|
+
"default": "0",
|
|
31533
|
+
"description": "The distance in pixels from which to offset the panel along its anchor.",
|
|
31534
|
+
"attribute": "skidding"
|
|
31527
31535
|
},
|
|
31528
31536
|
{
|
|
31529
31537
|
"kind": "field",
|
|
31530
|
-
"name": "
|
|
31538
|
+
"name": "arrow",
|
|
31531
31539
|
"type": {
|
|
31532
31540
|
"text": "boolean"
|
|
31533
31541
|
},
|
|
31534
31542
|
"default": "false",
|
|
31535
|
-
"description": "
|
|
31536
|
-
"attribute": "
|
|
31543
|
+
"description": "Attaches an arrow to the popup. The arrow's size and color can be customized using the `--arrow-size` and\n`--arrow-color` custom properties. For additional customizations, you can also target the arrow using\n`::part(arrow)` in your stylesheet.",
|
|
31544
|
+
"attribute": "arrow"
|
|
31537
31545
|
},
|
|
31538
31546
|
{
|
|
31539
31547
|
"kind": "field",
|
|
31540
|
-
"name": "
|
|
31548
|
+
"name": "arrowPlacement",
|
|
31541
31549
|
"type": {
|
|
31542
|
-
"text": "
|
|
31550
|
+
"text": "'start' | 'end' | 'center' | 'anchor'"
|
|
31543
31551
|
},
|
|
31544
|
-
"default": "'
|
|
31545
|
-
"description": "
|
|
31546
|
-
"attribute": "
|
|
31547
|
-
"reflects": true
|
|
31552
|
+
"default": "'anchor'",
|
|
31553
|
+
"description": "The placement of the arrow. The default is `anchor`, which will align the arrow as close to the center of the\nanchor as possible, considering available space and `arrow-padding`. A value of `start`, `end`, or `center` will\nalign the arrow to the start, end, or center of the popover instead.",
|
|
31554
|
+
"attribute": "arrow-placement"
|
|
31548
31555
|
},
|
|
31549
31556
|
{
|
|
31550
31557
|
"kind": "field",
|
|
31551
|
-
"name": "
|
|
31558
|
+
"name": "arrowPadding",
|
|
31552
31559
|
"type": {
|
|
31553
|
-
"text": "
|
|
31560
|
+
"text": "number"
|
|
31554
31561
|
},
|
|
31555
|
-
"default": "
|
|
31556
|
-
"description": "
|
|
31557
|
-
"attribute": "
|
|
31558
|
-
"reflects": true
|
|
31562
|
+
"default": "10",
|
|
31563
|
+
"description": "The amount of padding between the arrow and the edges of the popup. If the popup has a border-radius, for example,\nthis will prevent it from overflowing the corners.",
|
|
31564
|
+
"attribute": "arrow-padding"
|
|
31559
31565
|
},
|
|
31560
31566
|
{
|
|
31561
31567
|
"kind": "field",
|
|
31562
|
-
"name": "
|
|
31568
|
+
"name": "flip",
|
|
31563
31569
|
"type": {
|
|
31564
31570
|
"text": "boolean"
|
|
31565
31571
|
},
|
|
31566
31572
|
"default": "false",
|
|
31567
|
-
"description": "
|
|
31568
|
-
"attribute": "
|
|
31569
|
-
"reflects": true
|
|
31573
|
+
"description": "When set, placement of the popup will flip to the opposite site to keep it in view. You can use\n`flipFallbackPlacements` to further configure how the fallback placement is determined.",
|
|
31574
|
+
"attribute": "flip"
|
|
31570
31575
|
},
|
|
31571
31576
|
{
|
|
31572
31577
|
"kind": "field",
|
|
31573
|
-
"name": "
|
|
31578
|
+
"name": "flipFallbackPlacements",
|
|
31574
31579
|
"type": {
|
|
31575
|
-
"text": "
|
|
31576
|
-
}
|
|
31580
|
+
"text": "string"
|
|
31581
|
+
},
|
|
31582
|
+
"default": "''",
|
|
31583
|
+
"description": "If the preferred placement doesn't fit, popup will be tested in these fallback placements until one fits. Must be a\nstring of any number of placements separated by a space, e.g. \"top bottom left\". If no placement fits, the flip\nfallback strategy will be used instead.",
|
|
31584
|
+
"attribute": "flip-fallback-placements"
|
|
31577
31585
|
},
|
|
31578
31586
|
{
|
|
31579
31587
|
"kind": "field",
|
|
31580
|
-
"name": "
|
|
31588
|
+
"name": "flipFallbackStrategy",
|
|
31581
31589
|
"type": {
|
|
31582
|
-
"text": "
|
|
31590
|
+
"text": "'best-fit' | 'initial'"
|
|
31583
31591
|
},
|
|
31584
|
-
"
|
|
31585
|
-
"
|
|
31592
|
+
"default": "'best-fit'",
|
|
31593
|
+
"description": "When neither the preferred placement nor the fallback placements fit, this value will be used to determine whether\nthe popup should be positioned using the best available fit based on available space or as it was initially\npreferred.",
|
|
31594
|
+
"attribute": "flip-fallback-strategy"
|
|
31586
31595
|
},
|
|
31587
31596
|
{
|
|
31588
31597
|
"kind": "field",
|
|
31589
|
-
"name": "
|
|
31598
|
+
"name": "flipBoundary",
|
|
31590
31599
|
"type": {
|
|
31591
|
-
"text": "
|
|
31600
|
+
"text": "Element | Element[]"
|
|
31592
31601
|
},
|
|
31593
|
-
"
|
|
31594
|
-
"
|
|
31595
|
-
"description": "Height of the embedded page's content, when it's known: reported by the\nembed (`height` on hp-preview:rendered, or an hp-preview:height message) or\nmeasured directly for a same-origin embed. The frame is laid out at this\nheight rather than the panel's, so the page never scrolls inside the frame\n— the panel scrolls instead, which is what makes an overflowing preview\nreachable while pointer input to the frame is blocked. 0 = unknown, and the\nframe falls back to filling the panel. Kept up to date either way, but only\nlaid out when the frame is inert: an `interactive` frame scrolls itself."
|
|
31602
|
+
"description": "The flip boundary describes clipping element(s) that overflow will be checked relative to when flipping. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
|
|
31603
|
+
"attribute": "flipBoundary"
|
|
31596
31604
|
},
|
|
31597
31605
|
{
|
|
31598
31606
|
"kind": "field",
|
|
31599
|
-
"name": "
|
|
31607
|
+
"name": "flipPadding",
|
|
31600
31608
|
"type": {
|
|
31601
31609
|
"text": "number"
|
|
31602
31610
|
},
|
|
31603
|
-
"
|
|
31604
|
-
"
|
|
31611
|
+
"default": "0",
|
|
31612
|
+
"description": "The amount of padding, in pixels, to exceed before the flip behavior will occur.",
|
|
31613
|
+
"attribute": "flip-padding"
|
|
31605
31614
|
},
|
|
31606
31615
|
{
|
|
31607
31616
|
"kind": "field",
|
|
31608
|
-
"name": "
|
|
31617
|
+
"name": "shift",
|
|
31609
31618
|
"type": {
|
|
31610
|
-
"text": "
|
|
31619
|
+
"text": "boolean"
|
|
31611
31620
|
},
|
|
31612
|
-
"
|
|
31621
|
+
"default": "false",
|
|
31622
|
+
"description": "Moves the popup along the axis to keep it in view when clipped.",
|
|
31623
|
+
"attribute": "shift"
|
|
31613
31624
|
},
|
|
31614
31625
|
{
|
|
31615
31626
|
"kind": "field",
|
|
31616
|
-
"name": "
|
|
31627
|
+
"name": "shiftBoundary",
|
|
31617
31628
|
"type": {
|
|
31618
|
-
"text": "
|
|
31629
|
+
"text": "Element | Element[]"
|
|
31619
31630
|
},
|
|
31620
|
-
"
|
|
31631
|
+
"description": "The shift boundary describes clipping element(s) that overflow will be checked relative to when shifting. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
|
|
31632
|
+
"attribute": "shiftBoundary"
|
|
31621
31633
|
},
|
|
31622
31634
|
{
|
|
31623
31635
|
"kind": "field",
|
|
31624
|
-
"name": "
|
|
31625
|
-
"
|
|
31626
|
-
|
|
31627
|
-
|
|
31636
|
+
"name": "shiftPadding",
|
|
31637
|
+
"type": {
|
|
31638
|
+
"text": "number"
|
|
31639
|
+
},
|
|
31640
|
+
"default": "0",
|
|
31641
|
+
"description": "The amount of padding, in pixels, to exceed before the shift behavior will occur.",
|
|
31642
|
+
"attribute": "shift-padding"
|
|
31628
31643
|
},
|
|
31629
31644
|
{
|
|
31630
31645
|
"kind": "field",
|
|
31631
|
-
"name": "
|
|
31632
|
-
"
|
|
31633
|
-
|
|
31634
|
-
|
|
31646
|
+
"name": "autoSize",
|
|
31647
|
+
"type": {
|
|
31648
|
+
"text": "'horizontal' | 'vertical' | 'both'"
|
|
31649
|
+
},
|
|
31650
|
+
"description": "When set, this will cause the popup to automatically resize itself to prevent it from overflowing.",
|
|
31651
|
+
"attribute": "auto-size"
|
|
31635
31652
|
},
|
|
31636
31653
|
{
|
|
31637
31654
|
"kind": "field",
|
|
31638
|
-
"name": "
|
|
31655
|
+
"name": "sync",
|
|
31639
31656
|
"type": {
|
|
31640
|
-
"text": "
|
|
31657
|
+
"text": "'width' | 'height' | 'both'"
|
|
31641
31658
|
},
|
|
31642
|
-
"
|
|
31643
|
-
"
|
|
31659
|
+
"description": "Syncs the popup's width or height to that of the anchor element.",
|
|
31660
|
+
"attribute": "sync"
|
|
31644
31661
|
},
|
|
31645
31662
|
{
|
|
31646
31663
|
"kind": "field",
|
|
31647
|
-
"name": "
|
|
31664
|
+
"name": "autoSizeBoundary",
|
|
31648
31665
|
"type": {
|
|
31649
|
-
"text": "
|
|
31666
|
+
"text": "Element | Element[]"
|
|
31650
31667
|
},
|
|
31651
|
-
"
|
|
31668
|
+
"description": "The auto-size boundary describes clipping element(s) that overflow will be checked relative to when resizing. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
|
|
31669
|
+
"attribute": "autoSizeBoundary"
|
|
31652
31670
|
},
|
|
31653
31671
|
{
|
|
31654
31672
|
"kind": "field",
|
|
31655
|
-
"name": "
|
|
31656
|
-
"
|
|
31657
|
-
|
|
31658
|
-
|
|
31673
|
+
"name": "autoSizePadding",
|
|
31674
|
+
"type": {
|
|
31675
|
+
"text": "number"
|
|
31676
|
+
},
|
|
31677
|
+
"default": "0",
|
|
31678
|
+
"description": "The amount of padding, in pixels, to exceed before the auto-size behavior will occur.",
|
|
31679
|
+
"attribute": "auto-size-padding"
|
|
31659
31680
|
},
|
|
31660
31681
|
{
|
|
31661
31682
|
"kind": "field",
|
|
31662
|
-
"name": "
|
|
31663
|
-
"
|
|
31664
|
-
|
|
31665
|
-
|
|
31666
|
-
|
|
31667
|
-
"
|
|
31668
|
-
"
|
|
31669
|
-
"privacy": "private",
|
|
31670
|
-
"parameters": [
|
|
31671
|
-
{
|
|
31672
|
-
"name": "height",
|
|
31673
|
-
"type": {
|
|
31674
|
-
"text": "unknown"
|
|
31675
|
-
}
|
|
31676
|
-
}
|
|
31677
|
-
]
|
|
31683
|
+
"name": "hoverBridge",
|
|
31684
|
+
"type": {
|
|
31685
|
+
"text": "boolean"
|
|
31686
|
+
},
|
|
31687
|
+
"default": "false",
|
|
31688
|
+
"description": "When a gap exists between the anchor and the popup element, this option will add a \"hover bridge\" that fills the\ngap using an invisible element. This makes listening for events such as `mouseenter` and `mouseleave` more sane\nbecause the pointer never technically leaves the element. The hover bridge will only be drawn when the popover is\nactive.",
|
|
31689
|
+
"attribute": "hover-bridge"
|
|
31678
31690
|
},
|
|
31679
31691
|
{
|
|
31680
31692
|
"kind": "method",
|
|
31681
|
-
"name": "
|
|
31693
|
+
"name": "handleAnchorChange",
|
|
31682
31694
|
"privacy": "private"
|
|
31683
31695
|
},
|
|
31684
31696
|
{
|
|
31685
31697
|
"kind": "field",
|
|
31686
|
-
"name": "
|
|
31687
|
-
"privacy": "
|
|
31688
|
-
"readonly": true
|
|
31698
|
+
"name": "handleAnchorHover",
|
|
31699
|
+
"privacy": "public"
|
|
31689
31700
|
},
|
|
31690
31701
|
{
|
|
31691
31702
|
"kind": "method",
|
|
31692
|
-
"name": "
|
|
31693
|
-
"
|
|
31703
|
+
"name": "start",
|
|
31704
|
+
"privacy": "private"
|
|
31694
31705
|
},
|
|
31695
31706
|
{
|
|
31696
31707
|
"kind": "method",
|
|
31697
|
-
"name": "
|
|
31698
|
-
"
|
|
31699
|
-
|
|
31700
|
-
|
|
31701
|
-
"
|
|
31702
|
-
"text": "Record<string, unknown>"
|
|
31703
|
-
}
|
|
31708
|
+
"name": "stop",
|
|
31709
|
+
"privacy": "private",
|
|
31710
|
+
"return": {
|
|
31711
|
+
"type": {
|
|
31712
|
+
"text": "Promise<void>"
|
|
31704
31713
|
}
|
|
31705
|
-
|
|
31706
|
-
"description": "Pushes a theme payload into the preview. The payload is retained and\nre-posted after every ready handshake, so a frame reload doesn't drop an\nin-progress theme."
|
|
31714
|
+
}
|
|
31707
31715
|
},
|
|
31708
31716
|
{
|
|
31709
31717
|
"kind": "method",
|
|
31710
|
-
"name": "
|
|
31711
|
-
"
|
|
31718
|
+
"name": "reposition",
|
|
31719
|
+
"description": "Forces the popup to recalculate and reposition itself."
|
|
31712
31720
|
},
|
|
31713
31721
|
{
|
|
31714
|
-
"kind": "
|
|
31715
|
-
"name": "
|
|
31722
|
+
"kind": "field",
|
|
31723
|
+
"name": "updateHoverBridge",
|
|
31716
31724
|
"privacy": "private"
|
|
31717
|
-
}
|
|
31725
|
+
}
|
|
31726
|
+
],
|
|
31727
|
+
"events": [
|
|
31718
31728
|
{
|
|
31719
|
-
"
|
|
31720
|
-
"name": "
|
|
31721
|
-
|
|
31729
|
+
"description": "Emitted as an example.",
|
|
31730
|
+
"name": "zn-event-name"
|
|
31731
|
+
}
|
|
31732
|
+
],
|
|
31733
|
+
"attributes": [
|
|
31734
|
+
{
|
|
31735
|
+
"name": "anchor",
|
|
31736
|
+
"type": {
|
|
31737
|
+
"text": "Element | string | VirtualElement"
|
|
31738
|
+
},
|
|
31739
|
+
"description": "The element the popup will be anchored to. If the anchor lives outside of the popup, you can provide the anchor\nelement `id`, a DOM element reference, or a `VirtualElement`. If the anchor lives inside the popup, use the\n`anchor` slot instead.",
|
|
31740
|
+
"fieldName": "anchor"
|
|
31722
31741
|
},
|
|
31723
31742
|
{
|
|
31724
|
-
"
|
|
31725
|
-
"
|
|
31726
|
-
|
|
31727
|
-
|
|
31743
|
+
"name": "active",
|
|
31744
|
+
"type": {
|
|
31745
|
+
"text": "boolean"
|
|
31746
|
+
},
|
|
31747
|
+
"default": "false",
|
|
31748
|
+
"description": "Activates the positioning logic and shows the popup. When this attribute is removed, the positioning logic is torn\ndown and the popup will be hidden.",
|
|
31749
|
+
"fieldName": "active"
|
|
31728
31750
|
},
|
|
31729
31751
|
{
|
|
31730
|
-
"
|
|
31731
|
-
"
|
|
31732
|
-
|
|
31733
|
-
|
|
31734
|
-
|
|
31735
|
-
|
|
31736
|
-
|
|
31737
|
-
"text": "HTMLFormElement"
|
|
31738
|
-
}
|
|
31739
|
-
}
|
|
31740
|
-
]
|
|
31752
|
+
"name": "placement",
|
|
31753
|
+
"type": {
|
|
31754
|
+
"text": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'left'\n | 'left-start'\n | 'left-end'"
|
|
31755
|
+
},
|
|
31756
|
+
"default": "'top'",
|
|
31757
|
+
"description": "The preferred placement of the popup. Note that the actual placement will vary as configured to keep the\npanel inside of the viewport.",
|
|
31758
|
+
"fieldName": "placement"
|
|
31741
31759
|
},
|
|
31742
31760
|
{
|
|
31743
|
-
"
|
|
31744
|
-
"
|
|
31745
|
-
|
|
31746
|
-
|
|
31761
|
+
"name": "strategy",
|
|
31762
|
+
"type": {
|
|
31763
|
+
"text": "'absolute' | 'fixed'"
|
|
31764
|
+
},
|
|
31765
|
+
"default": "'fixed'",
|
|
31766
|
+
"description": "Determines how the popup is positioned. The `absolute` strategy works well in most cases, but if overflow is\nclipped, using a `fixed` position strategy can often workaround it.",
|
|
31767
|
+
"fieldName": "strategy"
|
|
31747
31768
|
},
|
|
31748
31769
|
{
|
|
31749
|
-
"
|
|
31750
|
-
"
|
|
31751
|
-
|
|
31752
|
-
|
|
31770
|
+
"name": "distance",
|
|
31771
|
+
"type": {
|
|
31772
|
+
"text": "number"
|
|
31773
|
+
},
|
|
31774
|
+
"default": "0",
|
|
31775
|
+
"description": "The distance in pixels from which to offset the panel away from its anchor.",
|
|
31776
|
+
"fieldName": "distance"
|
|
31753
31777
|
},
|
|
31754
31778
|
{
|
|
31755
|
-
"
|
|
31756
|
-
"
|
|
31757
|
-
|
|
31758
|
-
|
|
31759
|
-
|
|
31760
|
-
|
|
31761
|
-
|
|
31762
|
-
"text": "HTMLFormElement"
|
|
31763
|
-
}
|
|
31764
|
-
}
|
|
31765
|
-
]
|
|
31779
|
+
"name": "skidding",
|
|
31780
|
+
"type": {
|
|
31781
|
+
"text": "number"
|
|
31782
|
+
},
|
|
31783
|
+
"default": "0",
|
|
31784
|
+
"description": "The distance in pixels from which to offset the panel along its anchor.",
|
|
31785
|
+
"fieldName": "skidding"
|
|
31766
31786
|
},
|
|
31767
31787
|
{
|
|
31768
|
-
"
|
|
31769
|
-
"
|
|
31770
|
-
|
|
31771
|
-
|
|
31772
|
-
|
|
31773
|
-
|
|
31774
|
-
|
|
31775
|
-
|
|
31776
|
-
}
|
|
31777
|
-
}
|
|
31778
|
-
]
|
|
31779
|
-
}
|
|
31780
|
-
],
|
|
31781
|
-
"events": [
|
|
31788
|
+
"name": "arrow",
|
|
31789
|
+
"type": {
|
|
31790
|
+
"text": "boolean"
|
|
31791
|
+
},
|
|
31792
|
+
"default": "false",
|
|
31793
|
+
"description": "Attaches an arrow to the popup. The arrow's size and color can be customized using the `--arrow-size` and\n`--arrow-color` custom properties. For additional customizations, you can also target the arrow using\n`::part(arrow)` in your stylesheet.",
|
|
31794
|
+
"fieldName": "arrow"
|
|
31795
|
+
},
|
|
31782
31796
|
{
|
|
31783
|
-
"
|
|
31784
|
-
"
|
|
31785
|
-
|
|
31786
|
-
|
|
31787
|
-
|
|
31797
|
+
"name": "arrow-placement",
|
|
31798
|
+
"type": {
|
|
31799
|
+
"text": "'start' | 'end' | 'center' | 'anchor'"
|
|
31800
|
+
},
|
|
31801
|
+
"default": "'anchor'",
|
|
31802
|
+
"description": "The placement of the arrow. The default is `anchor`, which will align the arrow as close to the center of the\nanchor as possible, considering available space and `arrow-padding`. A value of `start`, `end`, or `center` will\nalign the arrow to the start, end, or center of the popover instead.",
|
|
31803
|
+
"fieldName": "arrowPlacement"
|
|
31804
|
+
},
|
|
31788
31805
|
{
|
|
31789
|
-
"name": "
|
|
31806
|
+
"name": "arrow-padding",
|
|
31790
31807
|
"type": {
|
|
31791
|
-
"text": "
|
|
31808
|
+
"text": "number"
|
|
31792
31809
|
},
|
|
31793
|
-
"default": "
|
|
31794
|
-
"description": "
|
|
31795
|
-
"fieldName": "
|
|
31810
|
+
"default": "10",
|
|
31811
|
+
"description": "The amount of padding between the arrow and the edges of the popup. If the popup has a border-radius, for example,\nthis will prevent it from overflowing the corners.",
|
|
31812
|
+
"fieldName": "arrowPadding"
|
|
31796
31813
|
},
|
|
31797
31814
|
{
|
|
31798
|
-
"name": "
|
|
31815
|
+
"name": "flip",
|
|
31799
31816
|
"type": {
|
|
31800
|
-
"text": "
|
|
31817
|
+
"text": "boolean"
|
|
31801
31818
|
},
|
|
31802
|
-
"default": "
|
|
31803
|
-
"description": "
|
|
31804
|
-
"fieldName": "
|
|
31819
|
+
"default": "false",
|
|
31820
|
+
"description": "When set, placement of the popup will flip to the opposite site to keep it in view. You can use\n`flipFallbackPlacements` to further configure how the fallback placement is determined.",
|
|
31821
|
+
"fieldName": "flip"
|
|
31805
31822
|
},
|
|
31806
31823
|
{
|
|
31807
|
-
"name": "
|
|
31824
|
+
"name": "flip-fallback-placements",
|
|
31808
31825
|
"type": {
|
|
31809
31826
|
"text": "string"
|
|
31810
31827
|
},
|
|
31811
31828
|
"default": "''",
|
|
31812
|
-
"description": "
|
|
31813
|
-
"fieldName": "
|
|
31829
|
+
"description": "If the preferred placement doesn't fit, popup will be tested in these fallback placements until one fits. Must be a\nstring of any number of placements separated by a space, e.g. \"top bottom left\". If no placement fits, the flip\nfallback strategy will be used instead.",
|
|
31830
|
+
"fieldName": "flipFallbackPlacements"
|
|
31814
31831
|
},
|
|
31815
31832
|
{
|
|
31816
|
-
"name": "
|
|
31833
|
+
"name": "flip-fallback-strategy",
|
|
31817
31834
|
"type": {
|
|
31818
|
-
"text": "
|
|
31835
|
+
"text": "'best-fit' | 'initial'"
|
|
31819
31836
|
},
|
|
31820
|
-
"default": "'
|
|
31821
|
-
"description": "
|
|
31822
|
-
"fieldName": "
|
|
31837
|
+
"default": "'best-fit'",
|
|
31838
|
+
"description": "When neither the preferred placement nor the fallback placements fit, this value will be used to determine whether\nthe popup should be positioned using the best available fit based on available space or as it was initially\npreferred.",
|
|
31839
|
+
"fieldName": "flipFallbackStrategy"
|
|
31823
31840
|
},
|
|
31824
31841
|
{
|
|
31825
|
-
"name": "
|
|
31842
|
+
"name": "flipBoundary",
|
|
31826
31843
|
"type": {
|
|
31827
|
-
"text": "
|
|
31844
|
+
"text": "Element | Element[]"
|
|
31828
31845
|
},
|
|
31829
|
-
"
|
|
31830
|
-
"
|
|
31831
|
-
"fieldName": "refreshOn"
|
|
31846
|
+
"description": "The flip boundary describes clipping element(s) that overflow will be checked relative to when flipping. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
|
|
31847
|
+
"fieldName": "flipBoundary"
|
|
31832
31848
|
},
|
|
31833
31849
|
{
|
|
31834
|
-
"name": "
|
|
31850
|
+
"name": "flip-padding",
|
|
31835
31851
|
"type": {
|
|
31836
31852
|
"text": "number"
|
|
31837
31853
|
},
|
|
31838
|
-
"default": "
|
|
31839
|
-
"description": "
|
|
31840
|
-
"fieldName": "
|
|
31854
|
+
"default": "0",
|
|
31855
|
+
"description": "The amount of padding, in pixels, to exceed before the flip behavior will occur.",
|
|
31856
|
+
"fieldName": "flipPadding"
|
|
31841
31857
|
},
|
|
31842
31858
|
{
|
|
31843
|
-
"name": "
|
|
31859
|
+
"name": "shift",
|
|
31844
31860
|
"type": {
|
|
31845
|
-
"text": "
|
|
31861
|
+
"text": "boolean"
|
|
31846
31862
|
},
|
|
31847
|
-
"default": "
|
|
31848
|
-
"description": "
|
|
31849
|
-
"fieldName": "
|
|
31863
|
+
"default": "false",
|
|
31864
|
+
"description": "Moves the popup along the axis to keep it in view when clipped.",
|
|
31865
|
+
"fieldName": "shift"
|
|
31850
31866
|
},
|
|
31851
31867
|
{
|
|
31852
|
-
"name": "
|
|
31868
|
+
"name": "shiftBoundary",
|
|
31869
|
+
"type": {
|
|
31870
|
+
"text": "Element | Element[]"
|
|
31871
|
+
},
|
|
31872
|
+
"description": "The shift boundary describes clipping element(s) that overflow will be checked relative to when shifting. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
|
|
31873
|
+
"fieldName": "shiftBoundary"
|
|
31874
|
+
},
|
|
31875
|
+
{
|
|
31876
|
+
"name": "shift-padding",
|
|
31853
31877
|
"type": {
|
|
31854
31878
|
"text": "number"
|
|
31855
31879
|
},
|
|
31856
|
-
"default": "
|
|
31857
|
-
"description": "The
|
|
31858
|
-
"fieldName": "
|
|
31880
|
+
"default": "0",
|
|
31881
|
+
"description": "The amount of padding, in pixels, to exceed before the shift behavior will occur.",
|
|
31882
|
+
"fieldName": "shiftPadding"
|
|
31859
31883
|
},
|
|
31860
31884
|
{
|
|
31861
|
-
"name": "
|
|
31885
|
+
"name": "auto-size",
|
|
31862
31886
|
"type": {
|
|
31863
|
-
"text": "
|
|
31887
|
+
"text": "'horizontal' | 'vertical' | 'both'"
|
|
31864
31888
|
},
|
|
31865
|
-
"
|
|
31866
|
-
"
|
|
31867
|
-
"fieldName": "fill"
|
|
31889
|
+
"description": "When set, this will cause the popup to automatically resize itself to prevent it from overflowing.",
|
|
31890
|
+
"fieldName": "autoSize"
|
|
31868
31891
|
},
|
|
31869
31892
|
{
|
|
31870
|
-
"name": "
|
|
31893
|
+
"name": "sync",
|
|
31871
31894
|
"type": {
|
|
31872
|
-
"text": "
|
|
31895
|
+
"text": "'width' | 'height' | 'both'"
|
|
31873
31896
|
},
|
|
31874
|
-
"
|
|
31875
|
-
"
|
|
31876
|
-
"fieldName": "device"
|
|
31897
|
+
"description": "Syncs the popup's width or height to that of the anchor element.",
|
|
31898
|
+
"fieldName": "sync"
|
|
31877
31899
|
},
|
|
31878
31900
|
{
|
|
31879
|
-
"name": "
|
|
31901
|
+
"name": "autoSizeBoundary",
|
|
31880
31902
|
"type": {
|
|
31881
|
-
"text": "
|
|
31903
|
+
"text": "Element | Element[]"
|
|
31882
31904
|
},
|
|
31883
|
-
"
|
|
31884
|
-
"
|
|
31885
|
-
"fieldName": "backdrop"
|
|
31905
|
+
"description": "The auto-size boundary describes clipping element(s) that overflow will be checked relative to when resizing. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
|
|
31906
|
+
"fieldName": "autoSizeBoundary"
|
|
31886
31907
|
},
|
|
31887
31908
|
{
|
|
31888
|
-
"name": "
|
|
31909
|
+
"name": "auto-size-padding",
|
|
31910
|
+
"type": {
|
|
31911
|
+
"text": "number"
|
|
31912
|
+
},
|
|
31913
|
+
"default": "0",
|
|
31914
|
+
"description": "The amount of padding, in pixels, to exceed before the auto-size behavior will occur.",
|
|
31915
|
+
"fieldName": "autoSizePadding"
|
|
31916
|
+
},
|
|
31917
|
+
{
|
|
31918
|
+
"name": "hover-bridge",
|
|
31889
31919
|
"type": {
|
|
31890
31920
|
"text": "boolean"
|
|
31891
31921
|
},
|
|
31892
31922
|
"default": "false",
|
|
31893
|
-
"description": "
|
|
31894
|
-
"fieldName": "
|
|
31923
|
+
"description": "When a gap exists between the anchor and the popup element, this option will add a \"hover bridge\" that fills the\ngap using an invisible element. This makes listening for events such as `mouseenter` and `mouseleave` more sane\nbecause the pointer never technically leaves the element. The hover bridge will only be drawn when the popover is\nactive.",
|
|
31924
|
+
"fieldName": "hoverBridge"
|
|
31895
31925
|
}
|
|
31896
31926
|
],
|
|
31897
31927
|
"superclass": {
|
|
31898
31928
|
"name": "ZincElement",
|
|
31899
31929
|
"module": "/src/internal/zinc-element"
|
|
31900
31930
|
},
|
|
31901
|
-
"summary": "
|
|
31902
|
-
"tagNameWithoutPrefix": "
|
|
31903
|
-
"tagName": "zn-
|
|
31931
|
+
"summary": "Short summary of the component's intended use.",
|
|
31932
|
+
"tagNameWithoutPrefix": "popup",
|
|
31933
|
+
"tagName": "zn-popup",
|
|
31904
31934
|
"customElement": true,
|
|
31905
|
-
"jsDoc": "/**\n * @summary
|
|
31906
|
-
"documentation": "https://zinc.style/components/
|
|
31935
|
+
"jsDoc": "/**\n * @summary Short summary of the component's intended use.\n * @documentation https://zinc.style/components/popup\n * @status experimental\n * @since 1.0\n *\n * @dependency zn-example\n *\n * @event zn-event-name - Emitted as an example.\n *\n * @slot - The default slot.\n * @slot example - An example slot.\n *\n * @csspart base - The component's base wrapper.\n *\n * @cssproperty --example - An example CSS custom property.\n */",
|
|
31936
|
+
"documentation": "https://zinc.style/components/popup",
|
|
31907
31937
|
"status": "experimental",
|
|
31908
|
-
"since": "1.0"
|
|
31938
|
+
"since": "1.0",
|
|
31939
|
+
"dependencies": [
|
|
31940
|
+
"zn-example"
|
|
31941
|
+
]
|
|
31909
31942
|
}
|
|
31910
31943
|
],
|
|
31911
31944
|
"exports": [
|
|
@@ -31913,652 +31946,510 @@
|
|
|
31913
31946
|
"kind": "js",
|
|
31914
31947
|
"name": "default",
|
|
31915
31948
|
"declaration": {
|
|
31916
|
-
"name": "
|
|
31917
|
-
"module": "components/
|
|
31949
|
+
"name": "ZnPopup",
|
|
31950
|
+
"module": "components/popup/popup.js"
|
|
31918
31951
|
}
|
|
31919
31952
|
}
|
|
31920
31953
|
]
|
|
31921
31954
|
},
|
|
31922
31955
|
{
|
|
31923
31956
|
"kind": "javascript-module",
|
|
31924
|
-
"path": "components/
|
|
31957
|
+
"path": "components/preview-frame/preview-frame.js",
|
|
31925
31958
|
"declarations": [
|
|
31926
31959
|
{
|
|
31927
31960
|
"kind": "class",
|
|
31928
31961
|
"description": "",
|
|
31929
|
-
"name": "
|
|
31962
|
+
"name": "ZnPreviewFrame",
|
|
31930
31963
|
"cssProperties": [
|
|
31931
31964
|
{
|
|
31932
|
-
"description": "
|
|
31933
|
-
"name": "--zn-
|
|
31934
|
-
},
|
|
31935
|
-
{
|
|
31936
|
-
"description": "The padding inside each item. Defaults to `var(--zn-spacing-small) var(--zn-spacing-medium)`.",
|
|
31937
|
-
"name": "--zn-priority-list-item-padding"
|
|
31938
|
-
},
|
|
31939
|
-
{
|
|
31940
|
-
"description": "The gap between an item's slotted actions. Defaults to `var(--zn-spacing-x-small)`.",
|
|
31941
|
-
"name": "--zn-priority-list-actions-gap"
|
|
31942
|
-
},
|
|
31943
|
-
{
|
|
31944
|
-
"description": "The color of the drag handle. Defaults to `var(--zn-color-neutral-500)`.",
|
|
31945
|
-
"name": "--zn-priority-list-handle-color"
|
|
31965
|
+
"description": "Spacing of the backdrop dot grid (`backdrop=\"dots\"`). Defaults to 20px.",
|
|
31966
|
+
"name": "--zn-preview-frame-dot-spacing"
|
|
31946
31967
|
},
|
|
31947
31968
|
{
|
|
31948
|
-
"description": "
|
|
31949
|
-
"name": "--zn-
|
|
31969
|
+
"description": "Opacity of the backdrop dots (`backdrop=\"dots\"`). Defaults to 0.08.",
|
|
31970
|
+
"name": "--zn-preview-frame-dot-opacity"
|
|
31950
31971
|
}
|
|
31951
31972
|
],
|
|
31952
31973
|
"cssParts": [
|
|
31953
31974
|
{
|
|
31954
|
-
"description": "The
|
|
31955
|
-
"name": "
|
|
31956
|
-
},
|
|
31957
|
-
{
|
|
31958
|
-
"description": "The label wrapper.",
|
|
31959
|
-
"name": "form-control-label"
|
|
31960
|
-
},
|
|
31961
|
-
{
|
|
31962
|
-
"description": "The input area wrapper.",
|
|
31963
|
-
"name": "form-control-input"
|
|
31964
|
-
},
|
|
31965
|
-
{
|
|
31966
|
-
"description": "The help text wrapper.",
|
|
31967
|
-
"name": "form-control-help-text"
|
|
31968
|
-
},
|
|
31969
|
-
{
|
|
31970
|
-
"description": "The list container.",
|
|
31971
|
-
"name": "list"
|
|
31972
|
-
},
|
|
31973
|
-
{
|
|
31974
|
-
"description": "An individual list item row.",
|
|
31975
|
-
"name": "item"
|
|
31976
|
-
},
|
|
31977
|
-
{
|
|
31978
|
-
"description": "The drag handle icon.",
|
|
31979
|
-
"name": "drag-handle"
|
|
31980
|
-
},
|
|
31981
|
-
{
|
|
31982
|
-
"description": "The priority number badge.",
|
|
31983
|
-
"name": "priority"
|
|
31984
|
-
},
|
|
31985
|
-
{
|
|
31986
|
-
"description": "The content area of an item.",
|
|
31987
|
-
"name": "content"
|
|
31988
|
-
}
|
|
31989
|
-
],
|
|
31990
|
-
"slots": [
|
|
31991
|
-
{
|
|
31992
|
-
"description": "The default slot where list items are placed. Each slotted element must have a `value` attribute that uniquely identifies the item. The component automatically assigns slot names to project each item into the correct position. The item's position in the list determines its priority (top = `priority-start`, incrementing).",
|
|
31993
|
-
"name": ""
|
|
31975
|
+
"description": "The component's base wrapper.",
|
|
31976
|
+
"name": "base"
|
|
31994
31977
|
},
|
|
31995
31978
|
{
|
|
31996
|
-
"description": "The
|
|
31997
|
-
"name": "
|
|
31979
|
+
"description": "The device-width wrapper around the iframe.",
|
|
31980
|
+
"name": "stage"
|
|
31998
31981
|
},
|
|
31999
31982
|
{
|
|
32000
|
-
"description": "
|
|
32001
|
-
"name": "
|
|
31983
|
+
"description": "The preview iframe.",
|
|
31984
|
+
"name": "iframe"
|
|
32002
31985
|
},
|
|
32003
31986
|
{
|
|
32004
|
-
"description": "
|
|
32005
|
-
"name": "
|
|
31987
|
+
"description": "The error overlay.",
|
|
31988
|
+
"name": "error"
|
|
32006
31989
|
}
|
|
32007
31990
|
],
|
|
32008
31991
|
"members": [
|
|
32009
31992
|
{
|
|
32010
31993
|
"kind": "field",
|
|
32011
|
-
"name": "
|
|
31994
|
+
"name": "src",
|
|
32012
31995
|
"type": {
|
|
32013
|
-
"text": "
|
|
31996
|
+
"text": "string"
|
|
32014
31997
|
},
|
|
32015
|
-
"
|
|
32016
|
-
"
|
|
32017
|
-
|
|
32018
|
-
{
|
|
32019
|
-
"kind": "field",
|
|
32020
|
-
"name": "formControlController",
|
|
32021
|
-
"privacy": "protected",
|
|
32022
|
-
"readonly": true,
|
|
32023
|
-
"default": "new FormControlController(this, { value: (control: ZnPriorityList) => { return JSON.stringify(control.getPriorityMap()); }, defaultValue: (control: ZnPriorityList) => control.defaultValue, // A form reset passes defaultValue straight back in, so this has to accept the // key array as well as the serialised value other callers set. setValue: (control: ZnPriorityList, value: string | string[]) => { if (!value || (Array.isArray(value) && value.length === 0)) return; const keys: unknown = Array.isArray(value) ? value : safeParse(value); if (Array.isArray(keys) && keys.every((item: unknown): item is string => typeof item === 'string')) { control.value = keys as string[]; } }, })"
|
|
32024
|
-
},
|
|
32025
|
-
{
|
|
32026
|
-
"kind": "field",
|
|
32027
|
-
"name": "hasSlotController",
|
|
32028
|
-
"privacy": "private",
|
|
32029
|
-
"readonly": true,
|
|
32030
|
-
"default": "new HasSlotController(this, 'help-text', 'label')"
|
|
31998
|
+
"default": "''",
|
|
31999
|
+
"description": "URL of the preview shell page (tokened embed URL).",
|
|
32000
|
+
"attribute": "src"
|
|
32031
32001
|
},
|
|
32032
32002
|
{
|
|
32033
32003
|
"kind": "field",
|
|
32034
|
-
"name": "
|
|
32004
|
+
"name": "frameOrigin",
|
|
32035
32005
|
"type": {
|
|
32036
|
-
"text": "
|
|
32037
|
-
}
|
|
32006
|
+
"text": "string"
|
|
32007
|
+
},
|
|
32008
|
+
"default": "''",
|
|
32009
|
+
"description": "Expected origin of the iframe; all postMessage traffic is checked against it.",
|
|
32010
|
+
"attribute": "frame-origin"
|
|
32038
32011
|
},
|
|
32039
32012
|
{
|
|
32040
32013
|
"kind": "field",
|
|
32041
|
-
"name": "
|
|
32014
|
+
"name": "dataUri",
|
|
32042
32015
|
"type": {
|
|
32043
32016
|
"text": "string"
|
|
32044
32017
|
},
|
|
32045
32018
|
"default": "''",
|
|
32046
|
-
"description": "
|
|
32047
|
-
"attribute": "
|
|
32019
|
+
"description": "Endpoint returning the hp-preview:config payload JSON. The console proxy rewrites this attribute to an app-prefixed path for proper fetch resolution.",
|
|
32020
|
+
"attribute": "data-uri"
|
|
32048
32021
|
},
|
|
32049
32022
|
{
|
|
32050
32023
|
"kind": "field",
|
|
32051
|
-
"name": "
|
|
32024
|
+
"name": "watch",
|
|
32052
32025
|
"type": {
|
|
32053
|
-
"text": "string
|
|
32026
|
+
"text": "string"
|
|
32054
32027
|
},
|
|
32055
|
-
"
|
|
32056
|
-
"
|
|
32028
|
+
"default": "'form[data-auto-save]'",
|
|
32029
|
+
"description": "Selector (resolved against the component's root node) for the forms to watch.\nDefaults to only forms explicitly opted in via a `data-auto-save` attribute —\nunmarked forms keep normal submit behavior and are never intercepted,\nauto-saved, or used to trigger a preview refresh. Override to widen the scope.",
|
|
32030
|
+
"attribute": "watch"
|
|
32057
32031
|
},
|
|
32058
32032
|
{
|
|
32059
32033
|
"kind": "field",
|
|
32060
|
-
"name": "
|
|
32034
|
+
"name": "refreshOn",
|
|
32061
32035
|
"type": {
|
|
32062
|
-
"text": "string
|
|
32036
|
+
"text": "string"
|
|
32063
32037
|
},
|
|
32064
|
-
"
|
|
32065
|
-
"
|
|
32038
|
+
"default": "'form'",
|
|
32039
|
+
"description": "Selector for forms whose saves are left to the shell but should still\nrefresh the preview. These are never intercepted: the shell submits them\n(so its own response handling — alerts, refreshes — runs as normal) and the\npreview re-fetches its config once the shell reports the save complete.\nMatched by delegation on the shell's bubbled `complete` event rather than\nby attaching to the forms themselves, so a save anywhere on the page\nrefreshes the preview — including forms in a different DOM root, e.g. a\npage-level form saved while the preview sits inside a tab panel's shadow\nroot (a page's Template select lives on one tab, its preview on another).\nSet empty to disable.",
|
|
32040
|
+
"attribute": "refresh-on"
|
|
32066
32041
|
},
|
|
32067
32042
|
{
|
|
32068
32043
|
"kind": "field",
|
|
32069
|
-
"name": "
|
|
32044
|
+
"name": "debounce",
|
|
32070
32045
|
"type": {
|
|
32071
|
-
"text": "
|
|
32046
|
+
"text": "number"
|
|
32072
32047
|
},
|
|
32073
|
-
"default": "
|
|
32048
|
+
"default": "400",
|
|
32049
|
+
"description": "Debounce in ms between a form change and its auto-save.",
|
|
32050
|
+
"attribute": "debounce"
|
|
32074
32051
|
},
|
|
32075
32052
|
{
|
|
32076
32053
|
"kind": "field",
|
|
32077
|
-
"name": "
|
|
32054
|
+
"name": "zoom",
|
|
32078
32055
|
"type": {
|
|
32079
|
-
"text": "
|
|
32056
|
+
"text": "number"
|
|
32080
32057
|
},
|
|
32081
|
-
"default": "
|
|
32082
|
-
"description": "The
|
|
32083
|
-
"attribute": "
|
|
32058
|
+
"default": "1",
|
|
32059
|
+
"description": "Zooms the previewed page out (0–1]. The frame always fills the panel;\nzoom shrinks the content browser-style, so 0.4 shows the page at 40%\nsize with correspondingly more of it visible. 1 = natural size.\nIgnored when `fill` is set.",
|
|
32060
|
+
"attribute": "zoom"
|
|
32084
32061
|
},
|
|
32085
32062
|
{
|
|
32086
32063
|
"kind": "field",
|
|
32087
|
-
"name": "
|
|
32064
|
+
"name": "minHeight",
|
|
32088
32065
|
"type": {
|
|
32089
|
-
"text": "
|
|
32066
|
+
"text": "number"
|
|
32090
32067
|
},
|
|
32091
|
-
"default": "
|
|
32092
|
-
"description": "
|
|
32093
|
-
"attribute": "
|
|
32068
|
+
"default": "480",
|
|
32069
|
+
"description": "The visible height (in CSS pixels) of the preview panel. Fixed rather\nthan measured, because a measured height would feed back into the\nscaled iframe's layout box and grow unbounded. With `fill` set, this\nbecomes a `min-height` floor instead of the height.",
|
|
32070
|
+
"attribute": "min-height"
|
|
32094
32071
|
},
|
|
32095
32072
|
{
|
|
32096
32073
|
"kind": "field",
|
|
32097
|
-
"name": "
|
|
32074
|
+
"name": "fill",
|
|
32098
32075
|
"type": {
|
|
32099
|
-
"text": "
|
|
32076
|
+
"text": "boolean"
|
|
32100
32077
|
},
|
|
32101
|
-
"default": "
|
|
32102
|
-
"description": "
|
|
32103
|
-
"attribute": "
|
|
32078
|
+
"default": "false",
|
|
32079
|
+
"description": "Fills the panel's own column height instead of using a fixed\n`min-height` pixel height — for hosts (like zn-theme-editor) whose\nlayout already stretches the column to match a taller sibling.\n`zoom` is ignored when set: its oversize maths depends on a known\npixel height, which `fill` deliberately doesn't have.",
|
|
32080
|
+
"attribute": "fill"
|
|
32104
32081
|
},
|
|
32105
32082
|
{
|
|
32106
32083
|
"kind": "field",
|
|
32107
|
-
"name": "
|
|
32084
|
+
"name": "device",
|
|
32108
32085
|
"type": {
|
|
32109
|
-
"text": "
|
|
32086
|
+
"text": "PreviewFrameDevice"
|
|
32110
32087
|
},
|
|
32111
|
-
"default": "''",
|
|
32112
|
-
"description": "
|
|
32113
|
-
"attribute": "
|
|
32088
|
+
"default": "'desktop'",
|
|
32089
|
+
"description": "Constrains and centres the preview to a device width: `desktop` (100%),\n`tablet` (768px) or `mobile` (390px). The iframe element itself is\nnarrowed, so the embedded page's own media queries fire.",
|
|
32090
|
+
"attribute": "device",
|
|
32114
32091
|
"reflects": true
|
|
32115
32092
|
},
|
|
32116
32093
|
{
|
|
32117
32094
|
"kind": "field",
|
|
32118
|
-
"name": "
|
|
32095
|
+
"name": "backdrop",
|
|
32119
32096
|
"type": {
|
|
32120
|
-
"text": "'
|
|
32097
|
+
"text": "'dots' | 'panel'"
|
|
32121
32098
|
},
|
|
32122
|
-
"default": "'
|
|
32123
|
-
"description": "
|
|
32124
|
-
"attribute": "
|
|
32099
|
+
"default": "'dots'",
|
|
32100
|
+
"description": "Backdrop behind the stage: `dots` (default) is the canvas dot grid; `panel` is a plain `rgb(var(--zn-panel))` fill.",
|
|
32101
|
+
"attribute": "backdrop",
|
|
32125
32102
|
"reflects": true
|
|
32126
32103
|
},
|
|
32127
32104
|
{
|
|
32128
32105
|
"kind": "field",
|
|
32129
|
-
"name": "
|
|
32106
|
+
"name": "interactive",
|
|
32130
32107
|
"type": {
|
|
32131
32108
|
"text": "boolean"
|
|
32132
32109
|
},
|
|
32133
32110
|
"default": "false",
|
|
32134
|
-
"description": "
|
|
32135
|
-
"attribute": "
|
|
32111
|
+
"description": "Lets pointer input through to the embedded page. The preview is inert by\ndefault: clicks never reach the frame, so the previewed page can't be\nnavigated or submitted from inside the preview. Cross-origin content can't\nbe reached from here to cancel its own handlers, so this blocks pointer\ninput entirely — hover goes with it. Scrolling doesn't: an overflowing\npage is scrolled by the panel rather than by the frame (see _contentHeight).\n\nSet, the frame becomes a real viewport instead: it stays the panel's own\nheight and the embed scrolls itself, so there is one scrollbar rather than\na panel scrolling an oversized frame, and the embed's viewport-relative\nlayout (`100vh`, `position: fixed`, sticky headers) sizes to what's on\nscreen. _contentHeight is ignored while this is set.",
|
|
32112
|
+
"attribute": "interactive",
|
|
32136
32113
|
"reflects": true
|
|
32137
32114
|
},
|
|
32138
32115
|
{
|
|
32139
32116
|
"kind": "field",
|
|
32140
|
-
"name": "
|
|
32117
|
+
"name": "frame",
|
|
32141
32118
|
"type": {
|
|
32142
|
-
"text": "
|
|
32119
|
+
"text": "HTMLIFrameElement"
|
|
32120
|
+
}
|
|
32121
|
+
},
|
|
32122
|
+
{
|
|
32123
|
+
"kind": "field",
|
|
32124
|
+
"name": "error",
|
|
32125
|
+
"type": {
|
|
32126
|
+
"text": "string"
|
|
32143
32127
|
},
|
|
32144
|
-
"
|
|
32145
|
-
"
|
|
32146
|
-
"attribute": "required",
|
|
32147
|
-
"reflects": true
|
|
32128
|
+
"privacy": "private",
|
|
32129
|
+
"default": "''"
|
|
32148
32130
|
},
|
|
32149
32131
|
{
|
|
32150
32132
|
"kind": "field",
|
|
32151
|
-
"name": "
|
|
32133
|
+
"name": "_contentHeight",
|
|
32152
32134
|
"type": {
|
|
32153
32135
|
"text": "number"
|
|
32154
32136
|
},
|
|
32155
|
-
"
|
|
32156
|
-
"
|
|
32157
|
-
"
|
|
32137
|
+
"privacy": "private",
|
|
32138
|
+
"default": "0",
|
|
32139
|
+
"description": "Height of the embedded page's content, when it's known: reported by the\nembed (`height` on hp-preview:rendered, or an hp-preview:height message) or\nmeasured directly for a same-origin embed. The frame is laid out at this\nheight rather than the panel's, so the page never scrolls inside the frame\n— the panel scrolls instead, which is what makes an overflowing preview\nreachable while pointer input to the frame is blocked. 0 = unknown, and the\nframe falls back to filling the panel. Kept up to date either way, but only\nlaid out when the frame is inert: an `interactive` frame scrolls itself."
|
|
32158
32140
|
},
|
|
32159
32141
|
{
|
|
32160
32142
|
"kind": "field",
|
|
32161
|
-
"name": "
|
|
32143
|
+
"name": "_generation",
|
|
32162
32144
|
"type": {
|
|
32163
|
-
"text": "
|
|
32145
|
+
"text": "number"
|
|
32164
32146
|
},
|
|
32165
|
-
"
|
|
32166
|
-
"
|
|
32147
|
+
"privacy": "private",
|
|
32148
|
+
"default": "0"
|
|
32167
32149
|
},
|
|
32168
32150
|
{
|
|
32169
32151
|
"kind": "field",
|
|
32170
|
-
"name": "
|
|
32152
|
+
"name": "_theme",
|
|
32171
32153
|
"type": {
|
|
32172
|
-
"text": "string"
|
|
32154
|
+
"text": "Record<string, unknown> | undefined"
|
|
32173
32155
|
},
|
|
32174
|
-
"
|
|
32175
|
-
"description": "A comma-separated list of item keys defining the initial display order.\nKeys must match the `value` attributes on slotted children.\nAny slotted items not listed are appended at the end in DOM order.",
|
|
32176
|
-
"attribute": "order"
|
|
32156
|
+
"privacy": "private"
|
|
32177
32157
|
},
|
|
32178
32158
|
{
|
|
32179
32159
|
"kind": "field",
|
|
32180
|
-
"name": "
|
|
32160
|
+
"name": "_contentObserver",
|
|
32181
32161
|
"type": {
|
|
32182
|
-
"text": "
|
|
32162
|
+
"text": "ResizeObserver | undefined"
|
|
32183
32163
|
},
|
|
32164
|
+
"privacy": "private"
|
|
32165
|
+
},
|
|
32166
|
+
{
|
|
32167
|
+
"kind": "field",
|
|
32168
|
+
"name": "_watchedForms",
|
|
32184
32169
|
"privacy": "private",
|
|
32185
|
-
"
|
|
32170
|
+
"readonly": true,
|
|
32171
|
+
"default": "new Set<HTMLFormElement>()"
|
|
32186
32172
|
},
|
|
32187
32173
|
{
|
|
32188
32174
|
"kind": "field",
|
|
32189
|
-
"name": "
|
|
32190
|
-
"type": {
|
|
32191
|
-
"text": "boolean"
|
|
32192
|
-
},
|
|
32175
|
+
"name": "_debounceTimers",
|
|
32193
32176
|
"privacy": "private",
|
|
32194
|
-
"
|
|
32177
|
+
"readonly": true,
|
|
32178
|
+
"default": "new Map<HTMLFormElement, number>()"
|
|
32195
32179
|
},
|
|
32196
32180
|
{
|
|
32197
32181
|
"kind": "field",
|
|
32198
|
-
"name": "
|
|
32182
|
+
"name": "_shellSaveRoots",
|
|
32199
32183
|
"type": {
|
|
32200
|
-
"text": "
|
|
32184
|
+
"text": "EventTarget[]"
|
|
32201
32185
|
},
|
|
32202
32186
|
"privacy": "private",
|
|
32203
|
-
"default": "
|
|
32187
|
+
"default": "[]"
|
|
32204
32188
|
},
|
|
32205
32189
|
{
|
|
32206
32190
|
"kind": "field",
|
|
32207
|
-
"name": "
|
|
32191
|
+
"name": "_lastShellSave",
|
|
32208
32192
|
"type": {
|
|
32209
|
-
"text": "
|
|
32193
|
+
"text": "Event | undefined"
|
|
32210
32194
|
},
|
|
32211
|
-
"
|
|
32212
|
-
"readonly": true
|
|
32195
|
+
"privacy": "private"
|
|
32213
32196
|
},
|
|
32214
32197
|
{
|
|
32215
32198
|
"kind": "field",
|
|
32216
|
-
"name": "
|
|
32217
|
-
"
|
|
32218
|
-
|
|
32219
|
-
},
|
|
32220
|
-
"description": "Gets the validation message.",
|
|
32221
|
-
"readonly": true
|
|
32199
|
+
"name": "_formObserver",
|
|
32200
|
+
"privacy": "private",
|
|
32201
|
+
"readonly": true,
|
|
32202
|
+
"default": "new MutationController(this, { target: null, config: {subtree: true, childList: true}, callback: () => this._attachForms(), })"
|
|
32222
32203
|
},
|
|
32223
32204
|
{
|
|
32224
|
-
"kind": "
|
|
32225
|
-
"name": "
|
|
32205
|
+
"kind": "field",
|
|
32206
|
+
"name": "_onMessage",
|
|
32226
32207
|
"privacy": "private",
|
|
32227
|
-
"
|
|
32208
|
+
"readonly": true
|
|
32228
32209
|
},
|
|
32229
32210
|
{
|
|
32230
32211
|
"kind": "method",
|
|
32231
|
-
"name": "
|
|
32212
|
+
"name": "_applyContentHeight",
|
|
32232
32213
|
"privacy": "private",
|
|
32233
|
-
"
|
|
32234
|
-
|
|
32235
|
-
"
|
|
32214
|
+
"parameters": [
|
|
32215
|
+
{
|
|
32216
|
+
"name": "height",
|
|
32217
|
+
"type": {
|
|
32218
|
+
"text": "unknown"
|
|
32219
|
+
}
|
|
32236
32220
|
}
|
|
32237
|
-
|
|
32238
|
-
"description": "Gets all direct children with a `value` attribute (excluding those in reserved slots)."
|
|
32221
|
+
]
|
|
32239
32222
|
},
|
|
32240
32223
|
{
|
|
32241
32224
|
"kind": "method",
|
|
32242
|
-
"name": "
|
|
32243
|
-
"privacy": "private"
|
|
32244
|
-
"description": "Assigns `slot` attributes to light DOM children based on their `value` attribute,\nso they project into the correct named slot in the shadow DOM."
|
|
32225
|
+
"name": "_resetContentHeight",
|
|
32226
|
+
"privacy": "private"
|
|
32245
32227
|
},
|
|
32246
32228
|
{
|
|
32247
|
-
"kind": "
|
|
32248
|
-
"name": "
|
|
32249
|
-
"
|
|
32250
|
-
|
|
32251
|
-
"text": "PriorityItem[]"
|
|
32252
|
-
}
|
|
32253
|
-
},
|
|
32254
|
-
"description": "Returns the priority map: an array of { key, priority } objects."
|
|
32229
|
+
"kind": "field",
|
|
32230
|
+
"name": "_onFrameLoad",
|
|
32231
|
+
"privacy": "private",
|
|
32232
|
+
"readonly": true
|
|
32255
32233
|
},
|
|
32256
32234
|
{
|
|
32257
32235
|
"kind": "method",
|
|
32258
|
-
"name": "
|
|
32259
|
-
"
|
|
32260
|
-
"description": "Syncs hidden inputs so form data includes priority values."
|
|
32236
|
+
"name": "refresh",
|
|
32237
|
+
"description": "Re-fetches the payload and pushes a fresh config to the preview."
|
|
32261
32238
|
},
|
|
32262
32239
|
{
|
|
32263
32240
|
"kind": "method",
|
|
32264
|
-
"name": "
|
|
32265
|
-
"privacy": "private",
|
|
32241
|
+
"name": "setTheme",
|
|
32266
32242
|
"parameters": [
|
|
32267
32243
|
{
|
|
32268
|
-
"name": "
|
|
32269
|
-
"type": {
|
|
32270
|
-
"text": "number"
|
|
32271
|
-
}
|
|
32272
|
-
},
|
|
32273
|
-
{
|
|
32274
|
-
"name": "toIndex",
|
|
32244
|
+
"name": "theme",
|
|
32275
32245
|
"type": {
|
|
32276
|
-
"text": "
|
|
32246
|
+
"text": "Record<string, unknown>"
|
|
32277
32247
|
}
|
|
32278
32248
|
}
|
|
32279
32249
|
],
|
|
32280
|
-
"description": "
|
|
32250
|
+
"description": "Pushes a theme payload into the preview. The payload is retained and\nre-posted after every ready handshake, so a frame reload doesn't drop an\nin-progress theme."
|
|
32281
32251
|
},
|
|
32282
32252
|
{
|
|
32283
32253
|
"kind": "method",
|
|
32284
|
-
"name": "
|
|
32285
|
-
"privacy": "private"
|
|
32286
|
-
"description": "Submits the associated form if a `formaction` attribute is set."
|
|
32254
|
+
"name": "_postTheme",
|
|
32255
|
+
"privacy": "private"
|
|
32287
32256
|
},
|
|
32288
32257
|
{
|
|
32289
32258
|
"kind": "method",
|
|
32290
|
-
"name": "
|
|
32291
|
-
"privacy": "private"
|
|
32292
|
-
"parameters": [
|
|
32293
|
-
{
|
|
32294
|
-
"name": "event",
|
|
32295
|
-
"type": {
|
|
32296
|
-
"text": "DragEvent"
|
|
32297
|
-
}
|
|
32298
|
-
},
|
|
32299
|
-
{
|
|
32300
|
-
"name": "key",
|
|
32301
|
-
"type": {
|
|
32302
|
-
"text": "string"
|
|
32303
|
-
}
|
|
32304
|
-
}
|
|
32305
|
-
]
|
|
32259
|
+
"name": "_sendConfig",
|
|
32260
|
+
"privacy": "private"
|
|
32306
32261
|
},
|
|
32307
32262
|
{
|
|
32308
32263
|
"kind": "method",
|
|
32309
|
-
"name": "
|
|
32264
|
+
"name": "_attachForms",
|
|
32310
32265
|
"privacy": "private"
|
|
32311
32266
|
},
|
|
32312
32267
|
{
|
|
32313
|
-
"kind": "
|
|
32314
|
-
"name": "
|
|
32268
|
+
"kind": "field",
|
|
32269
|
+
"name": "_onShellSave",
|
|
32315
32270
|
"privacy": "private",
|
|
32316
|
-
"
|
|
32317
|
-
{
|
|
32318
|
-
"name": "event",
|
|
32319
|
-
"type": {
|
|
32320
|
-
"text": "DragEvent"
|
|
32321
|
-
}
|
|
32322
|
-
},
|
|
32323
|
-
{
|
|
32324
|
-
"name": "key",
|
|
32325
|
-
"type": {
|
|
32326
|
-
"text": "string"
|
|
32327
|
-
}
|
|
32328
|
-
}
|
|
32329
|
-
]
|
|
32271
|
+
"readonly": true
|
|
32330
32272
|
},
|
|
32331
32273
|
{
|
|
32332
32274
|
"kind": "method",
|
|
32333
|
-
"name": "
|
|
32275
|
+
"name": "_detachForm",
|
|
32334
32276
|
"privacy": "private",
|
|
32335
32277
|
"parameters": [
|
|
32336
32278
|
{
|
|
32337
|
-
"name": "
|
|
32338
|
-
"type": {
|
|
32339
|
-
"text": "DragEvent"
|
|
32340
|
-
}
|
|
32341
|
-
},
|
|
32342
|
-
{
|
|
32343
|
-
"name": "key",
|
|
32279
|
+
"name": "form",
|
|
32344
32280
|
"type": {
|
|
32345
|
-
"text": "
|
|
32281
|
+
"text": "HTMLFormElement"
|
|
32346
32282
|
}
|
|
32347
32283
|
}
|
|
32348
32284
|
]
|
|
32349
32285
|
},
|
|
32286
|
+
{
|
|
32287
|
+
"kind": "field",
|
|
32288
|
+
"name": "_onChange",
|
|
32289
|
+
"privacy": "private",
|
|
32290
|
+
"readonly": true
|
|
32291
|
+
},
|
|
32292
|
+
{
|
|
32293
|
+
"kind": "field",
|
|
32294
|
+
"name": "_onSubmit",
|
|
32295
|
+
"privacy": "private",
|
|
32296
|
+
"readonly": true
|
|
32297
|
+
},
|
|
32350
32298
|
{
|
|
32351
32299
|
"kind": "method",
|
|
32352
|
-
"name": "
|
|
32300
|
+
"name": "_save",
|
|
32353
32301
|
"privacy": "private",
|
|
32354
32302
|
"parameters": [
|
|
32355
32303
|
{
|
|
32356
|
-
"name": "
|
|
32304
|
+
"name": "form",
|
|
32357
32305
|
"type": {
|
|
32358
|
-
"text": "
|
|
32306
|
+
"text": "HTMLFormElement"
|
|
32359
32307
|
}
|
|
32360
32308
|
}
|
|
32361
32309
|
]
|
|
32362
32310
|
},
|
|
32363
32311
|
{
|
|
32364
32312
|
"kind": "method",
|
|
32365
|
-
"name": "
|
|
32313
|
+
"name": "_fail",
|
|
32366
32314
|
"privacy": "private",
|
|
32367
32315
|
"parameters": [
|
|
32368
32316
|
{
|
|
32369
|
-
"name": "
|
|
32370
|
-
"type": {
|
|
32371
|
-
"text": "KeyboardEvent"
|
|
32372
|
-
}
|
|
32373
|
-
},
|
|
32374
|
-
{
|
|
32375
|
-
"name": "key",
|
|
32317
|
+
"name": "message",
|
|
32376
32318
|
"type": {
|
|
32377
32319
|
"text": "string"
|
|
32378
32320
|
}
|
|
32379
32321
|
}
|
|
32380
32322
|
]
|
|
32381
|
-
},
|
|
32382
|
-
{
|
|
32383
|
-
"kind": "method",
|
|
32384
|
-
"name": "_handleSlotChange",
|
|
32385
|
-
"privacy": "private"
|
|
32386
|
-
},
|
|
32387
|
-
{
|
|
32388
|
-
"kind": "method",
|
|
32389
|
-
"name": "checkValidity",
|
|
32390
|
-
"return": {
|
|
32391
|
-
"type": {
|
|
32392
|
-
"text": "boolean"
|
|
32393
|
-
}
|
|
32394
|
-
},
|
|
32395
|
-
"description": "Checks for validity but does not show a validation message."
|
|
32396
|
-
},
|
|
32397
|
-
{
|
|
32398
|
-
"kind": "method",
|
|
32399
|
-
"name": "getForm",
|
|
32400
|
-
"return": {
|
|
32401
|
-
"type": {
|
|
32402
|
-
"text": "HTMLFormElement | null"
|
|
32403
|
-
}
|
|
32404
|
-
},
|
|
32405
|
-
"description": "Gets the associated form, if one exists."
|
|
32406
|
-
},
|
|
32407
|
-
{
|
|
32408
|
-
"kind": "method",
|
|
32409
|
-
"name": "reportValidity",
|
|
32410
|
-
"return": {
|
|
32411
|
-
"type": {
|
|
32412
|
-
"text": "boolean"
|
|
32413
|
-
}
|
|
32414
|
-
},
|
|
32415
|
-
"description": "Checks for validity and shows the browser's validation message if the control is invalid."
|
|
32416
|
-
},
|
|
32417
|
-
{
|
|
32418
|
-
"kind": "method",
|
|
32419
|
-
"name": "setCustomValidity",
|
|
32420
|
-
"parameters": [
|
|
32421
|
-
{
|
|
32422
|
-
"name": "_message",
|
|
32423
|
-
"default": "''"
|
|
32424
|
-
}
|
|
32425
|
-
],
|
|
32426
|
-
"description": "Sets a custom validation message. Pass an empty string to restore validity."
|
|
32427
32323
|
}
|
|
32428
32324
|
],
|
|
32429
32325
|
"events": [
|
|
32430
32326
|
{
|
|
32431
|
-
"description": "Emitted when the
|
|
32432
|
-
"name": "zn-
|
|
32433
|
-
},
|
|
32434
|
-
{
|
|
32435
|
-
"description": "Emitted when items are reordered. Call `getPriorityMap()` on the component to get the updated `{ key: string, priority: number }[]` array.",
|
|
32436
|
-
"name": "zn-reorder"
|
|
32327
|
+
"description": "Emitted when the preview reports a render error or a save fails.",
|
|
32328
|
+
"name": "zn-error"
|
|
32437
32329
|
}
|
|
32438
32330
|
],
|
|
32439
32331
|
"attributes": [
|
|
32440
32332
|
{
|
|
32441
|
-
"name": "
|
|
32333
|
+
"name": "src",
|
|
32442
32334
|
"type": {
|
|
32443
32335
|
"text": "string"
|
|
32444
32336
|
},
|
|
32445
32337
|
"default": "''",
|
|
32446
|
-
"description": "
|
|
32447
|
-
"fieldName": "
|
|
32338
|
+
"description": "URL of the preview shell page (tokened embed URL).",
|
|
32339
|
+
"fieldName": "src"
|
|
32448
32340
|
},
|
|
32449
32341
|
{
|
|
32450
|
-
"name": "
|
|
32342
|
+
"name": "frame-origin",
|
|
32451
32343
|
"type": {
|
|
32452
|
-
"text": "string
|
|
32344
|
+
"text": "string"
|
|
32453
32345
|
},
|
|
32454
|
-
"
|
|
32455
|
-
"
|
|
32346
|
+
"default": "''",
|
|
32347
|
+
"description": "Expected origin of the iframe; all postMessage traffic is checked against it.",
|
|
32348
|
+
"fieldName": "frameOrigin"
|
|
32456
32349
|
},
|
|
32457
32350
|
{
|
|
32458
|
-
"name": "
|
|
32351
|
+
"name": "data-uri",
|
|
32459
32352
|
"type": {
|
|
32460
32353
|
"text": "string"
|
|
32461
32354
|
},
|
|
32462
32355
|
"default": "''",
|
|
32463
|
-
"description": "
|
|
32464
|
-
"fieldName": "
|
|
32356
|
+
"description": "Endpoint returning the hp-preview:config payload JSON. The console proxy rewrites this attribute to an app-prefixed path for proper fetch resolution.",
|
|
32357
|
+
"fieldName": "dataUri"
|
|
32465
32358
|
},
|
|
32466
32359
|
{
|
|
32467
|
-
"name": "
|
|
32360
|
+
"name": "watch",
|
|
32468
32361
|
"type": {
|
|
32469
32362
|
"text": "string"
|
|
32470
32363
|
},
|
|
32471
|
-
"default": "''",
|
|
32472
|
-
"description": "
|
|
32473
|
-
"fieldName": "
|
|
32364
|
+
"default": "'form[data-auto-save]'",
|
|
32365
|
+
"description": "Selector (resolved against the component's root node) for the forms to watch.\nDefaults to only forms explicitly opted in via a `data-auto-save` attribute —\nunmarked forms keep normal submit behavior and are never intercepted,\nauto-saved, or used to trigger a preview refresh. Override to widen the scope.",
|
|
32366
|
+
"fieldName": "watch"
|
|
32474
32367
|
},
|
|
32475
32368
|
{
|
|
32476
|
-
"name": "
|
|
32369
|
+
"name": "refresh-on",
|
|
32477
32370
|
"type": {
|
|
32478
32371
|
"text": "string"
|
|
32479
32372
|
},
|
|
32480
|
-
"default": "''",
|
|
32481
|
-
"description": "
|
|
32482
|
-
"fieldName": "
|
|
32373
|
+
"default": "'form'",
|
|
32374
|
+
"description": "Selector for forms whose saves are left to the shell but should still\nrefresh the preview. These are never intercepted: the shell submits them\n(so its own response handling — alerts, refreshes — runs as normal) and the\npreview re-fetches its config once the shell reports the save complete.\nMatched by delegation on the shell's bubbled `complete` event rather than\nby attaching to the forms themselves, so a save anywhere on the page\nrefreshes the preview — including forms in a different DOM root, e.g. a\npage-level form saved while the preview sits inside a tab panel's shadow\nroot (a page's Template select lives on one tab, its preview on another).\nSet empty to disable.",
|
|
32375
|
+
"fieldName": "refreshOn"
|
|
32483
32376
|
},
|
|
32484
32377
|
{
|
|
32485
|
-
"name": "
|
|
32378
|
+
"name": "debounce",
|
|
32486
32379
|
"type": {
|
|
32487
|
-
"text": "
|
|
32380
|
+
"text": "number"
|
|
32488
32381
|
},
|
|
32489
|
-
"default": "
|
|
32490
|
-
"description": "
|
|
32491
|
-
"fieldName": "
|
|
32382
|
+
"default": "400",
|
|
32383
|
+
"description": "Debounce in ms between a form change and its auto-save.",
|
|
32384
|
+
"fieldName": "debounce"
|
|
32492
32385
|
},
|
|
32493
32386
|
{
|
|
32494
|
-
"name": "
|
|
32387
|
+
"name": "zoom",
|
|
32495
32388
|
"type": {
|
|
32496
|
-
"text": "
|
|
32389
|
+
"text": "number"
|
|
32497
32390
|
},
|
|
32498
|
-
"default": "
|
|
32499
|
-
"description": "The
|
|
32500
|
-
"fieldName": "
|
|
32391
|
+
"default": "1",
|
|
32392
|
+
"description": "Zooms the previewed page out (0–1]. The frame always fills the panel;\nzoom shrinks the content browser-style, so 0.4 shows the page at 40%\nsize with correspondingly more of it visible. 1 = natural size.\nIgnored when `fill` is set.",
|
|
32393
|
+
"fieldName": "zoom"
|
|
32501
32394
|
},
|
|
32502
32395
|
{
|
|
32503
|
-
"name": "
|
|
32396
|
+
"name": "min-height",
|
|
32504
32397
|
"type": {
|
|
32505
|
-
"text": "
|
|
32398
|
+
"text": "number"
|
|
32506
32399
|
},
|
|
32507
|
-
"default": "
|
|
32508
|
-
"description": "
|
|
32509
|
-
"fieldName": "
|
|
32400
|
+
"default": "480",
|
|
32401
|
+
"description": "The visible height (in CSS pixels) of the preview panel. Fixed rather\nthan measured, because a measured height would feed back into the\nscaled iframe's layout box and grow unbounded. With `fill` set, this\nbecomes a `min-height` floor instead of the height.",
|
|
32402
|
+
"fieldName": "minHeight"
|
|
32510
32403
|
},
|
|
32511
32404
|
{
|
|
32512
|
-
"name": "
|
|
32405
|
+
"name": "fill",
|
|
32513
32406
|
"type": {
|
|
32514
32407
|
"text": "boolean"
|
|
32515
32408
|
},
|
|
32516
32409
|
"default": "false",
|
|
32517
|
-
"description": "
|
|
32518
|
-
"fieldName": "
|
|
32410
|
+
"description": "Fills the panel's own column height instead of using a fixed\n`min-height` pixel height — for hosts (like zn-theme-editor) whose\nlayout already stretches the column to match a taller sibling.\n`zoom` is ignored when set: its oversize maths depends on a known\npixel height, which `fill` deliberately doesn't have.",
|
|
32411
|
+
"fieldName": "fill"
|
|
32519
32412
|
},
|
|
32520
32413
|
{
|
|
32521
|
-
"name": "
|
|
32414
|
+
"name": "device",
|
|
32522
32415
|
"type": {
|
|
32523
|
-
"text": "
|
|
32416
|
+
"text": "PreviewFrameDevice"
|
|
32524
32417
|
},
|
|
32525
|
-
"default": "
|
|
32526
|
-
"description": "
|
|
32527
|
-
"fieldName": "
|
|
32418
|
+
"default": "'desktop'",
|
|
32419
|
+
"description": "Constrains and centres the preview to a device width: `desktop` (100%),\n`tablet` (768px) or `mobile` (390px). The iframe element itself is\nnarrowed, so the embedded page's own media queries fire.",
|
|
32420
|
+
"fieldName": "device"
|
|
32528
32421
|
},
|
|
32529
32422
|
{
|
|
32530
|
-
"name": "
|
|
32423
|
+
"name": "backdrop",
|
|
32531
32424
|
"type": {
|
|
32532
|
-
"text": "
|
|
32425
|
+
"text": "'dots' | 'panel'"
|
|
32533
32426
|
},
|
|
32534
|
-
"
|
|
32535
|
-
"
|
|
32427
|
+
"default": "'dots'",
|
|
32428
|
+
"description": "Backdrop behind the stage: `dots` (default) is the canvas dot grid; `panel` is a plain `rgb(var(--zn-panel))` fill.",
|
|
32429
|
+
"fieldName": "backdrop"
|
|
32536
32430
|
},
|
|
32537
32431
|
{
|
|
32538
|
-
"name": "
|
|
32432
|
+
"name": "interactive",
|
|
32539
32433
|
"type": {
|
|
32540
|
-
"text": "
|
|
32434
|
+
"text": "boolean"
|
|
32541
32435
|
},
|
|
32542
|
-
"default": "
|
|
32543
|
-
"description": "
|
|
32544
|
-
"fieldName": "
|
|
32436
|
+
"default": "false",
|
|
32437
|
+
"description": "Lets pointer input through to the embedded page. The preview is inert by\ndefault: clicks never reach the frame, so the previewed page can't be\nnavigated or submitted from inside the preview. Cross-origin content can't\nbe reached from here to cancel its own handlers, so this blocks pointer\ninput entirely — hover goes with it. Scrolling doesn't: an overflowing\npage is scrolled by the panel rather than by the frame (see _contentHeight).\n\nSet, the frame becomes a real viewport instead: it stays the panel's own\nheight and the embed scrolls itself, so there is one scrollbar rather than\na panel scrolling an oversized frame, and the embed's viewport-relative\nlayout (`100vh`, `position: fixed`, sticky headers) sizes to what's on\nscreen. _contentHeight is ignored while this is set.",
|
|
32438
|
+
"fieldName": "interactive"
|
|
32545
32439
|
}
|
|
32546
32440
|
],
|
|
32547
32441
|
"superclass": {
|
|
32548
32442
|
"name": "ZincElement",
|
|
32549
32443
|
"module": "/src/internal/zinc-element"
|
|
32550
32444
|
},
|
|
32551
|
-
"summary": "
|
|
32552
|
-
"tagNameWithoutPrefix": "
|
|
32553
|
-
"tagName": "zn-
|
|
32445
|
+
"summary": "Embeds a live preview iframe and drives the hp-preview postMessage\nprotocol: answers the frame's ready handshake with a config payload fetched\nfrom data-uri, auto-saves watched forms on change, refreshes the preview\nafter each save (its own, or a shell-driven save of a `refresh-on` form),\naccepts a theme payload via setTheme() that is retained and replayed\nafter every ready handshake, and grows the frame to a content height the\nembed reports so the panel scrolls an overflowing page.",
|
|
32446
|
+
"tagNameWithoutPrefix": "preview-frame",
|
|
32447
|
+
"tagName": "zn-preview-frame",
|
|
32554
32448
|
"customElement": true,
|
|
32555
|
-
"jsDoc": "/**\n * @summary
|
|
32556
|
-
"documentation": "https://zinc.style/components/
|
|
32449
|
+
"jsDoc": "/**\n * @summary Embeds a live preview iframe and drives the hp-preview postMessage\n * protocol: answers the frame's ready handshake with a config payload fetched\n * from data-uri, auto-saves watched forms on change, refreshes the preview\n * after each save (its own, or a shell-driven save of a `refresh-on` form),\n * accepts a theme payload via setTheme() that is retained and replayed\n * after every ready handshake, and grows the frame to a content height the\n * embed reports so the panel scrolls an overflowing page.\n *\n * @documentation https://zinc.style/components/preview-frame\n * @status experimental\n * @since 1.0\n *\n * @event zn-error - Emitted when the preview reports a render error or a save fails.\n *\n * @csspart base - The component's base wrapper.\n * @csspart stage - The device-width wrapper around the iframe.\n * @csspart iframe - The preview iframe.\n * @csspart error - The error overlay.\n *\n * @cssproperty --zn-preview-frame-dot-spacing - Spacing of the backdrop dot grid (`backdrop=\"dots\"`). Defaults to 20px.\n * @cssproperty --zn-preview-frame-dot-opacity - Opacity of the backdrop dots (`backdrop=\"dots\"`). Defaults to 0.08.\n */",
|
|
32450
|
+
"documentation": "https://zinc.style/components/preview-frame",
|
|
32557
32451
|
"status": "experimental",
|
|
32558
|
-
"since": "1.0"
|
|
32559
|
-
"dependencies": [
|
|
32560
|
-
"zn-icon"
|
|
32561
|
-
]
|
|
32452
|
+
"since": "1.0"
|
|
32562
32453
|
}
|
|
32563
32454
|
],
|
|
32564
32455
|
"exports": [
|
|
@@ -32566,542 +32457,651 @@
|
|
|
32566
32457
|
"kind": "js",
|
|
32567
32458
|
"name": "default",
|
|
32568
32459
|
"declaration": {
|
|
32569
|
-
"name": "
|
|
32570
|
-
"module": "components/
|
|
32460
|
+
"name": "ZnPreviewFrame",
|
|
32461
|
+
"module": "components/preview-frame/preview-frame.js"
|
|
32571
32462
|
}
|
|
32572
32463
|
}
|
|
32573
32464
|
]
|
|
32574
32465
|
},
|
|
32575
32466
|
{
|
|
32576
32467
|
"kind": "javascript-module",
|
|
32577
|
-
"path": "components/
|
|
32468
|
+
"path": "components/priority-list/priority-list.js",
|
|
32578
32469
|
"declarations": [
|
|
32579
32470
|
{
|
|
32580
32471
|
"kind": "class",
|
|
32581
32472
|
"description": "",
|
|
32582
|
-
"name": "
|
|
32473
|
+
"name": "ZnPriorityList",
|
|
32583
32474
|
"cssProperties": [
|
|
32584
32475
|
{
|
|
32585
|
-
"description": "
|
|
32586
|
-
"name": "--
|
|
32476
|
+
"description": "The gap between list items. Defaults to `var(--zn-spacing-2x-small)`.",
|
|
32477
|
+
"name": "--zn-priority-list-item-gap"
|
|
32478
|
+
},
|
|
32479
|
+
{
|
|
32480
|
+
"description": "The padding inside each item. Defaults to `var(--zn-spacing-small) var(--zn-spacing-medium)`.",
|
|
32481
|
+
"name": "--zn-priority-list-item-padding"
|
|
32482
|
+
},
|
|
32483
|
+
{
|
|
32484
|
+
"description": "The gap between an item's slotted actions. Defaults to `var(--zn-spacing-x-small)`.",
|
|
32485
|
+
"name": "--zn-priority-list-actions-gap"
|
|
32486
|
+
},
|
|
32487
|
+
{
|
|
32488
|
+
"description": "The color of the drag handle. Defaults to `var(--zn-color-neutral-500)`.",
|
|
32489
|
+
"name": "--zn-priority-list-handle-color"
|
|
32490
|
+
},
|
|
32491
|
+
{
|
|
32492
|
+
"description": "The color of the priority number. Defaults to `var(--zn-color-neutral-600)`.",
|
|
32493
|
+
"name": "--zn-priority-list-priority-color"
|
|
32587
32494
|
}
|
|
32588
32495
|
],
|
|
32589
32496
|
"cssParts": [
|
|
32590
32497
|
{
|
|
32591
|
-
"description": "The
|
|
32592
|
-
"name": "
|
|
32498
|
+
"description": "The form control wrapper.",
|
|
32499
|
+
"name": "form-control"
|
|
32500
|
+
},
|
|
32501
|
+
{
|
|
32502
|
+
"description": "The label wrapper.",
|
|
32503
|
+
"name": "form-control-label"
|
|
32504
|
+
},
|
|
32505
|
+
{
|
|
32506
|
+
"description": "The input area wrapper.",
|
|
32507
|
+
"name": "form-control-input"
|
|
32508
|
+
},
|
|
32509
|
+
{
|
|
32510
|
+
"description": "The help text wrapper.",
|
|
32511
|
+
"name": "form-control-help-text"
|
|
32512
|
+
},
|
|
32513
|
+
{
|
|
32514
|
+
"description": "The list container.",
|
|
32515
|
+
"name": "list"
|
|
32516
|
+
},
|
|
32517
|
+
{
|
|
32518
|
+
"description": "An individual list item row.",
|
|
32519
|
+
"name": "item"
|
|
32520
|
+
},
|
|
32521
|
+
{
|
|
32522
|
+
"description": "The drag handle icon.",
|
|
32523
|
+
"name": "drag-handle"
|
|
32524
|
+
},
|
|
32525
|
+
{
|
|
32526
|
+
"description": "The priority number badge.",
|
|
32527
|
+
"name": "priority"
|
|
32528
|
+
},
|
|
32529
|
+
{
|
|
32530
|
+
"description": "The content area of an item.",
|
|
32531
|
+
"name": "content"
|
|
32593
32532
|
}
|
|
32594
32533
|
],
|
|
32595
32534
|
"slots": [
|
|
32596
32535
|
{
|
|
32597
|
-
"description": "The default slot.",
|
|
32536
|
+
"description": "The default slot where list items are placed. Each slotted element must have a `value` attribute that uniquely identifies the item. The component automatically assigns slot names to project each item into the correct position. The item's position in the list determines its priority (top = `priority-start`, incrementing).",
|
|
32598
32537
|
"name": ""
|
|
32599
32538
|
},
|
|
32600
32539
|
{
|
|
32601
|
-
"description": "
|
|
32602
|
-
"name": "
|
|
32540
|
+
"description": "The component's label. Required for proper accessibility. Alternatively, use the `label` attribute.",
|
|
32541
|
+
"name": "label"
|
|
32542
|
+
},
|
|
32543
|
+
{
|
|
32544
|
+
"description": "Used to add text displayed in a tooltip next to the label.",
|
|
32545
|
+
"name": "label-tooltip"
|
|
32546
|
+
},
|
|
32547
|
+
{
|
|
32548
|
+
"description": "Text that describes how to use the component. Alternatively, use the `help-text` attribute.",
|
|
32549
|
+
"name": "help-text"
|
|
32603
32550
|
}
|
|
32604
32551
|
],
|
|
32605
32552
|
"members": [
|
|
32606
32553
|
{
|
|
32607
32554
|
"kind": "field",
|
|
32608
|
-
"name": "
|
|
32555
|
+
"name": "dependencies",
|
|
32609
32556
|
"type": {
|
|
32610
|
-
"text": "
|
|
32557
|
+
"text": "object"
|
|
32611
32558
|
},
|
|
32612
|
-
"
|
|
32559
|
+
"static": true,
|
|
32560
|
+
"default": "{ 'zn-icon': ZnIcon, }"
|
|
32613
32561
|
},
|
|
32614
32562
|
{
|
|
32615
32563
|
"kind": "field",
|
|
32616
|
-
"name": "
|
|
32617
|
-
"
|
|
32618
|
-
|
|
32619
|
-
},
|
|
32620
|
-
"privacy": "private"
|
|
32564
|
+
"name": "formControlController",
|
|
32565
|
+
"privacy": "protected",
|
|
32566
|
+
"readonly": true,
|
|
32567
|
+
"default": "new FormControlController(this, { value: (control: ZnPriorityList) => { return JSON.stringify(control.getPriorityMap()); }, defaultValue: (control: ZnPriorityList) => control.defaultValue, // A form reset passes defaultValue straight back in, so this has to accept the // key array as well as the serialised value other callers set. setValue: (control: ZnPriorityList, value: string | string[]) => { if (!value || (Array.isArray(value) && value.length === 0)) return; const keys: unknown = Array.isArray(value) ? value : safeParse(value); if (Array.isArray(keys) && keys.every((item: unknown): item is string => typeof item === 'string')) { control.value = keys as string[]; } }, })"
|
|
32621
32568
|
},
|
|
32622
32569
|
{
|
|
32623
32570
|
"kind": "field",
|
|
32624
|
-
"name": "
|
|
32625
|
-
"
|
|
32626
|
-
|
|
32627
|
-
|
|
32628
|
-
"description": "A reference to the internal popup container. Useful for animating and styling the popup with JavaScript."
|
|
32571
|
+
"name": "hasSlotController",
|
|
32572
|
+
"privacy": "private",
|
|
32573
|
+
"readonly": true,
|
|
32574
|
+
"default": "new HasSlotController(this, 'help-text', 'label')"
|
|
32629
32575
|
},
|
|
32630
32576
|
{
|
|
32631
32577
|
"kind": "field",
|
|
32632
|
-
"name": "
|
|
32578
|
+
"name": "hiddenInputsContainer",
|
|
32633
32579
|
"type": {
|
|
32634
|
-
"text": "
|
|
32635
|
-
}
|
|
32636
|
-
"privacy": "private"
|
|
32580
|
+
"text": "HTMLDivElement"
|
|
32581
|
+
}
|
|
32637
32582
|
},
|
|
32638
32583
|
{
|
|
32639
32584
|
"kind": "field",
|
|
32640
|
-
"name": "
|
|
32585
|
+
"name": "name",
|
|
32641
32586
|
"type": {
|
|
32642
|
-
"text": "
|
|
32587
|
+
"text": "string"
|
|
32643
32588
|
},
|
|
32644
|
-
"
|
|
32645
|
-
"
|
|
32589
|
+
"default": "''",
|
|
32590
|
+
"description": "The name prefix for form submission. Each item generates a hidden input named `{name}[{itemValue}]`\nwith the priority number as its value.",
|
|
32591
|
+
"attribute": "name"
|
|
32646
32592
|
},
|
|
32647
32593
|
{
|
|
32648
32594
|
"kind": "field",
|
|
32649
|
-
"name": "
|
|
32595
|
+
"name": "value",
|
|
32650
32596
|
"type": {
|
|
32651
|
-
"text": "
|
|
32597
|
+
"text": "string[]"
|
|
32652
32598
|
},
|
|
32653
|
-
"
|
|
32654
|
-
"
|
|
32655
|
-
"attribute": "active",
|
|
32656
|
-
"reflects": true
|
|
32599
|
+
"description": "The current ordered list of item keys, reflecting the visual order. This is the source of truth for ordering.\nEach entry should match a `value` attribute on a slotted child element.",
|
|
32600
|
+
"attribute": "value"
|
|
32657
32601
|
},
|
|
32658
32602
|
{
|
|
32659
32603
|
"kind": "field",
|
|
32660
|
-
"name": "
|
|
32604
|
+
"name": "_value",
|
|
32661
32605
|
"type": {
|
|
32662
|
-
"text": "
|
|
32606
|
+
"text": "string[]"
|
|
32663
32607
|
},
|
|
32664
|
-
"
|
|
32665
|
-
"
|
|
32666
|
-
"attribute": "placement",
|
|
32667
|
-
"reflects": true
|
|
32608
|
+
"privacy": "private",
|
|
32609
|
+
"default": "[]"
|
|
32668
32610
|
},
|
|
32669
32611
|
{
|
|
32670
32612
|
"kind": "field",
|
|
32671
|
-
"name": "
|
|
32613
|
+
"name": "defaultValue",
|
|
32672
32614
|
"type": {
|
|
32673
|
-
"text": "
|
|
32615
|
+
"text": "string[]"
|
|
32674
32616
|
},
|
|
32675
|
-
"default": "
|
|
32676
|
-
"description": "Determines how the popup is positioned. The `absolute` strategy works well in most cases, but if overflow is\nclipped, using a `fixed` position strategy can often workaround it.",
|
|
32677
|
-
"attribute": "strategy",
|
|
32678
|
-
"reflects": true
|
|
32617
|
+
"default": "[]"
|
|
32679
32618
|
},
|
|
32680
32619
|
{
|
|
32681
32620
|
"kind": "field",
|
|
32682
|
-
"name": "
|
|
32621
|
+
"name": "label",
|
|
32683
32622
|
"type": {
|
|
32684
|
-
"text": "
|
|
32623
|
+
"text": "string"
|
|
32685
32624
|
},
|
|
32686
|
-
"default": "
|
|
32687
|
-
"description": "The
|
|
32688
|
-
"attribute": "
|
|
32625
|
+
"default": "''",
|
|
32626
|
+
"description": "The component's label. Required for proper accessibility.",
|
|
32627
|
+
"attribute": "label"
|
|
32689
32628
|
},
|
|
32690
32629
|
{
|
|
32691
32630
|
"kind": "field",
|
|
32692
|
-
"name": "
|
|
32631
|
+
"name": "labelTooltip",
|
|
32693
32632
|
"type": {
|
|
32694
|
-
"text": "
|
|
32633
|
+
"text": "string"
|
|
32695
32634
|
},
|
|
32696
|
-
"default": "
|
|
32697
|
-
"description": "
|
|
32698
|
-
"attribute": "
|
|
32635
|
+
"default": "''",
|
|
32636
|
+
"description": "Text that appears in a tooltip next to the label.",
|
|
32637
|
+
"attribute": "label-tooltip"
|
|
32699
32638
|
},
|
|
32700
32639
|
{
|
|
32701
32640
|
"kind": "field",
|
|
32702
|
-
"name": "
|
|
32641
|
+
"name": "helpText",
|
|
32703
32642
|
"type": {
|
|
32704
|
-
"text": "
|
|
32643
|
+
"text": "string"
|
|
32705
32644
|
},
|
|
32706
|
-
"default": "
|
|
32707
|
-
"description": "
|
|
32708
|
-
"attribute": "
|
|
32645
|
+
"default": "''",
|
|
32646
|
+
"description": "Help text that describes how to use the component.",
|
|
32647
|
+
"attribute": "help-text"
|
|
32709
32648
|
},
|
|
32710
32649
|
{
|
|
32711
32650
|
"kind": "field",
|
|
32712
|
-
"name": "
|
|
32651
|
+
"name": "form",
|
|
32713
32652
|
"type": {
|
|
32714
|
-
"text": "
|
|
32653
|
+
"text": "string"
|
|
32715
32654
|
},
|
|
32716
|
-
"default": "'
|
|
32717
|
-
"description": "
|
|
32718
|
-
"attribute": "
|
|
32655
|
+
"default": "''",
|
|
32656
|
+
"description": "Associates the control with a form by id. The form must be in the same document or shadow root.",
|
|
32657
|
+
"attribute": "form",
|
|
32658
|
+
"reflects": true
|
|
32719
32659
|
},
|
|
32720
32660
|
{
|
|
32721
32661
|
"kind": "field",
|
|
32722
|
-
"name": "
|
|
32662
|
+
"name": "size",
|
|
32723
32663
|
"type": {
|
|
32724
|
-
"text": "
|
|
32664
|
+
"text": "'small' | 'medium' | 'large'"
|
|
32725
32665
|
},
|
|
32726
|
-
"default": "
|
|
32727
|
-
"description": "The
|
|
32728
|
-
"attribute": "
|
|
32666
|
+
"default": "'medium'",
|
|
32667
|
+
"description": "The size of the list items.",
|
|
32668
|
+
"attribute": "size",
|
|
32669
|
+
"reflects": true
|
|
32729
32670
|
},
|
|
32730
32671
|
{
|
|
32731
32672
|
"kind": "field",
|
|
32732
|
-
"name": "
|
|
32673
|
+
"name": "disabled",
|
|
32733
32674
|
"type": {
|
|
32734
32675
|
"text": "boolean"
|
|
32735
32676
|
},
|
|
32736
32677
|
"default": "false",
|
|
32737
|
-
"description": "
|
|
32738
|
-
"attribute": "
|
|
32678
|
+
"description": "Whether the priority list is disabled.",
|
|
32679
|
+
"attribute": "disabled",
|
|
32680
|
+
"reflects": true
|
|
32739
32681
|
},
|
|
32740
32682
|
{
|
|
32741
32683
|
"kind": "field",
|
|
32742
|
-
"name": "
|
|
32684
|
+
"name": "required",
|
|
32743
32685
|
"type": {
|
|
32744
|
-
"text": "
|
|
32686
|
+
"text": "boolean"
|
|
32745
32687
|
},
|
|
32746
|
-
"default": "
|
|
32747
|
-
"description": "
|
|
32748
|
-
"attribute": "
|
|
32688
|
+
"default": "false",
|
|
32689
|
+
"description": "Ensures the form control has a value before allowing submission.",
|
|
32690
|
+
"attribute": "required",
|
|
32691
|
+
"reflects": true
|
|
32749
32692
|
},
|
|
32750
32693
|
{
|
|
32751
32694
|
"kind": "field",
|
|
32752
|
-
"name": "
|
|
32695
|
+
"name": "priorityStart",
|
|
32753
32696
|
"type": {
|
|
32754
|
-
"text": "
|
|
32697
|
+
"text": "number"
|
|
32755
32698
|
},
|
|
32756
|
-
"default": "
|
|
32757
|
-
"description": "
|
|
32758
|
-
"attribute": "
|
|
32699
|
+
"default": "1",
|
|
32700
|
+
"description": "The starting priority number. Defaults to 1.",
|
|
32701
|
+
"attribute": "priority-start"
|
|
32759
32702
|
},
|
|
32760
32703
|
{
|
|
32761
32704
|
"kind": "field",
|
|
32762
|
-
"name": "
|
|
32705
|
+
"name": "formAction",
|
|
32763
32706
|
"type": {
|
|
32764
|
-
"text": "
|
|
32707
|
+
"text": "string"
|
|
32765
32708
|
},
|
|
32766
|
-
"description": "
|
|
32767
|
-
"attribute": "
|
|
32709
|
+
"description": "When set, the associated form will be submitted with the given action URL whenever items are reordered.\nIf set to an empty string, the form will be submitted using its existing action.",
|
|
32710
|
+
"attribute": "formaction"
|
|
32768
32711
|
},
|
|
32769
32712
|
{
|
|
32770
32713
|
"kind": "field",
|
|
32771
|
-
"name": "
|
|
32714
|
+
"name": "order",
|
|
32772
32715
|
"type": {
|
|
32773
|
-
"text": "
|
|
32716
|
+
"text": "string"
|
|
32774
32717
|
},
|
|
32775
|
-
"default": "
|
|
32776
|
-
"description": "
|
|
32777
|
-
"attribute": "
|
|
32718
|
+
"default": "''",
|
|
32719
|
+
"description": "A comma-separated list of item keys defining the initial display order.\nKeys must match the `value` attributes on slotted children.\nAny slotted items not listed are appended at the end in DOM order.",
|
|
32720
|
+
"attribute": "order"
|
|
32778
32721
|
},
|
|
32779
32722
|
{
|
|
32780
32723
|
"kind": "field",
|
|
32781
|
-
"name": "
|
|
32724
|
+
"name": "draggedKey",
|
|
32782
32725
|
"type": {
|
|
32783
|
-
"text": "
|
|
32726
|
+
"text": "string | null"
|
|
32784
32727
|
},
|
|
32785
|
-
"
|
|
32786
|
-
"
|
|
32787
|
-
"attribute": "shift"
|
|
32728
|
+
"privacy": "private",
|
|
32729
|
+
"default": "null"
|
|
32788
32730
|
},
|
|
32789
32731
|
{
|
|
32790
32732
|
"kind": "field",
|
|
32791
|
-
"name": "
|
|
32733
|
+
"name": "isDragging",
|
|
32792
32734
|
"type": {
|
|
32793
|
-
"text": "
|
|
32735
|
+
"text": "boolean"
|
|
32794
32736
|
},
|
|
32795
|
-
"
|
|
32796
|
-
"
|
|
32737
|
+
"privacy": "private",
|
|
32738
|
+
"default": "false"
|
|
32797
32739
|
},
|
|
32798
32740
|
{
|
|
32799
32741
|
"kind": "field",
|
|
32800
|
-
"name": "
|
|
32742
|
+
"name": "dragOverKey",
|
|
32801
32743
|
"type": {
|
|
32802
|
-
"text": "
|
|
32744
|
+
"text": "string | null"
|
|
32803
32745
|
},
|
|
32804
|
-
"
|
|
32805
|
-
"
|
|
32806
|
-
"attribute": "shift-padding"
|
|
32746
|
+
"privacy": "private",
|
|
32747
|
+
"default": "null"
|
|
32807
32748
|
},
|
|
32808
32749
|
{
|
|
32809
32750
|
"kind": "field",
|
|
32810
|
-
"name": "
|
|
32751
|
+
"name": "validity",
|
|
32811
32752
|
"type": {
|
|
32812
|
-
"text": "
|
|
32753
|
+
"text": "ValidityState"
|
|
32813
32754
|
},
|
|
32814
|
-
"description": "
|
|
32815
|
-
"
|
|
32755
|
+
"description": "Gets the validity state object.",
|
|
32756
|
+
"readonly": true
|
|
32816
32757
|
},
|
|
32817
32758
|
{
|
|
32818
32759
|
"kind": "field",
|
|
32819
|
-
"name": "
|
|
32760
|
+
"name": "validationMessage",
|
|
32820
32761
|
"type": {
|
|
32821
|
-
"text": "
|
|
32762
|
+
"text": "string"
|
|
32822
32763
|
},
|
|
32823
|
-
"description": "
|
|
32824
|
-
"
|
|
32764
|
+
"description": "Gets the validation message.",
|
|
32765
|
+
"readonly": true
|
|
32825
32766
|
},
|
|
32826
32767
|
{
|
|
32827
|
-
"kind": "
|
|
32828
|
-
"name": "
|
|
32829
|
-
"
|
|
32830
|
-
|
|
32831
|
-
},
|
|
32832
|
-
"description": "The auto-size boundary describes clipping element(s) that overflow will be checked relative to when resizing. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
|
|
32833
|
-
"attribute": "autoSizeBoundary"
|
|
32768
|
+
"kind": "method",
|
|
32769
|
+
"name": "_initializeOrderFromSlot",
|
|
32770
|
+
"privacy": "private",
|
|
32771
|
+
"description": "Initialize item order from slotted children if no explicit value was provided.\nIf an `order` attribute is set, use it to define the initial order,\nappending any slotted items not listed in the order at the end."
|
|
32834
32772
|
},
|
|
32835
32773
|
{
|
|
32836
|
-
"kind": "
|
|
32837
|
-
"name": "
|
|
32838
|
-
"
|
|
32839
|
-
|
|
32774
|
+
"kind": "method",
|
|
32775
|
+
"name": "_getSlottedItems",
|
|
32776
|
+
"privacy": "private",
|
|
32777
|
+
"return": {
|
|
32778
|
+
"type": {
|
|
32779
|
+
"text": "HTMLElement[]"
|
|
32780
|
+
}
|
|
32840
32781
|
},
|
|
32841
|
-
"
|
|
32842
|
-
"description": "The amount of padding, in pixels, to exceed before the auto-size behavior will occur.",
|
|
32843
|
-
"attribute": "auto-size-padding"
|
|
32782
|
+
"description": "Gets all direct children with a `value` attribute (excluding those in reserved slots)."
|
|
32844
32783
|
},
|
|
32845
32784
|
{
|
|
32846
|
-
"kind": "
|
|
32847
|
-
"name": "
|
|
32848
|
-
"
|
|
32849
|
-
|
|
32850
|
-
},
|
|
32851
|
-
"default": "false",
|
|
32852
|
-
"description": "When a gap exists between the anchor and the popup element, this option will add a \"hover bridge\" that fills the\ngap using an invisible element. This makes listening for events such as `mouseenter` and `mouseleave` more sane\nbecause the pointer never technically leaves the element. The hover bridge will only be drawn when the popover is\nactive.",
|
|
32853
|
-
"attribute": "hover-bridge"
|
|
32785
|
+
"kind": "method",
|
|
32786
|
+
"name": "_assignSlotNames",
|
|
32787
|
+
"privacy": "private",
|
|
32788
|
+
"description": "Assigns `slot` attributes to light DOM children based on their `value` attribute,\nso they project into the correct named slot in the shadow DOM."
|
|
32854
32789
|
},
|
|
32855
32790
|
{
|
|
32856
32791
|
"kind": "method",
|
|
32857
|
-
"name": "
|
|
32858
|
-
"
|
|
32792
|
+
"name": "getPriorityMap",
|
|
32793
|
+
"return": {
|
|
32794
|
+
"type": {
|
|
32795
|
+
"text": "PriorityItem[]"
|
|
32796
|
+
}
|
|
32797
|
+
},
|
|
32798
|
+
"description": "Returns the priority map: an array of { key, priority } objects."
|
|
32859
32799
|
},
|
|
32860
32800
|
{
|
|
32861
|
-
"kind": "
|
|
32862
|
-
"name": "
|
|
32863
|
-
"privacy": "
|
|
32801
|
+
"kind": "method",
|
|
32802
|
+
"name": "_syncHiddenInputs",
|
|
32803
|
+
"privacy": "private",
|
|
32804
|
+
"description": "Syncs hidden inputs so form data includes priority values."
|
|
32864
32805
|
},
|
|
32865
32806
|
{
|
|
32866
32807
|
"kind": "method",
|
|
32867
|
-
"name": "
|
|
32868
|
-
"privacy": "private"
|
|
32808
|
+
"name": "_moveItem",
|
|
32809
|
+
"privacy": "private",
|
|
32810
|
+
"parameters": [
|
|
32811
|
+
{
|
|
32812
|
+
"name": "fromIndex",
|
|
32813
|
+
"type": {
|
|
32814
|
+
"text": "number"
|
|
32815
|
+
}
|
|
32816
|
+
},
|
|
32817
|
+
{
|
|
32818
|
+
"name": "toIndex",
|
|
32819
|
+
"type": {
|
|
32820
|
+
"text": "number"
|
|
32821
|
+
}
|
|
32822
|
+
}
|
|
32823
|
+
],
|
|
32824
|
+
"description": "Moves an item from one index to another."
|
|
32869
32825
|
},
|
|
32870
32826
|
{
|
|
32871
32827
|
"kind": "method",
|
|
32872
|
-
"name": "
|
|
32828
|
+
"name": "_submitForm",
|
|
32873
32829
|
"privacy": "private",
|
|
32874
|
-
"
|
|
32875
|
-
"type": {
|
|
32876
|
-
"text": "Promise<void>"
|
|
32877
|
-
}
|
|
32878
|
-
}
|
|
32830
|
+
"description": "Submits the associated form if a `formaction` attribute is set."
|
|
32879
32831
|
},
|
|
32880
32832
|
{
|
|
32881
32833
|
"kind": "method",
|
|
32882
|
-
"name": "
|
|
32883
|
-
"
|
|
32834
|
+
"name": "_handleDragStart",
|
|
32835
|
+
"privacy": "private",
|
|
32836
|
+
"parameters": [
|
|
32837
|
+
{
|
|
32838
|
+
"name": "event",
|
|
32839
|
+
"type": {
|
|
32840
|
+
"text": "DragEvent"
|
|
32841
|
+
}
|
|
32842
|
+
},
|
|
32843
|
+
{
|
|
32844
|
+
"name": "key",
|
|
32845
|
+
"type": {
|
|
32846
|
+
"text": "string"
|
|
32847
|
+
}
|
|
32848
|
+
}
|
|
32849
|
+
]
|
|
32884
32850
|
},
|
|
32885
32851
|
{
|
|
32886
|
-
"kind": "
|
|
32887
|
-
"name": "
|
|
32852
|
+
"kind": "method",
|
|
32853
|
+
"name": "_handleDragEnd",
|
|
32888
32854
|
"privacy": "private"
|
|
32889
|
-
}
|
|
32890
|
-
],
|
|
32891
|
-
"events": [
|
|
32892
|
-
{
|
|
32893
|
-
"description": "Emitted as an example.",
|
|
32894
|
-
"name": "zn-event-name"
|
|
32895
|
-
}
|
|
32896
|
-
],
|
|
32897
|
-
"attributes": [
|
|
32898
|
-
{
|
|
32899
|
-
"name": "anchor",
|
|
32900
|
-
"type": {
|
|
32901
|
-
"text": "Element | string | VirtualElement"
|
|
32902
|
-
},
|
|
32903
|
-
"description": "The element the popup will be anchored to. If the anchor lives outside of the popup, you can provide the anchor\nelement `id`, a DOM element reference, or a `VirtualElement`. If the anchor lives inside the popup, use the\n`anchor` slot instead.",
|
|
32904
|
-
"fieldName": "anchor"
|
|
32905
32855
|
},
|
|
32906
32856
|
{
|
|
32907
|
-
"
|
|
32908
|
-
"
|
|
32909
|
-
|
|
32910
|
-
|
|
32911
|
-
|
|
32912
|
-
|
|
32913
|
-
|
|
32857
|
+
"kind": "method",
|
|
32858
|
+
"name": "_handleDragOver",
|
|
32859
|
+
"privacy": "private",
|
|
32860
|
+
"parameters": [
|
|
32861
|
+
{
|
|
32862
|
+
"name": "event",
|
|
32863
|
+
"type": {
|
|
32864
|
+
"text": "DragEvent"
|
|
32865
|
+
}
|
|
32866
|
+
},
|
|
32867
|
+
{
|
|
32868
|
+
"name": "key",
|
|
32869
|
+
"type": {
|
|
32870
|
+
"text": "string"
|
|
32871
|
+
}
|
|
32872
|
+
}
|
|
32873
|
+
]
|
|
32914
32874
|
},
|
|
32915
32875
|
{
|
|
32916
|
-
"
|
|
32917
|
-
"
|
|
32918
|
-
|
|
32919
|
-
|
|
32920
|
-
|
|
32921
|
-
|
|
32922
|
-
|
|
32876
|
+
"kind": "method",
|
|
32877
|
+
"name": "_handleDragLeave",
|
|
32878
|
+
"privacy": "private",
|
|
32879
|
+
"parameters": [
|
|
32880
|
+
{
|
|
32881
|
+
"name": "event",
|
|
32882
|
+
"type": {
|
|
32883
|
+
"text": "DragEvent"
|
|
32884
|
+
}
|
|
32885
|
+
},
|
|
32886
|
+
{
|
|
32887
|
+
"name": "key",
|
|
32888
|
+
"type": {
|
|
32889
|
+
"text": "string"
|
|
32890
|
+
}
|
|
32891
|
+
}
|
|
32892
|
+
]
|
|
32923
32893
|
},
|
|
32924
32894
|
{
|
|
32925
|
-
"
|
|
32926
|
-
"
|
|
32927
|
-
|
|
32928
|
-
|
|
32929
|
-
|
|
32930
|
-
|
|
32931
|
-
|
|
32895
|
+
"kind": "method",
|
|
32896
|
+
"name": "_handleDrop",
|
|
32897
|
+
"privacy": "private",
|
|
32898
|
+
"parameters": [
|
|
32899
|
+
{
|
|
32900
|
+
"name": "event",
|
|
32901
|
+
"type": {
|
|
32902
|
+
"text": "DragEvent"
|
|
32903
|
+
}
|
|
32904
|
+
}
|
|
32905
|
+
]
|
|
32932
32906
|
},
|
|
32933
32907
|
{
|
|
32934
|
-
"
|
|
32935
|
-
"
|
|
32936
|
-
|
|
32937
|
-
|
|
32938
|
-
|
|
32939
|
-
|
|
32940
|
-
|
|
32908
|
+
"kind": "method",
|
|
32909
|
+
"name": "_handleKeyDown",
|
|
32910
|
+
"privacy": "private",
|
|
32911
|
+
"parameters": [
|
|
32912
|
+
{
|
|
32913
|
+
"name": "event",
|
|
32914
|
+
"type": {
|
|
32915
|
+
"text": "KeyboardEvent"
|
|
32916
|
+
}
|
|
32917
|
+
},
|
|
32918
|
+
{
|
|
32919
|
+
"name": "key",
|
|
32920
|
+
"type": {
|
|
32921
|
+
"text": "string"
|
|
32922
|
+
}
|
|
32923
|
+
}
|
|
32924
|
+
]
|
|
32941
32925
|
},
|
|
32942
32926
|
{
|
|
32943
|
-
"
|
|
32944
|
-
"
|
|
32945
|
-
|
|
32946
|
-
},
|
|
32947
|
-
"default": "0",
|
|
32948
|
-
"description": "The distance in pixels from which to offset the panel along its anchor.",
|
|
32949
|
-
"fieldName": "skidding"
|
|
32927
|
+
"kind": "method",
|
|
32928
|
+
"name": "_handleSlotChange",
|
|
32929
|
+
"privacy": "private"
|
|
32950
32930
|
},
|
|
32951
32931
|
{
|
|
32952
|
-
"
|
|
32953
|
-
"
|
|
32954
|
-
|
|
32932
|
+
"kind": "method",
|
|
32933
|
+
"name": "checkValidity",
|
|
32934
|
+
"return": {
|
|
32935
|
+
"type": {
|
|
32936
|
+
"text": "boolean"
|
|
32937
|
+
}
|
|
32955
32938
|
},
|
|
32956
|
-
"
|
|
32957
|
-
"description": "Attaches an arrow to the popup. The arrow's size and color can be customized using the `--arrow-size` and\n`--arrow-color` custom properties. For additional customizations, you can also target the arrow using\n`::part(arrow)` in your stylesheet.",
|
|
32958
|
-
"fieldName": "arrow"
|
|
32939
|
+
"description": "Checks for validity but does not show a validation message."
|
|
32959
32940
|
},
|
|
32960
32941
|
{
|
|
32961
|
-
"
|
|
32962
|
-
"
|
|
32963
|
-
|
|
32942
|
+
"kind": "method",
|
|
32943
|
+
"name": "getForm",
|
|
32944
|
+
"return": {
|
|
32945
|
+
"type": {
|
|
32946
|
+
"text": "HTMLFormElement | null"
|
|
32947
|
+
}
|
|
32964
32948
|
},
|
|
32965
|
-
"
|
|
32966
|
-
"description": "The placement of the arrow. The default is `anchor`, which will align the arrow as close to the center of the\nanchor as possible, considering available space and `arrow-padding`. A value of `start`, `end`, or `center` will\nalign the arrow to the start, end, or center of the popover instead.",
|
|
32967
|
-
"fieldName": "arrowPlacement"
|
|
32949
|
+
"description": "Gets the associated form, if one exists."
|
|
32968
32950
|
},
|
|
32969
32951
|
{
|
|
32970
|
-
"
|
|
32971
|
-
"
|
|
32972
|
-
|
|
32952
|
+
"kind": "method",
|
|
32953
|
+
"name": "reportValidity",
|
|
32954
|
+
"return": {
|
|
32955
|
+
"type": {
|
|
32956
|
+
"text": "boolean"
|
|
32957
|
+
}
|
|
32973
32958
|
},
|
|
32974
|
-
"
|
|
32975
|
-
"description": "The amount of padding between the arrow and the edges of the popup. If the popup has a border-radius, for example,\nthis will prevent it from overflowing the corners.",
|
|
32976
|
-
"fieldName": "arrowPadding"
|
|
32959
|
+
"description": "Checks for validity and shows the browser's validation message if the control is invalid."
|
|
32977
32960
|
},
|
|
32978
32961
|
{
|
|
32979
|
-
"
|
|
32980
|
-
"
|
|
32981
|
-
|
|
32982
|
-
|
|
32983
|
-
|
|
32984
|
-
|
|
32985
|
-
|
|
32962
|
+
"kind": "method",
|
|
32963
|
+
"name": "setCustomValidity",
|
|
32964
|
+
"parameters": [
|
|
32965
|
+
{
|
|
32966
|
+
"name": "_message",
|
|
32967
|
+
"default": "''"
|
|
32968
|
+
}
|
|
32969
|
+
],
|
|
32970
|
+
"description": "Sets a custom validation message. Pass an empty string to restore validity."
|
|
32971
|
+
}
|
|
32972
|
+
],
|
|
32973
|
+
"events": [
|
|
32974
|
+
{
|
|
32975
|
+
"description": "Emitted when the order of items changes.",
|
|
32976
|
+
"name": "zn-change"
|
|
32986
32977
|
},
|
|
32987
32978
|
{
|
|
32988
|
-
"
|
|
32979
|
+
"description": "Emitted when items are reordered. Call `getPriorityMap()` on the component to get the updated `{ key: string, priority: number }[]` array.",
|
|
32980
|
+
"name": "zn-reorder"
|
|
32981
|
+
}
|
|
32982
|
+
],
|
|
32983
|
+
"attributes": [
|
|
32984
|
+
{
|
|
32985
|
+
"name": "name",
|
|
32989
32986
|
"type": {
|
|
32990
32987
|
"text": "string"
|
|
32991
32988
|
},
|
|
32992
32989
|
"default": "''",
|
|
32993
|
-
"description": "
|
|
32994
|
-
"fieldName": "
|
|
32990
|
+
"description": "The name prefix for form submission. Each item generates a hidden input named `{name}[{itemValue}]`\nwith the priority number as its value.",
|
|
32991
|
+
"fieldName": "name"
|
|
32995
32992
|
},
|
|
32996
32993
|
{
|
|
32997
|
-
"name": "
|
|
32994
|
+
"name": "value",
|
|
32998
32995
|
"type": {
|
|
32999
|
-
"text": "
|
|
32996
|
+
"text": "string[]"
|
|
33000
32997
|
},
|
|
33001
|
-
"
|
|
33002
|
-
"
|
|
33003
|
-
"fieldName": "flipFallbackStrategy"
|
|
32998
|
+
"description": "The current ordered list of item keys, reflecting the visual order. This is the source of truth for ordering.\nEach entry should match a `value` attribute on a slotted child element.",
|
|
32999
|
+
"fieldName": "value"
|
|
33004
33000
|
},
|
|
33005
33001
|
{
|
|
33006
|
-
"name": "
|
|
33002
|
+
"name": "label",
|
|
33007
33003
|
"type": {
|
|
33008
|
-
"text": "
|
|
33004
|
+
"text": "string"
|
|
33009
33005
|
},
|
|
33010
|
-
"
|
|
33011
|
-
"
|
|
33006
|
+
"default": "''",
|
|
33007
|
+
"description": "The component's label. Required for proper accessibility.",
|
|
33008
|
+
"fieldName": "label"
|
|
33012
33009
|
},
|
|
33013
33010
|
{
|
|
33014
|
-
"name": "
|
|
33011
|
+
"name": "label-tooltip",
|
|
33015
33012
|
"type": {
|
|
33016
|
-
"text": "
|
|
33013
|
+
"text": "string"
|
|
33017
33014
|
},
|
|
33018
|
-
"default": "
|
|
33019
|
-
"description": "
|
|
33020
|
-
"fieldName": "
|
|
33015
|
+
"default": "''",
|
|
33016
|
+
"description": "Text that appears in a tooltip next to the label.",
|
|
33017
|
+
"fieldName": "labelTooltip"
|
|
33021
33018
|
},
|
|
33022
33019
|
{
|
|
33023
|
-
"name": "
|
|
33020
|
+
"name": "help-text",
|
|
33024
33021
|
"type": {
|
|
33025
|
-
"text": "
|
|
33022
|
+
"text": "string"
|
|
33026
33023
|
},
|
|
33027
|
-
"default": "
|
|
33028
|
-
"description": "
|
|
33029
|
-
"fieldName": "
|
|
33024
|
+
"default": "''",
|
|
33025
|
+
"description": "Help text that describes how to use the component.",
|
|
33026
|
+
"fieldName": "helpText"
|
|
33030
33027
|
},
|
|
33031
33028
|
{
|
|
33032
|
-
"name": "
|
|
33029
|
+
"name": "form",
|
|
33033
33030
|
"type": {
|
|
33034
|
-
"text": "
|
|
33031
|
+
"text": "string"
|
|
33035
33032
|
},
|
|
33036
|
-
"
|
|
33037
|
-
"
|
|
33033
|
+
"default": "''",
|
|
33034
|
+
"description": "Associates the control with a form by id. The form must be in the same document or shadow root.",
|
|
33035
|
+
"fieldName": "form"
|
|
33038
33036
|
},
|
|
33039
33037
|
{
|
|
33040
|
-
"name": "
|
|
33038
|
+
"name": "size",
|
|
33041
33039
|
"type": {
|
|
33042
|
-
"text": "
|
|
33040
|
+
"text": "'small' | 'medium' | 'large'"
|
|
33043
33041
|
},
|
|
33044
|
-
"default": "
|
|
33045
|
-
"description": "The
|
|
33046
|
-
"fieldName": "
|
|
33042
|
+
"default": "'medium'",
|
|
33043
|
+
"description": "The size of the list items.",
|
|
33044
|
+
"fieldName": "size"
|
|
33047
33045
|
},
|
|
33048
33046
|
{
|
|
33049
|
-
"name": "
|
|
33047
|
+
"name": "disabled",
|
|
33050
33048
|
"type": {
|
|
33051
|
-
"text": "
|
|
33049
|
+
"text": "boolean"
|
|
33052
33050
|
},
|
|
33053
|
-
"
|
|
33054
|
-
"
|
|
33051
|
+
"default": "false",
|
|
33052
|
+
"description": "Whether the priority list is disabled.",
|
|
33053
|
+
"fieldName": "disabled"
|
|
33055
33054
|
},
|
|
33056
33055
|
{
|
|
33057
|
-
"name": "
|
|
33056
|
+
"name": "required",
|
|
33058
33057
|
"type": {
|
|
33059
|
-
"text": "
|
|
33058
|
+
"text": "boolean"
|
|
33060
33059
|
},
|
|
33061
|
-
"
|
|
33062
|
-
"
|
|
33060
|
+
"default": "false",
|
|
33061
|
+
"description": "Ensures the form control has a value before allowing submission.",
|
|
33062
|
+
"fieldName": "required"
|
|
33063
33063
|
},
|
|
33064
33064
|
{
|
|
33065
|
-
"name": "
|
|
33065
|
+
"name": "priority-start",
|
|
33066
33066
|
"type": {
|
|
33067
|
-
"text": "
|
|
33067
|
+
"text": "number"
|
|
33068
33068
|
},
|
|
33069
|
-
"
|
|
33070
|
-
"
|
|
33069
|
+
"default": "1",
|
|
33070
|
+
"description": "The starting priority number. Defaults to 1.",
|
|
33071
|
+
"fieldName": "priorityStart"
|
|
33071
33072
|
},
|
|
33072
33073
|
{
|
|
33073
|
-
"name": "
|
|
33074
|
+
"name": "formaction",
|
|
33074
33075
|
"type": {
|
|
33075
|
-
"text": "
|
|
33076
|
+
"text": "string"
|
|
33076
33077
|
},
|
|
33077
|
-
"
|
|
33078
|
-
"
|
|
33079
|
-
"fieldName": "autoSizePadding"
|
|
33078
|
+
"description": "When set, the associated form will be submitted with the given action URL whenever items are reordered.\nIf set to an empty string, the form will be submitted using its existing action.",
|
|
33079
|
+
"fieldName": "formAction"
|
|
33080
33080
|
},
|
|
33081
33081
|
{
|
|
33082
|
-
"name": "
|
|
33082
|
+
"name": "order",
|
|
33083
33083
|
"type": {
|
|
33084
|
-
"text": "
|
|
33084
|
+
"text": "string"
|
|
33085
33085
|
},
|
|
33086
|
-
"default": "
|
|
33087
|
-
"description": "
|
|
33088
|
-
"fieldName": "
|
|
33086
|
+
"default": "''",
|
|
33087
|
+
"description": "A comma-separated list of item keys defining the initial display order.\nKeys must match the `value` attributes on slotted children.\nAny slotted items not listed are appended at the end in DOM order.",
|
|
33088
|
+
"fieldName": "order"
|
|
33089
33089
|
}
|
|
33090
33090
|
],
|
|
33091
33091
|
"superclass": {
|
|
33092
33092
|
"name": "ZincElement",
|
|
33093
33093
|
"module": "/src/internal/zinc-element"
|
|
33094
33094
|
},
|
|
33095
|
-
"summary": "
|
|
33096
|
-
"tagNameWithoutPrefix": "
|
|
33097
|
-
"tagName": "zn-
|
|
33095
|
+
"summary": "A reorderable list where each item receives a numerical priority based on its position. Supports drag-and-drop\nand keyboard reordering. Priority values are submitted as form data via hidden inputs.",
|
|
33096
|
+
"tagNameWithoutPrefix": "priority-list",
|
|
33097
|
+
"tagName": "zn-priority-list",
|
|
33098
33098
|
"customElement": true,
|
|
33099
|
-
"jsDoc": "/**\n * @summary
|
|
33100
|
-
"documentation": "https://zinc.style/components/
|
|
33099
|
+
"jsDoc": "/**\n * @summary A reorderable list where each item receives a numerical priority based on its position. Supports drag-and-drop\n * and keyboard reordering. Priority values are submitted as form data via hidden inputs.\n *\n * @documentation https://zinc.style/components/priority-list\n * @status experimental\n * @since 1.0\n *\n * @dependency zn-icon\n *\n * @slot - The default slot where list items are placed. Each slotted element must have a `value` attribute that\n * uniquely identifies the item. The component automatically assigns slot names to project each item into the\n * correct position. The item's position in the list determines its priority (top = `priority-start`, incrementing).\n * @slot label - The component's label. Required for proper accessibility. Alternatively, use the `label` attribute.\n * @slot label-tooltip - Used to add text displayed in a tooltip next to the label.\n * @slot help-text - Text that describes how to use the component. Alternatively, use the `help-text` attribute.\n *\n * @event zn-change - Emitted when the order of items changes.\n * @event zn-reorder - Emitted when items are reordered. Call `getPriorityMap()` on the component to get\n * the updated `{ key: string, priority: number }[]` array.\n *\n * @csspart form-control - The form control wrapper.\n * @csspart form-control-label - The label wrapper.\n * @csspart form-control-input - The input area wrapper.\n * @csspart form-control-help-text - The help text wrapper.\n * @csspart list - The list container.\n * @csspart item - An individual list item row.\n * @csspart drag-handle - The drag handle icon.\n * @csspart priority - The priority number badge.\n * @csspart content - The content area of an item.\n *\n * @cssproperty --zn-priority-list-item-gap - The gap between list items. Defaults to `var(--zn-spacing-2x-small)`.\n * @cssproperty --zn-priority-list-item-padding - The padding inside each item. Defaults to `var(--zn-spacing-small) var(--zn-spacing-medium)`.\n * @cssproperty --zn-priority-list-actions-gap - The gap between an item's slotted actions. Defaults to `var(--zn-spacing-x-small)`.\n * @cssproperty --zn-priority-list-handle-color - The color of the drag handle. Defaults to `var(--zn-color-neutral-500)`.\n * @cssproperty --zn-priority-list-priority-color - The color of the priority number. Defaults to `var(--zn-color-neutral-600)`.\n */",
|
|
33100
|
+
"documentation": "https://zinc.style/components/priority-list",
|
|
33101
33101
|
"status": "experimental",
|
|
33102
33102
|
"since": "1.0",
|
|
33103
33103
|
"dependencies": [
|
|
33104
|
-
"zn-
|
|
33104
|
+
"zn-icon"
|
|
33105
33105
|
]
|
|
33106
33106
|
}
|
|
33107
33107
|
],
|
|
@@ -33110,8 +33110,8 @@
|
|
|
33110
33110
|
"kind": "js",
|
|
33111
33111
|
"name": "default",
|
|
33112
33112
|
"declaration": {
|
|
33113
|
-
"name": "
|
|
33114
|
-
"module": "components/
|
|
33113
|
+
"name": "ZnPriorityList",
|
|
33114
|
+
"module": "components/priority-list/priority-list.js"
|
|
33115
33115
|
}
|
|
33116
33116
|
}
|
|
33117
33117
|
]
|
|
@@ -53005,7 +53005,7 @@
|
|
|
53005
53005
|
"package": {
|
|
53006
53006
|
"name": "@kubex/zinc",
|
|
53007
53007
|
"description": "A collection of web components for building web applications based off of @shoelace-style/Shoelace",
|
|
53008
|
-
"version": "1.1.
|
|
53008
|
+
"version": "1.1.137",
|
|
53009
53009
|
"author": "",
|
|
53010
53010
|
"license": "MIT"
|
|
53011
53011
|
}
|