@taprootio/espalier 2.8.1 → 2.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/custom-elements.json +2756 -445
- package/dist/button/esp-button.d.ts +3 -0
- package/dist/button/esp-button.js +14 -13
- package/dist/flyout/esp-flyout.d.ts +40 -18
- package/dist/flyout/esp-flyout.js +65 -17
- package/dist/form-item/esp-form-item.d.ts +22 -0
- package/dist/form-item/esp-form-item.js +60 -14
- package/dist/header/esp-header.js +4 -4
- package/dist/help/esp-help-button.d.ts +61 -0
- package/dist/help/esp-help-button.js +49 -0
- package/dist/help/esp-help-provider.d.ts +40 -0
- package/dist/help/esp-help-provider.js +5 -0
- package/dist/help/help-document.js +52 -0
- package/dist/index.d.ts +4 -1
- package/dist/index.js +1 -1
- package/dist/menu/esp-menu.js +2 -2
- package/dist/page/esp-page.d.ts +59 -0
- package/dist/page/esp-page.js +104 -11
- package/dist/shared/bus-events.d.ts +20 -1
- package/dist/shared/esp-bus.d.ts +1 -1
- package/dist/shared/esp-bus.js +1 -1
- package/dist/shared/events.d.ts +1 -0
- package/dist/shared/flyout-events.d.ts +16 -5
- package/dist/shared/flyout-events.js +1 -1
- package/dist/shared/help-events.d.ts +55 -0
- package/dist/shared/help-events.js +1 -0
- package/espalier.token-manifest.json +12 -0
- package/package.json +9 -1
package/custom-elements.json
CHANGED
|
@@ -159,6 +159,22 @@
|
|
|
159
159
|
"module": "dist/form-item/esp-form-item.js"
|
|
160
160
|
}
|
|
161
161
|
},
|
|
162
|
+
{
|
|
163
|
+
"kind": "js",
|
|
164
|
+
"name": "*",
|
|
165
|
+
"declaration": {
|
|
166
|
+
"name": "*",
|
|
167
|
+
"module": "dist/help/esp-help-button.js"
|
|
168
|
+
}
|
|
169
|
+
},
|
|
170
|
+
{
|
|
171
|
+
"kind": "js",
|
|
172
|
+
"name": "*",
|
|
173
|
+
"declaration": {
|
|
174
|
+
"name": "*",
|
|
175
|
+
"module": "dist/help/esp-help-provider.js"
|
|
176
|
+
}
|
|
177
|
+
},
|
|
162
178
|
{
|
|
163
179
|
"kind": "js",
|
|
164
180
|
"name": "*",
|
|
@@ -631,6 +647,30 @@
|
|
|
631
647
|
"module": "./shared/flyout-events.js"
|
|
632
648
|
}
|
|
633
649
|
},
|
|
650
|
+
{
|
|
651
|
+
"kind": "js",
|
|
652
|
+
"name": "requestHelp",
|
|
653
|
+
"declaration": {
|
|
654
|
+
"name": "requestHelp",
|
|
655
|
+
"module": "./shared/help-events.js"
|
|
656
|
+
}
|
|
657
|
+
},
|
|
658
|
+
{
|
|
659
|
+
"kind": "js",
|
|
660
|
+
"name": "HelpRequest",
|
|
661
|
+
"declaration": {
|
|
662
|
+
"name": "HelpRequest",
|
|
663
|
+
"module": "./shared/help-events.js"
|
|
664
|
+
}
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
"kind": "js",
|
|
668
|
+
"name": "HelpState",
|
|
669
|
+
"declaration": {
|
|
670
|
+
"name": "HelpState",
|
|
671
|
+
"module": "./shared/help-events.js"
|
|
672
|
+
}
|
|
673
|
+
},
|
|
634
674
|
{
|
|
635
675
|
"kind": "js",
|
|
636
676
|
"name": "getEspBus",
|
|
@@ -671,6 +711,14 @@
|
|
|
671
711
|
"module": "./shared/bus-events.js"
|
|
672
712
|
}
|
|
673
713
|
},
|
|
714
|
+
{
|
|
715
|
+
"kind": "js",
|
|
716
|
+
"name": "HelpEvents",
|
|
717
|
+
"declaration": {
|
|
718
|
+
"name": "HelpEvents",
|
|
719
|
+
"module": "./shared/bus-events.js"
|
|
720
|
+
}
|
|
721
|
+
},
|
|
674
722
|
{
|
|
675
723
|
"kind": "js",
|
|
676
724
|
"name": "PopoverEvents",
|
|
@@ -6953,147 +7001,6 @@
|
|
|
6953
7001
|
}
|
|
6954
7002
|
]
|
|
6955
7003
|
},
|
|
6956
|
-
{
|
|
6957
|
-
"kind": "javascript-module",
|
|
6958
|
-
"path": "dist/burger/esp-burger.js",
|
|
6959
|
-
"declarations": [
|
|
6960
|
-
{
|
|
6961
|
-
"kind": "class",
|
|
6962
|
-
"description": "Animated burger button for showing and hiding navigation\ncomponents.\n\n```html\n<esp-burger></esp-burger>\n```",
|
|
6963
|
-
"name": "EspalierBurger",
|
|
6964
|
-
"cssProperties": [
|
|
6965
|
-
{
|
|
6966
|
-
"description": "The color of the burger lines when closed.",
|
|
6967
|
-
"name": "--esp-color-burger"
|
|
6968
|
-
},
|
|
6969
|
-
{
|
|
6970
|
-
"description": "The hover color of the burger lines when closed.",
|
|
6971
|
-
"name": "--esp-color-burger-hover"
|
|
6972
|
-
},
|
|
6973
|
-
{
|
|
6974
|
-
"description": "The color of the burger lines when open.",
|
|
6975
|
-
"name": "--esp-color-burger-opened"
|
|
6976
|
-
},
|
|
6977
|
-
{
|
|
6978
|
-
"description": "The hover color of the burger lines when open.",
|
|
6979
|
-
"name": "--esp-color-burger-opened-hover"
|
|
6980
|
-
},
|
|
6981
|
-
{
|
|
6982
|
-
"description": "The stroke width of the burger lines.",
|
|
6983
|
-
"name": "--esp-size-burger-stroke"
|
|
6984
|
-
}
|
|
6985
|
-
],
|
|
6986
|
-
"members": [
|
|
6987
|
-
{
|
|
6988
|
-
"kind": "field",
|
|
6989
|
-
"name": "menuOpen",
|
|
6990
|
-
"type": {
|
|
6991
|
-
"text": "boolean"
|
|
6992
|
-
},
|
|
6993
|
-
"privacy": "public",
|
|
6994
|
-
"default": "false",
|
|
6995
|
-
"description": "Whether or not the burger indicates an open state.",
|
|
6996
|
-
"attribute": "menu-open"
|
|
6997
|
-
},
|
|
6998
|
-
{
|
|
6999
|
-
"kind": "field",
|
|
7000
|
-
"name": "presentationOnly",
|
|
7001
|
-
"type": {
|
|
7002
|
-
"text": "boolean"
|
|
7003
|
-
},
|
|
7004
|
-
"privacy": "public",
|
|
7005
|
-
"default": "false",
|
|
7006
|
-
"description": "Render only the animated burger graphic. Use this when an\nouter control owns activation, labeling, and expanded state.",
|
|
7007
|
-
"attribute": "presentation-only"
|
|
7008
|
-
},
|
|
7009
|
-
{
|
|
7010
|
-
"kind": "method",
|
|
7011
|
-
"name": "toggleMenu"
|
|
7012
|
-
}
|
|
7013
|
-
],
|
|
7014
|
-
"events": [
|
|
7015
|
-
{
|
|
7016
|
-
"name": "opened",
|
|
7017
|
-
"type": {
|
|
7018
|
-
"text": "CustomEvent"
|
|
7019
|
-
},
|
|
7020
|
-
"description": "Emitted when the button is clicked and the image changes from a burger to an X."
|
|
7021
|
-
},
|
|
7022
|
-
{
|
|
7023
|
-
"name": "closed",
|
|
7024
|
-
"type": {
|
|
7025
|
-
"text": "CustomEvent"
|
|
7026
|
-
},
|
|
7027
|
-
"description": "Emitted when the button is clicked and the image changes from an X to a burger. ```html <esp-burger></esp-burger> <script> const theBurger = findByTagName(\"esp-burger\")[0]; theBurger.addEventListener(\"opened\", () => { showToast({ message: \"It would be a good time to show the menu. This message will self-destruct in 4 seconds...\", icon: \"info-i\", duration: 4 }); }); theBurger.addEventListener(\"closed\", () => { showToast({ message: \"It would be a good time to hide the menu. This message will self-destruct in 4 seconds...\", icon: \"info-i\", duration: 4 }); }); </script> ```"
|
|
7028
|
-
}
|
|
7029
|
-
],
|
|
7030
|
-
"attributes": [
|
|
7031
|
-
{
|
|
7032
|
-
"name": "menu-open",
|
|
7033
|
-
"type": {
|
|
7034
|
-
"text": "boolean"
|
|
7035
|
-
},
|
|
7036
|
-
"default": "false",
|
|
7037
|
-
"description": "Whether or not the burger indicates an open state.",
|
|
7038
|
-
"fieldName": "menuOpen"
|
|
7039
|
-
},
|
|
7040
|
-
{
|
|
7041
|
-
"name": "presentation-only",
|
|
7042
|
-
"type": {
|
|
7043
|
-
"text": "boolean"
|
|
7044
|
-
},
|
|
7045
|
-
"default": "false",
|
|
7046
|
-
"description": "Render only the animated burger graphic. Use this when an\nouter control owns activation, labeling, and expanded state.",
|
|
7047
|
-
"fieldName": "presentationOnly"
|
|
7048
|
-
}
|
|
7049
|
-
],
|
|
7050
|
-
"superclass": {
|
|
7051
|
-
"name": "LitElement",
|
|
7052
|
-
"package": "lit"
|
|
7053
|
-
},
|
|
7054
|
-
"docPageTitle": {
|
|
7055
|
-
"name": "Burger",
|
|
7056
|
-
"description": ""
|
|
7057
|
-
},
|
|
7058
|
-
"docUrl": {
|
|
7059
|
-
"name": "/components/burger",
|
|
7060
|
-
"description": ""
|
|
7061
|
-
},
|
|
7062
|
-
"menuGroup": {
|
|
7063
|
-
"name": "Interaction",
|
|
7064
|
-
"description": ""
|
|
7065
|
-
},
|
|
7066
|
-
"menuLabel": {
|
|
7067
|
-
"name": "Burger",
|
|
7068
|
-
"description": ""
|
|
7069
|
-
},
|
|
7070
|
-
"menuIcon": {
|
|
7071
|
-
"name": "burger",
|
|
7072
|
-
"description": ""
|
|
7073
|
-
},
|
|
7074
|
-
"tagName": "esp-burger",
|
|
7075
|
-
"customElement": true
|
|
7076
|
-
}
|
|
7077
|
-
],
|
|
7078
|
-
"exports": [
|
|
7079
|
-
{
|
|
7080
|
-
"kind": "js",
|
|
7081
|
-
"name": "EspalierBurger",
|
|
7082
|
-
"declaration": {
|
|
7083
|
-
"name": "EspalierBurger",
|
|
7084
|
-
"module": "dist/burger/esp-burger.js"
|
|
7085
|
-
}
|
|
7086
|
-
},
|
|
7087
|
-
{
|
|
7088
|
-
"kind": "custom-element-definition",
|
|
7089
|
-
"name": "esp-burger",
|
|
7090
|
-
"declaration": {
|
|
7091
|
-
"name": "EspalierBurger",
|
|
7092
|
-
"module": "dist/burger/esp-burger.js"
|
|
7093
|
-
}
|
|
7094
|
-
}
|
|
7095
|
-
]
|
|
7096
|
-
},
|
|
7097
7004
|
{
|
|
7098
7005
|
"kind": "javascript-module",
|
|
7099
7006
|
"path": "dist/button/action-state-lightness.js",
|
|
@@ -8259,6 +8166,10 @@
|
|
|
8259
8166
|
{
|
|
8260
8167
|
"name": "tabindex"
|
|
8261
8168
|
},
|
|
8169
|
+
{
|
|
8170
|
+
"name": "aria-pressed",
|
|
8171
|
+
"description": "Forwards a toggle's pressed state to the inner native button. Use `\"true\"` while the controlled content is active and `\"false\"` otherwise."
|
|
8172
|
+
},
|
|
8262
8173
|
{
|
|
8263
8174
|
"description": "Renders the button with a borderless, transparent treatment for\nquiet icon or inline actions.\n\n```html\n<esp-button incognito icon-only icon=\"edit\" aria-label=\"Edit\"></esp-button>\n```",
|
|
8264
8175
|
"name": "incognito",
|
|
@@ -8440,6 +8351,147 @@
|
|
|
8440
8351
|
}
|
|
8441
8352
|
]
|
|
8442
8353
|
},
|
|
8354
|
+
{
|
|
8355
|
+
"kind": "javascript-module",
|
|
8356
|
+
"path": "dist/burger/esp-burger.js",
|
|
8357
|
+
"declarations": [
|
|
8358
|
+
{
|
|
8359
|
+
"kind": "class",
|
|
8360
|
+
"description": "Animated burger button for showing and hiding navigation\ncomponents.\n\n```html\n<esp-burger></esp-burger>\n```",
|
|
8361
|
+
"name": "EspalierBurger",
|
|
8362
|
+
"cssProperties": [
|
|
8363
|
+
{
|
|
8364
|
+
"description": "The color of the burger lines when closed.",
|
|
8365
|
+
"name": "--esp-color-burger"
|
|
8366
|
+
},
|
|
8367
|
+
{
|
|
8368
|
+
"description": "The hover color of the burger lines when closed.",
|
|
8369
|
+
"name": "--esp-color-burger-hover"
|
|
8370
|
+
},
|
|
8371
|
+
{
|
|
8372
|
+
"description": "The color of the burger lines when open.",
|
|
8373
|
+
"name": "--esp-color-burger-opened"
|
|
8374
|
+
},
|
|
8375
|
+
{
|
|
8376
|
+
"description": "The hover color of the burger lines when open.",
|
|
8377
|
+
"name": "--esp-color-burger-opened-hover"
|
|
8378
|
+
},
|
|
8379
|
+
{
|
|
8380
|
+
"description": "The stroke width of the burger lines.",
|
|
8381
|
+
"name": "--esp-size-burger-stroke"
|
|
8382
|
+
}
|
|
8383
|
+
],
|
|
8384
|
+
"members": [
|
|
8385
|
+
{
|
|
8386
|
+
"kind": "field",
|
|
8387
|
+
"name": "menuOpen",
|
|
8388
|
+
"type": {
|
|
8389
|
+
"text": "boolean"
|
|
8390
|
+
},
|
|
8391
|
+
"privacy": "public",
|
|
8392
|
+
"default": "false",
|
|
8393
|
+
"description": "Whether or not the burger indicates an open state.",
|
|
8394
|
+
"attribute": "menu-open"
|
|
8395
|
+
},
|
|
8396
|
+
{
|
|
8397
|
+
"kind": "field",
|
|
8398
|
+
"name": "presentationOnly",
|
|
8399
|
+
"type": {
|
|
8400
|
+
"text": "boolean"
|
|
8401
|
+
},
|
|
8402
|
+
"privacy": "public",
|
|
8403
|
+
"default": "false",
|
|
8404
|
+
"description": "Render only the animated burger graphic. Use this when an\nouter control owns activation, labeling, and expanded state.",
|
|
8405
|
+
"attribute": "presentation-only"
|
|
8406
|
+
},
|
|
8407
|
+
{
|
|
8408
|
+
"kind": "method",
|
|
8409
|
+
"name": "toggleMenu"
|
|
8410
|
+
}
|
|
8411
|
+
],
|
|
8412
|
+
"events": [
|
|
8413
|
+
{
|
|
8414
|
+
"name": "opened",
|
|
8415
|
+
"type": {
|
|
8416
|
+
"text": "CustomEvent"
|
|
8417
|
+
},
|
|
8418
|
+
"description": "Emitted when the button is clicked and the image changes from a burger to an X."
|
|
8419
|
+
},
|
|
8420
|
+
{
|
|
8421
|
+
"name": "closed",
|
|
8422
|
+
"type": {
|
|
8423
|
+
"text": "CustomEvent"
|
|
8424
|
+
},
|
|
8425
|
+
"description": "Emitted when the button is clicked and the image changes from an X to a burger. ```html <esp-burger></esp-burger> <script> const theBurger = findByTagName(\"esp-burger\")[0]; theBurger.addEventListener(\"opened\", () => { showToast({ message: \"It would be a good time to show the menu. This message will self-destruct in 4 seconds...\", icon: \"info-i\", duration: 4 }); }); theBurger.addEventListener(\"closed\", () => { showToast({ message: \"It would be a good time to hide the menu. This message will self-destruct in 4 seconds...\", icon: \"info-i\", duration: 4 }); }); </script> ```"
|
|
8426
|
+
}
|
|
8427
|
+
],
|
|
8428
|
+
"attributes": [
|
|
8429
|
+
{
|
|
8430
|
+
"name": "menu-open",
|
|
8431
|
+
"type": {
|
|
8432
|
+
"text": "boolean"
|
|
8433
|
+
},
|
|
8434
|
+
"default": "false",
|
|
8435
|
+
"description": "Whether or not the burger indicates an open state.",
|
|
8436
|
+
"fieldName": "menuOpen"
|
|
8437
|
+
},
|
|
8438
|
+
{
|
|
8439
|
+
"name": "presentation-only",
|
|
8440
|
+
"type": {
|
|
8441
|
+
"text": "boolean"
|
|
8442
|
+
},
|
|
8443
|
+
"default": "false",
|
|
8444
|
+
"description": "Render only the animated burger graphic. Use this when an\nouter control owns activation, labeling, and expanded state.",
|
|
8445
|
+
"fieldName": "presentationOnly"
|
|
8446
|
+
}
|
|
8447
|
+
],
|
|
8448
|
+
"superclass": {
|
|
8449
|
+
"name": "LitElement",
|
|
8450
|
+
"package": "lit"
|
|
8451
|
+
},
|
|
8452
|
+
"docPageTitle": {
|
|
8453
|
+
"name": "Burger",
|
|
8454
|
+
"description": ""
|
|
8455
|
+
},
|
|
8456
|
+
"docUrl": {
|
|
8457
|
+
"name": "/components/burger",
|
|
8458
|
+
"description": ""
|
|
8459
|
+
},
|
|
8460
|
+
"menuGroup": {
|
|
8461
|
+
"name": "Interaction",
|
|
8462
|
+
"description": ""
|
|
8463
|
+
},
|
|
8464
|
+
"menuLabel": {
|
|
8465
|
+
"name": "Burger",
|
|
8466
|
+
"description": ""
|
|
8467
|
+
},
|
|
8468
|
+
"menuIcon": {
|
|
8469
|
+
"name": "burger",
|
|
8470
|
+
"description": ""
|
|
8471
|
+
},
|
|
8472
|
+
"tagName": "esp-burger",
|
|
8473
|
+
"customElement": true
|
|
8474
|
+
}
|
|
8475
|
+
],
|
|
8476
|
+
"exports": [
|
|
8477
|
+
{
|
|
8478
|
+
"kind": "js",
|
|
8479
|
+
"name": "EspalierBurger",
|
|
8480
|
+
"declaration": {
|
|
8481
|
+
"name": "EspalierBurger",
|
|
8482
|
+
"module": "dist/burger/esp-burger.js"
|
|
8483
|
+
}
|
|
8484
|
+
},
|
|
8485
|
+
{
|
|
8486
|
+
"kind": "custom-element-definition",
|
|
8487
|
+
"name": "esp-burger",
|
|
8488
|
+
"declaration": {
|
|
8489
|
+
"name": "EspalierBurger",
|
|
8490
|
+
"module": "dist/burger/esp-burger.js"
|
|
8491
|
+
}
|
|
8492
|
+
}
|
|
8493
|
+
]
|
|
8494
|
+
},
|
|
8443
8495
|
{
|
|
8444
8496
|
"kind": "javascript-module",
|
|
8445
8497
|
"path": "dist/checkbox/esp-checkbox-group.js",
|
|
@@ -16224,7 +16276,7 @@
|
|
|
16224
16276
|
"declarations": [
|
|
16225
16277
|
{
|
|
16226
16278
|
"kind": "class",
|
|
16227
|
-
"description": "A transient panel for help, more-info, and preview content that\nclaims designed spare width before ever covering the page.\n\nPlace one `esp-flyout` in an `esp-page`'s `flyout` slot. The panel\nlives on the canvas, outside the content surface. The page decides\nwhere it goes, from widest viewport to narrowest:\n\n1. **Gutter** — the panel occupies the right canvas gutter. When the\n gutter already has room, it claims existing spare canvas and the\n main content does not move at all, on any alignment.\n2. **Shift** — when the gutter is not quite wide enough, the surface\n slides toward `start` by exactly the shortfall (no more) to free\n the difference.\n3. **Docked sidebar** — once the gutter is gone, the panel competes\n for width with the main well; content narrows but is never\n covered.\n4. **Overlay drawer** — below the mobile threshold (`50em`, the\n same one the `esp-menu` drawer uses) the panel becomes a fixed\n drawer over a vellum backdrop. Set `mode=\"overlay\"` to get this\n presentation at every width.\n\nThe panel is styled as a tear-off piece: a dotted perforation on\nits leading edge, rounded trailing corners, and no shadow — all\noverridable through the `--esp-flyout-*` tokens below.\n\nA11y follows the presentation. In the in-grid modes (1–3) the\nflyout is a non-modal `complementary` landmark named by its\n`heading`, and opening it never steals focus. In the overlay-drawer\nmode (4) it is a true modal: `role=\"dialog\"` + `aria-modal`, the\nbackground goes inert, scroll is locked, focus moves into the drawer\nand is trapped, and focus is restored on close. `Escape` closes it\nin every mode.\n\n```html\n<style>\nesp-page.flyout-demo {\n --esp-page-max-width: 420px;\n --esp-page-canvas-background: var(--esp-color-layer-1);\n &::part(wrapper) {\n min-height: 320px;\n height: 320px;\n }\n > div {\n padding: var(--esp-size-padding);\n }\n}\n</style>\n<esp-page class=\"flyout-demo\" align=\"center\">\n <esp-flyout slot=\"flyout\" heading=\"More info\" id=\"demo-flyout\" standalone>\n <p>Spare width claimed; the well shifted only enough to make room.</p>\n </esp-flyout>\n <div>\n <esp-button id=\"toggle-flyout\" label=\"Toggle flyout\" collapsed></esp-button>\n </div>\n</esp-page>\n<script>\n const flyout = findById(\"demo-flyout\");\n findById(\"toggle-flyout\").addEventListener(\"clicked\", () => flyout.toggle());\n</script>\n```\n\nBy default the panel is a tear-off — a dotted perforation on its\nleading edge, rounded trailing corners, no shadow. Add\n`match-surface` to lift the trailing edge with the page's surface\nedge shadow, so the flyout reads as a raised peer of the content it\nflies out from while staying attached at the leading perforation:\n\n```html\n<style>\nesp-page.flyout-match-demo {\n --esp-page-max-width: 420px;\n &::part(wrapper) {\n min-height: 320px;\n height: 320px;\n }\n > div {\n padding: var(--esp-size-padding);\n }\n}\n</style>\n<esp-page class=\"flyout-match-demo\" align=\"center\">\n <esp-flyout slot=\"flyout\" heading=\"More info\" id=\"match-flyout\" match-surface standalone>\n <p>Attached at the perforation, trailing edge raised like the surface.</p>\n </esp-flyout>\n <div>\n <esp-button id=\"toggle-match\" label=\"Toggle flyout\" collapsed></esp-button>\n </div>\n</esp-page>\n<script>\n const matchFlyout = findById(\"match-flyout\");\n findById(\"toggle-match\").addEventListener(\"clicked\", () => matchFlyout.toggle());\n</script>\n```\n\nWhen the page has no spare width to claim — a `kind=\"full\"` page,\nor a capped page on a viewport at the cap — the open flyout docks\nas a right sidebar and the content makes room:\n\n```html\n<style>\nesp-page.flyout-docked-demo {\n &::part(wrapper) {\n min-height: 320px;\n height: 320px;\n }\n > div {\n padding: var(--esp-size-padding);\n }\n}\n</style>\n<esp-page class=\"flyout-docked-demo\" kind=\"full\">\n <esp-flyout slot=\"flyout\" heading=\"Docked\" id=\"docked-flyout\" standalone>\n <p>No gutter to claim, so the content narrows instead.</p>\n </esp-flyout>\n <div>\n <p>A <code>kind=\"full\"</code> page has no canvas gutters at any\n width — the flyout squeezes the main well and never covers it.</p>\n <esp-button id=\"toggle-docked\" label=\"Toggle flyout\" collapsed></esp-button>\n </div>\n</esp-page>\n<script>\n const dockedFlyout = findById(\"docked-flyout\");\n findById(\"toggle-docked\").addEventListener(\"clicked\", () => dockedFlyout.toggle());\n</script>\n```\n\nBelow the `50em` viewport threshold every flyout becomes a fixed\noverlay drawer over a vellum — there is no room for a side-by-side\nsplit on a phone. `mode=\"overlay\"` forces that presentation at any\nwidth (try it here; `Escape` or the vellum closes it):\n\n```html\n<style>\nesp-page.flyout-overlay-demo {\n &::part(wrapper) {\n min-height: 160px;\n height: 160px;\n }\n > div {\n padding: var(--esp-size-padding);\n }\n}\n</style>\n<esp-page class=\"flyout-overlay-demo\">\n <esp-flyout slot=\"flyout\" heading=\"Overlay drawer\" mode=\"overlay\" id=\"overlay-flyout\" standalone>\n <p>A fixed drawer over a vellum — what every flyout becomes on\n small viewports.</p>\n </esp-flyout>\n <div>\n <esp-button id=\"open-overlay\" label=\"Open overlay flyout\" collapsed></esp-button>\n </div>\n</esp-page>\n<script>\n const overlayFlyout = findById(\"overlay-flyout\");\n findById(\"open-overlay\").addEventListener(\"clicked\", () => overlayFlyout.toggle());\n</script>\n```\n\nComponents that cannot know where the flyout lives can request it\nover the bus with `showFlyout()` — the same pattern `showToast()`\nuses. A second request swaps the content in place; it never\nstacks. Content passed as a string renders as plain text; pass a\n`Node` for rich content. Pass the triggering element as `anchor` to\nalign the in-grid panel with that control and keep both in the same\nscroll flow. If the panel would cross the visible viewport's bottom,\nit shifts up only far enough to fit and returns to its natural trigger\nalignment as the page scrolls. Content taller than the viewport\nscrolls inside the panel. Overlay drawers stay
|
|
16279
|
+
"description": "A transient panel for help, more-info, and preview content that\nclaims designed spare width before ever covering the page.\n\nPlace one `esp-flyout` in an `esp-page`'s `flyout` slot. The panel\nlives on the canvas, outside the content surface. The page decides\nwhere it goes, from widest viewport to narrowest:\n\n1. **Gutter** — the panel occupies the right canvas gutter. When the\n gutter already has room, it claims existing spare canvas and the\n main content does not move at all, on any alignment.\n2. **Shift** — when the gutter is not quite wide enough, the surface\n slides toward `start` by exactly the shortfall (no more) to free\n the difference.\n3. **Docked sidebar** — once the gutter is gone, the panel competes\n for width with the main well; content narrows but is never\n covered.\n4. **Overlay drawer** — below the mobile threshold (`50em`, the\n same one the `esp-menu` drawer uses) the panel becomes a fixed\n drawer over a vellum backdrop. Set `mode=\"overlay\"` to get this\n presentation at every width.\n\nThe panel is styled as a tear-off piece: a dotted perforation on\nits leading edge, rounded trailing corners, and no shadow — all\noverridable through the `--esp-flyout-*` tokens below.\n\nA11y follows the presentation. In the in-grid modes (1–3) the\nflyout is a non-modal `complementary` landmark named by its\n`heading`, and opening it never steals focus. In the overlay-drawer\nmode (4) it is a true modal: `role=\"dialog\"` + `aria-modal`, the\nbackground goes inert, scroll is locked, focus moves into the drawer\nand is trapped, and focus is restored on close. `Escape` closes it\nin every mode.\n\n```html\n<style>\nesp-page.flyout-demo {\n --esp-page-max-width: 420px;\n --esp-page-canvas-background: var(--esp-color-layer-1);\n &::part(wrapper) {\n min-height: 320px;\n height: 320px;\n }\n > div {\n padding: var(--esp-size-padding);\n }\n}\n</style>\n<esp-page class=\"flyout-demo\" align=\"center\">\n <esp-flyout slot=\"flyout\" heading=\"More info\" id=\"demo-flyout\" standalone>\n <p>Spare width claimed; the well shifted only enough to make room.</p>\n </esp-flyout>\n <div>\n <esp-button id=\"toggle-flyout\" label=\"Toggle flyout\" collapsed></esp-button>\n </div>\n</esp-page>\n<script>\n const flyout = findById(\"demo-flyout\");\n findById(\"toggle-flyout\").addEventListener(\"clicked\", () => flyout.toggle());\n</script>\n```\n\nBy default the panel is a tear-off — a dotted perforation on its\nleading edge, rounded trailing corners, no shadow. Add\n`match-surface` to lift the trailing edge with the page's surface\nedge shadow, so the flyout reads as a raised peer of the content it\nflies out from while staying attached at the leading perforation:\n\n```html\n<style>\nesp-page.flyout-match-demo {\n --esp-page-max-width: 420px;\n &::part(wrapper) {\n min-height: 320px;\n height: 320px;\n }\n > div {\n padding: var(--esp-size-padding);\n }\n}\n</style>\n<esp-page class=\"flyout-match-demo\" align=\"center\">\n <esp-flyout slot=\"flyout\" heading=\"More info\" id=\"match-flyout\" match-surface standalone>\n <p>Attached at the perforation, trailing edge raised like the surface.</p>\n </esp-flyout>\n <div>\n <esp-button id=\"toggle-match\" label=\"Toggle flyout\" collapsed></esp-button>\n </div>\n</esp-page>\n<script>\n const matchFlyout = findById(\"match-flyout\");\n findById(\"toggle-match\").addEventListener(\"clicked\", () => matchFlyout.toggle());\n</script>\n```\n\nWhen the page has no spare width to claim — a `kind=\"full\"` page,\nor a capped page on a viewport at the cap — the open flyout docks\nas a right sidebar and the content makes room:\n\n```html\n<style>\nesp-page.flyout-docked-demo {\n &::part(wrapper) {\n min-height: 320px;\n height: 320px;\n }\n > div {\n padding: var(--esp-size-padding);\n }\n}\n</style>\n<esp-page class=\"flyout-docked-demo\" kind=\"full\">\n <esp-flyout slot=\"flyout\" heading=\"Docked\" id=\"docked-flyout\" standalone>\n <p>No gutter to claim, so the content narrows instead.</p>\n </esp-flyout>\n <div>\n <p>A <code>kind=\"full\"</code> page has no canvas gutters at any\n width — the flyout squeezes the main well and never covers it.</p>\n <esp-button id=\"toggle-docked\" label=\"Toggle flyout\" collapsed></esp-button>\n </div>\n</esp-page>\n<script>\n const dockedFlyout = findById(\"docked-flyout\");\n findById(\"toggle-docked\").addEventListener(\"clicked\", () => dockedFlyout.toggle());\n</script>\n```\n\nBelow the `50em` viewport threshold every flyout becomes a fixed\noverlay drawer over a vellum — there is no room for a side-by-side\nsplit on a phone. `mode=\"overlay\"` forces that presentation at any\nwidth (try it here; `Escape` or the vellum closes it):\n\n```html\n<style>\nesp-page.flyout-overlay-demo {\n &::part(wrapper) {\n min-height: 160px;\n height: 160px;\n }\n > div {\n padding: var(--esp-size-padding);\n }\n}\n</style>\n<esp-page class=\"flyout-overlay-demo\">\n <esp-flyout slot=\"flyout\" heading=\"Overlay drawer\" mode=\"overlay\" id=\"overlay-flyout\" standalone>\n <p>A fixed drawer over a vellum — what every flyout becomes on\n small viewports.</p>\n </esp-flyout>\n <div>\n <esp-button id=\"open-overlay\" label=\"Open overlay flyout\" collapsed></esp-button>\n </div>\n</esp-page>\n<script>\n const overlayFlyout = findById(\"overlay-flyout\");\n findById(\"open-overlay\").addEventListener(\"clicked\", () => overlayFlyout.toggle());\n</script>\n```\n\nComponents that cannot know where the flyout lives can request it\nover the bus with `showFlyout()` — the same pattern `showToast()`\nuses. A second request swaps the content in place; it never\nstacks. Content passed as a string renders as plain text; pass a\n`Node` for rich content. Pass the triggering element as `anchor` to\nalign the in-grid panel with that control and keep both in the same\nscroll flow. If the panel would cross the visible viewport's bottom,\nit shifts up only far enough to fit and returns to its natural trigger\nalignment as the page scrolls. Content taller than the viewport\nscrolls inside the panel. Pass `fullHeight: true` (or set the\n`full-height` attribute) when a reading surface should fill the visible\nblock-size even when its content is short. Overlay drawers stay\nviewport-fixed.\n\nBus requests anchored inside nested pages are presented by the\noutermost containing page's flyout by default. This keeps previews,\nembedded tools, and nested layouts from trapping application-level\nhelp or detail panels. Set `scope=\"nearest\"` on a nested flyout when\nthat page should explicitly own requests originating inside it.\nThe demos above are each driven by their own toggle button, so they\nare marked `standalone` to opt out of the bus entirely.\n\n```html\n<style>\nesp-page.flyout-bus-demo {\n --esp-page-max-width: 420px;\n &::part(wrapper) {\n min-height: 320px;\n }\n > div {\n padding: var(--esp-size-padding);\n }\n .flyout-demo-copy {\n max-inline-size: 42ch;\n }\n}\n</style>\n<esp-page class=\"flyout-bus-demo\">\n <esp-flyout slot=\"flyout\"></esp-flyout>\n <div>\n <esp-button id=\"show-apples\" label=\"Apples\" collapsed></esp-button>\n <div class=\"flyout-demo-copy\">\n <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod\n tempor incididunt ut labore et dolore magna aliqua.</p>\n <p>Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi\n ut aliquip ex ea commodo consequat.</p>\n <p>Duis aute irure dolor in reprehenderit in voluptate velit esse cillum\n dolore eu fugiat nulla pariatur.</p>\n </div>\n <esp-button id=\"show-pears\" label=\"Pears\" collapsed></esp-button>\n <template id=\"pears-description\">\n <p>Ripen pears at room temperature until the neck yields gently to\n pressure, then refrigerate them to slow further ripening.</p>\n <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer\n nec odio. Praesent libero. Sed cursus ante dapibus diam.</p>\n <p>Sed nisi. Nulla quis sem at nibh elementum imperdiet. Duis\n sagittis ipsum. Praesent mauris. Fusce nec tellus sed augue semper\n porta.</p>\n <p>Mauris massa. Vestibulum lacinia arcu eget nulla. Class aptent\n taciti sociosqu ad litora torquent per conubia nostra.</p>\n <p>Curabitur sodales ligula in libero. Sed dignissim lacinia nunc.\n Curabitur tortor. Pellentesque nibh. Aenean quam.</p>\n <p>In scelerisque sem at dolor. Maecenas mattis. Sed convallis\n tristique sem. Proin ut ligula vel nunc egestas porttitor.</p>\n <p>Morbi lectus risus, iaculis vel, suscipit quis, luctus non,\n massa. Fusce ac turpis quis ligula lacinia aliquet.</p>\n <p>Mauris ipsum. Nulla metus metus, ullamcorper vel, tincidunt sed,\n euismod in, nibh. Quisque volutpat condimentum velit.</p>\n </template>\n <div class=\"flyout-demo-copy\">\n <p>Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia\n deserunt mollit anim id est laborum.</p>\n <p>Curabitur pretium tincidunt lacus. Nulla gravida orci a odio, nullam\n varius, turpis et commodo pharetra.</p>\n </div>\n </div>\n</esp-page>\n<script>\n const applesButton = findById(\"show-apples\");\n applesButton.addEventListener(\"clicked\", () => {\n showFlyout({ heading: \"Apples\", content: \"Crisp. Store cold.\", anchor: applesButton });\n });\n const pearsButton = findById(\"show-pears\");\n const pearsDescription = findById(\"pears-description\");\n pearsButton.addEventListener(\"clicked\", () => {\n showFlyout({\n heading: \"Pears\",\n content: pearsDescription.content.cloneNode(true),\n anchor: pearsButton,\n });\n });\n</script>\n```",
|
|
16228
16280
|
"name": "EspalierFlyout",
|
|
16229
16281
|
"cssProperties": [
|
|
16230
16282
|
{
|
|
@@ -16371,7 +16423,19 @@
|
|
|
16371
16423
|
"text": "HTMLElement | undefined"
|
|
16372
16424
|
},
|
|
16373
16425
|
"privacy": "public",
|
|
16374
|
-
"description": "Triggering element whose block-start edge the in-grid panel should\nalign with. Anchored panels
|
|
16426
|
+
"description": "Triggering element whose block-start edge the in-grid panel should\nalign with. Anchored panels size to their content when it fits, shift\nonly enough to remain visible when it does not, and keep an edge\nmarker aligned with the trigger. Overlay drawers ignore this geometry\nand remain fixed to the viewport."
|
|
16427
|
+
},
|
|
16428
|
+
{
|
|
16429
|
+
"kind": "field",
|
|
16430
|
+
"name": "fullHeight",
|
|
16431
|
+
"type": {
|
|
16432
|
+
"text": "boolean"
|
|
16433
|
+
},
|
|
16434
|
+
"privacy": "public",
|
|
16435
|
+
"default": "false",
|
|
16436
|
+
"description": "Fill the visible block-size in gutter and docked modes. The content\nregion scrolls independently. Overlay drawers already fill the viewport.",
|
|
16437
|
+
"attribute": "full-height",
|
|
16438
|
+
"reflects": true
|
|
16375
16439
|
},
|
|
16376
16440
|
{
|
|
16377
16441
|
"kind": "field",
|
|
@@ -16393,10 +16457,22 @@
|
|
|
16393
16457
|
},
|
|
16394
16458
|
"privacy": "public",
|
|
16395
16459
|
"default": "false",
|
|
16396
|
-
"description": "Whether this flyout ignores the shared `showFlyout()` /\n`closeFlyout()` bus and is driven only through its own\n`show()` / `close()` / `toggle()` API.\n\nBy default a flyout services the bus, so a single flyout in a\npage \"just works\" as the target of `showFlyout()` — the same\nzero-config model as `<esp-toaster>` and `showToast()`.
|
|
16460
|
+
"description": "Whether this flyout ignores the shared `showFlyout()` /\n`closeFlyout()` bus and is driven only through its own\n`show()` / `close()` / `toggle()` API.\n\nBy default a flyout services the bus, so a single flyout in a\npage \"just works\" as the target of `showFlyout()` — the same\nzero-config model as `<esp-toaster>` and `showToast()`. Anchored\nrequests resolve to one page scope according to `scope`; set\n`standalone` on flyouts that should never answer the bus.",
|
|
16397
16461
|
"attribute": "standalone",
|
|
16398
16462
|
"reflects": true
|
|
16399
16463
|
},
|
|
16464
|
+
{
|
|
16465
|
+
"kind": "field",
|
|
16466
|
+
"name": "scope",
|
|
16467
|
+
"type": {
|
|
16468
|
+
"text": "\"outermost\" | \"nearest\""
|
|
16469
|
+
},
|
|
16470
|
+
"privacy": "public",
|
|
16471
|
+
"default": "\"outermost\"",
|
|
16472
|
+
"description": "Which containing page owns anchored bus requests.\n\n- `\"outermost\"` (default) routes to the flyout in the outermost\n `esp-page` containing the request trigger.\n- `\"nearest\"` explicitly gives this flyout precedence for requests\n originating in its own page or nested descendants.\n\nA `scope=\"nearest\"` flyout must be a light-DOM descendant of the\n`esp-page` whose requests it owns so that page can discover it.\n\nRequests without an `anchor` or `returnFocusTo` have no local context,\nso only outermost page flyouts service them. Use the instance API for\na directly controlled nested flyout.",
|
|
16473
|
+
"attribute": "scope",
|
|
16474
|
+
"reflects": true
|
|
16475
|
+
},
|
|
16400
16476
|
{
|
|
16401
16477
|
"kind": "field",
|
|
16402
16478
|
"name": "returnFocusTo",
|
|
@@ -16450,6 +16526,11 @@
|
|
|
16450
16526
|
"name": "boundAnchorViewportChange",
|
|
16451
16527
|
"privacy": "private"
|
|
16452
16528
|
},
|
|
16529
|
+
{
|
|
16530
|
+
"kind": "field",
|
|
16531
|
+
"name": "boundFullHeightRequest",
|
|
16532
|
+
"privacy": "private"
|
|
16533
|
+
},
|
|
16453
16534
|
{
|
|
16454
16535
|
"kind": "field",
|
|
16455
16536
|
"name": "anchorPositionRaf",
|
|
@@ -16627,6 +16708,60 @@
|
|
|
16627
16708
|
],
|
|
16628
16709
|
"description": "Service a `\"show-flyout\"` bus request: swap in the requested\nheading/content (never stacking) and open."
|
|
16629
16710
|
},
|
|
16711
|
+
{
|
|
16712
|
+
"kind": "method",
|
|
16713
|
+
"name": "shouldHandleShowRequest",
|
|
16714
|
+
"privacy": "private",
|
|
16715
|
+
"return": {
|
|
16716
|
+
"type": {
|
|
16717
|
+
"text": "boolean"
|
|
16718
|
+
}
|
|
16719
|
+
},
|
|
16720
|
+
"parameters": [
|
|
16721
|
+
{
|
|
16722
|
+
"name": "config",
|
|
16723
|
+
"type": {
|
|
16724
|
+
"text": "FlyoutConfig"
|
|
16725
|
+
}
|
|
16726
|
+
}
|
|
16727
|
+
]
|
|
16728
|
+
},
|
|
16729
|
+
{
|
|
16730
|
+
"kind": "method",
|
|
16731
|
+
"name": "getPageChain",
|
|
16732
|
+
"privacy": "private",
|
|
16733
|
+
"return": {
|
|
16734
|
+
"type": {
|
|
16735
|
+
"text": "HTMLElement[]"
|
|
16736
|
+
}
|
|
16737
|
+
},
|
|
16738
|
+
"parameters": [
|
|
16739
|
+
{
|
|
16740
|
+
"name": "from",
|
|
16741
|
+
"type": {
|
|
16742
|
+
"text": "Element"
|
|
16743
|
+
}
|
|
16744
|
+
}
|
|
16745
|
+
]
|
|
16746
|
+
},
|
|
16747
|
+
{
|
|
16748
|
+
"kind": "method",
|
|
16749
|
+
"name": "hasNearestScopeFlyout",
|
|
16750
|
+
"privacy": "private",
|
|
16751
|
+
"return": {
|
|
16752
|
+
"type": {
|
|
16753
|
+
"text": "boolean"
|
|
16754
|
+
}
|
|
16755
|
+
},
|
|
16756
|
+
"parameters": [
|
|
16757
|
+
{
|
|
16758
|
+
"name": "page",
|
|
16759
|
+
"type": {
|
|
16760
|
+
"text": "HTMLElement"
|
|
16761
|
+
}
|
|
16762
|
+
}
|
|
16763
|
+
]
|
|
16764
|
+
},
|
|
16630
16765
|
{
|
|
16631
16766
|
"kind": "method",
|
|
16632
16767
|
"name": "handleKeydown",
|
|
@@ -16664,7 +16799,7 @@
|
|
|
16664
16799
|
"text": "void"
|
|
16665
16800
|
}
|
|
16666
16801
|
},
|
|
16667
|
-
"description": "Position an anchored in-grid flyout at the trigger
|
|
16802
|
+
"description": "Position an anchored in-grid flyout at the trigger. Content-height\npanels shift upward only when they would overflow; explicitly\nfull-height panels use the complete scrollport. The leading-edge\nmarker remains aligned with the trigger for contextual help and is\nomitted from the full-height reading surface."
|
|
16668
16803
|
},
|
|
16669
16804
|
{
|
|
16670
16805
|
"kind": "method",
|
|
@@ -17335,6 +17470,15 @@
|
|
|
17335
17470
|
"description": "Placement behavior.\n\n- `\"auto\"` (default) — the page's placement ladder: gutter,\n docked sidebar, then overlay drawer below the `50em` viewport\n threshold.\n- `\"overlay\"` — always the fixed overlay drawer, at any width.\n The page never reserves a grid track for an overlay-mode\n flyout.",
|
|
17336
17471
|
"fieldName": "mode"
|
|
17337
17472
|
},
|
|
17473
|
+
{
|
|
17474
|
+
"name": "full-height",
|
|
17475
|
+
"type": {
|
|
17476
|
+
"text": "boolean"
|
|
17477
|
+
},
|
|
17478
|
+
"default": "false",
|
|
17479
|
+
"description": "Fill the visible block-size in gutter and docked modes. The content\nregion scrolls independently. Overlay drawers already fill the viewport.",
|
|
17480
|
+
"fieldName": "fullHeight"
|
|
17481
|
+
},
|
|
17338
17482
|
{
|
|
17339
17483
|
"name": "match-surface",
|
|
17340
17484
|
"type": {
|
|
@@ -17350,9 +17494,18 @@
|
|
|
17350
17494
|
"text": "boolean"
|
|
17351
17495
|
},
|
|
17352
17496
|
"default": "false",
|
|
17353
|
-
"description": "Whether this flyout ignores the shared `showFlyout()` /\n`closeFlyout()` bus and is driven only through its own\n`show()` / `close()` / `toggle()` API.\n\nBy default a flyout services the bus, so a single flyout in a\npage \"just works\" as the target of `showFlyout()` — the same\nzero-config model as `<esp-toaster>` and `showToast()`.
|
|
17497
|
+
"description": "Whether this flyout ignores the shared `showFlyout()` /\n`closeFlyout()` bus and is driven only through its own\n`show()` / `close()` / `toggle()` API.\n\nBy default a flyout services the bus, so a single flyout in a\npage \"just works\" as the target of `showFlyout()` — the same\nzero-config model as `<esp-toaster>` and `showToast()`. Anchored\nrequests resolve to one page scope according to `scope`; set\n`standalone` on flyouts that should never answer the bus.",
|
|
17354
17498
|
"fieldName": "standalone"
|
|
17355
17499
|
},
|
|
17500
|
+
{
|
|
17501
|
+
"name": "scope",
|
|
17502
|
+
"type": {
|
|
17503
|
+
"text": "\"outermost\" | \"nearest\""
|
|
17504
|
+
},
|
|
17505
|
+
"default": "\"outermost\"",
|
|
17506
|
+
"description": "Which containing page owns anchored bus requests.\n\n- `\"outermost\"` (default) routes to the flyout in the outermost\n `esp-page` containing the request trigger.\n- `\"nearest\"` explicitly gives this flyout precedence for requests\n originating in its own page or nested descendants.\n\nA `scope=\"nearest\"` flyout must be a light-DOM descendant of the\n`esp-page` whose requests it owns so that page can discover it.\n\nRequests without an `anchor` or `returnFocusTo` have no local context,\nso only outermost page flyouts service them. Use the instance API for\na directly controlled nested flyout.",
|
|
17507
|
+
"fieldName": "scope"
|
|
17508
|
+
},
|
|
17356
17509
|
{
|
|
17357
17510
|
"name": "scheme",
|
|
17358
17511
|
"type": {
|
|
@@ -22166,6 +22319,14 @@
|
|
|
22166
22319
|
"name": "fieldSlot",
|
|
22167
22320
|
"privacy": "private"
|
|
22168
22321
|
},
|
|
22322
|
+
{
|
|
22323
|
+
"kind": "field",
|
|
22324
|
+
"name": "fieldElement",
|
|
22325
|
+
"type": {
|
|
22326
|
+
"text": "HTMLElement | undefined"
|
|
22327
|
+
},
|
|
22328
|
+
"privacy": "private"
|
|
22329
|
+
},
|
|
22169
22330
|
{
|
|
22170
22331
|
"kind": "field",
|
|
22171
22332
|
"name": "theField",
|
|
@@ -22361,6 +22522,28 @@
|
|
|
22361
22522
|
"description": "Identifies this form item's field. Serves two purposes:\n1. Filters errors from the bound `errorPool` to show only\n errors whose `fieldName` matches.\n2. Propagates as the `name` attribute on the slotted form\n field, so there is no need to set `name` separately.",
|
|
22362
22523
|
"attribute": "field-name"
|
|
22363
22524
|
},
|
|
22525
|
+
{
|
|
22526
|
+
"kind": "field",
|
|
22527
|
+
"name": "helpUrl",
|
|
22528
|
+
"type": {
|
|
22529
|
+
"text": "string"
|
|
22530
|
+
},
|
|
22531
|
+
"privacy": "public",
|
|
22532
|
+
"default": "\"\"",
|
|
22533
|
+
"description": "Per-field help document override. A URL fragment selects the topic;\notherwise `field-name` supplies the anchor. When omitted, the nearest\ncomposed-tree ancestor's `help-src` is used.\n\n```html\n<esp-form-item\n label=\"Email address\"\n field-name=\"email\"\n help-url=\"/help/account.html#contact-email\">\n <esp-input type=\"email\"></esp-input>\n</esp-form-item>\n```",
|
|
22534
|
+
"attribute": "help-url"
|
|
22535
|
+
},
|
|
22536
|
+
{
|
|
22537
|
+
"kind": "field",
|
|
22538
|
+
"name": "helpTitleSource",
|
|
22539
|
+
"type": {
|
|
22540
|
+
"text": "\"field\" | \"document\""
|
|
22541
|
+
},
|
|
22542
|
+
"privacy": "public",
|
|
22543
|
+
"default": "\"field\"",
|
|
22544
|
+
"description": "Chooses the flyout title for form-context help. The default, `field`,\nuses this form item's visible `label`. Set `document` to adopt the text\nof the matched heading in the help document instead.",
|
|
22545
|
+
"attribute": "help-title-source"
|
|
22546
|
+
},
|
|
22364
22547
|
{
|
|
22365
22548
|
"kind": "field",
|
|
22366
22549
|
"name": "errorPool",
|
|
@@ -22530,6 +22713,24 @@
|
|
|
22530
22713
|
"description": "Identifies this form item's field. Serves two purposes:\n1. Filters errors from the bound `errorPool` to show only\n errors whose `fieldName` matches.\n2. Propagates as the `name` attribute on the slotted form\n field, so there is no need to set `name` separately.",
|
|
22531
22714
|
"fieldName": "fieldName"
|
|
22532
22715
|
},
|
|
22716
|
+
{
|
|
22717
|
+
"name": "help-url",
|
|
22718
|
+
"type": {
|
|
22719
|
+
"text": "string"
|
|
22720
|
+
},
|
|
22721
|
+
"default": "\"\"",
|
|
22722
|
+
"description": "Per-field help document override. A URL fragment selects the topic;\notherwise `field-name` supplies the anchor. When omitted, the nearest\ncomposed-tree ancestor's `help-src` is used.\n\n```html\n<esp-form-item\n label=\"Email address\"\n field-name=\"email\"\n help-url=\"/help/account.html#contact-email\">\n <esp-input type=\"email\"></esp-input>\n</esp-form-item>\n```",
|
|
22723
|
+
"fieldName": "helpUrl"
|
|
22724
|
+
},
|
|
22725
|
+
{
|
|
22726
|
+
"name": "help-title-source",
|
|
22727
|
+
"type": {
|
|
22728
|
+
"text": "\"field\" | \"document\""
|
|
22729
|
+
},
|
|
22730
|
+
"default": "\"field\"",
|
|
22731
|
+
"description": "Chooses the flyout title for form-context help. The default, `field`,\nuses this form item's visible `label`. Set `document` to adopt the text\nof the matched heading in the help document instead.",
|
|
22732
|
+
"fieldName": "helpTitleSource"
|
|
22733
|
+
},
|
|
22533
22734
|
{
|
|
22534
22735
|
"name": "error-pool",
|
|
22535
22736
|
"type": {
|
|
@@ -26119,206 +26320,1962 @@
|
|
|
26119
26320
|
}
|
|
26120
26321
|
}
|
|
26121
26322
|
],
|
|
26122
|
-
"events": [
|
|
26123
|
-
{
|
|
26124
|
-
"type": {
|
|
26125
|
-
"text": "CustomEvent<EspThemeToggleEventDetail>"
|
|
26126
|
-
},
|
|
26127
|
-
"description": "Fired after the built-in theme toggle changes the nearest `esp-root`. Bubbles and crosses the shadow boundary.",
|
|
26128
|
-
"name": "esp-theme-toggle"
|
|
26129
|
-
},
|
|
26323
|
+
"events": [
|
|
26324
|
+
{
|
|
26325
|
+
"type": {
|
|
26326
|
+
"text": "CustomEvent<EspThemeToggleEventDetail>"
|
|
26327
|
+
},
|
|
26328
|
+
"description": "Fired after the built-in theme toggle changes the nearest `esp-root`. Bubbles and crosses the shadow boundary.",
|
|
26329
|
+
"name": "esp-theme-toggle"
|
|
26330
|
+
},
|
|
26331
|
+
{
|
|
26332
|
+
"name": "value-changed",
|
|
26333
|
+
"type": {
|
|
26334
|
+
"text": "CustomEvent"
|
|
26335
|
+
},
|
|
26336
|
+
"inheritedFrom": {
|
|
26337
|
+
"name": "EspalierElementBase",
|
|
26338
|
+
"module": "dist/shared/esp-element-base.js"
|
|
26339
|
+
}
|
|
26340
|
+
}
|
|
26341
|
+
],
|
|
26342
|
+
"attributes": [
|
|
26343
|
+
{
|
|
26344
|
+
"name": "show-burger",
|
|
26345
|
+
"type": {
|
|
26346
|
+
"text": "boolean"
|
|
26347
|
+
},
|
|
26348
|
+
"default": "false",
|
|
26349
|
+
"description": "Force the burger button to be visible regardless of the\nmenu width. Use this when the burger controls an external\nelement (e.g. a sidebar drawer) instead of the built-in\n`<esp-menu>` overlay.",
|
|
26350
|
+
"fieldName": "showBurger"
|
|
26351
|
+
},
|
|
26352
|
+
{
|
|
26353
|
+
"name": "layout",
|
|
26354
|
+
"type": {
|
|
26355
|
+
"text": "HeaderLayout"
|
|
26356
|
+
},
|
|
26357
|
+
"description": "Header layout style.\n\n- `standard` places brand, menu, and actions on one row.\n- `centered-brand` centers the brand between left navigation and actions.\n- `extended` puts navigation on a second row on wide screens.\n- `extended-centered` centers the brand and second-row navigation.\n- `minimal` keeps only brand/actions inline and uses the drawer menu.\n\n```html\n<div style=\"display: grid; gap: var(--esp-size-padding);\">\n <esp-header\n brand-logo=\"/assets/favicon.svg\"\n brand-text=\"Espalier\"\n brand-href=\"#\"\n brand-alt=\"Espalier logo\"\n layout=\"standard\"\n theme-toggle=\"visible\">\n <esp-menu slot=\"menu\" mode=\"horizontal\">\n <esp-menu-item label=\"Components\" url=\"#components\"></esp-menu-item>\n <esp-menu-item label=\"Guides\" url=\"#guides\"></esp-menu-item>\n </esp-menu>\n </esp-header>\n\n <div\n style=\"\n display: grid;\n gap: var(--esp-size-small);\n \">\n <esp-form-item label=\"Header layout\">\n <esp-pick-one>\n <esp-picker-item text=\"Standard\" value=\"standard\" selected></esp-picker-item>\n <esp-picker-item text=\"Centered brand\" value=\"centered-brand\"></esp-picker-item>\n <esp-picker-item text=\"Extended\" value=\"extended\"></esp-picker-item>\n <esp-picker-item text=\"Extended centered\" value=\"extended-centered\"></esp-picker-item>\n <esp-picker-item text=\"Minimal\" value=\"minimal\"></esp-picker-item>\n </esp-pick-one>\n </esp-form-item>\n </div>\n</div>\n<script>\n const header = findByTagName(\"esp-header\")[0];\n const picker = findByTagName(\"esp-pick-one\")[0];\n\n function applyLayout(event) {\n header.layout = event.detail?.value || picker.value || \"standard\";\n }\n\n picker.addEventListener(\"value-changed\", applyLayout);\n</script>\n```",
|
|
26358
|
+
"default": "\"standard\"",
|
|
26359
|
+
"fieldName": "layout"
|
|
26360
|
+
},
|
|
26361
|
+
{
|
|
26362
|
+
"name": "brand-text",
|
|
26363
|
+
"type": {
|
|
26364
|
+
"text": "string"
|
|
26365
|
+
},
|
|
26366
|
+
"default": "\"\"",
|
|
26367
|
+
"description": "Configured brand text used when the `brand` slot is empty.",
|
|
26368
|
+
"fieldName": "brandText"
|
|
26369
|
+
},
|
|
26370
|
+
{
|
|
26371
|
+
"name": "brand-logo",
|
|
26372
|
+
"type": {
|
|
26373
|
+
"text": "string"
|
|
26374
|
+
},
|
|
26375
|
+
"default": "\"\"",
|
|
26376
|
+
"description": "Configured brand logo URL used when the `brand` slot is empty.",
|
|
26377
|
+
"fieldName": "brandLogo"
|
|
26378
|
+
},
|
|
26379
|
+
{
|
|
26380
|
+
"name": "light-brand-logo",
|
|
26381
|
+
"type": {
|
|
26382
|
+
"text": "string"
|
|
26383
|
+
},
|
|
26384
|
+
"default": "\"\"",
|
|
26385
|
+
"description": "Configured brand logo URL used in light scheme. A non-empty value\noverrides `brand-logo`; an empty value falls back to it.",
|
|
26386
|
+
"fieldName": "lightBrandLogo"
|
|
26387
|
+
},
|
|
26388
|
+
{
|
|
26389
|
+
"name": "dark-brand-logo",
|
|
26390
|
+
"type": {
|
|
26391
|
+
"text": "string"
|
|
26392
|
+
},
|
|
26393
|
+
"default": "\"\"",
|
|
26394
|
+
"description": "Configured brand logo URL used in dark scheme. A non-empty value\noverrides `brand-logo`; an empty value falls back to it.",
|
|
26395
|
+
"fieldName": "darkBrandLogo"
|
|
26396
|
+
},
|
|
26397
|
+
{
|
|
26398
|
+
"name": "brand-href",
|
|
26399
|
+
"type": {
|
|
26400
|
+
"text": "string"
|
|
26401
|
+
},
|
|
26402
|
+
"default": "\"\"",
|
|
26403
|
+
"description": "Optional brand link used by configured logo/text branding.",
|
|
26404
|
+
"fieldName": "brandHref"
|
|
26405
|
+
},
|
|
26406
|
+
{
|
|
26407
|
+
"name": "brand-alt",
|
|
26408
|
+
"type": {
|
|
26409
|
+
"text": "string"
|
|
26410
|
+
},
|
|
26411
|
+
"default": "\"\"",
|
|
26412
|
+
"description": "Accessible text for a logo-only configured brand. When brand text\nis also present, the logo is decorative unless this is set.",
|
|
26413
|
+
"fieldName": "brandAlt"
|
|
26414
|
+
},
|
|
26415
|
+
{
|
|
26416
|
+
"name": "brand-color",
|
|
26417
|
+
"type": {
|
|
26418
|
+
"text": "string"
|
|
26419
|
+
},
|
|
26420
|
+
"default": "\"\"",
|
|
26421
|
+
"description": "Optional configured brand color. Prefer theme fields for\nproduct-wide brand typography and this property for a local\nheader override.",
|
|
26422
|
+
"fieldName": "brandColor"
|
|
26423
|
+
},
|
|
26424
|
+
{
|
|
26425
|
+
"name": "light-brand-color",
|
|
26426
|
+
"type": {
|
|
26427
|
+
"text": "string"
|
|
26428
|
+
},
|
|
26429
|
+
"default": "\"\"",
|
|
26430
|
+
"description": "Configured brand color used in light scheme. A non-empty value\noverrides `brand-color`; an empty value falls back to it and then\n`--esp-header-brand-color`.",
|
|
26431
|
+
"fieldName": "lightBrandColor"
|
|
26432
|
+
},
|
|
26433
|
+
{
|
|
26434
|
+
"name": "dark-brand-color",
|
|
26435
|
+
"type": {
|
|
26436
|
+
"text": "string"
|
|
26437
|
+
},
|
|
26438
|
+
"default": "\"\"",
|
|
26439
|
+
"description": "Configured brand color used in dark scheme. A non-empty value\noverrides `brand-color`; an empty value falls back to it and then\n`--esp-header-brand-color`.",
|
|
26440
|
+
"fieldName": "darkBrandColor"
|
|
26441
|
+
},
|
|
26442
|
+
{
|
|
26443
|
+
"name": "brand-align",
|
|
26444
|
+
"type": {
|
|
26445
|
+
"text": "HeaderBrandAlign"
|
|
26446
|
+
},
|
|
26447
|
+
"description": "Horizontal placement of the brand content inside its grid area.",
|
|
26448
|
+
"default": "\"start\"",
|
|
26449
|
+
"fieldName": "brandAlign"
|
|
26450
|
+
},
|
|
26451
|
+
{
|
|
26452
|
+
"name": "brand-wrap",
|
|
26453
|
+
"type": {
|
|
26454
|
+
"text": "HeaderBrandWrap"
|
|
26455
|
+
},
|
|
26456
|
+
"description": "Long-brand behavior for configured brand text.",
|
|
26457
|
+
"default": "\"truncate\"",
|
|
26458
|
+
"fieldName": "brandWrap"
|
|
26459
|
+
},
|
|
26460
|
+
{
|
|
26461
|
+
"name": "menu-display",
|
|
26462
|
+
"type": {
|
|
26463
|
+
"text": "HeaderMenuDisplay"
|
|
26464
|
+
},
|
|
26465
|
+
"description": "Navigation display intent. `auto` tries inline navigation before\nusing a drawer, `drawer` always uses the burger/drawer pattern,\nand `inline` leaves overflow handling to the slotted menu.",
|
|
26466
|
+
"default": "\"auto\"",
|
|
26467
|
+
"fieldName": "menuDisplay"
|
|
26468
|
+
},
|
|
26469
|
+
{
|
|
26470
|
+
"name": "theme-toggle",
|
|
26471
|
+
"type": {
|
|
26472
|
+
"text": "HeaderThemeToggle"
|
|
26473
|
+
},
|
|
26474
|
+
"description": "Whether the header renders its built-in light/dark toggle.\nConsumers can still provide their own control in the `buttons`\nslot when this is `hidden`.",
|
|
26475
|
+
"default": "\"hidden\"",
|
|
26476
|
+
"fieldName": "themeToggle"
|
|
26477
|
+
},
|
|
26478
|
+
{
|
|
26479
|
+
"name": "scroll-behavior",
|
|
26480
|
+
"type": {
|
|
26481
|
+
"text": "string"
|
|
26482
|
+
},
|
|
26483
|
+
"default": "\"none\"",
|
|
26484
|
+
"description": "Space-separated scroll behavior tokens. Supported tokens:\n`compact`, `elevate`, `transparent`, `reveal`, `dock`,\n`collapse-topbar`, and `progress`.",
|
|
26485
|
+
"fieldName": "scrollBehavior"
|
|
26486
|
+
},
|
|
26487
|
+
{
|
|
26488
|
+
"name": "scroll-threshold",
|
|
26489
|
+
"type": {
|
|
26490
|
+
"text": "number"
|
|
26491
|
+
},
|
|
26492
|
+
"default": "16",
|
|
26493
|
+
"description": "Scroll distance in pixels before scroll-reactive behavior applies.",
|
|
26494
|
+
"fieldName": "scrollThreshold"
|
|
26495
|
+
},
|
|
26496
|
+
{
|
|
26497
|
+
"name": "dock-offset",
|
|
26498
|
+
"type": {
|
|
26499
|
+
"text": "number"
|
|
26500
|
+
},
|
|
26501
|
+
"default": "0",
|
|
26502
|
+
"description": "Scroll distance in pixels before `scroll-behavior=\"dock\"` applies.\nThis is commonly set to the hero height when a transparent header\nshould dock after the first section.",
|
|
26503
|
+
"fieldName": "dockOffset"
|
|
26504
|
+
},
|
|
26505
|
+
{
|
|
26506
|
+
"name": "drawer-target",
|
|
26507
|
+
"type": {
|
|
26508
|
+
"text": "string"
|
|
26509
|
+
},
|
|
26510
|
+
"default": "\"\"",
|
|
26511
|
+
"description": "Optional ID of an external drawer-capable menu controlled by the\nheader burger. When set, burger open/close events call\n`openDrawer()` / `closeDrawer()` on that element instead of the\nmenu slotted into the header.",
|
|
26512
|
+
"fieldName": "drawerTarget"
|
|
26513
|
+
},
|
|
26514
|
+
{
|
|
26515
|
+
"name": "full-bleed-content",
|
|
26516
|
+
"type": {
|
|
26517
|
+
"text": "boolean"
|
|
26518
|
+
},
|
|
26519
|
+
"default": "false",
|
|
26520
|
+
"description": "Opt out of surface alignment. When an `esp-header` is slotted into an\n`esp-page`, it constrains its bar content to the page's content\nsurface by default (the bar background stays full-bleed). Set this to\nlet the content span the full width instead, as it did before the\npage grew alignment modes. Standalone headers (outside `esp-page`) are\nalready full-bleed and unaffected.",
|
|
26521
|
+
"fieldName": "fullBleedContent"
|
|
26522
|
+
},
|
|
26523
|
+
{
|
|
26524
|
+
"name": "scheme",
|
|
26525
|
+
"type": {
|
|
26526
|
+
"text": "\"dark\" | \"light\""
|
|
26527
|
+
},
|
|
26528
|
+
"default": "\"light\"",
|
|
26529
|
+
"description": "The scheme to use for the component. This property is used internally\nto control the light/dark scheme so it matches the scheme of\n[esp-root](/components/root). It should not be set manually, it\nexists as an attribute for styling purposes.",
|
|
26530
|
+
"fieldName": "scheme",
|
|
26531
|
+
"inheritedFrom": {
|
|
26532
|
+
"name": "EspalierElementBase",
|
|
26533
|
+
"module": "dist/shared/esp-element-base.js"
|
|
26534
|
+
}
|
|
26535
|
+
},
|
|
26536
|
+
{
|
|
26537
|
+
"name": "variant",
|
|
26538
|
+
"type": {
|
|
26539
|
+
"text": "EspalierVariant"
|
|
26540
|
+
},
|
|
26541
|
+
"description": "The [color variant](/guides/color/variants) of the element.",
|
|
26542
|
+
"fieldName": "variant",
|
|
26543
|
+
"inheritedFrom": {
|
|
26544
|
+
"name": "EspalierElementBase",
|
|
26545
|
+
"module": "dist/shared/esp-element-base.js"
|
|
26546
|
+
}
|
|
26547
|
+
}
|
|
26548
|
+
],
|
|
26549
|
+
"superclass": {
|
|
26550
|
+
"name": "EspalierElementBase",
|
|
26551
|
+
"module": "dist/shared/esp-element-base.js"
|
|
26552
|
+
},
|
|
26553
|
+
"tagName": "esp-header",
|
|
26554
|
+
"customElement": true,
|
|
26555
|
+
"docPageTitle": {
|
|
26556
|
+
"name": "Header",
|
|
26557
|
+
"description": ""
|
|
26558
|
+
},
|
|
26559
|
+
"docUrl": {
|
|
26560
|
+
"name": "/components/header",
|
|
26561
|
+
"description": ""
|
|
26562
|
+
},
|
|
26563
|
+
"menuGroup": {
|
|
26564
|
+
"name": "Navigation",
|
|
26565
|
+
"description": ""
|
|
26566
|
+
},
|
|
26567
|
+
"menuLabel": {
|
|
26568
|
+
"name": "Header",
|
|
26569
|
+
"description": ""
|
|
26570
|
+
},
|
|
26571
|
+
"menuIcon": {
|
|
26572
|
+
"name": "layout-navbar",
|
|
26573
|
+
"description": ""
|
|
26574
|
+
}
|
|
26575
|
+
}
|
|
26576
|
+
],
|
|
26577
|
+
"exports": [
|
|
26578
|
+
{
|
|
26579
|
+
"kind": "js",
|
|
26580
|
+
"name": "EspalierHeader",
|
|
26581
|
+
"declaration": {
|
|
26582
|
+
"name": "EspalierHeader",
|
|
26583
|
+
"module": "dist/header/esp-header.js"
|
|
26584
|
+
}
|
|
26585
|
+
},
|
|
26586
|
+
{
|
|
26587
|
+
"kind": "custom-element-definition",
|
|
26588
|
+
"name": "esp-header",
|
|
26589
|
+
"declaration": {
|
|
26590
|
+
"name": "EspalierHeader",
|
|
26591
|
+
"module": "dist/header/esp-header.js"
|
|
26592
|
+
}
|
|
26593
|
+
}
|
|
26594
|
+
]
|
|
26595
|
+
},
|
|
26596
|
+
{
|
|
26597
|
+
"kind": "javascript-module",
|
|
26598
|
+
"path": "dist/header/esp-menu-group.js",
|
|
26599
|
+
"declarations": [],
|
|
26600
|
+
"exports": [
|
|
26601
|
+
{
|
|
26602
|
+
"kind": "js",
|
|
26603
|
+
"name": "*",
|
|
26604
|
+
"declaration": {
|
|
26605
|
+
"name": "*",
|
|
26606
|
+
"module": "dist/menu/esp-menu-group.js"
|
|
26607
|
+
}
|
|
26608
|
+
}
|
|
26609
|
+
]
|
|
26610
|
+
},
|
|
26611
|
+
{
|
|
26612
|
+
"kind": "javascript-module",
|
|
26613
|
+
"path": "dist/header/esp-menu-item.js",
|
|
26614
|
+
"declarations": [],
|
|
26615
|
+
"exports": [
|
|
26616
|
+
{
|
|
26617
|
+
"kind": "js",
|
|
26618
|
+
"name": "*",
|
|
26619
|
+
"declaration": {
|
|
26620
|
+
"name": "*",
|
|
26621
|
+
"module": "dist/menu/esp-menu-item.js"
|
|
26622
|
+
}
|
|
26623
|
+
}
|
|
26624
|
+
]
|
|
26625
|
+
},
|
|
26626
|
+
{
|
|
26627
|
+
"kind": "javascript-module",
|
|
26628
|
+
"path": "dist/header/esp-menu.js",
|
|
26629
|
+
"declarations": [],
|
|
26630
|
+
"exports": [
|
|
26631
|
+
{
|
|
26632
|
+
"kind": "js",
|
|
26633
|
+
"name": "*",
|
|
26634
|
+
"declaration": {
|
|
26635
|
+
"name": "*",
|
|
26636
|
+
"module": "dist/menu/esp-menu.js"
|
|
26637
|
+
}
|
|
26638
|
+
}
|
|
26639
|
+
]
|
|
26640
|
+
},
|
|
26641
|
+
{
|
|
26642
|
+
"kind": "javascript-module",
|
|
26643
|
+
"path": "dist/header/index.js",
|
|
26644
|
+
"declarations": [],
|
|
26645
|
+
"exports": [
|
|
26646
|
+
{
|
|
26647
|
+
"kind": "js",
|
|
26648
|
+
"name": "*",
|
|
26649
|
+
"declaration": {
|
|
26650
|
+
"name": "*",
|
|
26651
|
+
"module": "dist/burger/esp-burger.js"
|
|
26652
|
+
}
|
|
26653
|
+
},
|
|
26654
|
+
{
|
|
26655
|
+
"kind": "js",
|
|
26656
|
+
"name": "*",
|
|
26657
|
+
"declaration": {
|
|
26658
|
+
"name": "*",
|
|
26659
|
+
"module": "dist/menu/index.js"
|
|
26660
|
+
}
|
|
26661
|
+
},
|
|
26662
|
+
{
|
|
26663
|
+
"kind": "js",
|
|
26664
|
+
"name": "*",
|
|
26665
|
+
"declaration": {
|
|
26666
|
+
"name": "*",
|
|
26667
|
+
"module": "dist/header/esp-header-button.js"
|
|
26668
|
+
}
|
|
26669
|
+
},
|
|
26670
|
+
{
|
|
26671
|
+
"kind": "js",
|
|
26672
|
+
"name": "*",
|
|
26673
|
+
"declaration": {
|
|
26674
|
+
"name": "*",
|
|
26675
|
+
"module": "dist/header/esp-header.js"
|
|
26676
|
+
}
|
|
26677
|
+
}
|
|
26678
|
+
]
|
|
26679
|
+
},
|
|
26680
|
+
{
|
|
26681
|
+
"kind": "javascript-module",
|
|
26682
|
+
"path": "dist/help/esp-help-button.js",
|
|
26683
|
+
"declarations": [
|
|
26684
|
+
{
|
|
26685
|
+
"kind": "class",
|
|
26686
|
+
"description": "An icon-only trigger for URL-addressable help. Set `help-url` directly or\nplace the button beneath an ancestor carrying `help-src`; `anchor` selects\na stable heading id inside that document. The provider keeps the button's\npressed state synchronized while its topic is showing.\n\n```html\n<section help-src=\"/help/billing.html\">\n <h2>\n Billing\n <esp-help-button anchor=\"billing\" label=\"Help for billing\"></esp-help-button>\n </h2>\n</section>\n\n<esp-help-button\n help-url=\"/help/exporting.html#csv\"\n label=\"Help with CSV exports\"\n title=\"Export help\">\n</esp-help-button>\n```",
|
|
26687
|
+
"name": "EspalierHelpButton",
|
|
26688
|
+
"members": [
|
|
26689
|
+
{
|
|
26690
|
+
"kind": "field",
|
|
26691
|
+
"name": "helpUrl",
|
|
26692
|
+
"type": {
|
|
26693
|
+
"text": "string"
|
|
26694
|
+
},
|
|
26695
|
+
"privacy": "public",
|
|
26696
|
+
"default": "\"\"",
|
|
26697
|
+
"description": "Per-trigger help document override. May include a topic fragment. When\nomitted, the nearest composed-tree ancestor's `help-src` is used.",
|
|
26698
|
+
"attribute": "help-url"
|
|
26699
|
+
},
|
|
26700
|
+
{
|
|
26701
|
+
"kind": "field",
|
|
26702
|
+
"name": "anchor",
|
|
26703
|
+
"type": {
|
|
26704
|
+
"text": "string"
|
|
26705
|
+
},
|
|
26706
|
+
"privacy": "public",
|
|
26707
|
+
"default": "\"\"",
|
|
26708
|
+
"description": "Stable heading id inside the resolved help document.",
|
|
26709
|
+
"attribute": "anchor"
|
|
26710
|
+
},
|
|
26711
|
+
{
|
|
26712
|
+
"kind": "field",
|
|
26713
|
+
"name": "label",
|
|
26714
|
+
"type": {
|
|
26715
|
+
"text": "string"
|
|
26716
|
+
},
|
|
26717
|
+
"privacy": "public",
|
|
26718
|
+
"default": "\"Help\"",
|
|
26719
|
+
"description": "Accessible label for the icon-only button.",
|
|
26720
|
+
"attribute": "label"
|
|
26721
|
+
},
|
|
26722
|
+
{
|
|
26723
|
+
"kind": "field",
|
|
26724
|
+
"name": "helpTitle",
|
|
26725
|
+
"type": {
|
|
26726
|
+
"text": "string"
|
|
26727
|
+
},
|
|
26728
|
+
"privacy": "public",
|
|
26729
|
+
"default": "\"\"",
|
|
26730
|
+
"description": "Optional flyout heading. Topic/document headings are used when omitted.",
|
|
26731
|
+
"attribute": "title"
|
|
26732
|
+
},
|
|
26733
|
+
{
|
|
26734
|
+
"kind": "field",
|
|
26735
|
+
"name": "placementTarget",
|
|
26736
|
+
"type": {
|
|
26737
|
+
"text": "HTMLElement | undefined"
|
|
26738
|
+
},
|
|
26739
|
+
"privacy": "public",
|
|
26740
|
+
"description": "Element the contextual flyout should point at. Form items set this to\ntheir field control while the help button remains the focus-return target."
|
|
26741
|
+
},
|
|
26742
|
+
{
|
|
26743
|
+
"kind": "field",
|
|
26744
|
+
"name": "active",
|
|
26745
|
+
"type": {
|
|
26746
|
+
"text": "boolean"
|
|
26747
|
+
},
|
|
26748
|
+
"privacy": "public",
|
|
26749
|
+
"default": "false",
|
|
26750
|
+
"description": "Whether this button's exact help topic is currently showing.",
|
|
26751
|
+
"attribute": "active",
|
|
26752
|
+
"reflects": true
|
|
26753
|
+
},
|
|
26754
|
+
{
|
|
26755
|
+
"kind": "field",
|
|
26756
|
+
"name": "boundHelpStateChanged",
|
|
26757
|
+
"privacy": "private",
|
|
26758
|
+
"readonly": true
|
|
26759
|
+
},
|
|
26760
|
+
{
|
|
26761
|
+
"kind": "field",
|
|
26762
|
+
"name": "resolvedTarget",
|
|
26763
|
+
"privacy": "private",
|
|
26764
|
+
"readonly": true
|
|
26765
|
+
},
|
|
26766
|
+
{
|
|
26767
|
+
"kind": "method",
|
|
26768
|
+
"name": "focus",
|
|
26769
|
+
"privacy": "public",
|
|
26770
|
+
"return": {
|
|
26771
|
+
"type": {
|
|
26772
|
+
"text": "void"
|
|
26773
|
+
}
|
|
26774
|
+
},
|
|
26775
|
+
"parameters": [
|
|
26776
|
+
{
|
|
26777
|
+
"name": "options",
|
|
26778
|
+
"optional": true,
|
|
26779
|
+
"type": {
|
|
26780
|
+
"text": "FocusOptions"
|
|
26781
|
+
}
|
|
26782
|
+
}
|
|
26783
|
+
],
|
|
26784
|
+
"description": "Forward focus to the composed native control."
|
|
26785
|
+
},
|
|
26786
|
+
{
|
|
26787
|
+
"kind": "field",
|
|
26788
|
+
"name": "handleActivation",
|
|
26789
|
+
"privacy": "private",
|
|
26790
|
+
"readonly": true
|
|
26791
|
+
},
|
|
26792
|
+
{
|
|
26793
|
+
"kind": "field",
|
|
26794
|
+
"name": "seedColorBacker",
|
|
26795
|
+
"type": {
|
|
26796
|
+
"text": "string"
|
|
26797
|
+
},
|
|
26798
|
+
"privacy": "private",
|
|
26799
|
+
"default": "\"oklch(0.7 0.125 216)\"",
|
|
26800
|
+
"inheritedFrom": {
|
|
26801
|
+
"name": "EspalierElementBase",
|
|
26802
|
+
"module": "dist/shared/esp-element-base.js"
|
|
26803
|
+
}
|
|
26804
|
+
},
|
|
26805
|
+
{
|
|
26806
|
+
"kind": "field",
|
|
26807
|
+
"name": "espRoot",
|
|
26808
|
+
"type": {
|
|
26809
|
+
"text": "EspalierRoot | null"
|
|
26810
|
+
},
|
|
26811
|
+
"privacy": "private",
|
|
26812
|
+
"default": "null",
|
|
26813
|
+
"inheritedFrom": {
|
|
26814
|
+
"name": "EspalierElementBase",
|
|
26815
|
+
"module": "dist/shared/esp-element-base.js"
|
|
26816
|
+
}
|
|
26817
|
+
},
|
|
26818
|
+
{
|
|
26819
|
+
"kind": "field",
|
|
26820
|
+
"name": "variantTokenOriginalValues",
|
|
26821
|
+
"privacy": "private",
|
|
26822
|
+
"readonly": true,
|
|
26823
|
+
"default": "new Map< string, { generatedPriority: string; generatedValue: string; originalPriority: string; originalValue: string | null; } >()",
|
|
26824
|
+
"inheritedFrom": {
|
|
26825
|
+
"name": "EspalierElementBase",
|
|
26826
|
+
"module": "dist/shared/esp-element-base.js"
|
|
26827
|
+
}
|
|
26828
|
+
},
|
|
26829
|
+
{
|
|
26830
|
+
"kind": "field",
|
|
26831
|
+
"name": "rootEventSubscriptionsActive",
|
|
26832
|
+
"type": {
|
|
26833
|
+
"text": "boolean"
|
|
26834
|
+
},
|
|
26835
|
+
"privacy": "private",
|
|
26836
|
+
"default": "false",
|
|
26837
|
+
"inheritedFrom": {
|
|
26838
|
+
"name": "EspalierElementBase",
|
|
26839
|
+
"module": "dist/shared/esp-element-base.js"
|
|
26840
|
+
}
|
|
26841
|
+
},
|
|
26842
|
+
{
|
|
26843
|
+
"kind": "field",
|
|
26844
|
+
"name": "subscribedRoot",
|
|
26845
|
+
"type": {
|
|
26846
|
+
"text": "EspalierRoot | null"
|
|
26847
|
+
},
|
|
26848
|
+
"privacy": "private",
|
|
26849
|
+
"default": "null",
|
|
26850
|
+
"inheritedFrom": {
|
|
26851
|
+
"name": "EspalierElementBase",
|
|
26852
|
+
"module": "dist/shared/esp-element-base.js"
|
|
26853
|
+
}
|
|
26854
|
+
},
|
|
26855
|
+
{
|
|
26856
|
+
"kind": "field",
|
|
26857
|
+
"name": "rootEventUnsubscribers",
|
|
26858
|
+
"type": {
|
|
26859
|
+
"text": "Array<() => void>"
|
|
26860
|
+
},
|
|
26861
|
+
"privacy": "private",
|
|
26862
|
+
"default": "[]",
|
|
26863
|
+
"inheritedFrom": {
|
|
26864
|
+
"name": "EspalierElementBase",
|
|
26865
|
+
"module": "dist/shared/esp-element-base.js"
|
|
26866
|
+
}
|
|
26867
|
+
},
|
|
26868
|
+
{
|
|
26869
|
+
"kind": "field",
|
|
26870
|
+
"name": "variantBacker",
|
|
26871
|
+
"type": {
|
|
26872
|
+
"text": "EspalierVariant"
|
|
26873
|
+
},
|
|
26874
|
+
"privacy": "protected",
|
|
26875
|
+
"default": "\"primary\"",
|
|
26876
|
+
"inheritedFrom": {
|
|
26877
|
+
"name": "EspalierElementBase",
|
|
26878
|
+
"module": "dist/shared/esp-element-base.js"
|
|
26879
|
+
}
|
|
26880
|
+
},
|
|
26881
|
+
{
|
|
26882
|
+
"kind": "field",
|
|
26883
|
+
"name": "seedColor",
|
|
26884
|
+
"type": {
|
|
26885
|
+
"text": "string"
|
|
26886
|
+
},
|
|
26887
|
+
"privacy": "public",
|
|
26888
|
+
"inheritedFrom": {
|
|
26889
|
+
"name": "EspalierElementBase",
|
|
26890
|
+
"module": "dist/shared/esp-element-base.js"
|
|
26891
|
+
}
|
|
26892
|
+
},
|
|
26893
|
+
{
|
|
26894
|
+
"kind": "field",
|
|
26895
|
+
"name": "correlationId",
|
|
26896
|
+
"privacy": "public",
|
|
26897
|
+
"inheritedFrom": {
|
|
26898
|
+
"name": "EspalierElementBase",
|
|
26899
|
+
"module": "dist/shared/esp-element-base.js"
|
|
26900
|
+
}
|
|
26901
|
+
},
|
|
26902
|
+
{
|
|
26903
|
+
"kind": "method",
|
|
26904
|
+
"name": "focusResolvedElementAfterUpdate",
|
|
26905
|
+
"privacy": "protected",
|
|
26906
|
+
"return": {
|
|
26907
|
+
"type": {
|
|
26908
|
+
"text": "void"
|
|
26909
|
+
}
|
|
26910
|
+
},
|
|
26911
|
+
"parameters": [
|
|
26912
|
+
{
|
|
26913
|
+
"name": "resolveTarget",
|
|
26914
|
+
"type": {
|
|
26915
|
+
"text": "() => HTMLElement | null | undefined"
|
|
26916
|
+
}
|
|
26917
|
+
},
|
|
26918
|
+
{
|
|
26919
|
+
"name": "options",
|
|
26920
|
+
"optional": true,
|
|
26921
|
+
"type": {
|
|
26922
|
+
"text": "FocusOptions"
|
|
26923
|
+
}
|
|
26924
|
+
}
|
|
26925
|
+
],
|
|
26926
|
+
"inheritedFrom": {
|
|
26927
|
+
"name": "EspalierElementBase",
|
|
26928
|
+
"module": "dist/shared/esp-element-base.js"
|
|
26929
|
+
}
|
|
26930
|
+
},
|
|
26931
|
+
{
|
|
26932
|
+
"kind": "method",
|
|
26933
|
+
"name": "focusShadowElementAfterUpdate",
|
|
26934
|
+
"privacy": "protected",
|
|
26935
|
+
"return": {
|
|
26936
|
+
"type": {
|
|
26937
|
+
"text": "void"
|
|
26938
|
+
}
|
|
26939
|
+
},
|
|
26940
|
+
"parameters": [
|
|
26941
|
+
{
|
|
26942
|
+
"name": "selector",
|
|
26943
|
+
"type": {
|
|
26944
|
+
"text": "string"
|
|
26945
|
+
}
|
|
26946
|
+
},
|
|
26947
|
+
{
|
|
26948
|
+
"name": "options",
|
|
26949
|
+
"optional": true,
|
|
26950
|
+
"type": {
|
|
26951
|
+
"text": "FocusOptions"
|
|
26952
|
+
}
|
|
26953
|
+
}
|
|
26954
|
+
],
|
|
26955
|
+
"inheritedFrom": {
|
|
26956
|
+
"name": "EspalierElementBase",
|
|
26957
|
+
"module": "dist/shared/esp-element-base.js"
|
|
26958
|
+
}
|
|
26959
|
+
},
|
|
26960
|
+
{
|
|
26961
|
+
"kind": "method",
|
|
26962
|
+
"name": "emitValueChanged",
|
|
26963
|
+
"privacy": "protected",
|
|
26964
|
+
"return": {
|
|
26965
|
+
"type": {
|
|
26966
|
+
"text": "void"
|
|
26967
|
+
}
|
|
26968
|
+
},
|
|
26969
|
+
"parameters": [
|
|
26970
|
+
{
|
|
26971
|
+
"name": "detail",
|
|
26972
|
+
"type": {
|
|
26973
|
+
"text": "T"
|
|
26974
|
+
}
|
|
26975
|
+
}
|
|
26976
|
+
],
|
|
26977
|
+
"inheritedFrom": {
|
|
26978
|
+
"name": "EspalierElementBase",
|
|
26979
|
+
"module": "dist/shared/esp-element-base.js"
|
|
26980
|
+
}
|
|
26981
|
+
},
|
|
26982
|
+
{
|
|
26983
|
+
"kind": "field",
|
|
26984
|
+
"name": "scheme",
|
|
26985
|
+
"type": {
|
|
26986
|
+
"text": "\"dark\" | \"light\""
|
|
26987
|
+
},
|
|
26988
|
+
"privacy": "public",
|
|
26989
|
+
"default": "\"light\"",
|
|
26990
|
+
"description": "The scheme to use for the component. This property is used internally\nto control the light/dark scheme so it matches the scheme of\n[esp-root](/components/root). It should not be set manually, it\nexists as an attribute for styling purposes.",
|
|
26991
|
+
"attribute": "scheme",
|
|
26992
|
+
"reflects": true,
|
|
26993
|
+
"inheritedFrom": {
|
|
26994
|
+
"name": "EspalierElementBase",
|
|
26995
|
+
"module": "dist/shared/esp-element-base.js"
|
|
26996
|
+
}
|
|
26997
|
+
},
|
|
26998
|
+
{
|
|
26999
|
+
"kind": "field",
|
|
27000
|
+
"name": "variant",
|
|
27001
|
+
"type": {
|
|
27002
|
+
"text": "EspalierVariant"
|
|
27003
|
+
},
|
|
27004
|
+
"privacy": "public",
|
|
27005
|
+
"description": "The [color variant](/guides/color/variants) of the element.",
|
|
27006
|
+
"attribute": "variant",
|
|
27007
|
+
"reflects": true,
|
|
27008
|
+
"inheritedFrom": {
|
|
27009
|
+
"name": "EspalierElementBase",
|
|
27010
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27011
|
+
}
|
|
27012
|
+
},
|
|
27013
|
+
{
|
|
27014
|
+
"kind": "method",
|
|
27015
|
+
"name": "syncRootFromDom",
|
|
27016
|
+
"privacy": "private",
|
|
27017
|
+
"return": {
|
|
27018
|
+
"type": {
|
|
27019
|
+
"text": "EspalierRoot | null"
|
|
27020
|
+
}
|
|
27021
|
+
},
|
|
27022
|
+
"parameters": [
|
|
27023
|
+
{
|
|
27024
|
+
"name": "throwIfMissing",
|
|
27025
|
+
"type": {
|
|
27026
|
+
"text": "boolean"
|
|
27027
|
+
}
|
|
27028
|
+
}
|
|
27029
|
+
],
|
|
27030
|
+
"inheritedFrom": {
|
|
27031
|
+
"name": "EspalierElementBase",
|
|
27032
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27033
|
+
}
|
|
27034
|
+
},
|
|
27035
|
+
{
|
|
27036
|
+
"kind": "method",
|
|
27037
|
+
"name": "subscribeToRootEvents",
|
|
27038
|
+
"privacy": "private",
|
|
27039
|
+
"return": {
|
|
27040
|
+
"type": {
|
|
27041
|
+
"text": "void"
|
|
27042
|
+
}
|
|
27043
|
+
},
|
|
27044
|
+
"parameters": [
|
|
27045
|
+
{
|
|
27046
|
+
"name": "root",
|
|
27047
|
+
"type": {
|
|
27048
|
+
"text": "EspalierRoot"
|
|
27049
|
+
}
|
|
27050
|
+
}
|
|
27051
|
+
],
|
|
27052
|
+
"inheritedFrom": {
|
|
27053
|
+
"name": "EspalierElementBase",
|
|
27054
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27055
|
+
}
|
|
27056
|
+
},
|
|
27057
|
+
{
|
|
27058
|
+
"kind": "method",
|
|
27059
|
+
"name": "unsubscribeFromRootEvents",
|
|
27060
|
+
"privacy": "private",
|
|
27061
|
+
"return": {
|
|
27062
|
+
"type": {
|
|
27063
|
+
"text": "void"
|
|
27064
|
+
}
|
|
27065
|
+
},
|
|
27066
|
+
"inheritedFrom": {
|
|
27067
|
+
"name": "EspalierElementBase",
|
|
27068
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27069
|
+
}
|
|
27070
|
+
},
|
|
27071
|
+
{
|
|
27072
|
+
"kind": "field",
|
|
27073
|
+
"name": "handleSeedColorChanged",
|
|
27074
|
+
"privacy": "private",
|
|
27075
|
+
"inheritedFrom": {
|
|
27076
|
+
"name": "EspalierElementBase",
|
|
27077
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27078
|
+
}
|
|
27079
|
+
},
|
|
27080
|
+
{
|
|
27081
|
+
"kind": "field",
|
|
27082
|
+
"name": "handleSchemeChanged",
|
|
27083
|
+
"privacy": "private",
|
|
27084
|
+
"inheritedFrom": {
|
|
27085
|
+
"name": "EspalierElementBase",
|
|
27086
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27087
|
+
}
|
|
27088
|
+
},
|
|
27089
|
+
{
|
|
27090
|
+
"kind": "field",
|
|
27091
|
+
"name": "handleThemeChanged",
|
|
27092
|
+
"privacy": "private",
|
|
27093
|
+
"inheritedFrom": {
|
|
27094
|
+
"name": "EspalierElementBase",
|
|
27095
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27096
|
+
}
|
|
27097
|
+
},
|
|
27098
|
+
{
|
|
27099
|
+
"kind": "field",
|
|
27100
|
+
"name": "handleIconSpriteUrlChanged",
|
|
27101
|
+
"privacy": "private",
|
|
27102
|
+
"inheritedFrom": {
|
|
27103
|
+
"name": "EspalierElementBase",
|
|
27104
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27105
|
+
}
|
|
27106
|
+
},
|
|
27107
|
+
{
|
|
27108
|
+
"kind": "method",
|
|
27109
|
+
"name": "traverseToClosest",
|
|
27110
|
+
"privacy": "public",
|
|
27111
|
+
"return": {
|
|
27112
|
+
"type": {
|
|
27113
|
+
"text": ""
|
|
27114
|
+
}
|
|
27115
|
+
},
|
|
27116
|
+
"parameters": [
|
|
27117
|
+
{
|
|
27118
|
+
"name": "selector",
|
|
27119
|
+
"type": {
|
|
27120
|
+
"text": "string"
|
|
27121
|
+
},
|
|
27122
|
+
"description": "The selector of the element to look for"
|
|
27123
|
+
}
|
|
27124
|
+
],
|
|
27125
|
+
"description": "Traverse up the DOM tree to find the closest element that\nmatches the selector. This method is aware of shadow DOM\nboundaries and will traverse through them to find the element.",
|
|
27126
|
+
"inheritedFrom": {
|
|
27127
|
+
"name": "EspalierElementBase",
|
|
27128
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27129
|
+
}
|
|
27130
|
+
},
|
|
27131
|
+
{
|
|
27132
|
+
"kind": "field",
|
|
27133
|
+
"name": "textContrast",
|
|
27134
|
+
"type": {
|
|
27135
|
+
"text": "Partial<\n Record<SemanticColorName, { bg: SemanticColorName; targetLc: number }>\n >"
|
|
27136
|
+
},
|
|
27137
|
+
"privacy": "private",
|
|
27138
|
+
"static": true,
|
|
27139
|
+
"readonly": true,
|
|
27140
|
+
"default": "{ text: { bg: \"background\", targetLc: 75 }, dangerText: { bg: \"background\", targetLc: 75 }, headings: { bg: \"background\", targetLc: 60 }, headingsHover: { bg: \"background\", targetLc: 60 }, link: { bg: \"background\", targetLc: 75 }, linkHover: { bg: \"background\", targetLc: 75 }, actionText: { bg: \"actionBackground\", targetLc: 75 }, inputCaret: { bg: \"layer2\", targetLc: 60 }, inputSelection: { bg: \"inputSelectionBg\", targetLc: 60 }, }",
|
|
27141
|
+
"description": "Text tokens that require APCA contrast enforcement.\n\nEach entry maps a text-bearing semantic token to:\n - `bg`: the semantic token it sits on (reference color)\n - `targetLc`: the minimum |Lc| the text must achieve",
|
|
27142
|
+
"inheritedFrom": {
|
|
27143
|
+
"name": "EspalierElementBase",
|
|
27144
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27145
|
+
}
|
|
27146
|
+
},
|
|
27147
|
+
{
|
|
27148
|
+
"kind": "field",
|
|
27149
|
+
"name": "statusVariantSources",
|
|
27150
|
+
"type": {
|
|
27151
|
+
"text": "ReadonlySet<ColorSource>"
|
|
27152
|
+
},
|
|
27153
|
+
"privacy": "private",
|
|
27154
|
+
"static": true,
|
|
27155
|
+
"readonly": true,
|
|
27156
|
+
"default": "new Set<ColorSource>([ \"danger\", \"success\", \"warning\", ])",
|
|
27157
|
+
"description": "Variant color sources whose meaning is carried by a fixed hue rather\nthan the brand seed — the destructive / positive / warning status\nfamilies (ADR-004). For these variants the filled-action tokens are\npinned to the variant's own color so a theme cannot make them look\nlike an ordinary brand action. See task 098.",
|
|
27158
|
+
"inheritedFrom": {
|
|
27159
|
+
"name": "EspalierElementBase",
|
|
27160
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27161
|
+
}
|
|
27162
|
+
},
|
|
27163
|
+
{
|
|
27164
|
+
"kind": "field",
|
|
27165
|
+
"name": "semanticActionTokens",
|
|
27166
|
+
"type": {
|
|
27167
|
+
"text": "ReadonlySet<SemanticColorName>"
|
|
27168
|
+
},
|
|
27169
|
+
"privacy": "private",
|
|
27170
|
+
"static": true,
|
|
27171
|
+
"readonly": true,
|
|
27172
|
+
"default": "new Set<SemanticColorName>([\"actionBackground\", \"actionText\"])",
|
|
27173
|
+
"description": "Semantic tokens that paint a control's filled action surface. For a\nstatus variant these always derive from the variant's own color, so\nthe Taproot \"Buttons\" semantic group (which re-points\n`actionBackground` / `actionText` to a brand source) cannot rotate a\ndestructive / warning / positive action off its semantic hue. See\ntask 098.",
|
|
27174
|
+
"inheritedFrom": {
|
|
27175
|
+
"name": "EspalierElementBase",
|
|
27176
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27177
|
+
}
|
|
27178
|
+
},
|
|
27179
|
+
{
|
|
27180
|
+
"kind": "method",
|
|
27181
|
+
"name": "applyVariantTokens",
|
|
27182
|
+
"privacy": "protected",
|
|
27183
|
+
"return": {
|
|
27184
|
+
"type": {
|
|
27185
|
+
"text": "void"
|
|
27186
|
+
}
|
|
27187
|
+
},
|
|
27188
|
+
"inheritedFrom": {
|
|
27189
|
+
"name": "EspalierElementBase",
|
|
27190
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27191
|
+
}
|
|
27192
|
+
},
|
|
27193
|
+
{
|
|
27194
|
+
"kind": "method",
|
|
27195
|
+
"name": "effectiveVariantTokenSource",
|
|
27196
|
+
"privacy": "private",
|
|
27197
|
+
"return": {
|
|
27198
|
+
"type": {
|
|
27199
|
+
"text": "ColorSource"
|
|
27200
|
+
}
|
|
27201
|
+
},
|
|
27202
|
+
"parameters": [
|
|
27203
|
+
{
|
|
27204
|
+
"name": "name",
|
|
27205
|
+
"type": {
|
|
27206
|
+
"text": "SemanticColorName"
|
|
27207
|
+
}
|
|
27208
|
+
},
|
|
27209
|
+
{
|
|
27210
|
+
"name": "mappedSource",
|
|
27211
|
+
"type": {
|
|
27212
|
+
"text": "ColorSource"
|
|
27213
|
+
}
|
|
27214
|
+
},
|
|
27215
|
+
{
|
|
27216
|
+
"name": "isStatusVariant",
|
|
27217
|
+
"type": {
|
|
27218
|
+
"text": "boolean"
|
|
27219
|
+
}
|
|
27220
|
+
}
|
|
27221
|
+
],
|
|
27222
|
+
"description": "Resolve the color source used to derive a semantic token for the\nactive variant.\n\nNormally this is the theme's mapping source, so the variant performs a\nfull palette shift relative to its own color. The exception is the\nmeaning-bearing status variants (`danger`, `success`, `warning`): their\nfilled-action tokens (`actionBackground`, `actionText`) are pinned to\nthe variant's own color — the `primary` entry of the sub-variant\npalette, which is the variant color itself — so a theme that re-points\nthe Buttons semantic group to a brand source cannot rotate a\ndestructive / warning / positive action off its semantic hue. Ordinary\nbrand and primary variants keep full theme customization. See task 098.",
|
|
27223
|
+
"inheritedFrom": {
|
|
27224
|
+
"name": "EspalierElementBase",
|
|
27225
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27226
|
+
}
|
|
27227
|
+
},
|
|
27228
|
+
{
|
|
27229
|
+
"kind": "method",
|
|
27230
|
+
"name": "getVariantColorSource",
|
|
27231
|
+
"privacy": "protected",
|
|
27232
|
+
"return": {
|
|
27233
|
+
"type": {
|
|
27234
|
+
"text": "ColorSource | \"\""
|
|
27235
|
+
}
|
|
27236
|
+
},
|
|
27237
|
+
"inheritedFrom": {
|
|
27238
|
+
"name": "EspalierElementBase",
|
|
27239
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27240
|
+
}
|
|
27241
|
+
},
|
|
27242
|
+
{
|
|
27243
|
+
"kind": "method",
|
|
27244
|
+
"name": "setVariantTokenProperty",
|
|
27245
|
+
"privacy": "private",
|
|
27246
|
+
"return": {
|
|
27247
|
+
"type": {
|
|
27248
|
+
"text": "void"
|
|
27249
|
+
}
|
|
27250
|
+
},
|
|
27251
|
+
"parameters": [
|
|
27252
|
+
{
|
|
27253
|
+
"name": "name",
|
|
27254
|
+
"type": {
|
|
27255
|
+
"text": "string"
|
|
27256
|
+
}
|
|
27257
|
+
},
|
|
27258
|
+
{
|
|
27259
|
+
"name": "value",
|
|
27260
|
+
"type": {
|
|
27261
|
+
"text": "string"
|
|
27262
|
+
}
|
|
27263
|
+
}
|
|
27264
|
+
],
|
|
27265
|
+
"inheritedFrom": {
|
|
27266
|
+
"name": "EspalierElementBase",
|
|
27267
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27268
|
+
}
|
|
27269
|
+
},
|
|
27270
|
+
{
|
|
27271
|
+
"kind": "method",
|
|
27272
|
+
"name": "clearVariantTokens",
|
|
27273
|
+
"privacy": "private",
|
|
27274
|
+
"return": {
|
|
27275
|
+
"type": {
|
|
27276
|
+
"text": "void"
|
|
27277
|
+
}
|
|
27278
|
+
},
|
|
27279
|
+
"inheritedFrom": {
|
|
27280
|
+
"name": "EspalierElementBase",
|
|
27281
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27282
|
+
}
|
|
27283
|
+
}
|
|
27284
|
+
],
|
|
27285
|
+
"attributes": [
|
|
27286
|
+
{
|
|
27287
|
+
"name": "help-url",
|
|
27288
|
+
"type": {
|
|
27289
|
+
"text": "string"
|
|
27290
|
+
},
|
|
27291
|
+
"default": "\"\"",
|
|
27292
|
+
"description": "Per-trigger help document override. May include a topic fragment. When\nomitted, the nearest composed-tree ancestor's `help-src` is used.",
|
|
27293
|
+
"fieldName": "helpUrl"
|
|
27294
|
+
},
|
|
27295
|
+
{
|
|
27296
|
+
"name": "anchor",
|
|
27297
|
+
"type": {
|
|
27298
|
+
"text": "string"
|
|
27299
|
+
},
|
|
27300
|
+
"default": "\"\"",
|
|
27301
|
+
"description": "Stable heading id inside the resolved help document.",
|
|
27302
|
+
"fieldName": "anchor"
|
|
27303
|
+
},
|
|
27304
|
+
{
|
|
27305
|
+
"name": "label",
|
|
27306
|
+
"type": {
|
|
27307
|
+
"text": "string"
|
|
27308
|
+
},
|
|
27309
|
+
"default": "\"Help\"",
|
|
27310
|
+
"description": "Accessible label for the icon-only button.",
|
|
27311
|
+
"fieldName": "label"
|
|
27312
|
+
},
|
|
27313
|
+
{
|
|
27314
|
+
"name": "title",
|
|
27315
|
+
"type": {
|
|
27316
|
+
"text": "string"
|
|
27317
|
+
},
|
|
27318
|
+
"default": "\"\"",
|
|
27319
|
+
"description": "Optional flyout heading. Topic/document headings are used when omitted.",
|
|
27320
|
+
"fieldName": "helpTitle"
|
|
27321
|
+
},
|
|
27322
|
+
{
|
|
27323
|
+
"name": "active",
|
|
27324
|
+
"type": {
|
|
27325
|
+
"text": "boolean"
|
|
27326
|
+
},
|
|
27327
|
+
"default": "false",
|
|
27328
|
+
"description": "Whether this button's exact help topic is currently showing.",
|
|
27329
|
+
"fieldName": "active"
|
|
27330
|
+
},
|
|
27331
|
+
{
|
|
27332
|
+
"name": "scheme",
|
|
27333
|
+
"type": {
|
|
27334
|
+
"text": "\"dark\" | \"light\""
|
|
27335
|
+
},
|
|
27336
|
+
"default": "\"light\"",
|
|
27337
|
+
"description": "The scheme to use for the component. This property is used internally\nto control the light/dark scheme so it matches the scheme of\n[esp-root](/components/root). It should not be set manually, it\nexists as an attribute for styling purposes.",
|
|
27338
|
+
"fieldName": "scheme",
|
|
27339
|
+
"inheritedFrom": {
|
|
27340
|
+
"name": "EspalierElementBase",
|
|
27341
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27342
|
+
}
|
|
27343
|
+
},
|
|
27344
|
+
{
|
|
27345
|
+
"name": "variant",
|
|
27346
|
+
"type": {
|
|
27347
|
+
"text": "EspalierVariant"
|
|
27348
|
+
},
|
|
27349
|
+
"description": "The [color variant](/guides/color/variants) of the element.",
|
|
27350
|
+
"fieldName": "variant",
|
|
27351
|
+
"inheritedFrom": {
|
|
27352
|
+
"name": "EspalierElementBase",
|
|
27353
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27354
|
+
}
|
|
27355
|
+
}
|
|
27356
|
+
],
|
|
27357
|
+
"superclass": {
|
|
27358
|
+
"name": "EspalierElementBase",
|
|
27359
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27360
|
+
},
|
|
27361
|
+
"docPageTitle": {
|
|
27362
|
+
"name": "Help",
|
|
27363
|
+
"description": "Button"
|
|
27364
|
+
},
|
|
27365
|
+
"docUrl": {
|
|
27366
|
+
"name": "/components/help/button",
|
|
27367
|
+
"description": ""
|
|
27368
|
+
},
|
|
27369
|
+
"menuGroup": {
|
|
27370
|
+
"name": "Interaction",
|
|
27371
|
+
"description": ""
|
|
27372
|
+
},
|
|
27373
|
+
"menuLabel": {
|
|
27374
|
+
"name": "Help",
|
|
27375
|
+
"description": "Button"
|
|
27376
|
+
},
|
|
27377
|
+
"menuIcon": {
|
|
27378
|
+
"name": "info",
|
|
27379
|
+
"description": ""
|
|
27380
|
+
},
|
|
27381
|
+
"tagName": "esp-help-button",
|
|
27382
|
+
"customElement": true,
|
|
27383
|
+
"cssProperties": [
|
|
27384
|
+
{
|
|
27385
|
+
"description": "Background color of the shared field shell. Defaults to `var(--esp-color-layer-2)`.",
|
|
27386
|
+
"name": "--esp-field-background",
|
|
27387
|
+
"inheritedFrom": {
|
|
27388
|
+
"name": "EspalierElementBase",
|
|
27389
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27390
|
+
}
|
|
27391
|
+
},
|
|
27392
|
+
{
|
|
27393
|
+
"description": "Border color of the shared field shell. Defaults to `var(--esp-color-border)`.",
|
|
27394
|
+
"name": "--esp-field-border-color",
|
|
27395
|
+
"inheritedFrom": {
|
|
27396
|
+
"name": "EspalierElementBase",
|
|
27397
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27398
|
+
}
|
|
27399
|
+
},
|
|
27400
|
+
{
|
|
27401
|
+
"description": "Border width of the shared field shell. Defaults to `1px`.",
|
|
27402
|
+
"name": "--esp-field-border-width",
|
|
27403
|
+
"inheritedFrom": {
|
|
27404
|
+
"name": "EspalierElementBase",
|
|
27405
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27406
|
+
}
|
|
27407
|
+
},
|
|
27408
|
+
{
|
|
27409
|
+
"description": "Text color used inside the shared field shell. Defaults to `var(--esp-color-text)`.",
|
|
27410
|
+
"name": "--esp-field-text-color",
|
|
27411
|
+
"inheritedFrom": {
|
|
27412
|
+
"name": "EspalierElementBase",
|
|
27413
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27414
|
+
}
|
|
27415
|
+
},
|
|
27416
|
+
{
|
|
27417
|
+
"description": "Hover background color of the shared field shell. Derived from `--esp-field-background`.",
|
|
27418
|
+
"name": "--esp-field-hover-bg",
|
|
27419
|
+
"inheritedFrom": {
|
|
27420
|
+
"name": "EspalierElementBase",
|
|
27421
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27422
|
+
}
|
|
27423
|
+
},
|
|
27424
|
+
{
|
|
27425
|
+
"description": "Focus background color of the shared field shell. Derived from `--esp-field-background`.",
|
|
27426
|
+
"name": "--esp-field-focus-bg",
|
|
27427
|
+
"inheritedFrom": {
|
|
27428
|
+
"name": "EspalierElementBase",
|
|
27429
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27430
|
+
}
|
|
27431
|
+
},
|
|
27432
|
+
{
|
|
27433
|
+
"description": "Shadow color used for shared field focus treatment. Defaults to `var(--esp-color-shadow)`.",
|
|
27434
|
+
"name": "--esp-field-focus-shadow",
|
|
27435
|
+
"inheritedFrom": {
|
|
27436
|
+
"name": "EspalierElementBase",
|
|
27437
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27438
|
+
}
|
|
27439
|
+
}
|
|
27440
|
+
],
|
|
27441
|
+
"events": [
|
|
27442
|
+
{
|
|
27443
|
+
"name": "value-changed",
|
|
27444
|
+
"type": {
|
|
27445
|
+
"text": "CustomEvent"
|
|
27446
|
+
},
|
|
27447
|
+
"inheritedFrom": {
|
|
27448
|
+
"name": "EspalierElementBase",
|
|
27449
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27450
|
+
}
|
|
27451
|
+
}
|
|
27452
|
+
]
|
|
27453
|
+
}
|
|
27454
|
+
],
|
|
27455
|
+
"exports": [
|
|
27456
|
+
{
|
|
27457
|
+
"kind": "js",
|
|
27458
|
+
"name": "EspalierHelpButton",
|
|
27459
|
+
"declaration": {
|
|
27460
|
+
"name": "EspalierHelpButton",
|
|
27461
|
+
"module": "dist/help/esp-help-button.js"
|
|
27462
|
+
}
|
|
27463
|
+
},
|
|
27464
|
+
{
|
|
27465
|
+
"kind": "custom-element-definition",
|
|
27466
|
+
"name": "esp-help-button",
|
|
27467
|
+
"declaration": {
|
|
27468
|
+
"name": "EspalierHelpButton",
|
|
27469
|
+
"module": "dist/help/esp-help-button.js"
|
|
27470
|
+
}
|
|
27471
|
+
}
|
|
27472
|
+
]
|
|
27473
|
+
},
|
|
27474
|
+
{
|
|
27475
|
+
"kind": "javascript-module",
|
|
27476
|
+
"path": "dist/help/esp-help-provider.js",
|
|
27477
|
+
"declarations": [
|
|
27478
|
+
{
|
|
27479
|
+
"kind": "class",
|
|
27480
|
+
"description": "Headless provider for URL-addressable help documents. Place one provider\ninside the same `<esp-root>` as the page's shared `<esp-flyout>`. It\nservices `requestHelp()` calls, fetches and normalizes the document, and\nswaps an internal help view into the generic flyout surface.\n\nSuccessful documents are cached by absolute source URL. A newer request\naborts an older in-flight fetch, so help always reflects the most recent\ntrigger. If no flyout services the provider's presentation request, the\noriginal URL opens in a new tab. Fetch failures stay in the flyout and\noffer an explicit \"Open help document\" action.\n\n```html\n<esp-root>\n <esp-help-provider></esp-help-provider>\n <esp-page help-src=\"/help/account.html\">\n <esp-flyout slot=\"flyout\"></esp-flyout>\n <!-- page content -->\n </esp-page>\n</esp-root>\n```",
|
|
27481
|
+
"name": "EspalierHelpProvider",
|
|
27482
|
+
"members": [
|
|
27483
|
+
{
|
|
27484
|
+
"kind": "field",
|
|
27485
|
+
"name": "cache",
|
|
27486
|
+
"privacy": "private",
|
|
27487
|
+
"readonly": true,
|
|
27488
|
+
"default": "new Map<string, NormalizedHelpDocument>()"
|
|
27489
|
+
},
|
|
27490
|
+
{
|
|
27491
|
+
"kind": "field",
|
|
27492
|
+
"name": "warnedMissingAnchors",
|
|
27493
|
+
"privacy": "private",
|
|
27494
|
+
"readonly": true,
|
|
27495
|
+
"default": "new Set<string>()"
|
|
27496
|
+
},
|
|
27497
|
+
{
|
|
27498
|
+
"kind": "field",
|
|
27499
|
+
"name": "activeRequest",
|
|
27500
|
+
"type": {
|
|
27501
|
+
"text": "HelpRequest | null"
|
|
27502
|
+
},
|
|
27503
|
+
"privacy": "private",
|
|
27504
|
+
"default": "null"
|
|
27505
|
+
},
|
|
27506
|
+
{
|
|
27507
|
+
"kind": "field",
|
|
27508
|
+
"name": "activeController",
|
|
27509
|
+
"type": {
|
|
27510
|
+
"text": "AbortController | null"
|
|
27511
|
+
},
|
|
27512
|
+
"privacy": "private",
|
|
27513
|
+
"default": "null"
|
|
27514
|
+
},
|
|
27515
|
+
{
|
|
27516
|
+
"kind": "field",
|
|
27517
|
+
"name": "activeContent",
|
|
27518
|
+
"type": {
|
|
27519
|
+
"text": "HTMLElement | null"
|
|
27520
|
+
},
|
|
27521
|
+
"privacy": "private",
|
|
27522
|
+
"default": "null"
|
|
27523
|
+
},
|
|
27524
|
+
{
|
|
27525
|
+
"kind": "field",
|
|
27526
|
+
"name": "contentObserver",
|
|
27527
|
+
"privacy": "private",
|
|
27528
|
+
"readonly": true,
|
|
27529
|
+
"default": "new MutationObserver(() => { if (this.activeContent && !this.activeContent.isConnected) { this.endActiveRequest(); } })"
|
|
27530
|
+
},
|
|
27531
|
+
{
|
|
27532
|
+
"kind": "field",
|
|
27533
|
+
"name": "requestSequence",
|
|
27534
|
+
"type": {
|
|
27535
|
+
"text": "number"
|
|
27536
|
+
},
|
|
27537
|
+
"privacy": "private",
|
|
27538
|
+
"default": "0"
|
|
27539
|
+
},
|
|
27540
|
+
{
|
|
27541
|
+
"kind": "field",
|
|
27542
|
+
"name": "subscribed",
|
|
27543
|
+
"type": {
|
|
27544
|
+
"text": "boolean"
|
|
27545
|
+
},
|
|
27546
|
+
"privacy": "private",
|
|
27547
|
+
"default": "false"
|
|
27548
|
+
},
|
|
27549
|
+
{
|
|
27550
|
+
"kind": "field",
|
|
27551
|
+
"name": "boundRequest",
|
|
27552
|
+
"privacy": "private",
|
|
27553
|
+
"readonly": true
|
|
27554
|
+
},
|
|
27555
|
+
{
|
|
27556
|
+
"kind": "field",
|
|
27557
|
+
"name": "boundCloseRequest",
|
|
27558
|
+
"privacy": "private",
|
|
27559
|
+
"readonly": true
|
|
27560
|
+
},
|
|
27561
|
+
{
|
|
27562
|
+
"kind": "field",
|
|
27563
|
+
"name": "boundFlyoutClosed",
|
|
27564
|
+
"privacy": "private",
|
|
27565
|
+
"readonly": true
|
|
27566
|
+
},
|
|
27567
|
+
{
|
|
27568
|
+
"kind": "method",
|
|
27569
|
+
"name": "handleRequest",
|
|
27570
|
+
"privacy": "private",
|
|
27571
|
+
"return": {
|
|
27572
|
+
"type": {
|
|
27573
|
+
"text": "Promise<void>"
|
|
27574
|
+
}
|
|
27575
|
+
},
|
|
27576
|
+
"parameters": [
|
|
27577
|
+
{
|
|
27578
|
+
"name": "request",
|
|
27579
|
+
"type": {
|
|
27580
|
+
"text": "HelpRequest"
|
|
27581
|
+
}
|
|
27582
|
+
}
|
|
27583
|
+
]
|
|
27584
|
+
},
|
|
27585
|
+
{
|
|
27586
|
+
"kind": "method",
|
|
27587
|
+
"name": "fetchDocument",
|
|
27588
|
+
"privacy": "private",
|
|
27589
|
+
"return": {
|
|
27590
|
+
"type": {
|
|
27591
|
+
"text": "Promise<NormalizedHelpDocument>"
|
|
27592
|
+
}
|
|
27593
|
+
},
|
|
27594
|
+
"parameters": [
|
|
27595
|
+
{
|
|
27596
|
+
"name": "request",
|
|
27597
|
+
"type": {
|
|
27598
|
+
"text": "HelpRequest"
|
|
27599
|
+
}
|
|
27600
|
+
},
|
|
27601
|
+
{
|
|
27602
|
+
"name": "controller",
|
|
27603
|
+
"type": {
|
|
27604
|
+
"text": "AbortController"
|
|
27605
|
+
}
|
|
27606
|
+
}
|
|
27607
|
+
]
|
|
27608
|
+
},
|
|
27609
|
+
{
|
|
27610
|
+
"kind": "method",
|
|
27611
|
+
"name": "showInFlyout",
|
|
27612
|
+
"privacy": "private",
|
|
27613
|
+
"return": {
|
|
27614
|
+
"type": {
|
|
27615
|
+
"text": "number"
|
|
27616
|
+
}
|
|
27617
|
+
},
|
|
27618
|
+
"parameters": [
|
|
27619
|
+
{
|
|
27620
|
+
"name": "request",
|
|
27621
|
+
"type": {
|
|
27622
|
+
"text": "HelpRequest"
|
|
27623
|
+
}
|
|
27624
|
+
},
|
|
27625
|
+
{
|
|
27626
|
+
"name": "config",
|
|
27627
|
+
"type": {
|
|
27628
|
+
"text": "FlyoutConfig"
|
|
27629
|
+
}
|
|
27630
|
+
}
|
|
27631
|
+
]
|
|
27632
|
+
},
|
|
27633
|
+
{
|
|
27634
|
+
"kind": "method",
|
|
27635
|
+
"name": "publishState",
|
|
27636
|
+
"privacy": "private",
|
|
27637
|
+
"return": {
|
|
27638
|
+
"type": {
|
|
27639
|
+
"text": "void"
|
|
27640
|
+
}
|
|
27641
|
+
},
|
|
27642
|
+
"parameters": [
|
|
27643
|
+
{
|
|
27644
|
+
"name": "request",
|
|
27645
|
+
"type": {
|
|
27646
|
+
"text": "HelpRequest"
|
|
27647
|
+
}
|
|
27648
|
+
},
|
|
27649
|
+
{
|
|
27650
|
+
"name": "open",
|
|
27651
|
+
"type": {
|
|
27652
|
+
"text": "boolean"
|
|
27653
|
+
}
|
|
27654
|
+
}
|
|
27655
|
+
]
|
|
27656
|
+
},
|
|
27657
|
+
{
|
|
27658
|
+
"kind": "method",
|
|
27659
|
+
"name": "publishClosedState",
|
|
27660
|
+
"privacy": "private",
|
|
27661
|
+
"return": {
|
|
27662
|
+
"type": {
|
|
27663
|
+
"text": "void"
|
|
27664
|
+
}
|
|
27665
|
+
}
|
|
27666
|
+
},
|
|
27667
|
+
{
|
|
27668
|
+
"kind": "method",
|
|
27669
|
+
"name": "endActiveRequest",
|
|
27670
|
+
"privacy": "private",
|
|
27671
|
+
"return": {
|
|
27672
|
+
"type": {
|
|
27673
|
+
"text": "void"
|
|
27674
|
+
}
|
|
27675
|
+
}
|
|
27676
|
+
},
|
|
27677
|
+
{
|
|
27678
|
+
"kind": "method",
|
|
27679
|
+
"name": "warnForMissingAnchor",
|
|
27680
|
+
"privacy": "private",
|
|
27681
|
+
"return": {
|
|
27682
|
+
"type": {
|
|
27683
|
+
"text": "void"
|
|
27684
|
+
}
|
|
27685
|
+
},
|
|
27686
|
+
"parameters": [
|
|
27687
|
+
{
|
|
27688
|
+
"name": "request",
|
|
27689
|
+
"type": {
|
|
27690
|
+
"text": "HelpRequest"
|
|
27691
|
+
}
|
|
27692
|
+
},
|
|
27693
|
+
{
|
|
27694
|
+
"name": "anchorFound",
|
|
27695
|
+
"type": {
|
|
27696
|
+
"text": "boolean"
|
|
27697
|
+
}
|
|
27698
|
+
}
|
|
27699
|
+
]
|
|
27700
|
+
},
|
|
27701
|
+
{
|
|
27702
|
+
"kind": "field",
|
|
27703
|
+
"name": "seedColorBacker",
|
|
27704
|
+
"type": {
|
|
27705
|
+
"text": "string"
|
|
27706
|
+
},
|
|
27707
|
+
"privacy": "private",
|
|
27708
|
+
"default": "\"oklch(0.7 0.125 216)\"",
|
|
27709
|
+
"inheritedFrom": {
|
|
27710
|
+
"name": "EspalierElementBase",
|
|
27711
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27712
|
+
}
|
|
27713
|
+
},
|
|
27714
|
+
{
|
|
27715
|
+
"kind": "field",
|
|
27716
|
+
"name": "espRoot",
|
|
27717
|
+
"type": {
|
|
27718
|
+
"text": "EspalierRoot | null"
|
|
27719
|
+
},
|
|
27720
|
+
"privacy": "private",
|
|
27721
|
+
"default": "null",
|
|
27722
|
+
"inheritedFrom": {
|
|
27723
|
+
"name": "EspalierElementBase",
|
|
27724
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27725
|
+
}
|
|
27726
|
+
},
|
|
27727
|
+
{
|
|
27728
|
+
"kind": "field",
|
|
27729
|
+
"name": "variantTokenOriginalValues",
|
|
27730
|
+
"privacy": "private",
|
|
27731
|
+
"readonly": true,
|
|
27732
|
+
"default": "new Map< string, { generatedPriority: string; generatedValue: string; originalPriority: string; originalValue: string | null; } >()",
|
|
27733
|
+
"inheritedFrom": {
|
|
27734
|
+
"name": "EspalierElementBase",
|
|
27735
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27736
|
+
}
|
|
27737
|
+
},
|
|
27738
|
+
{
|
|
27739
|
+
"kind": "field",
|
|
27740
|
+
"name": "rootEventSubscriptionsActive",
|
|
27741
|
+
"type": {
|
|
27742
|
+
"text": "boolean"
|
|
27743
|
+
},
|
|
27744
|
+
"privacy": "private",
|
|
27745
|
+
"default": "false",
|
|
27746
|
+
"inheritedFrom": {
|
|
27747
|
+
"name": "EspalierElementBase",
|
|
27748
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27749
|
+
}
|
|
27750
|
+
},
|
|
27751
|
+
{
|
|
27752
|
+
"kind": "field",
|
|
27753
|
+
"name": "subscribedRoot",
|
|
27754
|
+
"type": {
|
|
27755
|
+
"text": "EspalierRoot | null"
|
|
27756
|
+
},
|
|
27757
|
+
"privacy": "private",
|
|
27758
|
+
"default": "null",
|
|
27759
|
+
"inheritedFrom": {
|
|
27760
|
+
"name": "EspalierElementBase",
|
|
27761
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27762
|
+
}
|
|
27763
|
+
},
|
|
27764
|
+
{
|
|
27765
|
+
"kind": "field",
|
|
27766
|
+
"name": "rootEventUnsubscribers",
|
|
27767
|
+
"type": {
|
|
27768
|
+
"text": "Array<() => void>"
|
|
27769
|
+
},
|
|
27770
|
+
"privacy": "private",
|
|
27771
|
+
"default": "[]",
|
|
27772
|
+
"inheritedFrom": {
|
|
27773
|
+
"name": "EspalierElementBase",
|
|
27774
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27775
|
+
}
|
|
27776
|
+
},
|
|
27777
|
+
{
|
|
27778
|
+
"kind": "field",
|
|
27779
|
+
"name": "variantBacker",
|
|
27780
|
+
"type": {
|
|
27781
|
+
"text": "EspalierVariant"
|
|
27782
|
+
},
|
|
27783
|
+
"privacy": "protected",
|
|
27784
|
+
"default": "\"primary\"",
|
|
27785
|
+
"inheritedFrom": {
|
|
27786
|
+
"name": "EspalierElementBase",
|
|
27787
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27788
|
+
}
|
|
27789
|
+
},
|
|
27790
|
+
{
|
|
27791
|
+
"kind": "field",
|
|
27792
|
+
"name": "seedColor",
|
|
27793
|
+
"type": {
|
|
27794
|
+
"text": "string"
|
|
27795
|
+
},
|
|
27796
|
+
"privacy": "public",
|
|
27797
|
+
"inheritedFrom": {
|
|
27798
|
+
"name": "EspalierElementBase",
|
|
27799
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27800
|
+
}
|
|
27801
|
+
},
|
|
27802
|
+
{
|
|
27803
|
+
"kind": "field",
|
|
27804
|
+
"name": "correlationId",
|
|
27805
|
+
"privacy": "public",
|
|
27806
|
+
"inheritedFrom": {
|
|
27807
|
+
"name": "EspalierElementBase",
|
|
27808
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27809
|
+
}
|
|
27810
|
+
},
|
|
27811
|
+
{
|
|
27812
|
+
"kind": "method",
|
|
27813
|
+
"name": "focusResolvedElementAfterUpdate",
|
|
27814
|
+
"privacy": "protected",
|
|
27815
|
+
"return": {
|
|
27816
|
+
"type": {
|
|
27817
|
+
"text": "void"
|
|
27818
|
+
}
|
|
27819
|
+
},
|
|
27820
|
+
"parameters": [
|
|
27821
|
+
{
|
|
27822
|
+
"name": "resolveTarget",
|
|
27823
|
+
"type": {
|
|
27824
|
+
"text": "() => HTMLElement | null | undefined"
|
|
27825
|
+
}
|
|
27826
|
+
},
|
|
27827
|
+
{
|
|
27828
|
+
"name": "options",
|
|
27829
|
+
"optional": true,
|
|
27830
|
+
"type": {
|
|
27831
|
+
"text": "FocusOptions"
|
|
27832
|
+
}
|
|
27833
|
+
}
|
|
27834
|
+
],
|
|
27835
|
+
"inheritedFrom": {
|
|
27836
|
+
"name": "EspalierElementBase",
|
|
27837
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27838
|
+
}
|
|
27839
|
+
},
|
|
27840
|
+
{
|
|
27841
|
+
"kind": "method",
|
|
27842
|
+
"name": "focusShadowElementAfterUpdate",
|
|
27843
|
+
"privacy": "protected",
|
|
27844
|
+
"return": {
|
|
27845
|
+
"type": {
|
|
27846
|
+
"text": "void"
|
|
27847
|
+
}
|
|
27848
|
+
},
|
|
27849
|
+
"parameters": [
|
|
27850
|
+
{
|
|
27851
|
+
"name": "selector",
|
|
27852
|
+
"type": {
|
|
27853
|
+
"text": "string"
|
|
27854
|
+
}
|
|
27855
|
+
},
|
|
27856
|
+
{
|
|
27857
|
+
"name": "options",
|
|
27858
|
+
"optional": true,
|
|
27859
|
+
"type": {
|
|
27860
|
+
"text": "FocusOptions"
|
|
27861
|
+
}
|
|
27862
|
+
}
|
|
27863
|
+
],
|
|
27864
|
+
"inheritedFrom": {
|
|
27865
|
+
"name": "EspalierElementBase",
|
|
27866
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27867
|
+
}
|
|
27868
|
+
},
|
|
27869
|
+
{
|
|
27870
|
+
"kind": "method",
|
|
27871
|
+
"name": "emitValueChanged",
|
|
27872
|
+
"privacy": "protected",
|
|
27873
|
+
"return": {
|
|
27874
|
+
"type": {
|
|
27875
|
+
"text": "void"
|
|
27876
|
+
}
|
|
27877
|
+
},
|
|
27878
|
+
"parameters": [
|
|
27879
|
+
{
|
|
27880
|
+
"name": "detail",
|
|
27881
|
+
"type": {
|
|
27882
|
+
"text": "T"
|
|
27883
|
+
}
|
|
27884
|
+
}
|
|
27885
|
+
],
|
|
27886
|
+
"inheritedFrom": {
|
|
27887
|
+
"name": "EspalierElementBase",
|
|
27888
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27889
|
+
}
|
|
27890
|
+
},
|
|
27891
|
+
{
|
|
27892
|
+
"kind": "field",
|
|
27893
|
+
"name": "scheme",
|
|
27894
|
+
"type": {
|
|
27895
|
+
"text": "\"dark\" | \"light\""
|
|
27896
|
+
},
|
|
27897
|
+
"privacy": "public",
|
|
27898
|
+
"default": "\"light\"",
|
|
27899
|
+
"description": "The scheme to use for the component. This property is used internally\nto control the light/dark scheme so it matches the scheme of\n[esp-root](/components/root). It should not be set manually, it\nexists as an attribute for styling purposes.",
|
|
27900
|
+
"attribute": "scheme",
|
|
27901
|
+
"reflects": true,
|
|
27902
|
+
"inheritedFrom": {
|
|
27903
|
+
"name": "EspalierElementBase",
|
|
27904
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27905
|
+
}
|
|
27906
|
+
},
|
|
27907
|
+
{
|
|
27908
|
+
"kind": "field",
|
|
27909
|
+
"name": "variant",
|
|
27910
|
+
"type": {
|
|
27911
|
+
"text": "EspalierVariant"
|
|
27912
|
+
},
|
|
27913
|
+
"privacy": "public",
|
|
27914
|
+
"description": "The [color variant](/guides/color/variants) of the element.",
|
|
27915
|
+
"attribute": "variant",
|
|
27916
|
+
"reflects": true,
|
|
27917
|
+
"inheritedFrom": {
|
|
27918
|
+
"name": "EspalierElementBase",
|
|
27919
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27920
|
+
}
|
|
27921
|
+
},
|
|
27922
|
+
{
|
|
27923
|
+
"kind": "method",
|
|
27924
|
+
"name": "syncRootFromDom",
|
|
27925
|
+
"privacy": "private",
|
|
27926
|
+
"return": {
|
|
27927
|
+
"type": {
|
|
27928
|
+
"text": "EspalierRoot | null"
|
|
27929
|
+
}
|
|
27930
|
+
},
|
|
27931
|
+
"parameters": [
|
|
27932
|
+
{
|
|
27933
|
+
"name": "throwIfMissing",
|
|
27934
|
+
"type": {
|
|
27935
|
+
"text": "boolean"
|
|
27936
|
+
}
|
|
27937
|
+
}
|
|
27938
|
+
],
|
|
27939
|
+
"inheritedFrom": {
|
|
27940
|
+
"name": "EspalierElementBase",
|
|
27941
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27942
|
+
}
|
|
27943
|
+
},
|
|
27944
|
+
{
|
|
27945
|
+
"kind": "method",
|
|
27946
|
+
"name": "subscribeToRootEvents",
|
|
27947
|
+
"privacy": "private",
|
|
27948
|
+
"return": {
|
|
27949
|
+
"type": {
|
|
27950
|
+
"text": "void"
|
|
27951
|
+
}
|
|
27952
|
+
},
|
|
27953
|
+
"parameters": [
|
|
27954
|
+
{
|
|
27955
|
+
"name": "root",
|
|
27956
|
+
"type": {
|
|
27957
|
+
"text": "EspalierRoot"
|
|
27958
|
+
}
|
|
27959
|
+
}
|
|
27960
|
+
],
|
|
27961
|
+
"inheritedFrom": {
|
|
27962
|
+
"name": "EspalierElementBase",
|
|
27963
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27964
|
+
}
|
|
27965
|
+
},
|
|
27966
|
+
{
|
|
27967
|
+
"kind": "method",
|
|
27968
|
+
"name": "unsubscribeFromRootEvents",
|
|
27969
|
+
"privacy": "private",
|
|
27970
|
+
"return": {
|
|
27971
|
+
"type": {
|
|
27972
|
+
"text": "void"
|
|
27973
|
+
}
|
|
27974
|
+
},
|
|
27975
|
+
"inheritedFrom": {
|
|
27976
|
+
"name": "EspalierElementBase",
|
|
27977
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27978
|
+
}
|
|
27979
|
+
},
|
|
27980
|
+
{
|
|
27981
|
+
"kind": "field",
|
|
27982
|
+
"name": "handleSeedColorChanged",
|
|
27983
|
+
"privacy": "private",
|
|
27984
|
+
"inheritedFrom": {
|
|
27985
|
+
"name": "EspalierElementBase",
|
|
27986
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27987
|
+
}
|
|
27988
|
+
},
|
|
27989
|
+
{
|
|
27990
|
+
"kind": "field",
|
|
27991
|
+
"name": "handleSchemeChanged",
|
|
27992
|
+
"privacy": "private",
|
|
27993
|
+
"inheritedFrom": {
|
|
27994
|
+
"name": "EspalierElementBase",
|
|
27995
|
+
"module": "dist/shared/esp-element-base.js"
|
|
27996
|
+
}
|
|
27997
|
+
},
|
|
27998
|
+
{
|
|
27999
|
+
"kind": "field",
|
|
28000
|
+
"name": "handleThemeChanged",
|
|
28001
|
+
"privacy": "private",
|
|
28002
|
+
"inheritedFrom": {
|
|
28003
|
+
"name": "EspalierElementBase",
|
|
28004
|
+
"module": "dist/shared/esp-element-base.js"
|
|
28005
|
+
}
|
|
28006
|
+
},
|
|
28007
|
+
{
|
|
28008
|
+
"kind": "field",
|
|
28009
|
+
"name": "handleIconSpriteUrlChanged",
|
|
28010
|
+
"privacy": "private",
|
|
28011
|
+
"inheritedFrom": {
|
|
28012
|
+
"name": "EspalierElementBase",
|
|
28013
|
+
"module": "dist/shared/esp-element-base.js"
|
|
28014
|
+
}
|
|
28015
|
+
},
|
|
28016
|
+
{
|
|
28017
|
+
"kind": "method",
|
|
28018
|
+
"name": "traverseToClosest",
|
|
28019
|
+
"privacy": "public",
|
|
28020
|
+
"return": {
|
|
28021
|
+
"type": {
|
|
28022
|
+
"text": ""
|
|
28023
|
+
}
|
|
28024
|
+
},
|
|
28025
|
+
"parameters": [
|
|
28026
|
+
{
|
|
28027
|
+
"name": "selector",
|
|
28028
|
+
"type": {
|
|
28029
|
+
"text": "string"
|
|
28030
|
+
},
|
|
28031
|
+
"description": "The selector of the element to look for"
|
|
28032
|
+
}
|
|
28033
|
+
],
|
|
28034
|
+
"description": "Traverse up the DOM tree to find the closest element that\nmatches the selector. This method is aware of shadow DOM\nboundaries and will traverse through them to find the element.",
|
|
28035
|
+
"inheritedFrom": {
|
|
28036
|
+
"name": "EspalierElementBase",
|
|
28037
|
+
"module": "dist/shared/esp-element-base.js"
|
|
28038
|
+
}
|
|
28039
|
+
},
|
|
28040
|
+
{
|
|
28041
|
+
"kind": "field",
|
|
28042
|
+
"name": "textContrast",
|
|
28043
|
+
"type": {
|
|
28044
|
+
"text": "Partial<\n Record<SemanticColorName, { bg: SemanticColorName; targetLc: number }>\n >"
|
|
28045
|
+
},
|
|
28046
|
+
"privacy": "private",
|
|
28047
|
+
"static": true,
|
|
28048
|
+
"readonly": true,
|
|
28049
|
+
"default": "{ text: { bg: \"background\", targetLc: 75 }, dangerText: { bg: \"background\", targetLc: 75 }, headings: { bg: \"background\", targetLc: 60 }, headingsHover: { bg: \"background\", targetLc: 60 }, link: { bg: \"background\", targetLc: 75 }, linkHover: { bg: \"background\", targetLc: 75 }, actionText: { bg: \"actionBackground\", targetLc: 75 }, inputCaret: { bg: \"layer2\", targetLc: 60 }, inputSelection: { bg: \"inputSelectionBg\", targetLc: 60 }, }",
|
|
28050
|
+
"description": "Text tokens that require APCA contrast enforcement.\n\nEach entry maps a text-bearing semantic token to:\n - `bg`: the semantic token it sits on (reference color)\n - `targetLc`: the minimum |Lc| the text must achieve",
|
|
28051
|
+
"inheritedFrom": {
|
|
28052
|
+
"name": "EspalierElementBase",
|
|
28053
|
+
"module": "dist/shared/esp-element-base.js"
|
|
28054
|
+
}
|
|
28055
|
+
},
|
|
28056
|
+
{
|
|
28057
|
+
"kind": "field",
|
|
28058
|
+
"name": "statusVariantSources",
|
|
28059
|
+
"type": {
|
|
28060
|
+
"text": "ReadonlySet<ColorSource>"
|
|
28061
|
+
},
|
|
28062
|
+
"privacy": "private",
|
|
28063
|
+
"static": true,
|
|
28064
|
+
"readonly": true,
|
|
28065
|
+
"default": "new Set<ColorSource>([ \"danger\", \"success\", \"warning\", ])",
|
|
28066
|
+
"description": "Variant color sources whose meaning is carried by a fixed hue rather\nthan the brand seed — the destructive / positive / warning status\nfamilies (ADR-004). For these variants the filled-action tokens are\npinned to the variant's own color so a theme cannot make them look\nlike an ordinary brand action. See task 098.",
|
|
28067
|
+
"inheritedFrom": {
|
|
28068
|
+
"name": "EspalierElementBase",
|
|
28069
|
+
"module": "dist/shared/esp-element-base.js"
|
|
28070
|
+
}
|
|
28071
|
+
},
|
|
28072
|
+
{
|
|
28073
|
+
"kind": "field",
|
|
28074
|
+
"name": "semanticActionTokens",
|
|
28075
|
+
"type": {
|
|
28076
|
+
"text": "ReadonlySet<SemanticColorName>"
|
|
28077
|
+
},
|
|
28078
|
+
"privacy": "private",
|
|
28079
|
+
"static": true,
|
|
28080
|
+
"readonly": true,
|
|
28081
|
+
"default": "new Set<SemanticColorName>([\"actionBackground\", \"actionText\"])",
|
|
28082
|
+
"description": "Semantic tokens that paint a control's filled action surface. For a\nstatus variant these always derive from the variant's own color, so\nthe Taproot \"Buttons\" semantic group (which re-points\n`actionBackground` / `actionText` to a brand source) cannot rotate a\ndestructive / warning / positive action off its semantic hue. See\ntask 098.",
|
|
28083
|
+
"inheritedFrom": {
|
|
28084
|
+
"name": "EspalierElementBase",
|
|
28085
|
+
"module": "dist/shared/esp-element-base.js"
|
|
28086
|
+
}
|
|
28087
|
+
},
|
|
28088
|
+
{
|
|
28089
|
+
"kind": "method",
|
|
28090
|
+
"name": "applyVariantTokens",
|
|
28091
|
+
"privacy": "protected",
|
|
28092
|
+
"return": {
|
|
28093
|
+
"type": {
|
|
28094
|
+
"text": "void"
|
|
28095
|
+
}
|
|
28096
|
+
},
|
|
28097
|
+
"inheritedFrom": {
|
|
28098
|
+
"name": "EspalierElementBase",
|
|
28099
|
+
"module": "dist/shared/esp-element-base.js"
|
|
28100
|
+
}
|
|
28101
|
+
},
|
|
28102
|
+
{
|
|
28103
|
+
"kind": "method",
|
|
28104
|
+
"name": "effectiveVariantTokenSource",
|
|
28105
|
+
"privacy": "private",
|
|
28106
|
+
"return": {
|
|
28107
|
+
"type": {
|
|
28108
|
+
"text": "ColorSource"
|
|
28109
|
+
}
|
|
28110
|
+
},
|
|
28111
|
+
"parameters": [
|
|
28112
|
+
{
|
|
28113
|
+
"name": "name",
|
|
28114
|
+
"type": {
|
|
28115
|
+
"text": "SemanticColorName"
|
|
28116
|
+
}
|
|
28117
|
+
},
|
|
28118
|
+
{
|
|
28119
|
+
"name": "mappedSource",
|
|
28120
|
+
"type": {
|
|
28121
|
+
"text": "ColorSource"
|
|
28122
|
+
}
|
|
28123
|
+
},
|
|
28124
|
+
{
|
|
28125
|
+
"name": "isStatusVariant",
|
|
28126
|
+
"type": {
|
|
28127
|
+
"text": "boolean"
|
|
28128
|
+
}
|
|
28129
|
+
}
|
|
28130
|
+
],
|
|
28131
|
+
"description": "Resolve the color source used to derive a semantic token for the\nactive variant.\n\nNormally this is the theme's mapping source, so the variant performs a\nfull palette shift relative to its own color. The exception is the\nmeaning-bearing status variants (`danger`, `success`, `warning`): their\nfilled-action tokens (`actionBackground`, `actionText`) are pinned to\nthe variant's own color — the `primary` entry of the sub-variant\npalette, which is the variant color itself — so a theme that re-points\nthe Buttons semantic group to a brand source cannot rotate a\ndestructive / warning / positive action off its semantic hue. Ordinary\nbrand and primary variants keep full theme customization. See task 098.",
|
|
28132
|
+
"inheritedFrom": {
|
|
28133
|
+
"name": "EspalierElementBase",
|
|
28134
|
+
"module": "dist/shared/esp-element-base.js"
|
|
28135
|
+
}
|
|
28136
|
+
},
|
|
28137
|
+
{
|
|
28138
|
+
"kind": "method",
|
|
28139
|
+
"name": "getVariantColorSource",
|
|
28140
|
+
"privacy": "protected",
|
|
28141
|
+
"return": {
|
|
28142
|
+
"type": {
|
|
28143
|
+
"text": "ColorSource | \"\""
|
|
28144
|
+
}
|
|
28145
|
+
},
|
|
28146
|
+
"inheritedFrom": {
|
|
28147
|
+
"name": "EspalierElementBase",
|
|
28148
|
+
"module": "dist/shared/esp-element-base.js"
|
|
28149
|
+
}
|
|
28150
|
+
},
|
|
28151
|
+
{
|
|
28152
|
+
"kind": "method",
|
|
28153
|
+
"name": "setVariantTokenProperty",
|
|
28154
|
+
"privacy": "private",
|
|
28155
|
+
"return": {
|
|
28156
|
+
"type": {
|
|
28157
|
+
"text": "void"
|
|
28158
|
+
}
|
|
28159
|
+
},
|
|
28160
|
+
"parameters": [
|
|
28161
|
+
{
|
|
28162
|
+
"name": "name",
|
|
28163
|
+
"type": {
|
|
28164
|
+
"text": "string"
|
|
28165
|
+
}
|
|
28166
|
+
},
|
|
28167
|
+
{
|
|
28168
|
+
"name": "value",
|
|
28169
|
+
"type": {
|
|
28170
|
+
"text": "string"
|
|
28171
|
+
}
|
|
28172
|
+
}
|
|
28173
|
+
],
|
|
28174
|
+
"inheritedFrom": {
|
|
28175
|
+
"name": "EspalierElementBase",
|
|
28176
|
+
"module": "dist/shared/esp-element-base.js"
|
|
28177
|
+
}
|
|
28178
|
+
},
|
|
28179
|
+
{
|
|
28180
|
+
"kind": "method",
|
|
28181
|
+
"name": "clearVariantTokens",
|
|
28182
|
+
"privacy": "private",
|
|
28183
|
+
"return": {
|
|
28184
|
+
"type": {
|
|
28185
|
+
"text": "void"
|
|
28186
|
+
}
|
|
28187
|
+
},
|
|
28188
|
+
"inheritedFrom": {
|
|
28189
|
+
"name": "EspalierElementBase",
|
|
28190
|
+
"module": "dist/shared/esp-element-base.js"
|
|
28191
|
+
}
|
|
28192
|
+
}
|
|
28193
|
+
],
|
|
28194
|
+
"superclass": {
|
|
28195
|
+
"name": "EspalierElementBase",
|
|
28196
|
+
"module": "dist/shared/esp-element-base.js"
|
|
28197
|
+
},
|
|
28198
|
+
"docPageTitle": {
|
|
28199
|
+
"name": "Help",
|
|
28200
|
+
"description": "Provider"
|
|
28201
|
+
},
|
|
28202
|
+
"docUrl": {
|
|
28203
|
+
"name": "/components/help/provider",
|
|
28204
|
+
"description": ""
|
|
28205
|
+
},
|
|
28206
|
+
"menuGroup": {
|
|
28207
|
+
"name": "Feedback",
|
|
28208
|
+
"description": ""
|
|
28209
|
+
},
|
|
28210
|
+
"menuLabel": {
|
|
28211
|
+
"name": "Help",
|
|
28212
|
+
"description": "Provider"
|
|
28213
|
+
},
|
|
28214
|
+
"menuIcon": {
|
|
28215
|
+
"name": "info",
|
|
28216
|
+
"description": ""
|
|
28217
|
+
},
|
|
28218
|
+
"tagName": "esp-help-provider",
|
|
28219
|
+
"customElement": true,
|
|
28220
|
+
"cssProperties": [
|
|
26130
28221
|
{
|
|
26131
|
-
"
|
|
26132
|
-
"
|
|
26133
|
-
"text": "CustomEvent"
|
|
26134
|
-
},
|
|
28222
|
+
"description": "Background color of the shared field shell. Defaults to `var(--esp-color-layer-2)`.",
|
|
28223
|
+
"name": "--esp-field-background",
|
|
26135
28224
|
"inheritedFrom": {
|
|
26136
28225
|
"name": "EspalierElementBase",
|
|
26137
28226
|
"module": "dist/shared/esp-element-base.js"
|
|
26138
28227
|
}
|
|
26139
|
-
}
|
|
26140
|
-
],
|
|
26141
|
-
"attributes": [
|
|
26142
|
-
{
|
|
26143
|
-
"name": "show-burger",
|
|
26144
|
-
"type": {
|
|
26145
|
-
"text": "boolean"
|
|
26146
|
-
},
|
|
26147
|
-
"default": "false",
|
|
26148
|
-
"description": "Force the burger button to be visible regardless of the\nmenu width. Use this when the burger controls an external\nelement (e.g. a sidebar drawer) instead of the built-in\n`<esp-menu>` overlay.",
|
|
26149
|
-
"fieldName": "showBurger"
|
|
26150
|
-
},
|
|
26151
|
-
{
|
|
26152
|
-
"name": "layout",
|
|
26153
|
-
"type": {
|
|
26154
|
-
"text": "HeaderLayout"
|
|
26155
|
-
},
|
|
26156
|
-
"description": "Header layout style.\n\n- `standard` places brand, menu, and actions on one row.\n- `centered-brand` centers the brand between left navigation and actions.\n- `extended` puts navigation on a second row on wide screens.\n- `extended-centered` centers the brand and second-row navigation.\n- `minimal` keeps only brand/actions inline and uses the drawer menu.\n\n```html\n<div style=\"display: grid; gap: var(--esp-size-padding);\">\n <esp-header\n brand-logo=\"/assets/favicon.svg\"\n brand-text=\"Espalier\"\n brand-href=\"#\"\n brand-alt=\"Espalier logo\"\n layout=\"standard\"\n theme-toggle=\"visible\">\n <esp-menu slot=\"menu\" mode=\"horizontal\">\n <esp-menu-item label=\"Components\" url=\"#components\"></esp-menu-item>\n <esp-menu-item label=\"Guides\" url=\"#guides\"></esp-menu-item>\n </esp-menu>\n </esp-header>\n\n <div\n style=\"\n display: grid;\n gap: var(--esp-size-small);\n \">\n <esp-form-item label=\"Header layout\">\n <esp-pick-one>\n <esp-picker-item text=\"Standard\" value=\"standard\" selected></esp-picker-item>\n <esp-picker-item text=\"Centered brand\" value=\"centered-brand\"></esp-picker-item>\n <esp-picker-item text=\"Extended\" value=\"extended\"></esp-picker-item>\n <esp-picker-item text=\"Extended centered\" value=\"extended-centered\"></esp-picker-item>\n <esp-picker-item text=\"Minimal\" value=\"minimal\"></esp-picker-item>\n </esp-pick-one>\n </esp-form-item>\n </div>\n</div>\n<script>\n const header = findByTagName(\"esp-header\")[0];\n const picker = findByTagName(\"esp-pick-one\")[0];\n\n function applyLayout(event) {\n header.layout = event.detail?.value || picker.value || \"standard\";\n }\n\n picker.addEventListener(\"value-changed\", applyLayout);\n</script>\n```",
|
|
26157
|
-
"default": "\"standard\"",
|
|
26158
|
-
"fieldName": "layout"
|
|
26159
|
-
},
|
|
26160
|
-
{
|
|
26161
|
-
"name": "brand-text",
|
|
26162
|
-
"type": {
|
|
26163
|
-
"text": "string"
|
|
26164
|
-
},
|
|
26165
|
-
"default": "\"\"",
|
|
26166
|
-
"description": "Configured brand text used when the `brand` slot is empty.",
|
|
26167
|
-
"fieldName": "brandText"
|
|
26168
|
-
},
|
|
26169
|
-
{
|
|
26170
|
-
"name": "brand-logo",
|
|
26171
|
-
"type": {
|
|
26172
|
-
"text": "string"
|
|
26173
|
-
},
|
|
26174
|
-
"default": "\"\"",
|
|
26175
|
-
"description": "Configured brand logo URL used when the `brand` slot is empty.",
|
|
26176
|
-
"fieldName": "brandLogo"
|
|
26177
|
-
},
|
|
26178
|
-
{
|
|
26179
|
-
"name": "light-brand-logo",
|
|
26180
|
-
"type": {
|
|
26181
|
-
"text": "string"
|
|
26182
|
-
},
|
|
26183
|
-
"default": "\"\"",
|
|
26184
|
-
"description": "Configured brand logo URL used in light scheme. A non-empty value\noverrides `brand-logo`; an empty value falls back to it.",
|
|
26185
|
-
"fieldName": "lightBrandLogo"
|
|
26186
|
-
},
|
|
26187
|
-
{
|
|
26188
|
-
"name": "dark-brand-logo",
|
|
26189
|
-
"type": {
|
|
26190
|
-
"text": "string"
|
|
26191
|
-
},
|
|
26192
|
-
"default": "\"\"",
|
|
26193
|
-
"description": "Configured brand logo URL used in dark scheme. A non-empty value\noverrides `brand-logo`; an empty value falls back to it.",
|
|
26194
|
-
"fieldName": "darkBrandLogo"
|
|
26195
28228
|
},
|
|
26196
28229
|
{
|
|
26197
|
-
"
|
|
26198
|
-
"
|
|
26199
|
-
|
|
26200
|
-
|
|
26201
|
-
|
|
26202
|
-
|
|
26203
|
-
"fieldName": "brandHref"
|
|
26204
|
-
},
|
|
26205
|
-
{
|
|
26206
|
-
"name": "brand-alt",
|
|
26207
|
-
"type": {
|
|
26208
|
-
"text": "string"
|
|
26209
|
-
},
|
|
26210
|
-
"default": "\"\"",
|
|
26211
|
-
"description": "Accessible text for a logo-only configured brand. When brand text\nis also present, the logo is decorative unless this is set.",
|
|
26212
|
-
"fieldName": "brandAlt"
|
|
26213
|
-
},
|
|
26214
|
-
{
|
|
26215
|
-
"name": "brand-color",
|
|
26216
|
-
"type": {
|
|
26217
|
-
"text": "string"
|
|
26218
|
-
},
|
|
26219
|
-
"default": "\"\"",
|
|
26220
|
-
"description": "Optional configured brand color. Prefer theme fields for\nproduct-wide brand typography and this property for a local\nheader override.",
|
|
26221
|
-
"fieldName": "brandColor"
|
|
26222
|
-
},
|
|
26223
|
-
{
|
|
26224
|
-
"name": "light-brand-color",
|
|
26225
|
-
"type": {
|
|
26226
|
-
"text": "string"
|
|
26227
|
-
},
|
|
26228
|
-
"default": "\"\"",
|
|
26229
|
-
"description": "Configured brand color used in light scheme. A non-empty value\noverrides `brand-color`; an empty value falls back to it and then\n`--esp-header-brand-color`.",
|
|
26230
|
-
"fieldName": "lightBrandColor"
|
|
26231
|
-
},
|
|
26232
|
-
{
|
|
26233
|
-
"name": "dark-brand-color",
|
|
26234
|
-
"type": {
|
|
26235
|
-
"text": "string"
|
|
26236
|
-
},
|
|
26237
|
-
"default": "\"\"",
|
|
26238
|
-
"description": "Configured brand color used in dark scheme. A non-empty value\noverrides `brand-color`; an empty value falls back to it and then\n`--esp-header-brand-color`.",
|
|
26239
|
-
"fieldName": "darkBrandColor"
|
|
26240
|
-
},
|
|
26241
|
-
{
|
|
26242
|
-
"name": "brand-align",
|
|
26243
|
-
"type": {
|
|
26244
|
-
"text": "HeaderBrandAlign"
|
|
26245
|
-
},
|
|
26246
|
-
"description": "Horizontal placement of the brand content inside its grid area.",
|
|
26247
|
-
"default": "\"start\"",
|
|
26248
|
-
"fieldName": "brandAlign"
|
|
26249
|
-
},
|
|
26250
|
-
{
|
|
26251
|
-
"name": "brand-wrap",
|
|
26252
|
-
"type": {
|
|
26253
|
-
"text": "HeaderBrandWrap"
|
|
26254
|
-
},
|
|
26255
|
-
"description": "Long-brand behavior for configured brand text.",
|
|
26256
|
-
"default": "\"truncate\"",
|
|
26257
|
-
"fieldName": "brandWrap"
|
|
26258
|
-
},
|
|
26259
|
-
{
|
|
26260
|
-
"name": "menu-display",
|
|
26261
|
-
"type": {
|
|
26262
|
-
"text": "HeaderMenuDisplay"
|
|
26263
|
-
},
|
|
26264
|
-
"description": "Navigation display intent. `auto` tries inline navigation before\nusing a drawer, `drawer` always uses the burger/drawer pattern,\nand `inline` leaves overflow handling to the slotted menu.",
|
|
26265
|
-
"default": "\"auto\"",
|
|
26266
|
-
"fieldName": "menuDisplay"
|
|
26267
|
-
},
|
|
26268
|
-
{
|
|
26269
|
-
"name": "theme-toggle",
|
|
26270
|
-
"type": {
|
|
26271
|
-
"text": "HeaderThemeToggle"
|
|
26272
|
-
},
|
|
26273
|
-
"description": "Whether the header renders its built-in light/dark toggle.\nConsumers can still provide their own control in the `buttons`\nslot when this is `hidden`.",
|
|
26274
|
-
"default": "\"hidden\"",
|
|
26275
|
-
"fieldName": "themeToggle"
|
|
28230
|
+
"description": "Border color of the shared field shell. Defaults to `var(--esp-color-border)`.",
|
|
28231
|
+
"name": "--esp-field-border-color",
|
|
28232
|
+
"inheritedFrom": {
|
|
28233
|
+
"name": "EspalierElementBase",
|
|
28234
|
+
"module": "dist/shared/esp-element-base.js"
|
|
28235
|
+
}
|
|
26276
28236
|
},
|
|
26277
28237
|
{
|
|
26278
|
-
"
|
|
26279
|
-
"
|
|
26280
|
-
|
|
26281
|
-
|
|
26282
|
-
|
|
26283
|
-
|
|
26284
|
-
"fieldName": "scrollBehavior"
|
|
28238
|
+
"description": "Border width of the shared field shell. Defaults to `1px`.",
|
|
28239
|
+
"name": "--esp-field-border-width",
|
|
28240
|
+
"inheritedFrom": {
|
|
28241
|
+
"name": "EspalierElementBase",
|
|
28242
|
+
"module": "dist/shared/esp-element-base.js"
|
|
28243
|
+
}
|
|
26285
28244
|
},
|
|
26286
28245
|
{
|
|
26287
|
-
"
|
|
26288
|
-
"
|
|
26289
|
-
|
|
26290
|
-
|
|
26291
|
-
|
|
26292
|
-
|
|
26293
|
-
"fieldName": "scrollThreshold"
|
|
28246
|
+
"description": "Text color used inside the shared field shell. Defaults to `var(--esp-color-text)`.",
|
|
28247
|
+
"name": "--esp-field-text-color",
|
|
28248
|
+
"inheritedFrom": {
|
|
28249
|
+
"name": "EspalierElementBase",
|
|
28250
|
+
"module": "dist/shared/esp-element-base.js"
|
|
28251
|
+
}
|
|
26294
28252
|
},
|
|
26295
28253
|
{
|
|
26296
|
-
"
|
|
26297
|
-
"
|
|
26298
|
-
|
|
26299
|
-
|
|
26300
|
-
|
|
26301
|
-
|
|
26302
|
-
"fieldName": "dockOffset"
|
|
28254
|
+
"description": "Hover background color of the shared field shell. Derived from `--esp-field-background`.",
|
|
28255
|
+
"name": "--esp-field-hover-bg",
|
|
28256
|
+
"inheritedFrom": {
|
|
28257
|
+
"name": "EspalierElementBase",
|
|
28258
|
+
"module": "dist/shared/esp-element-base.js"
|
|
28259
|
+
}
|
|
26303
28260
|
},
|
|
26304
28261
|
{
|
|
26305
|
-
"
|
|
26306
|
-
"
|
|
26307
|
-
|
|
26308
|
-
|
|
26309
|
-
|
|
26310
|
-
|
|
26311
|
-
"fieldName": "drawerTarget"
|
|
28262
|
+
"description": "Focus background color of the shared field shell. Derived from `--esp-field-background`.",
|
|
28263
|
+
"name": "--esp-field-focus-bg",
|
|
28264
|
+
"inheritedFrom": {
|
|
28265
|
+
"name": "EspalierElementBase",
|
|
28266
|
+
"module": "dist/shared/esp-element-base.js"
|
|
28267
|
+
}
|
|
26312
28268
|
},
|
|
26313
28269
|
{
|
|
26314
|
-
"
|
|
26315
|
-
"
|
|
26316
|
-
|
|
26317
|
-
|
|
26318
|
-
|
|
26319
|
-
|
|
26320
|
-
|
|
26321
|
-
|
|
28270
|
+
"description": "Shadow color used for shared field focus treatment. Defaults to `var(--esp-color-shadow)`.",
|
|
28271
|
+
"name": "--esp-field-focus-shadow",
|
|
28272
|
+
"inheritedFrom": {
|
|
28273
|
+
"name": "EspalierElementBase",
|
|
28274
|
+
"module": "dist/shared/esp-element-base.js"
|
|
28275
|
+
}
|
|
28276
|
+
}
|
|
28277
|
+
],
|
|
28278
|
+
"attributes": [
|
|
26322
28279
|
{
|
|
26323
28280
|
"name": "scheme",
|
|
26324
28281
|
"type": {
|
|
@@ -26345,136 +28302,44 @@
|
|
|
26345
28302
|
}
|
|
26346
28303
|
}
|
|
26347
28304
|
],
|
|
26348
|
-
"
|
|
26349
|
-
|
|
26350
|
-
|
|
26351
|
-
|
|
26352
|
-
|
|
26353
|
-
|
|
26354
|
-
|
|
26355
|
-
|
|
26356
|
-
|
|
26357
|
-
|
|
26358
|
-
|
|
26359
|
-
|
|
26360
|
-
"description": ""
|
|
26361
|
-
},
|
|
26362
|
-
"menuGroup": {
|
|
26363
|
-
"name": "Navigation",
|
|
26364
|
-
"description": ""
|
|
26365
|
-
},
|
|
26366
|
-
"menuLabel": {
|
|
26367
|
-
"name": "Header",
|
|
26368
|
-
"description": ""
|
|
26369
|
-
},
|
|
26370
|
-
"menuIcon": {
|
|
26371
|
-
"name": "layout-navbar",
|
|
26372
|
-
"description": ""
|
|
26373
|
-
}
|
|
28305
|
+
"events": [
|
|
28306
|
+
{
|
|
28307
|
+
"name": "value-changed",
|
|
28308
|
+
"type": {
|
|
28309
|
+
"text": "CustomEvent"
|
|
28310
|
+
},
|
|
28311
|
+
"inheritedFrom": {
|
|
28312
|
+
"name": "EspalierElementBase",
|
|
28313
|
+
"module": "dist/shared/esp-element-base.js"
|
|
28314
|
+
}
|
|
28315
|
+
}
|
|
28316
|
+
]
|
|
26374
28317
|
}
|
|
26375
28318
|
],
|
|
26376
28319
|
"exports": [
|
|
26377
28320
|
{
|
|
26378
28321
|
"kind": "js",
|
|
26379
|
-
"name": "
|
|
28322
|
+
"name": "EspalierHelpProvider",
|
|
26380
28323
|
"declaration": {
|
|
26381
|
-
"name": "
|
|
26382
|
-
"module": "dist/
|
|
28324
|
+
"name": "EspalierHelpProvider",
|
|
28325
|
+
"module": "dist/help/esp-help-provider.js"
|
|
26383
28326
|
}
|
|
26384
28327
|
},
|
|
26385
28328
|
{
|
|
26386
28329
|
"kind": "custom-element-definition",
|
|
26387
|
-
"name": "esp-
|
|
28330
|
+
"name": "esp-help-provider",
|
|
26388
28331
|
"declaration": {
|
|
26389
|
-
"name": "
|
|
26390
|
-
"module": "dist/
|
|
28332
|
+
"name": "EspalierHelpProvider",
|
|
28333
|
+
"module": "dist/help/esp-help-provider.js"
|
|
26391
28334
|
}
|
|
26392
28335
|
}
|
|
26393
28336
|
]
|
|
26394
28337
|
},
|
|
26395
28338
|
{
|
|
26396
28339
|
"kind": "javascript-module",
|
|
26397
|
-
"path": "dist/
|
|
28340
|
+
"path": "dist/help/help-document.js",
|
|
26398
28341
|
"declarations": [],
|
|
26399
|
-
"exports": [
|
|
26400
|
-
{
|
|
26401
|
-
"kind": "js",
|
|
26402
|
-
"name": "*",
|
|
26403
|
-
"declaration": {
|
|
26404
|
-
"name": "*",
|
|
26405
|
-
"module": "dist/menu/esp-menu-group.js"
|
|
26406
|
-
}
|
|
26407
|
-
}
|
|
26408
|
-
]
|
|
26409
|
-
},
|
|
26410
|
-
{
|
|
26411
|
-
"kind": "javascript-module",
|
|
26412
|
-
"path": "dist/header/esp-menu-item.js",
|
|
26413
|
-
"declarations": [],
|
|
26414
|
-
"exports": [
|
|
26415
|
-
{
|
|
26416
|
-
"kind": "js",
|
|
26417
|
-
"name": "*",
|
|
26418
|
-
"declaration": {
|
|
26419
|
-
"name": "*",
|
|
26420
|
-
"module": "dist/menu/esp-menu-item.js"
|
|
26421
|
-
}
|
|
26422
|
-
}
|
|
26423
|
-
]
|
|
26424
|
-
},
|
|
26425
|
-
{
|
|
26426
|
-
"kind": "javascript-module",
|
|
26427
|
-
"path": "dist/header/esp-menu.js",
|
|
26428
|
-
"declarations": [],
|
|
26429
|
-
"exports": [
|
|
26430
|
-
{
|
|
26431
|
-
"kind": "js",
|
|
26432
|
-
"name": "*",
|
|
26433
|
-
"declaration": {
|
|
26434
|
-
"name": "*",
|
|
26435
|
-
"module": "dist/menu/esp-menu.js"
|
|
26436
|
-
}
|
|
26437
|
-
}
|
|
26438
|
-
]
|
|
26439
|
-
},
|
|
26440
|
-
{
|
|
26441
|
-
"kind": "javascript-module",
|
|
26442
|
-
"path": "dist/header/index.js",
|
|
26443
|
-
"declarations": [],
|
|
26444
|
-
"exports": [
|
|
26445
|
-
{
|
|
26446
|
-
"kind": "js",
|
|
26447
|
-
"name": "*",
|
|
26448
|
-
"declaration": {
|
|
26449
|
-
"name": "*",
|
|
26450
|
-
"module": "dist/burger/esp-burger.js"
|
|
26451
|
-
}
|
|
26452
|
-
},
|
|
26453
|
-
{
|
|
26454
|
-
"kind": "js",
|
|
26455
|
-
"name": "*",
|
|
26456
|
-
"declaration": {
|
|
26457
|
-
"name": "*",
|
|
26458
|
-
"module": "dist/menu/index.js"
|
|
26459
|
-
}
|
|
26460
|
-
},
|
|
26461
|
-
{
|
|
26462
|
-
"kind": "js",
|
|
26463
|
-
"name": "*",
|
|
26464
|
-
"declaration": {
|
|
26465
|
-
"name": "*",
|
|
26466
|
-
"module": "dist/header/esp-header-button.js"
|
|
26467
|
-
}
|
|
26468
|
-
},
|
|
26469
|
-
{
|
|
26470
|
-
"kind": "js",
|
|
26471
|
-
"name": "*",
|
|
26472
|
-
"declaration": {
|
|
26473
|
-
"name": "*",
|
|
26474
|
-
"module": "dist/header/esp-header.js"
|
|
26475
|
-
}
|
|
26476
|
-
}
|
|
26477
|
-
]
|
|
28342
|
+
"exports": []
|
|
26478
28343
|
},
|
|
26479
28344
|
{
|
|
26480
28345
|
"kind": "javascript-module",
|
|
@@ -38199,6 +40064,14 @@
|
|
|
38199
40064
|
"description": "The width of the open flyout track (and of the `esp-flyout` overlay drawer). Defaults to `20rem`.",
|
|
38200
40065
|
"name": "--esp-page-flyout-width"
|
|
38201
40066
|
},
|
|
40067
|
+
{
|
|
40068
|
+
"description": "Width of the persistent preview panel. Defaults to `20rem`.",
|
|
40069
|
+
"name": "--esp-page-preview-width"
|
|
40070
|
+
},
|
|
40071
|
+
{
|
|
40072
|
+
"description": "Optional minimum width of the main content well while preview is reclaiming canvas/surface space. Unset by default, so preview uses spare canvas only. Set a length such as `900px` to opt into reclaim behavior.",
|
|
40073
|
+
"name": "--esp-page-preview-min-main-width"
|
|
40074
|
+
},
|
|
38202
40075
|
{
|
|
38203
40076
|
"description": "Offset reserved for fixed headers. Defaults to `var(--esp-header-height)`.",
|
|
38204
40077
|
"name": "--esp-page-fixed-header-offset"
|
|
@@ -38278,13 +40151,21 @@
|
|
|
38278
40151
|
"name": "canvas"
|
|
38279
40152
|
},
|
|
38280
40153
|
{
|
|
38281
|
-
"description": "The surface backdrop carrying the edge shadow/border.
|
|
40154
|
+
"description": "The surface backdrop carrying the edge shadow/border.",
|
|
38282
40155
|
"name": "surface"
|
|
40156
|
+
},
|
|
40157
|
+
{
|
|
40158
|
+
"description": "The persistent preview complementary landmark.",
|
|
40159
|
+
"name": "preview"
|
|
40160
|
+
},
|
|
40161
|
+
{
|
|
40162
|
+
"description": "The sticky wrapper around preview content. ```html <style> esp-page.with-background { --esp-page-background-image: url(/assets/espalier-paper-texture.png); --esp-page-background-image-opacity: .5; } </style> <esp-page class=\"docs with-background\"> <div slot=\"header\" style=\"background-color: red;\">header</div> <div slot=\"sidebar\" style=\"background-color: green;\">sidebar</div> <div slot=\"right\" style=\"background-color: purple;\">right</div> <esp-footer slot=\"footer\" brand-text=\"Espalier\"></esp-footer> <div style=\"overflow: hidden;\"> <h2>With background image</h2> </div> </esp-page> ``` Use `align` to place the surface within the page once it hits its cap, and the canvas tokens to style the gutters. A low `--esp-page-max-width` is set here only so the gutters are visible inside the narrow demo frame; the surface edge shadow is on by default. ```html <style> esp-page.align-demo { --esp-page-max-width: 520px; --esp-page-canvas-background: var(--esp-color-layer-1); } </style> <esp-page class=\"docs align-demo\" align=\"center\"> <div slot=\"header\" style=\"background-color: red;\">header</div> <div slot=\"sidebar\" style=\"background-color: green;\">sidebar</div> <div slot=\"right\" style=\"background-color: purple;\">right</div> <esp-footer slot=\"footer\" brand-text=\"Espalier\"></esp-footer> <div style=\"background-color: black; overflow: hidden;\"> content </div> </esp-page> ```",
|
|
40163
|
+
"name": "preview-content"
|
|
38283
40164
|
}
|
|
38284
40165
|
],
|
|
38285
40166
|
"slots": [
|
|
38286
40167
|
{
|
|
38287
|
-
"description": "Global navigation content (typically an `esp-header`). ```html <esp-page class=\"docs\"> <esp-header slot=\"header\"> <a href=\"#\" slot=\"brand\" class=\"nav-logo\"> <svg> <use href=\"/assets/icons.svg#taproot-logo\" /> </svg> </a> <esp-menu slot=\"menu\" mode=\"horizontal\"> <esp-menu-item label=\"Mammals\" url=\"#\"></esp-menu-item> <esp-menu-item label=\"Reptiles\" url=\"#\"></esp-menu-item> <esp-menu-item label=\"Amphibians\" url=\"#\"></esp-menu-item> </esp-menu> <esp-header-button slot=\"buttons\" icon=\"cog\" aria-label=\"Settings\"></esp-header-button> </esp-header> <esp-menu slot=\"sidebar\" mode=\"drawer\"></esp-menu> <div slot=\"right\" style=\"background-color: purple;\">right</div> <esp-footer slot=\"footer\" brand-text=\"Espalier\"></esp-footer> <div style=\"background-color: black; overflow: hidden;\"> content </div> </esp-page> ```",
|
|
40168
|
+
"description": "Global navigation content (typically an `esp-header`). ```html <esp-page class=\"docs\"> <esp-header slot=\"header\"> <a href=\"#\" slot=\"brand\" class=\"nav-logo\"> <svg> <use href=\"/assets/icons.svg#taproot-logo\" /> </svg> </a> <esp-menu slot=\"menu\" mode=\"horizontal\"> <esp-menu-item label=\"Mammals\" url=\"#\"></esp-menu-item> <esp-menu-item label=\"Reptiles\" url=\"#\"></esp-menu-item> <esp-menu-item label=\"Amphibians\" url=\"#\"></esp-menu-item> </esp-menu> <esp-header-button slot=\"buttons\" icon=\"cog\" aria-label=\"Settings\"></esp-header-button> </esp-header> <esp-menu slot=\"sidebar\" mode=\"drawer\"></esp-menu> <div slot=\"right\" style=\"background-color: purple;\">right</div> <esp-footer slot=\"footer\" brand-text=\"Espalier\"></esp-footer> <div style=\"background-color: black; overflow: hidden;\"> content </div> </esp-page> ``` A persistent preview uses spare trailing canvas first. Set a main-well floor to let it reclaim surface width, and opt into collapsing a directly paired header/sidebar navigation to its accessible burger/drawer mode: ```html <esp-page preview-open preview-collapse-sidebar style=\"--esp-page-preview-width: 20rem; --esp-page-preview-min-main-width: 900px;\" > <esp-header slot=\"header\" drawer-target=\"site-nav\"></esp-header> <esp-menu id=\"site-nav\" slot=\"sidebar\" mode=\"vertical\"></esp-menu> <article>Primary content</article> <aside slot=\"preview\">Preview content</aside> </esp-page> ```",
|
|
38288
40169
|
"name": "header"
|
|
38289
40170
|
},
|
|
38290
40171
|
{
|
|
@@ -38295,6 +40176,10 @@
|
|
|
38295
40176
|
"description": "Content to place in the right aside.",
|
|
38296
40177
|
"name": "right"
|
|
38297
40178
|
},
|
|
40179
|
+
{
|
|
40180
|
+
"description": "Persistent preview content that uses spare right canvas width first, then optionally reclaims navigation and main-well width down to `--esp-page-preview-min-main-width`. Unlike flyout content, preview content is never replaced by the flyout request bus.",
|
|
40181
|
+
"name": "preview"
|
|
40182
|
+
},
|
|
38298
40183
|
{
|
|
38299
40184
|
"description": "A transient `esp-flyout` panel that lives on the canvas, outside the content surface. Closed it costs no width; open it claims the right canvas gutter first — the surface keeps its alignment weighting and shifts only as far as the flyout's width requires — then docks as a width-competing right sidebar when no gutter exists, and becomes an overlay drawer on small viewports. The persistent `right` aside and the transient flyout are complementary, not alternatives. A flyout opened with an `anchor` aligns to that trigger and stays in the same document scroll flow.",
|
|
38300
40185
|
"name": "flyout"
|
|
@@ -38324,6 +40209,101 @@
|
|
|
38324
40209
|
"name": "footerSlot",
|
|
38325
40210
|
"privacy": "private"
|
|
38326
40211
|
},
|
|
40212
|
+
{
|
|
40213
|
+
"kind": "field",
|
|
40214
|
+
"name": "previewSlot",
|
|
40215
|
+
"privacy": "private"
|
|
40216
|
+
},
|
|
40217
|
+
{
|
|
40218
|
+
"kind": "field",
|
|
40219
|
+
"name": "previewSpace",
|
|
40220
|
+
"privacy": "private"
|
|
40221
|
+
},
|
|
40222
|
+
{
|
|
40223
|
+
"kind": "field",
|
|
40224
|
+
"name": "previewWidthProbe",
|
|
40225
|
+
"privacy": "private"
|
|
40226
|
+
},
|
|
40227
|
+
{
|
|
40228
|
+
"kind": "field",
|
|
40229
|
+
"name": "previewMainMinProbe",
|
|
40230
|
+
"privacy": "private"
|
|
40231
|
+
},
|
|
40232
|
+
{
|
|
40233
|
+
"kind": "field",
|
|
40234
|
+
"name": "previewResizeObserver",
|
|
40235
|
+
"type": {
|
|
40236
|
+
"text": "ResizeObserver | undefined"
|
|
40237
|
+
},
|
|
40238
|
+
"privacy": "private"
|
|
40239
|
+
},
|
|
40240
|
+
{
|
|
40241
|
+
"kind": "field",
|
|
40242
|
+
"name": "previewObservedWidths",
|
|
40243
|
+
"privacy": "private",
|
|
40244
|
+
"default": "new WeakMap<Element, number>()"
|
|
40245
|
+
},
|
|
40246
|
+
{
|
|
40247
|
+
"kind": "field",
|
|
40248
|
+
"name": "previewMediaQuery",
|
|
40249
|
+
"type": {
|
|
40250
|
+
"text": "MediaQueryList | undefined"
|
|
40251
|
+
},
|
|
40252
|
+
"privacy": "private"
|
|
40253
|
+
},
|
|
40254
|
+
{
|
|
40255
|
+
"kind": "field",
|
|
40256
|
+
"name": "previewSyncRaf",
|
|
40257
|
+
"type": {
|
|
40258
|
+
"text": "number | null"
|
|
40259
|
+
},
|
|
40260
|
+
"privacy": "private",
|
|
40261
|
+
"default": "null"
|
|
40262
|
+
},
|
|
40263
|
+
{
|
|
40264
|
+
"kind": "field",
|
|
40265
|
+
"name": "previewSyncGeneration",
|
|
40266
|
+
"type": {
|
|
40267
|
+
"text": "number"
|
|
40268
|
+
},
|
|
40269
|
+
"privacy": "private",
|
|
40270
|
+
"default": "0"
|
|
40271
|
+
},
|
|
40272
|
+
{
|
|
40273
|
+
"kind": "field",
|
|
40274
|
+
"name": "previewSyncTask",
|
|
40275
|
+
"type": {
|
|
40276
|
+
"text": "Promise<void>"
|
|
40277
|
+
},
|
|
40278
|
+
"privacy": "private"
|
|
40279
|
+
},
|
|
40280
|
+
{
|
|
40281
|
+
"kind": "field",
|
|
40282
|
+
"name": "previewHeader",
|
|
40283
|
+
"type": {
|
|
40284
|
+
"text": "PreviewCompactHeader | null"
|
|
40285
|
+
},
|
|
40286
|
+
"privacy": "private",
|
|
40287
|
+
"default": "null"
|
|
40288
|
+
},
|
|
40289
|
+
{
|
|
40290
|
+
"kind": "field",
|
|
40291
|
+
"name": "previewMenu",
|
|
40292
|
+
"type": {
|
|
40293
|
+
"text": "PreviewCompactMenu | null"
|
|
40294
|
+
},
|
|
40295
|
+
"privacy": "private",
|
|
40296
|
+
"default": "null"
|
|
40297
|
+
},
|
|
40298
|
+
{
|
|
40299
|
+
"kind": "field",
|
|
40300
|
+
"name": "previewCollapsedSidebarWidth",
|
|
40301
|
+
"type": {
|
|
40302
|
+
"text": "number"
|
|
40303
|
+
},
|
|
40304
|
+
"privacy": "private",
|
|
40305
|
+
"default": "0"
|
|
40306
|
+
},
|
|
38327
40307
|
{
|
|
38328
40308
|
"kind": "field",
|
|
38329
40309
|
"name": "footerWrapperIsLandmark",
|
|
@@ -38353,6 +40333,148 @@
|
|
|
38353
40333
|
],
|
|
38354
40334
|
"description": "Mirror the slotted flyout's open, overlay, and anchor state onto\nhost attributes read by the grid CSS. State is recomputed from the\nslot so multiple flyouts and slot changes stay correct."
|
|
38355
40335
|
},
|
|
40336
|
+
{
|
|
40337
|
+
"kind": "method",
|
|
40338
|
+
"name": "previewHasContent",
|
|
40339
|
+
"privacy": "private",
|
|
40340
|
+
"return": {
|
|
40341
|
+
"type": {
|
|
40342
|
+
"text": "boolean"
|
|
40343
|
+
}
|
|
40344
|
+
}
|
|
40345
|
+
},
|
|
40346
|
+
{
|
|
40347
|
+
"kind": "method",
|
|
40348
|
+
"name": "getPreviewNavigationPair",
|
|
40349
|
+
"privacy": "private",
|
|
40350
|
+
"return": {
|
|
40351
|
+
"type": {
|
|
40352
|
+
"text": "{\n header: PreviewCompactHeader;\n menu: PreviewCompactMenu;\n } | null"
|
|
40353
|
+
}
|
|
40354
|
+
}
|
|
40355
|
+
},
|
|
40356
|
+
{
|
|
40357
|
+
"kind": "method",
|
|
40358
|
+
"name": "setPreviewNavigationCollapse",
|
|
40359
|
+
"privacy": "private",
|
|
40360
|
+
"return": {
|
|
40361
|
+
"type": {
|
|
40362
|
+
"text": "Promise<boolean>"
|
|
40363
|
+
}
|
|
40364
|
+
},
|
|
40365
|
+
"parameters": [
|
|
40366
|
+
{
|
|
40367
|
+
"name": "requested",
|
|
40368
|
+
"type": {
|
|
40369
|
+
"text": "boolean"
|
|
40370
|
+
}
|
|
40371
|
+
}
|
|
40372
|
+
]
|
|
40373
|
+
},
|
|
40374
|
+
{
|
|
40375
|
+
"kind": "method",
|
|
40376
|
+
"name": "previewTokenIsConfigured",
|
|
40377
|
+
"privacy": "private",
|
|
40378
|
+
"return": {
|
|
40379
|
+
"type": {
|
|
40380
|
+
"text": "boolean"
|
|
40381
|
+
}
|
|
40382
|
+
}
|
|
40383
|
+
},
|
|
40384
|
+
{
|
|
40385
|
+
"kind": "method",
|
|
40386
|
+
"name": "setPreviewLayoutState",
|
|
40387
|
+
"privacy": "private",
|
|
40388
|
+
"return": {
|
|
40389
|
+
"type": {
|
|
40390
|
+
"text": "void"
|
|
40391
|
+
}
|
|
40392
|
+
},
|
|
40393
|
+
"parameters": [
|
|
40394
|
+
{
|
|
40395
|
+
"name": "visible",
|
|
40396
|
+
"type": {
|
|
40397
|
+
"text": "boolean"
|
|
40398
|
+
}
|
|
40399
|
+
},
|
|
40400
|
+
{
|
|
40401
|
+
"name": "reclaiming",
|
|
40402
|
+
"type": {
|
|
40403
|
+
"text": "boolean"
|
|
40404
|
+
}
|
|
40405
|
+
}
|
|
40406
|
+
]
|
|
40407
|
+
},
|
|
40408
|
+
{
|
|
40409
|
+
"kind": "method",
|
|
40410
|
+
"name": "previewFitsWithinPage",
|
|
40411
|
+
"privacy": "private",
|
|
40412
|
+
"return": {
|
|
40413
|
+
"type": {
|
|
40414
|
+
"text": "boolean"
|
|
40415
|
+
}
|
|
40416
|
+
},
|
|
40417
|
+
"parameters": [
|
|
40418
|
+
{
|
|
40419
|
+
"name": "minMainWidth",
|
|
40420
|
+
"type": {
|
|
40421
|
+
"text": "number"
|
|
40422
|
+
}
|
|
40423
|
+
},
|
|
40424
|
+
{
|
|
40425
|
+
"name": "previewWidth",
|
|
40426
|
+
"type": {
|
|
40427
|
+
"text": "number"
|
|
40428
|
+
}
|
|
40429
|
+
}
|
|
40430
|
+
]
|
|
40431
|
+
},
|
|
40432
|
+
{
|
|
40433
|
+
"kind": "method",
|
|
40434
|
+
"name": "syncPreviewLayout",
|
|
40435
|
+
"privacy": "private",
|
|
40436
|
+
"return": {
|
|
40437
|
+
"type": {
|
|
40438
|
+
"text": "Promise<void>"
|
|
40439
|
+
}
|
|
40440
|
+
},
|
|
40441
|
+
"parameters": [
|
|
40442
|
+
{
|
|
40443
|
+
"name": "generation",
|
|
40444
|
+
"type": {
|
|
40445
|
+
"text": "number"
|
|
40446
|
+
}
|
|
40447
|
+
}
|
|
40448
|
+
]
|
|
40449
|
+
},
|
|
40450
|
+
{
|
|
40451
|
+
"kind": "field",
|
|
40452
|
+
"name": "schedulePreviewLayout",
|
|
40453
|
+
"privacy": "private"
|
|
40454
|
+
},
|
|
40455
|
+
{
|
|
40456
|
+
"kind": "field",
|
|
40457
|
+
"name": "onPreviewMediaChange",
|
|
40458
|
+
"privacy": "private"
|
|
40459
|
+
},
|
|
40460
|
+
{
|
|
40461
|
+
"kind": "field",
|
|
40462
|
+
"name": "onPreviewResize",
|
|
40463
|
+
"type": {
|
|
40464
|
+
"text": "ResizeObserverCallback"
|
|
40465
|
+
},
|
|
40466
|
+
"privacy": "private"
|
|
40467
|
+
},
|
|
40468
|
+
{
|
|
40469
|
+
"kind": "method",
|
|
40470
|
+
"name": "setupPreviewLayoutObserver",
|
|
40471
|
+
"privacy": "private",
|
|
40472
|
+
"return": {
|
|
40473
|
+
"type": {
|
|
40474
|
+
"text": "void"
|
|
40475
|
+
}
|
|
40476
|
+
}
|
|
40477
|
+
},
|
|
38356
40478
|
{
|
|
38357
40479
|
"kind": "method",
|
|
38358
40480
|
"name": "footerElementProvidesLandmark",
|
|
@@ -38442,6 +40564,99 @@
|
|
|
38442
40564
|
"attribute": "fixed-menus",
|
|
38443
40565
|
"reflects": true
|
|
38444
40566
|
},
|
|
40567
|
+
{
|
|
40568
|
+
"kind": "field",
|
|
40569
|
+
"name": "previewOpen",
|
|
40570
|
+
"type": {
|
|
40571
|
+
"text": "boolean"
|
|
40572
|
+
},
|
|
40573
|
+
"privacy": "public",
|
|
40574
|
+
"default": "false",
|
|
40575
|
+
"description": "Whether the persistent preview is logically open. The page may keep the\npreview hidden while space is unavailable; `preview-visible` reflects its\nactual presentation and the preview restores automatically when room returns.",
|
|
40576
|
+
"attribute": "preview-open",
|
|
40577
|
+
"reflects": true
|
|
40578
|
+
},
|
|
40579
|
+
{
|
|
40580
|
+
"kind": "field",
|
|
40581
|
+
"name": "previewLabel",
|
|
40582
|
+
"type": {
|
|
40583
|
+
"text": "string"
|
|
40584
|
+
},
|
|
40585
|
+
"privacy": "public",
|
|
40586
|
+
"default": "\"Preview\"",
|
|
40587
|
+
"description": "Accessible name for the preview's complementary landmark.",
|
|
40588
|
+
"attribute": "preview-label",
|
|
40589
|
+
"reflects": true
|
|
40590
|
+
},
|
|
40591
|
+
{
|
|
40592
|
+
"kind": "field",
|
|
40593
|
+
"name": "previewCollapseSidebar",
|
|
40594
|
+
"type": {
|
|
40595
|
+
"text": "boolean"
|
|
40596
|
+
},
|
|
40597
|
+
"privacy": "public",
|
|
40598
|
+
"default": "false",
|
|
40599
|
+
"description": "Allow a directly slotted, safely linked vertical menu/header pair to\ncollapse to its burger/drawer presentation when preview needs more room.",
|
|
40600
|
+
"attribute": "preview-collapse-sidebar",
|
|
40601
|
+
"reflects": true
|
|
40602
|
+
},
|
|
40603
|
+
{
|
|
40604
|
+
"kind": "field",
|
|
40605
|
+
"name": "previewVisible",
|
|
40606
|
+
"type": {
|
|
40607
|
+
"text": "boolean"
|
|
40608
|
+
},
|
|
40609
|
+
"privacy": "public",
|
|
40610
|
+
"default": "false",
|
|
40611
|
+
"description": "Whether preview content is currently rendered. Managed by the page's\nspace negotiation; consumers should treat this reflected property as read-only.",
|
|
40612
|
+
"attribute": "preview-visible",
|
|
40613
|
+
"reflects": true
|
|
40614
|
+
},
|
|
40615
|
+
{
|
|
40616
|
+
"kind": "field",
|
|
40617
|
+
"name": "previewReclaiming",
|
|
40618
|
+
"type": {
|
|
40619
|
+
"text": "boolean"
|
|
40620
|
+
},
|
|
40621
|
+
"privacy": "public",
|
|
40622
|
+
"default": "false",
|
|
40623
|
+
"description": "Whether preview is currently reserving width and allowing the main well\nto shrink toward `--esp-page-preview-min-main-width`. Managed by the page.",
|
|
40624
|
+
"attribute": "preview-reclaiming",
|
|
40625
|
+
"reflects": true
|
|
40626
|
+
},
|
|
40627
|
+
{
|
|
40628
|
+
"kind": "method",
|
|
40629
|
+
"name": "showPreview",
|
|
40630
|
+
"privacy": "public",
|
|
40631
|
+
"return": {
|
|
40632
|
+
"type": {
|
|
40633
|
+
"text": "void"
|
|
40634
|
+
}
|
|
40635
|
+
},
|
|
40636
|
+
"description": "Request the persistent preview without moving focus."
|
|
40637
|
+
},
|
|
40638
|
+
{
|
|
40639
|
+
"kind": "method",
|
|
40640
|
+
"name": "closePreview",
|
|
40641
|
+
"privacy": "public",
|
|
40642
|
+
"return": {
|
|
40643
|
+
"type": {
|
|
40644
|
+
"text": "void"
|
|
40645
|
+
}
|
|
40646
|
+
},
|
|
40647
|
+
"description": "Close the persistent preview without moving focus."
|
|
40648
|
+
},
|
|
40649
|
+
{
|
|
40650
|
+
"kind": "method",
|
|
40651
|
+
"name": "togglePreview",
|
|
40652
|
+
"privacy": "public",
|
|
40653
|
+
"return": {
|
|
40654
|
+
"type": {
|
|
40655
|
+
"text": "void"
|
|
40656
|
+
}
|
|
40657
|
+
},
|
|
40658
|
+
"description": "Toggle the persistent preview without moving focus."
|
|
40659
|
+
},
|
|
38445
40660
|
{
|
|
38446
40661
|
"kind": "method",
|
|
38447
40662
|
"name": "AddDialog",
|
|
@@ -38996,6 +41211,51 @@
|
|
|
38996
41211
|
"description": "Compatibility alias for the original fixed header/sidebar behavior.\nPrefer `header-position=\"fixed\"` for new code.",
|
|
38997
41212
|
"fieldName": "fixedMenus"
|
|
38998
41213
|
},
|
|
41214
|
+
{
|
|
41215
|
+
"name": "preview-open",
|
|
41216
|
+
"type": {
|
|
41217
|
+
"text": "boolean"
|
|
41218
|
+
},
|
|
41219
|
+
"default": "false",
|
|
41220
|
+
"description": "Whether the persistent preview is logically open. The page may keep the\npreview hidden while space is unavailable; `preview-visible` reflects its\nactual presentation and the preview restores automatically when room returns.",
|
|
41221
|
+
"fieldName": "previewOpen"
|
|
41222
|
+
},
|
|
41223
|
+
{
|
|
41224
|
+
"name": "preview-label",
|
|
41225
|
+
"type": {
|
|
41226
|
+
"text": "string"
|
|
41227
|
+
},
|
|
41228
|
+
"default": "\"Preview\"",
|
|
41229
|
+
"description": "Accessible name for the preview's complementary landmark.",
|
|
41230
|
+
"fieldName": "previewLabel"
|
|
41231
|
+
},
|
|
41232
|
+
{
|
|
41233
|
+
"name": "preview-collapse-sidebar",
|
|
41234
|
+
"type": {
|
|
41235
|
+
"text": "boolean"
|
|
41236
|
+
},
|
|
41237
|
+
"default": "false",
|
|
41238
|
+
"description": "Allow a directly slotted, safely linked vertical menu/header pair to\ncollapse to its burger/drawer presentation when preview needs more room.",
|
|
41239
|
+
"fieldName": "previewCollapseSidebar"
|
|
41240
|
+
},
|
|
41241
|
+
{
|
|
41242
|
+
"name": "preview-visible",
|
|
41243
|
+
"type": {
|
|
41244
|
+
"text": "boolean"
|
|
41245
|
+
},
|
|
41246
|
+
"default": "false",
|
|
41247
|
+
"description": "Whether preview content is currently rendered. Managed by the page's\nspace negotiation; consumers should treat this reflected property as read-only.",
|
|
41248
|
+
"fieldName": "previewVisible"
|
|
41249
|
+
},
|
|
41250
|
+
{
|
|
41251
|
+
"name": "preview-reclaiming",
|
|
41252
|
+
"type": {
|
|
41253
|
+
"text": "boolean"
|
|
41254
|
+
},
|
|
41255
|
+
"default": "false",
|
|
41256
|
+
"description": "Whether preview is currently reserving width and allowing the main well\nto shrink toward `--esp-page-preview-min-main-width`. Managed by the page.",
|
|
41257
|
+
"fieldName": "previewReclaiming"
|
|
41258
|
+
},
|
|
38999
41259
|
{
|
|
39000
41260
|
"name": "scheme",
|
|
39001
41261
|
"type": {
|
|
@@ -51135,7 +53395,7 @@
|
|
|
51135
53395
|
"privacy": "public",
|
|
51136
53396
|
"return": {
|
|
51137
53397
|
"type": {
|
|
51138
|
-
"text": "
|
|
53398
|
+
"text": "number"
|
|
51139
53399
|
}
|
|
51140
53400
|
},
|
|
51141
53401
|
"parameters": [
|
|
@@ -52381,6 +54641,22 @@
|
|
|
52381
54641
|
"module": "./flyout-events.js"
|
|
52382
54642
|
}
|
|
52383
54643
|
},
|
|
54644
|
+
{
|
|
54645
|
+
"kind": "js",
|
|
54646
|
+
"name": "HelpRequest",
|
|
54647
|
+
"declaration": {
|
|
54648
|
+
"name": "HelpRequest",
|
|
54649
|
+
"module": "./help-events.js"
|
|
54650
|
+
}
|
|
54651
|
+
},
|
|
54652
|
+
{
|
|
54653
|
+
"kind": "js",
|
|
54654
|
+
"name": "HelpState",
|
|
54655
|
+
"declaration": {
|
|
54656
|
+
"name": "HelpState",
|
|
54657
|
+
"module": "./help-events.js"
|
|
54658
|
+
}
|
|
54659
|
+
},
|
|
52384
54660
|
{
|
|
52385
54661
|
"kind": "js",
|
|
52386
54662
|
"name": "PickerItem",
|
|
@@ -52469,7 +54745,7 @@
|
|
|
52469
54745
|
"description": "Flyout configuration."
|
|
52470
54746
|
}
|
|
52471
54747
|
],
|
|
52472
|
-
"description": "Open the page's flyout surface. Publishes a `\"show-flyout\"`\nevent on `EspBus` which is picked up by `<esp-flyout>`.\n\n```ts\nimport { showFlyout } from \"@taprootio/espalier\";\n\nshowFlyout({ heading: \"Details\", content: detailsFragment });\n```\n\
|
|
54748
|
+
"description": "Open the page's flyout surface. Publishes a `\"show-flyout\"`\nevent on `EspBus` which is picked up by `<esp-flyout>`.\n\n```ts\nimport { showFlyout } from \"@taprootio/espalier\";\n\nshowFlyout({ heading: \"Details\", content: detailsFragment });\n```\n\nAnchored requests target the outermost containing `esp-page` by\ndefault; a nested flyout with `scope=\"nearest\"` explicitly overrides\nthat routing. The nearest-scope flyout must be a light-DOM descendant\nof the page whose requests it owns. If no eligible `<esp-flyout>` is\nconnected, the event goes unserviced — callers that need a fallback\n(e.g. opening a URL in a new tab) should check for a connected flyout\nthemselves."
|
|
52473
54749
|
},
|
|
52474
54750
|
{
|
|
52475
54751
|
"kind": "function",
|
|
@@ -53004,6 +55280,41 @@
|
|
|
53004
55280
|
}
|
|
53005
55281
|
]
|
|
53006
55282
|
},
|
|
55283
|
+
{
|
|
55284
|
+
"kind": "javascript-module",
|
|
55285
|
+
"path": "dist/shared/help-events.js",
|
|
55286
|
+
"declarations": [
|
|
55287
|
+
{
|
|
55288
|
+
"kind": "function",
|
|
55289
|
+
"name": "requestHelp",
|
|
55290
|
+
"return": {
|
|
55291
|
+
"type": {
|
|
55292
|
+
"text": "void"
|
|
55293
|
+
}
|
|
55294
|
+
},
|
|
55295
|
+
"parameters": [
|
|
55296
|
+
{
|
|
55297
|
+
"name": "config",
|
|
55298
|
+
"type": {
|
|
55299
|
+
"text": "HelpRequest"
|
|
55300
|
+
},
|
|
55301
|
+
"description": "Help document, topic, title, and optional placement/focus targets."
|
|
55302
|
+
}
|
|
55303
|
+
],
|
|
55304
|
+
"description": "Request help through the shared provider. Relative `src` values are\nresolved against the current document; a fragment becomes `anchor`\nunless the explicit property wins. When no provider is connected,\nthe resolved topic opens in a new tab.\n\n```ts\nimport { requestHelp } from \"@taprootio/espalier\";\n\nrequestHelp({\n src: \"/help/account.html\",\n anchor: \"display-name\",\n title: \"Account help\",\n placementTarget: document.querySelector<HTMLElement>(\"#display-name\") ?? undefined,\n trigger: document.querySelector(\"#account-help\") ?? undefined,\n});\n```"
|
|
55305
|
+
}
|
|
55306
|
+
],
|
|
55307
|
+
"exports": [
|
|
55308
|
+
{
|
|
55309
|
+
"kind": "js",
|
|
55310
|
+
"name": "requestHelp",
|
|
55311
|
+
"declaration": {
|
|
55312
|
+
"name": "requestHelp",
|
|
55313
|
+
"module": "dist/shared/help-events.js"
|
|
55314
|
+
}
|
|
55315
|
+
}
|
|
55316
|
+
]
|
|
55317
|
+
},
|
|
53007
55318
|
{
|
|
53008
55319
|
"kind": "javascript-module",
|
|
53009
55320
|
"path": "dist/shared/image-texture-registry.js",
|