@fusion.dev/helix 0.165.0 → 0.166.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 +809 -5
- package/dist/code-block/root/code-block-root.css.js +2 -1
- package/dist/element-events.generated.js +15 -2
- package/dist/menu/item/menu-item.css.js +3 -0
- package/dist/menu/root/menu-root.css.js +1 -1
- package/dist/sandbox/root/sandbox-root.d.ts +26 -0
- package/dist/sandbox/root/sandbox-root.js +28 -3
- package/dist/sandbox/source/sandbox-source.d.ts +6 -0
- package/dist/sandbox/source/sandbox-source.js +9 -2
- package/lint.json +1 -1
- package/package.json +6 -6
- package/types/jsx.d.ts +260 -2
- package/types/vue.d.ts +75 -3
- package/types/words.d.ts +20 -0
package/custom-elements.json
CHANGED
|
@@ -38627,6 +38627,36 @@
|
|
|
38627
38627
|
"module": "src/code-block/root/code-block-root.ts"
|
|
38628
38628
|
}
|
|
38629
38629
|
},
|
|
38630
|
+
{
|
|
38631
|
+
"kind": "field",
|
|
38632
|
+
"name": "file",
|
|
38633
|
+
"type": {
|
|
38634
|
+
"text": "string | undefined"
|
|
38635
|
+
},
|
|
38636
|
+
"description": "The name of the file shown, where the block holds several Code Blocks:\nthe `label` of one, or its `language` without one.\n\nUnset, or a name no file has, shows the first.",
|
|
38637
|
+
"attribute": "file",
|
|
38638
|
+
"inheritedFrom": {
|
|
38639
|
+
"name": "HelixHeadlessCodeBlock",
|
|
38640
|
+
"module": "src/code-block/root/code-block-root.ts"
|
|
38641
|
+
}
|
|
38642
|
+
},
|
|
38643
|
+
{
|
|
38644
|
+
"kind": "field",
|
|
38645
|
+
"name": "filesLabel",
|
|
38646
|
+
"type": {
|
|
38647
|
+
"text": "string"
|
|
38648
|
+
},
|
|
38649
|
+
"default": "'Files'",
|
|
38650
|
+
"description": "The name of the file tabs, read by screen readers.",
|
|
38651
|
+
"attribute": "files-label",
|
|
38652
|
+
"helix": {
|
|
38653
|
+
"words": true
|
|
38654
|
+
},
|
|
38655
|
+
"inheritedFrom": {
|
|
38656
|
+
"name": "HelixHeadlessCodeBlock",
|
|
38657
|
+
"module": "src/code-block/root/code-block-root.ts"
|
|
38658
|
+
}
|
|
38659
|
+
},
|
|
38630
38660
|
{
|
|
38631
38661
|
"kind": "field",
|
|
38632
38662
|
"name": "hideUnchangedLabel",
|
|
@@ -39054,6 +39084,155 @@
|
|
|
39054
39084
|
"module": "src/code-block/root/code-block-root.ts"
|
|
39055
39085
|
}
|
|
39056
39086
|
},
|
|
39087
|
+
{
|
|
39088
|
+
"kind": "field",
|
|
39089
|
+
"name": "blocks",
|
|
39090
|
+
"type": {
|
|
39091
|
+
"text": "HelixHeadlessCodeBlock[]"
|
|
39092
|
+
},
|
|
39093
|
+
"privacy": "private",
|
|
39094
|
+
"description": "The Code Blocks this block holds as its code, once its children can be read.",
|
|
39095
|
+
"readonly": true,
|
|
39096
|
+
"inheritedFrom": {
|
|
39097
|
+
"name": "HelixHeadlessCodeBlock",
|
|
39098
|
+
"module": "src/code-block/root/code-block-root.ts"
|
|
39099
|
+
}
|
|
39100
|
+
},
|
|
39101
|
+
{
|
|
39102
|
+
"kind": "field",
|
|
39103
|
+
"name": "tabbed",
|
|
39104
|
+
"type": {
|
|
39105
|
+
"text": "boolean"
|
|
39106
|
+
},
|
|
39107
|
+
"privacy": "private",
|
|
39108
|
+
"description": "Whether the block is one of several files under another block's tabs,\nwhich name it. Read from the parent, so a block needs no telling.",
|
|
39109
|
+
"readonly": true,
|
|
39110
|
+
"inheritedFrom": {
|
|
39111
|
+
"name": "HelixHeadlessCodeBlock",
|
|
39112
|
+
"module": "src/code-block/root/code-block-root.ts"
|
|
39113
|
+
}
|
|
39114
|
+
},
|
|
39115
|
+
{
|
|
39116
|
+
"kind": "method",
|
|
39117
|
+
"name": "shownFile",
|
|
39118
|
+
"privacy": "private",
|
|
39119
|
+
"return": {
|
|
39120
|
+
"type": {
|
|
39121
|
+
"text": "HelixHeadlessCodeBlock | undefined"
|
|
39122
|
+
}
|
|
39123
|
+
},
|
|
39124
|
+
"parameters": [
|
|
39125
|
+
{
|
|
39126
|
+
"name": "blocks",
|
|
39127
|
+
"type": {
|
|
39128
|
+
"text": "HelixHeadlessCodeBlock[]"
|
|
39129
|
+
}
|
|
39130
|
+
}
|
|
39131
|
+
],
|
|
39132
|
+
"description": "The file shown among several: the one `file` names, or the first.",
|
|
39133
|
+
"inheritedFrom": {
|
|
39134
|
+
"name": "HelixHeadlessCodeBlock",
|
|
39135
|
+
"module": "src/code-block/root/code-block-root.ts"
|
|
39136
|
+
}
|
|
39137
|
+
},
|
|
39138
|
+
{
|
|
39139
|
+
"kind": "method",
|
|
39140
|
+
"name": "chooseFile",
|
|
39141
|
+
"privacy": "private",
|
|
39142
|
+
"return": {
|
|
39143
|
+
"type": {
|
|
39144
|
+
"text": "void"
|
|
39145
|
+
}
|
|
39146
|
+
},
|
|
39147
|
+
"parameters": [
|
|
39148
|
+
{
|
|
39149
|
+
"name": "block",
|
|
39150
|
+
"type": {
|
|
39151
|
+
"text": "HelixHeadlessCodeBlock"
|
|
39152
|
+
}
|
|
39153
|
+
}
|
|
39154
|
+
],
|
|
39155
|
+
"description": "Shows the file a tab names, once nobody refused.",
|
|
39156
|
+
"inheritedFrom": {
|
|
39157
|
+
"name": "HelixHeadlessCodeBlock",
|
|
39158
|
+
"module": "src/code-block/root/code-block-root.ts"
|
|
39159
|
+
}
|
|
39160
|
+
},
|
|
39161
|
+
{
|
|
39162
|
+
"kind": "field",
|
|
39163
|
+
"name": "handleFileKey",
|
|
39164
|
+
"privacy": "private",
|
|
39165
|
+
"readonly": true,
|
|
39166
|
+
"description": "Arrow keys, `Home` and `End` on the file tabs, which move to a tab and\nshow its file, as a tab list that follows focus does and as Sandbox's file\ntabs do. Left and Right swap on a right-to-left page.",
|
|
39167
|
+
"inheritedFrom": {
|
|
39168
|
+
"name": "HelixHeadlessCodeBlock",
|
|
39169
|
+
"module": "src/code-block/root/code-block-root.ts"
|
|
39170
|
+
}
|
|
39171
|
+
},
|
|
39172
|
+
{
|
|
39173
|
+
"kind": "field",
|
|
39174
|
+
"name": "hid",
|
|
39175
|
+
"privacy": "private",
|
|
39176
|
+
"readonly": true,
|
|
39177
|
+
"default": "new Set<Element>()",
|
|
39178
|
+
"description": "The blocks this element hid, to show them again.",
|
|
39179
|
+
"inheritedFrom": {
|
|
39180
|
+
"name": "HelixHeadlessCodeBlock",
|
|
39181
|
+
"module": "src/code-block/root/code-block-root.ts"
|
|
39182
|
+
}
|
|
39183
|
+
},
|
|
39184
|
+
{
|
|
39185
|
+
"kind": "field",
|
|
39186
|
+
"name": "fileCount",
|
|
39187
|
+
"type": {
|
|
39188
|
+
"text": "number"
|
|
39189
|
+
},
|
|
39190
|
+
"privacy": "private",
|
|
39191
|
+
"default": "0",
|
|
39192
|
+
"description": "How many files the block last held, so each is told when that changes.",
|
|
39193
|
+
"inheritedFrom": {
|
|
39194
|
+
"name": "HelixHeadlessCodeBlock",
|
|
39195
|
+
"module": "src/code-block/root/code-block-root.ts"
|
|
39196
|
+
}
|
|
39197
|
+
},
|
|
39198
|
+
{
|
|
39199
|
+
"kind": "method",
|
|
39200
|
+
"name": "showFile",
|
|
39201
|
+
"privacy": "private",
|
|
39202
|
+
"return": {
|
|
39203
|
+
"type": {
|
|
39204
|
+
"text": "void"
|
|
39205
|
+
}
|
|
39206
|
+
},
|
|
39207
|
+
"description": "Hides the files not shown, shows any this element hid that is now, and\ntells each file when how many there are changes, since a file draws its\nown name only while it is alone.",
|
|
39208
|
+
"inheritedFrom": {
|
|
39209
|
+
"name": "HelixHeadlessCodeBlock",
|
|
39210
|
+
"module": "src/code-block/root/code-block-root.ts"
|
|
39211
|
+
}
|
|
39212
|
+
},
|
|
39213
|
+
{
|
|
39214
|
+
"kind": "method",
|
|
39215
|
+
"name": "renderFiles",
|
|
39216
|
+
"privacy": "private",
|
|
39217
|
+
"return": {
|
|
39218
|
+
"type": {
|
|
39219
|
+
"text": "TemplateResult"
|
|
39220
|
+
}
|
|
39221
|
+
},
|
|
39222
|
+
"parameters": [
|
|
39223
|
+
{
|
|
39224
|
+
"name": "blocks",
|
|
39225
|
+
"type": {
|
|
39226
|
+
"text": "HelixHeadlessCodeBlock[]"
|
|
39227
|
+
}
|
|
39228
|
+
}
|
|
39229
|
+
],
|
|
39230
|
+
"description": "The tabs over several files, and the file shown under them. One file\ndraws no tabs, only itself.",
|
|
39231
|
+
"inheritedFrom": {
|
|
39232
|
+
"name": "HelixHeadlessCodeBlock",
|
|
39233
|
+
"module": "src/code-block/root/code-block-root.ts"
|
|
39234
|
+
}
|
|
39235
|
+
},
|
|
39057
39236
|
{
|
|
39058
39237
|
"kind": "method",
|
|
39059
39238
|
"name": "renderExpand",
|
|
@@ -39114,6 +39293,10 @@
|
|
|
39114
39293
|
"type": {
|
|
39115
39294
|
"text": "string"
|
|
39116
39295
|
}
|
|
39296
|
+
},
|
|
39297
|
+
{
|
|
39298
|
+
"name": "drawn",
|
|
39299
|
+
"default": "name"
|
|
39117
39300
|
}
|
|
39118
39301
|
],
|
|
39119
39302
|
"description": "The name with the copy button beside it, or nothing when there is no name.\n\n**The button is in the header wherever there is one**, because beside the\ncode it stands over the block and the block has to make room for it. A\ndiff cannot: its washes run to the edge, so the button stood on the hunk\nline and the line under it. In the header it is over nothing.\n\n**No name draws no header**, unless the page put a control in `actions`\nor asked for the wrap button. A bar holding the copy button alone turned a\n`Usage` section of one-line imports into a run of empty strips. The button\nthen stands beside the code, in room the block keeps for it.",
|
|
@@ -39744,6 +39927,10 @@
|
|
|
39744
39927
|
"description": "A long file capped at a height, with a button under it that shows every line and fewer again.",
|
|
39745
39928
|
"slug": "expandable"
|
|
39746
39929
|
},
|
|
39930
|
+
{
|
|
39931
|
+
"description": "Three code blocks shown as files under tabs, one at a time.",
|
|
39932
|
+
"slug": "files"
|
|
39933
|
+
},
|
|
39747
39934
|
{
|
|
39748
39935
|
"description": "A block drawn by a highlighter of your own, whose copy is still the code as written.",
|
|
39749
39936
|
"slug": "highlight"
|
|
@@ -39988,6 +40175,22 @@
|
|
|
39988
40175
|
"module": "src/code-block/root/code-block-root.ts"
|
|
39989
40176
|
}
|
|
39990
40177
|
},
|
|
40178
|
+
{
|
|
40179
|
+
"description": "One file tab, `aria-selected` while its file is shown.",
|
|
40180
|
+
"name": "file-tab",
|
|
40181
|
+
"inheritedFrom": {
|
|
40182
|
+
"name": "HelixHeadlessCodeBlock",
|
|
40183
|
+
"module": "src/code-block/root/code-block-root.ts"
|
|
40184
|
+
}
|
|
40185
|
+
},
|
|
40186
|
+
{
|
|
40187
|
+
"description": "The file tabs over the blocks a block holds, where there are several.",
|
|
40188
|
+
"name": "files",
|
|
40189
|
+
"inheritedFrom": {
|
|
40190
|
+
"name": "HelixHeadlessCodeBlock",
|
|
40191
|
+
"module": "src/code-block/root/code-block-root.ts"
|
|
40192
|
+
}
|
|
40193
|
+
},
|
|
39991
40194
|
{
|
|
39992
40195
|
"description": "In a split diff, the empty row opposite a line the other side does not have.",
|
|
39993
40196
|
"name": "filler",
|
|
@@ -40247,6 +40450,31 @@
|
|
|
40247
40450
|
"module": "src/code-block/root/code-block-root.ts"
|
|
40248
40451
|
}
|
|
40249
40452
|
},
|
|
40453
|
+
{
|
|
40454
|
+
"name": "file",
|
|
40455
|
+
"type": {
|
|
40456
|
+
"text": "string | undefined"
|
|
40457
|
+
},
|
|
40458
|
+
"description": "The name of the file shown, where the block holds several Code Blocks:\nthe `label` of one, or its `language` without one.\n\nUnset, or a name no file has, shows the first.",
|
|
40459
|
+
"fieldName": "file",
|
|
40460
|
+
"inheritedFrom": {
|
|
40461
|
+
"name": "HelixHeadlessCodeBlock",
|
|
40462
|
+
"module": "src/code-block/root/code-block-root.ts"
|
|
40463
|
+
}
|
|
40464
|
+
},
|
|
40465
|
+
{
|
|
40466
|
+
"name": "files-label",
|
|
40467
|
+
"type": {
|
|
40468
|
+
"text": "string"
|
|
40469
|
+
},
|
|
40470
|
+
"default": "'Files'",
|
|
40471
|
+
"description": "The name of the file tabs, read by screen readers.",
|
|
40472
|
+
"fieldName": "filesLabel",
|
|
40473
|
+
"inheritedFrom": {
|
|
40474
|
+
"name": "HelixHeadlessCodeBlock",
|
|
40475
|
+
"module": "src/code-block/root/code-block-root.ts"
|
|
40476
|
+
}
|
|
40477
|
+
},
|
|
40250
40478
|
{
|
|
40251
40479
|
"name": "hide-unchanged-label",
|
|
40252
40480
|
"type": {
|
|
@@ -40391,6 +40619,30 @@
|
|
|
40391
40619
|
}
|
|
40392
40620
|
],
|
|
40393
40621
|
"events": [
|
|
40622
|
+
{
|
|
40623
|
+
"type": {
|
|
40624
|
+
"text": "Event"
|
|
40625
|
+
},
|
|
40626
|
+
"description": "A file tab showed its file, whose name `file` now holds.",
|
|
40627
|
+
"name": "change",
|
|
40628
|
+
"reactProp": "onchange",
|
|
40629
|
+
"inheritedFrom": {
|
|
40630
|
+
"name": "HelixHeadlessCodeBlock",
|
|
40631
|
+
"module": "src/code-block/root/code-block-root.ts"
|
|
40632
|
+
}
|
|
40633
|
+
},
|
|
40634
|
+
{
|
|
40635
|
+
"type": {
|
|
40636
|
+
"text": "HelixBeforeChangeEvent"
|
|
40637
|
+
},
|
|
40638
|
+
"description": "A file tab is about to show its file, with the file's name in `detail.value`. Cancelable: cancel it to keep the file shown.",
|
|
40639
|
+
"name": "helix-before-change",
|
|
40640
|
+
"reactProp": "onhelix-before-change",
|
|
40641
|
+
"inheritedFrom": {
|
|
40642
|
+
"name": "HelixHeadlessCodeBlock",
|
|
40643
|
+
"module": "src/code-block/root/code-block-root.ts"
|
|
40644
|
+
}
|
|
40645
|
+
},
|
|
40394
40646
|
{
|
|
40395
40647
|
"type": {
|
|
40396
40648
|
"text": "HelixBeforeToggleEvent"
|
|
@@ -40403,6 +40655,30 @@
|
|
|
40403
40655
|
"module": "src/code-block/root/code-block-root.ts"
|
|
40404
40656
|
}
|
|
40405
40657
|
},
|
|
40658
|
+
{
|
|
40659
|
+
"type": {
|
|
40660
|
+
"text": "HelixCopyEvent"
|
|
40661
|
+
},
|
|
40662
|
+
"description": "The copy button put the code on the clipboard, with the text in `detail.value`.",
|
|
40663
|
+
"name": "helix-copy",
|
|
40664
|
+
"reactProp": "onhelix-copy",
|
|
40665
|
+
"inheritedFrom": {
|
|
40666
|
+
"name": "HelixHeadlessCodeBlock",
|
|
40667
|
+
"module": "src/code-block/root/code-block-root.ts"
|
|
40668
|
+
}
|
|
40669
|
+
},
|
|
40670
|
+
{
|
|
40671
|
+
"type": {
|
|
40672
|
+
"text": "HelixCopyErrorEvent"
|
|
40673
|
+
},
|
|
40674
|
+
"description": "A press on the copy button put nothing on the clipboard: the browser did not allow the write, or there was no code.",
|
|
40675
|
+
"name": "helix-copy-error",
|
|
40676
|
+
"reactProp": "onhelix-copy-error",
|
|
40677
|
+
"inheritedFrom": {
|
|
40678
|
+
"name": "HelixHeadlessCodeBlock",
|
|
40679
|
+
"module": "src/code-block/root/code-block-root.ts"
|
|
40680
|
+
}
|
|
40681
|
+
},
|
|
40406
40682
|
{
|
|
40407
40683
|
"type": {
|
|
40408
40684
|
"text": "HelixToggleEvent"
|
|
@@ -40425,6 +40701,14 @@
|
|
|
40425
40701
|
"module": "src/code-block/root/code-block-root.ts"
|
|
40426
40702
|
}
|
|
40427
40703
|
},
|
|
40704
|
+
{
|
|
40705
|
+
"description": "The block is one of several files under another block's tabs, which name it, so it draws no name of its own.",
|
|
40706
|
+
"name": "tabbed",
|
|
40707
|
+
"inheritedFrom": {
|
|
40708
|
+
"name": "HelixHeadlessCodeBlock",
|
|
40709
|
+
"module": "src/code-block/root/code-block-root.ts"
|
|
40710
|
+
}
|
|
40711
|
+
},
|
|
40428
40712
|
{
|
|
40429
40713
|
"description": "Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.",
|
|
40430
40714
|
"name": "settled",
|
|
@@ -83953,6 +84237,14 @@
|
|
|
83953
84237
|
"module": "src/filter-input/menu/filter-menu.ts"
|
|
83954
84238
|
}
|
|
83955
84239
|
},
|
|
84240
|
+
{
|
|
84241
|
+
"description": "The inner menu's filter field, drawn with `filterable`.",
|
|
84242
|
+
"name": "menu-search-field",
|
|
84243
|
+
"inheritedFrom": {
|
|
84244
|
+
"name": "HelixHeadlessFilterMenu",
|
|
84245
|
+
"module": "src/filter-input/menu/filter-menu.ts"
|
|
84246
|
+
}
|
|
84247
|
+
},
|
|
83956
84248
|
{
|
|
83957
84249
|
"description": "The floating panel the menu is drawn on.",
|
|
83958
84250
|
"name": "menu-surface",
|
|
@@ -130904,7 +131196,7 @@
|
|
|
130904
131196
|
"kind": "field",
|
|
130905
131197
|
"name": "describedBy",
|
|
130906
131198
|
"type": {
|
|
130907
|
-
"text": "string |
|
|
131199
|
+
"text": "string | null"
|
|
130908
131200
|
},
|
|
130909
131201
|
"privacy": "private",
|
|
130910
131202
|
"description": "What describes the row: the line under its label and the words after it.",
|
|
@@ -131138,6 +131430,20 @@
|
|
|
131138
131430
|
"module": "src/menu/item/menu-item.ts"
|
|
131139
131431
|
}
|
|
131140
131432
|
},
|
|
131433
|
+
{
|
|
131434
|
+
"kind": "field",
|
|
131435
|
+
"name": "onHost",
|
|
131436
|
+
"type": {
|
|
131437
|
+
"text": "boolean"
|
|
131438
|
+
},
|
|
131439
|
+
"privacy": "private",
|
|
131440
|
+
"description": "Whether the row says what it is from its host, for a field's `aria-activedescendant`.",
|
|
131441
|
+
"readonly": true,
|
|
131442
|
+
"inheritedFrom": {
|
|
131443
|
+
"name": "HelixHeadlessMenuItem",
|
|
131444
|
+
"module": "src/menu/item/menu-item.ts"
|
|
131445
|
+
}
|
|
131446
|
+
},
|
|
131141
131447
|
{
|
|
131142
131448
|
"kind": "method",
|
|
131143
131449
|
"name": "tag",
|
|
@@ -131794,6 +132100,14 @@
|
|
|
131794
132100
|
"module": "src/menu/item/menu-item.ts"
|
|
131795
132101
|
}
|
|
131796
132102
|
},
|
|
132103
|
+
{
|
|
132104
|
+
"description": "In a menu with `filterable`, the arrow keys or the pointer reached the row while focus stays in the filter field.",
|
|
132105
|
+
"name": "highlighted",
|
|
132106
|
+
"inheritedFrom": {
|
|
132107
|
+
"name": "HelixHeadlessMenuItem",
|
|
132108
|
+
"module": "src/menu/item/menu-item.ts"
|
|
132109
|
+
}
|
|
132110
|
+
},
|
|
131797
132111
|
{
|
|
131798
132112
|
"description": "Under `submenus=\"flyout\"`, a row in this row's submenu can be ticked or opens a submenu, so the submenu keeps its trailing column.",
|
|
131799
132113
|
"name": "submenu-mark",
|
|
@@ -132301,6 +132615,63 @@
|
|
|
132301
132615
|
"module": "src/menu/root/menu-root.ts"
|
|
132302
132616
|
}
|
|
132303
132617
|
},
|
|
132618
|
+
{
|
|
132619
|
+
"kind": "field",
|
|
132620
|
+
"name": "filter",
|
|
132621
|
+
"type": {
|
|
132622
|
+
"text": "string"
|
|
132623
|
+
},
|
|
132624
|
+
"default": "''",
|
|
132625
|
+
"description": "The text the rows are filtered by, which the filter field holds.\n\nCleared as the menu closes and as a submenu opens or closes, so each page\nstarts with every row showing.",
|
|
132626
|
+
"attribute": "filter",
|
|
132627
|
+
"inheritedFrom": {
|
|
132628
|
+
"name": "HelixHeadlessMenu",
|
|
132629
|
+
"module": "src/menu/root/menu-root.ts"
|
|
132630
|
+
}
|
|
132631
|
+
},
|
|
132632
|
+
{
|
|
132633
|
+
"kind": "field",
|
|
132634
|
+
"name": "filterable",
|
|
132635
|
+
"type": {
|
|
132636
|
+
"text": "boolean"
|
|
132637
|
+
},
|
|
132638
|
+
"default": "false",
|
|
132639
|
+
"description": "Whether the menu shows a field above its rows that narrows them as the\nreader types, with focus staying in the field.",
|
|
132640
|
+
"attribute": "filterable",
|
|
132641
|
+
"inheritedFrom": {
|
|
132642
|
+
"name": "HelixHeadlessMenu",
|
|
132643
|
+
"module": "src/menu/root/menu-root.ts"
|
|
132644
|
+
}
|
|
132645
|
+
},
|
|
132646
|
+
{
|
|
132647
|
+
"kind": "field",
|
|
132648
|
+
"name": "filterLabel",
|
|
132649
|
+
"type": {
|
|
132650
|
+
"text": "string"
|
|
132651
|
+
},
|
|
132652
|
+
"default": "'Filter'",
|
|
132653
|
+
"description": "The filter field's name and placeholder.",
|
|
132654
|
+
"attribute": "filter-label",
|
|
132655
|
+
"helix": {
|
|
132656
|
+
"words": true
|
|
132657
|
+
},
|
|
132658
|
+
"inheritedFrom": {
|
|
132659
|
+
"name": "HelixHeadlessMenu",
|
|
132660
|
+
"module": "src/menu/root/menu-root.ts"
|
|
132661
|
+
}
|
|
132662
|
+
},
|
|
132663
|
+
{
|
|
132664
|
+
"kind": "field",
|
|
132665
|
+
"name": "filterMatch",
|
|
132666
|
+
"type": {
|
|
132667
|
+
"text": "((text: string, filter: string) => boolean) | undefined | undefined"
|
|
132668
|
+
},
|
|
132669
|
+
"description": "Whether a row is kept by the filter: a function given the row's words and\nthe filter, trimmed, that returns `true` to keep it showing, as React\nAria's `Autocomplete` takes `filter`. See Listbox's `filterMatch`.\n\nAbsent, a row is kept where its words hold the filter, in any case. A\nproperty only, there being no way to write a function in markup.",
|
|
132670
|
+
"inheritedFrom": {
|
|
132671
|
+
"name": "HelixHeadlessMenu",
|
|
132672
|
+
"module": "src/menu/root/menu-root.ts"
|
|
132673
|
+
}
|
|
132674
|
+
},
|
|
132304
132675
|
{
|
|
132305
132676
|
"kind": "field",
|
|
132306
132677
|
"name": "label",
|
|
@@ -132457,6 +132828,23 @@
|
|
|
132457
132828
|
"module": "src/menu/root/menu-root.ts"
|
|
132458
132829
|
}
|
|
132459
132830
|
},
|
|
132831
|
+
{
|
|
132832
|
+
"kind": "field",
|
|
132833
|
+
"name": "noResultsText",
|
|
132834
|
+
"type": {
|
|
132835
|
+
"text": "string"
|
|
132836
|
+
},
|
|
132837
|
+
"default": "'No matches'",
|
|
132838
|
+
"description": "The text shown when the filter keeps no rows.",
|
|
132839
|
+
"attribute": "no-results-text",
|
|
132840
|
+
"helix": {
|
|
132841
|
+
"words": true
|
|
132842
|
+
},
|
|
132843
|
+
"inheritedFrom": {
|
|
132844
|
+
"name": "HelixHeadlessMenu",
|
|
132845
|
+
"module": "src/menu/root/menu-root.ts"
|
|
132846
|
+
}
|
|
132847
|
+
},
|
|
132460
132848
|
{
|
|
132461
132849
|
"kind": "field",
|
|
132462
132850
|
"name": "offset",
|
|
@@ -132581,7 +132969,7 @@
|
|
|
132581
132969
|
"name": "aria",
|
|
132582
132970
|
"privacy": "protected",
|
|
132583
132971
|
"readonly": true,
|
|
132584
|
-
"default": "new AriaForwardController(this, { label: true, target: () => this.
|
|
132972
|
+
"default": "new AriaForwardController(this, { label: true, target: () => this.menuBox, })",
|
|
132585
132973
|
"description": "Carries a host `aria-label` and `aria-labelledby` to the surface.",
|
|
132586
132974
|
"inheritedFrom": {
|
|
132587
132975
|
"name": "HelixHeadlessMenu",
|
|
@@ -132695,6 +133083,190 @@
|
|
|
132695
133083
|
"module": "src/menu/root/menu-root.ts"
|
|
132696
133084
|
}
|
|
132697
133085
|
},
|
|
133086
|
+
{
|
|
133087
|
+
"kind": "field",
|
|
133088
|
+
"name": "menuBox",
|
|
133089
|
+
"type": {
|
|
133090
|
+
"text": "HTMLElement | null"
|
|
133091
|
+
},
|
|
133092
|
+
"privacy": "private",
|
|
133093
|
+
"description": "The element that is the `menu`: the surface, or with `filterable` the box after the field.",
|
|
133094
|
+
"readonly": true,
|
|
133095
|
+
"inheritedFrom": {
|
|
133096
|
+
"name": "HelixHeadlessMenu",
|
|
133097
|
+
"module": "src/menu/root/menu-root.ts"
|
|
133098
|
+
}
|
|
133099
|
+
},
|
|
133100
|
+
{
|
|
133101
|
+
"kind": "field",
|
|
133102
|
+
"name": "field",
|
|
133103
|
+
"type": {
|
|
133104
|
+
"text": "HTMLInputElement | null"
|
|
133105
|
+
},
|
|
133106
|
+
"privacy": "private",
|
|
133107
|
+
"description": "The filter field, with `filterable`.",
|
|
133108
|
+
"readonly": true,
|
|
133109
|
+
"inheritedFrom": {
|
|
133110
|
+
"name": "HelixHeadlessMenu",
|
|
133111
|
+
"module": "src/menu/root/menu-root.ts"
|
|
133112
|
+
}
|
|
133113
|
+
},
|
|
133114
|
+
{
|
|
133115
|
+
"kind": "field",
|
|
133116
|
+
"name": "filterPage",
|
|
133117
|
+
"type": {
|
|
133118
|
+
"text": "HelixHeadlessMenuItem | null"
|
|
133119
|
+
},
|
|
133120
|
+
"privacy": "private",
|
|
133121
|
+
"default": "null",
|
|
133122
|
+
"description": "The submenu the filter narrows, or null for the top page.",
|
|
133123
|
+
"inheritedFrom": {
|
|
133124
|
+
"name": "HelixHeadlessMenu",
|
|
133125
|
+
"module": "src/menu/root/menu-root.ts"
|
|
133126
|
+
}
|
|
133127
|
+
},
|
|
133128
|
+
{
|
|
133129
|
+
"kind": "field",
|
|
133130
|
+
"name": "refused",
|
|
133131
|
+
"type": {
|
|
133132
|
+
"text": "string | undefined"
|
|
133133
|
+
},
|
|
133134
|
+
"privacy": "private",
|
|
133135
|
+
"description": "The filter a listener refused, which narrows nothing.",
|
|
133136
|
+
"inheritedFrom": {
|
|
133137
|
+
"name": "HelixHeadlessMenu",
|
|
133138
|
+
"module": "src/menu/root/menu-root.ts"
|
|
133139
|
+
}
|
|
133140
|
+
},
|
|
133141
|
+
{
|
|
133142
|
+
"kind": "field",
|
|
133143
|
+
"name": "filtering",
|
|
133144
|
+
"type": {
|
|
133145
|
+
"text": "boolean"
|
|
133146
|
+
},
|
|
133147
|
+
"privacy": "private",
|
|
133148
|
+
"description": "Whether the filter is narrowing the rows.",
|
|
133149
|
+
"readonly": true,
|
|
133150
|
+
"inheritedFrom": {
|
|
133151
|
+
"name": "HelixHeadlessMenu",
|
|
133152
|
+
"module": "src/menu/root/menu-root.ts"
|
|
133153
|
+
}
|
|
133154
|
+
},
|
|
133155
|
+
{
|
|
133156
|
+
"kind": "method",
|
|
133157
|
+
"name": "kept",
|
|
133158
|
+
"privacy": "private",
|
|
133159
|
+
"return": {
|
|
133160
|
+
"type": {
|
|
133161
|
+
"text": "boolean"
|
|
133162
|
+
}
|
|
133163
|
+
},
|
|
133164
|
+
"parameters": [
|
|
133165
|
+
{
|
|
133166
|
+
"name": "row",
|
|
133167
|
+
"type": {
|
|
133168
|
+
"text": "HelixHeadlessMenuItem"
|
|
133169
|
+
}
|
|
133170
|
+
}
|
|
133171
|
+
],
|
|
133172
|
+
"description": "Whether the filter keeps a row: one of another page, or one whose words it matches.",
|
|
133173
|
+
"inheritedFrom": {
|
|
133174
|
+
"name": "HelixHeadlessMenu",
|
|
133175
|
+
"module": "src/menu/root/menu-root.ts"
|
|
133176
|
+
}
|
|
133177
|
+
},
|
|
133178
|
+
{
|
|
133179
|
+
"kind": "method",
|
|
133180
|
+
"name": "requestFilter",
|
|
133181
|
+
"privacy": "private",
|
|
133182
|
+
"return": {
|
|
133183
|
+
"type": {
|
|
133184
|
+
"text": "void"
|
|
133185
|
+
}
|
|
133186
|
+
},
|
|
133187
|
+
"parameters": [
|
|
133188
|
+
{
|
|
133189
|
+
"name": "value",
|
|
133190
|
+
"type": {
|
|
133191
|
+
"text": "string"
|
|
133192
|
+
}
|
|
133193
|
+
}
|
|
133194
|
+
],
|
|
133195
|
+
"description": "Asks to filter by new text, which the field and `filter` then hold. A\nrefusal keeps every row showing, for a page that narrows them itself.",
|
|
133196
|
+
"inheritedFrom": {
|
|
133197
|
+
"name": "HelixHeadlessMenu",
|
|
133198
|
+
"module": "src/menu/root/menu-root.ts"
|
|
133199
|
+
}
|
|
133200
|
+
},
|
|
133201
|
+
{
|
|
133202
|
+
"kind": "field",
|
|
133203
|
+
"name": "handleFilterInput",
|
|
133204
|
+
"privacy": "private",
|
|
133205
|
+
"readonly": true,
|
|
133206
|
+
"inheritedFrom": {
|
|
133207
|
+
"name": "HelixHeadlessMenu",
|
|
133208
|
+
"module": "src/menu/root/menu-root.ts"
|
|
133209
|
+
}
|
|
133210
|
+
},
|
|
133211
|
+
{
|
|
133212
|
+
"kind": "method",
|
|
133213
|
+
"name": "filterBy",
|
|
133214
|
+
"privacy": "private",
|
|
133215
|
+
"return": {
|
|
133216
|
+
"type": {
|
|
133217
|
+
"text": "void"
|
|
133218
|
+
}
|
|
133219
|
+
},
|
|
133220
|
+
"parameters": [
|
|
133221
|
+
{
|
|
133222
|
+
"name": "value",
|
|
133223
|
+
"type": {
|
|
133224
|
+
"text": "string"
|
|
133225
|
+
}
|
|
133226
|
+
}
|
|
133227
|
+
],
|
|
133228
|
+
"description": "Filters by what the reader typed, and highlights the first row kept.",
|
|
133229
|
+
"inheritedFrom": {
|
|
133230
|
+
"name": "HelixHeadlessMenu",
|
|
133231
|
+
"module": "src/menu/root/menu-root.ts"
|
|
133232
|
+
}
|
|
133233
|
+
},
|
|
133234
|
+
{
|
|
133235
|
+
"kind": "field",
|
|
133236
|
+
"name": "highlighted",
|
|
133237
|
+
"type": {
|
|
133238
|
+
"text": "HelixHeadlessMenuItem | undefined"
|
|
133239
|
+
},
|
|
133240
|
+
"privacy": "private",
|
|
133241
|
+
"description": "The row the keys reached while focus stays in the filter field.",
|
|
133242
|
+
"inheritedFrom": {
|
|
133243
|
+
"name": "HelixHeadlessMenu",
|
|
133244
|
+
"module": "src/menu/root/menu-root.ts"
|
|
133245
|
+
}
|
|
133246
|
+
},
|
|
133247
|
+
{
|
|
133248
|
+
"kind": "method",
|
|
133249
|
+
"name": "reach",
|
|
133250
|
+
"privacy": "private",
|
|
133251
|
+
"return": {
|
|
133252
|
+
"type": {
|
|
133253
|
+
"text": "void"
|
|
133254
|
+
}
|
|
133255
|
+
},
|
|
133256
|
+
"parameters": [
|
|
133257
|
+
{
|
|
133258
|
+
"name": "row",
|
|
133259
|
+
"type": {
|
|
133260
|
+
"text": "HelixHeadlessMenuItem | undefined"
|
|
133261
|
+
}
|
|
133262
|
+
}
|
|
133263
|
+
],
|
|
133264
|
+
"description": "Moves the reader to a row: focus, or with `filterable` the highlight,\nwhich the field names with `aria-activedescendant`. An element reference,\nbecause the field is in this shadow root and the row in the tree around\nit, the one direction a reference crosses.",
|
|
133265
|
+
"inheritedFrom": {
|
|
133266
|
+
"name": "HelixHeadlessMenu",
|
|
133267
|
+
"module": "src/menu/root/menu-root.ts"
|
|
133268
|
+
}
|
|
133269
|
+
},
|
|
132698
133270
|
{
|
|
132699
133271
|
"kind": "method",
|
|
132700
133272
|
"name": "show",
|
|
@@ -132845,6 +133417,29 @@
|
|
|
132845
133417
|
"module": "src/menu/root/menu-root.ts"
|
|
132846
133418
|
}
|
|
132847
133419
|
},
|
|
133420
|
+
{
|
|
133421
|
+
"kind": "method",
|
|
133422
|
+
"name": "revealRow",
|
|
133423
|
+
"privacy": "private",
|
|
133424
|
+
"return": {
|
|
133425
|
+
"type": {
|
|
133426
|
+
"text": "void"
|
|
133427
|
+
}
|
|
133428
|
+
},
|
|
133429
|
+
"parameters": [
|
|
133430
|
+
{
|
|
133431
|
+
"name": "item",
|
|
133432
|
+
"type": {
|
|
133433
|
+
"text": "HelixHeadlessMenuItem"
|
|
133434
|
+
}
|
|
133435
|
+
}
|
|
133436
|
+
],
|
|
133437
|
+
"description": "Scrolls the panel that holds a row to show it.",
|
|
133438
|
+
"inheritedFrom": {
|
|
133439
|
+
"name": "HelixHeadlessMenu",
|
|
133440
|
+
"module": "src/menu/root/menu-root.ts"
|
|
133441
|
+
}
|
|
133442
|
+
},
|
|
132848
133443
|
{
|
|
132849
133444
|
"kind": "field",
|
|
132850
133445
|
"name": "handleKeydown",
|
|
@@ -132922,6 +133517,17 @@
|
|
|
132922
133517
|
"module": "src/menu/root/menu-root.ts"
|
|
132923
133518
|
}
|
|
132924
133519
|
},
|
|
133520
|
+
{
|
|
133521
|
+
"kind": "field",
|
|
133522
|
+
"name": "handleMouseDown",
|
|
133523
|
+
"privacy": "private",
|
|
133524
|
+
"readonly": true,
|
|
133525
|
+
"description": "Keeps focus in the filter field through a press on a row or the way\nback, as React Aria's virtual focus does: the press still chooses.",
|
|
133526
|
+
"inheritedFrom": {
|
|
133527
|
+
"name": "HelixHeadlessMenu",
|
|
133528
|
+
"module": "src/menu/root/menu-root.ts"
|
|
133529
|
+
}
|
|
133530
|
+
},
|
|
132925
133531
|
{
|
|
132926
133532
|
"kind": "field",
|
|
132927
133533
|
"name": "handlePointerMove",
|
|
@@ -133538,6 +134144,10 @@
|
|
|
133538
134144
|
"min": 300,
|
|
133539
134145
|
"slug": "events"
|
|
133540
134146
|
},
|
|
134147
|
+
{
|
|
134148
|
+
"description": "A menu with a filter field, which narrows its rows and its submenu's rows as you type.",
|
|
134149
|
+
"slug": "filter"
|
|
134150
|
+
},
|
|
133541
134151
|
{
|
|
133542
134152
|
"description": "A menu whose submenus open in a panel beside their rows.",
|
|
133543
134153
|
"min": 300,
|
|
@@ -133669,6 +134279,45 @@
|
|
|
133669
134279
|
"module": "src/menu/root/menu-root.ts"
|
|
133670
134280
|
}
|
|
133671
134281
|
},
|
|
134282
|
+
{
|
|
134283
|
+
"name": "filter",
|
|
134284
|
+
"type": {
|
|
134285
|
+
"text": "string"
|
|
134286
|
+
},
|
|
134287
|
+
"default": "''",
|
|
134288
|
+
"description": "The text the rows are filtered by, which the filter field holds.\n\nCleared as the menu closes and as a submenu opens or closes, so each page\nstarts with every row showing.",
|
|
134289
|
+
"fieldName": "filter",
|
|
134290
|
+
"inheritedFrom": {
|
|
134291
|
+
"name": "HelixHeadlessMenu",
|
|
134292
|
+
"module": "src/menu/root/menu-root.ts"
|
|
134293
|
+
}
|
|
134294
|
+
},
|
|
134295
|
+
{
|
|
134296
|
+
"name": "filterable",
|
|
134297
|
+
"type": {
|
|
134298
|
+
"text": "boolean"
|
|
134299
|
+
},
|
|
134300
|
+
"default": "false",
|
|
134301
|
+
"description": "Whether the menu shows a field above its rows that narrows them as the\nreader types, with focus staying in the field.",
|
|
134302
|
+
"fieldName": "filterable",
|
|
134303
|
+
"inheritedFrom": {
|
|
134304
|
+
"name": "HelixHeadlessMenu",
|
|
134305
|
+
"module": "src/menu/root/menu-root.ts"
|
|
134306
|
+
}
|
|
134307
|
+
},
|
|
134308
|
+
{
|
|
134309
|
+
"name": "filter-label",
|
|
134310
|
+
"type": {
|
|
134311
|
+
"text": "string"
|
|
134312
|
+
},
|
|
134313
|
+
"default": "'Filter'",
|
|
134314
|
+
"description": "The filter field's name and placeholder.",
|
|
134315
|
+
"fieldName": "filterLabel",
|
|
134316
|
+
"inheritedFrom": {
|
|
134317
|
+
"name": "HelixHeadlessMenu",
|
|
134318
|
+
"module": "src/menu/root/menu-root.ts"
|
|
134319
|
+
}
|
|
134320
|
+
},
|
|
133672
134321
|
{
|
|
133673
134322
|
"name": "label",
|
|
133674
134323
|
"type": {
|
|
@@ -133695,6 +134344,19 @@
|
|
|
133695
134344
|
"module": "src/menu/root/menu-root.ts"
|
|
133696
134345
|
}
|
|
133697
134346
|
},
|
|
134347
|
+
{
|
|
134348
|
+
"name": "no-results-text",
|
|
134349
|
+
"type": {
|
|
134350
|
+
"text": "string"
|
|
134351
|
+
},
|
|
134352
|
+
"default": "'No matches'",
|
|
134353
|
+
"description": "The text shown when the filter keeps no rows.",
|
|
134354
|
+
"fieldName": "noResultsText",
|
|
134355
|
+
"inheritedFrom": {
|
|
134356
|
+
"name": "HelixHeadlessMenu",
|
|
134357
|
+
"module": "src/menu/root/menu-root.ts"
|
|
134358
|
+
}
|
|
134359
|
+
},
|
|
133698
134360
|
{
|
|
133699
134361
|
"name": "offset",
|
|
133700
134362
|
"type": {
|
|
@@ -133785,6 +134447,18 @@
|
|
|
133785
134447
|
"module": "src/menu/root/menu-root.ts"
|
|
133786
134448
|
}
|
|
133787
134449
|
},
|
|
134450
|
+
{
|
|
134451
|
+
"type": {
|
|
134452
|
+
"text": "HelixFilterEvent"
|
|
134453
|
+
},
|
|
134454
|
+
"description": "The text in the filter field changed, with the new text in `detail.value`. Cancelable: cancel it to keep every row showing and narrow the rows yourself.",
|
|
134455
|
+
"name": "helix-filter",
|
|
134456
|
+
"reactProp": "onhelix-filter",
|
|
134457
|
+
"inheritedFrom": {
|
|
134458
|
+
"name": "HelixHeadlessMenu",
|
|
134459
|
+
"module": "src/menu/root/menu-root.ts"
|
|
134460
|
+
}
|
|
134461
|
+
},
|
|
133788
134462
|
{
|
|
133789
134463
|
"type": {
|
|
133790
134464
|
"text": "HelixSelectEvent"
|
|
@@ -133807,6 +134481,14 @@
|
|
|
133807
134481
|
"module": "src/menu/root/menu-root.ts"
|
|
133808
134482
|
}
|
|
133809
134483
|
},
|
|
134484
|
+
{
|
|
134485
|
+
"description": "What the menu shows when the filter keeps no rows, for content richer than `no-results-text`.",
|
|
134486
|
+
"name": "no-results",
|
|
134487
|
+
"inheritedFrom": {
|
|
134488
|
+
"name": "HelixHeadlessMenu",
|
|
134489
|
+
"module": "src/menu/root/menu-root.ts"
|
|
134490
|
+
}
|
|
134491
|
+
},
|
|
133810
134492
|
{
|
|
133811
134493
|
"description": "The control that opens the menu, or with `context` the area a context menu opens over.",
|
|
133812
134494
|
"name": "trigger",
|
|
@@ -133866,7 +134548,15 @@
|
|
|
133866
134548
|
}
|
|
133867
134549
|
},
|
|
133868
134550
|
{
|
|
133869
|
-
"description": "
|
|
134551
|
+
"description": "With `filterable`, the field that narrows the rows.",
|
|
134552
|
+
"name": "search-field",
|
|
134553
|
+
"inheritedFrom": {
|
|
134554
|
+
"name": "HelixHeadlessMenu",
|
|
134555
|
+
"module": "src/menu/root/menu-root.ts"
|
|
134556
|
+
}
|
|
134557
|
+
},
|
|
134558
|
+
{
|
|
134559
|
+
"description": "The floating panel the menu is drawn on. It is the `menu` itself, and with `filterable` it holds the filter field and then the `menu`.",
|
|
133870
134560
|
"name": "surface",
|
|
133871
134561
|
"inheritedFrom": {
|
|
133872
134562
|
"name": "HelixHeadlessMenu",
|
|
@@ -144244,6 +144934,32 @@
|
|
|
144244
144934
|
"module": "src/object-inspector/root/object-inspector-root.ts"
|
|
144245
144935
|
}
|
|
144246
144936
|
},
|
|
144937
|
+
{
|
|
144938
|
+
"kind": "method",
|
|
144939
|
+
"name": "focus",
|
|
144940
|
+
"return": {
|
|
144941
|
+
"type": {
|
|
144942
|
+
"text": "void"
|
|
144943
|
+
}
|
|
144944
|
+
},
|
|
144945
|
+
"parameters": [
|
|
144946
|
+
{
|
|
144947
|
+
"name": "options",
|
|
144948
|
+
"optional": true,
|
|
144949
|
+
"type": {
|
|
144950
|
+
"text": "FocusOptions"
|
|
144951
|
+
}
|
|
144952
|
+
}
|
|
144953
|
+
],
|
|
144954
|
+
"description": "Moves focus to the row the keys move from, or to the tree while that row\nis scrolled out of the window, as Tab reaches them.",
|
|
144955
|
+
"type": {
|
|
144956
|
+
"text": "focus(options?: FocusOptions) => void"
|
|
144957
|
+
},
|
|
144958
|
+
"inheritedFrom": {
|
|
144959
|
+
"name": "HelixHeadlessObjectInspector",
|
|
144960
|
+
"module": "src/object-inspector/root/object-inspector-root.ts"
|
|
144961
|
+
}
|
|
144962
|
+
},
|
|
144247
144963
|
{
|
|
144248
144964
|
"kind": "method",
|
|
144249
144965
|
"name": "focusActive",
|
|
@@ -166861,7 +167577,7 @@
|
|
|
166861
167577
|
"declarations": [
|
|
166862
167578
|
{
|
|
166863
167579
|
"kind": "class",
|
|
166864
|
-
"description": "A source pane dispatches `helix-before-edit`, which bubbles, and the sandbox\npasses the value to the preview slotted into it. The source pane and the\npreview do not reference each other, so you can replace either one or use it\nalone.\n\nThe event carries the pane's `name`, so one sandbox can hold several panes.\n`html` sets the preview's markup, `css` sets its stylesheet, and `js` sets\na script that runs as a module after the markup. The sandbox ignores a pane\nwith any other name, so that pane can show content without changing the\npreview.\n\n**The dividers are two nested `helix-splitter` elements**, which handle the\npointer, the keyboard, and the corner. The inner splitter holds the panes and\nthe outer one holds the panel, so the panel spans the full width.\n\n**Several source panes are files**, one shown at a time under a row of\ntabs, each named by the pane's `label` or, without one, its `name`. `file`\nholds the `name` of the pane shown. The tabs are a tab list: the arrow keys\nmove between them and show each pane, and `Home` and `End` go to the first\nand the last. Choosing one sends `helix-before-change` with the pane's\n`name`, which you can cancel, and `change` once `file` holds it. The panes\nnot shown carry `hidden`. One pane draws no tabs.\n\n**Any editor can be the source pane**: an element in the `source` slot with\na `name` that dispatches `helix-before-edit` with its text, which bubbles.\nA wrapper around CodeMirror or Monaco sends one on each change and is a pane\nlike `helix-sandbox-source`, and the sandbox reads its `value` to seed the\npreview. Dispatch `helix-caret` from it too for the status bar's position.\n\nOn a focused divider, the arrow keys move it, and `Home` and `End` move it\nto its ends. `Enter` on the panes divider shuts the lead pane, and pressed\nagain it opens the pane where it was. `Enter` on the panel divider shuts the\npanel to `panel-collapsed-size`, and pressed again it opens the panel to its\nlast height.",
|
|
167580
|
+
"description": "A source pane dispatches `helix-before-edit`, which bubbles, and the sandbox\npasses the value to the preview slotted into it. The source pane and the\npreview do not reference each other, so you can replace either one or use it\nalone.\n\nThe preview runs an edit once typing has rested for `preview-delay`, 300\nmilliseconds by default, so a word typed reloads it once. A pane's text when the sandbox starts reaches it at once.\n\nThe event carries the pane's `name`, so one sandbox can hold several panes.\n`html` sets the preview's markup, `css` sets its stylesheet, and `js` sets\na script that runs as a module after the markup. The sandbox ignores a pane\nwith any other name, so that pane can show content without changing the\npreview.\n\n**The dividers are two nested `helix-splitter` elements**, which handle the\npointer, the keyboard, and the corner. The inner splitter holds the panes and\nthe outer one holds the panel, so the panel spans the full width.\n\n**Several source panes are files**, one shown at a time under a row of\ntabs, each named by the pane's `label` or, without one, its `name`. `file`\nholds the `name` of the pane shown. The tabs are a tab list: the arrow keys\nmove between them and show each pane, and `Home` and `End` go to the first\nand the last. Choosing one sends `helix-before-change` with the pane's\n`name`, which you can cancel, and `change` once `file` holds it. The panes\nnot shown carry `hidden`. One pane draws no tabs.\n\n**Any editor can be the source pane**: an element in the `source` slot with\na `name` that dispatches `helix-before-edit` with its text, which bubbles.\nA wrapper around CodeMirror or Monaco sends one on each change and is a pane\nlike `helix-sandbox-source`, and the sandbox reads its `value` to seed the\npreview. Dispatch `helix-caret` from it too for the status bar's position.\n\nSandbox is styled only and has behavior, as `Aura` is. Its behavior is the\nhand-off from a source pane to a preview frame, which works with any pane\nthat sends `helix-before-edit`, and what it draws is the layout around them:\ndividers, file tabs, and a panel. A page that wants another look slots its\nown panes and keeps the hand-off, so there is nothing for a headless version\nto hold.\n\nA development build warns about a source pane with no `label` and no `name`,\nwhose file tab would have no words.\n\nOn a focused divider, the arrow keys move it, and `Home` and `End` move it\nto its ends. `Enter` on the panes divider shuts the lead pane, and pressed\nagain it opens the pane where it was. `Enter` on the panel divider shuts the\npanel to `panel-collapsed-size`, and pressed again it opens the panel to its\nlast height.",
|
|
166865
167581
|
"name": "HelixSandbox",
|
|
166866
167582
|
"cssProperties": [
|
|
166867
167583
|
{
|
|
@@ -167051,6 +167767,39 @@
|
|
|
167051
167767
|
"text": "number"
|
|
167052
167768
|
}
|
|
167053
167769
|
},
|
|
167770
|
+
{
|
|
167771
|
+
"kind": "field",
|
|
167772
|
+
"name": "previewDelay",
|
|
167773
|
+
"type": {
|
|
167774
|
+
"text": "number"
|
|
167775
|
+
},
|
|
167776
|
+
"default": "300",
|
|
167777
|
+
"description": "How long typing rests before the preview runs the new source, in\nmilliseconds, as Sandpack's `recompileDelay` does. The preview reloads its\nframe on each run, so a word typed runs it once. `0` runs it on every\nedit.",
|
|
167778
|
+
"attribute": "preview-delay"
|
|
167779
|
+
},
|
|
167780
|
+
{
|
|
167781
|
+
"kind": "field",
|
|
167782
|
+
"name": "edits",
|
|
167783
|
+
"privacy": "private",
|
|
167784
|
+
"readonly": true,
|
|
167785
|
+
"default": "new Map<PaneName, string>()",
|
|
167786
|
+
"description": "The edits waiting out `previewDelay`, the last text of each pane."
|
|
167787
|
+
},
|
|
167788
|
+
{
|
|
167789
|
+
"kind": "field",
|
|
167790
|
+
"name": "resting",
|
|
167791
|
+
"privacy": "private",
|
|
167792
|
+
"readonly": true,
|
|
167793
|
+
"default": "new DelayController(this, { renders: false })",
|
|
167794
|
+
"description": "The wait before the edits reach the previews."
|
|
167795
|
+
},
|
|
167796
|
+
{
|
|
167797
|
+
"kind": "field",
|
|
167798
|
+
"name": "runEdits",
|
|
167799
|
+
"privacy": "private",
|
|
167800
|
+
"readonly": true,
|
|
167801
|
+
"description": "Hands the waiting edits to the previews."
|
|
167802
|
+
},
|
|
167054
167803
|
{
|
|
167055
167804
|
"kind": "field",
|
|
167056
167805
|
"name": "separatorLabel",
|
|
@@ -168105,6 +168854,15 @@
|
|
|
168105
168854
|
"description": "Height of the panel, in pixels.",
|
|
168106
168855
|
"fieldName": "panelSize"
|
|
168107
168856
|
},
|
|
168857
|
+
{
|
|
168858
|
+
"name": "preview-delay",
|
|
168859
|
+
"type": {
|
|
168860
|
+
"text": "number"
|
|
168861
|
+
},
|
|
168862
|
+
"default": "300",
|
|
168863
|
+
"description": "How long typing rests before the preview runs the new source, in\nmilliseconds, as Sandpack's `recompileDelay` does. The preview reloads its\nframe on each run, so a word typed runs it once. `0` runs it on every\nedit.",
|
|
168864
|
+
"fieldName": "previewDelay"
|
|
168865
|
+
},
|
|
168108
168866
|
{
|
|
168109
168867
|
"name": "separator-label",
|
|
168110
168868
|
"type": {
|
|
@@ -168327,6 +169085,19 @@
|
|
|
168327
169085
|
"words": true
|
|
168328
169086
|
}
|
|
168329
169087
|
},
|
|
169088
|
+
{
|
|
169089
|
+
"kind": "field",
|
|
169090
|
+
"name": "fieldNameLabel",
|
|
169091
|
+
"type": {
|
|
169092
|
+
"text": "string"
|
|
169093
|
+
},
|
|
169094
|
+
"default": "'{field}, {name}'",
|
|
169095
|
+
"description": "The editable region's name where the pane has a `label`, so each file's\nfield says which file it holds. `{field}` is `field-label` and `{name}`\nthe pane's `label`.",
|
|
169096
|
+
"attribute": "field-name-label",
|
|
169097
|
+
"helix": {
|
|
169098
|
+
"words": true
|
|
169099
|
+
}
|
|
169100
|
+
},
|
|
168330
169101
|
{
|
|
168331
169102
|
"kind": "field",
|
|
168332
169103
|
"name": "keysDescription",
|
|
@@ -168849,6 +169620,15 @@
|
|
|
168849
169620
|
"description": "The editable region's name, read by screen readers.",
|
|
168850
169621
|
"fieldName": "fieldLabel"
|
|
168851
169622
|
},
|
|
169623
|
+
{
|
|
169624
|
+
"name": "field-name-label",
|
|
169625
|
+
"type": {
|
|
169626
|
+
"text": "string"
|
|
169627
|
+
},
|
|
169628
|
+
"default": "'{field}, {name}'",
|
|
169629
|
+
"description": "The editable region's name where the pane has a `label`, so each file's\nfield says which file it holds. `{field}` is `field-label` and `{name}`\nthe pane's `label`.",
|
|
169630
|
+
"fieldName": "fieldNameLabel"
|
|
169631
|
+
},
|
|
168852
169632
|
{
|
|
168853
169633
|
"name": "keys-description",
|
|
168854
169634
|
"type": {
|
|
@@ -235000,6 +235780,14 @@
|
|
|
235000
235780
|
"module": "src/video-playlist/menu/video-playlist-menu.ts"
|
|
235001
235781
|
}
|
|
235002
235782
|
},
|
|
235783
|
+
{
|
|
235784
|
+
"description": "The inner menu's filter field, drawn with `filterable`.",
|
|
235785
|
+
"name": "menu-search-field",
|
|
235786
|
+
"inheritedFrom": {
|
|
235787
|
+
"name": "HelixHeadlessVideoPlaylistMenu",
|
|
235788
|
+
"module": "src/video-playlist/menu/video-playlist-menu.ts"
|
|
235789
|
+
}
|
|
235790
|
+
},
|
|
235003
235791
|
{
|
|
235004
235792
|
"description": "The floating panel the menu is drawn on.",
|
|
235005
235793
|
"name": "menu-surface",
|
|
@@ -239958,6 +240746,14 @@
|
|
|
239958
240746
|
"module": "src/video/root/video-root.ts"
|
|
239959
240747
|
}
|
|
239960
240748
|
},
|
|
240749
|
+
{
|
|
240750
|
+
"description": "The inner menu's filter field, drawn with `filterable`.",
|
|
240751
|
+
"name": "captions-menu-search-field",
|
|
240752
|
+
"inheritedFrom": {
|
|
240753
|
+
"name": "HelixHeadlessVideo",
|
|
240754
|
+
"module": "src/video/root/video-root.ts"
|
|
240755
|
+
}
|
|
240756
|
+
},
|
|
239961
240757
|
{
|
|
239962
240758
|
"description": "The floating panel the menu is drawn on.",
|
|
239963
240759
|
"name": "captions-menu-surface",
|
|
@@ -240206,6 +241002,14 @@
|
|
|
240206
241002
|
"module": "src/video/root/video-root.ts"
|
|
240207
241003
|
}
|
|
240208
241004
|
},
|
|
241005
|
+
{
|
|
241006
|
+
"description": "The inner menu's filter field, drawn with `filterable`.",
|
|
241007
|
+
"name": "overflow-search-field",
|
|
241008
|
+
"inheritedFrom": {
|
|
241009
|
+
"name": "HelixHeadlessVideo",
|
|
241010
|
+
"module": "src/video/root/video-root.ts"
|
|
241011
|
+
}
|
|
241012
|
+
},
|
|
240209
241013
|
{
|
|
240210
241014
|
"description": "The floating panel the menu is drawn on.",
|
|
240211
241015
|
"name": "overflow-surface",
|
|
@@ -242834,6 +243638,6 @@
|
|
|
242834
243638
|
],
|
|
242835
243639
|
"helix": {
|
|
242836
243640
|
"package": "@fusion.dev/helix",
|
|
242837
|
-
"version": "0.
|
|
243641
|
+
"version": "0.166.0"
|
|
242838
243642
|
}
|
|
242839
243643
|
}
|