@fusion.dev/helix-core 0.104.1 → 0.105.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 +256 -164
- package/dist/controllers/floating-controller/floating-controller.d.ts +3 -3
- package/dist/events/events.d.ts +50 -0
- package/dist/events/events.js +24 -0
- package/dist/helix-element/helix-element.d.ts +3 -2
- package/dist/helix-form-element/helix-form-element.d.ts +7 -6
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/mixins/mixin-chart-source/mixin-chart-source.d.ts +11 -10
- package/dist/mixins/mixin-collection/mixin-collection.d.ts +5 -3
- package/dist/mixins/mixin-controller-active/mixin-controller-active.d.ts +6 -3
- package/dist/mixins/mixin-controller-checked/mixin-controller-checked.d.ts +4 -2
- package/dist/mixins/mixin-controller-open/mixin-controller-open.d.ts +3 -2
- package/dist/mixins/mixin-controller-value/mixin-controller-value.d.ts +4 -4
- package/dist/mixins/mixin-dismissible/mixin-dismissible.d.ts +3 -3
- package/dist/mixins/mixin-field/mixin-field.d.ts +8 -6
- package/dist/mixins/mixin-picker-editing/mixin-picker-editing.d.ts +5 -2
- package/dist/mixins/mixin-picker-field/mixin-picker-field.d.ts +2 -2
- package/dist/mixins/mixin-selectable-item/mixin-selectable-item.d.ts +9 -5
- package/dist/mixins/mixin-tokens/mixin-tokens.d.ts +4 -3
- package/dist/mixins/mixin-viewport/mixin-viewport.d.ts +14 -14
- package/package.json +4 -4
package/custom-elements.json
CHANGED
|
@@ -1175,15 +1175,15 @@
|
|
|
1175
1175
|
"name": "FloatingController",
|
|
1176
1176
|
"cssProperties": [
|
|
1177
1177
|
{
|
|
1178
|
-
"description": "
|
|
1178
|
+
"description": "The anchor's width, for a panel that matches it.",
|
|
1179
1179
|
"name": "--floating-anchor-inline-size"
|
|
1180
1180
|
},
|
|
1181
1181
|
{
|
|
1182
|
-
"description": "Where the
|
|
1182
|
+
"description": "Where the arrow meets the anchor, from the panel's left edge in both text directions.",
|
|
1183
1183
|
"name": "--floating-arrow-x"
|
|
1184
1184
|
},
|
|
1185
1185
|
{
|
|
1186
|
-
"description": "Where the
|
|
1186
|
+
"description": "Where the arrow meets the anchor, from the panel's top edge.",
|
|
1187
1187
|
"name": "--floating-arrow-y"
|
|
1188
1188
|
},
|
|
1189
1189
|
{
|
|
@@ -3625,6 +3625,50 @@
|
|
|
3625
3625
|
},
|
|
3626
3626
|
"helix": {}
|
|
3627
3627
|
},
|
|
3628
|
+
{
|
|
3629
|
+
"kind": "class",
|
|
3630
|
+
"description": "A marker, a position, a route or an area changed what it says: where it is,\nits points, its progress, its name.\n\n**Said rather than reflected.** The connector and the frame follow the\nparts, and heard them through their attributes until the parts reflected\nnothing CSS selects on: a live position's coordinates are state, and a\nroute's points are a payload, neither of which belongs in the markup. It\nbubbles to the frame, whose light-DOM children the parts are, and goes no\nfurther, being the family's own bookkeeping rather than news for a page.",
|
|
3631
|
+
"name": "HelixMapPartChangeEvent",
|
|
3632
|
+
"members": [
|
|
3633
|
+
{
|
|
3634
|
+
"kind": "field",
|
|
3635
|
+
"name": "eventName",
|
|
3636
|
+
"type": {
|
|
3637
|
+
"text": "string"
|
|
3638
|
+
},
|
|
3639
|
+
"static": true,
|
|
3640
|
+
"readonly": true,
|
|
3641
|
+
"default": "'helix-map-part-change'"
|
|
3642
|
+
}
|
|
3643
|
+
],
|
|
3644
|
+
"superclass": {
|
|
3645
|
+
"name": "CustomEvent",
|
|
3646
|
+
"module": "src/events/events.ts"
|
|
3647
|
+
},
|
|
3648
|
+
"helix": {}
|
|
3649
|
+
},
|
|
3650
|
+
{
|
|
3651
|
+
"kind": "class",
|
|
3652
|
+
"description": "A reader pressed a cluster, one marker standing for several that would have\ndrawn over each other.\n\n**Opened by zooming in**, which the connector does, framing the places the\ncluster holds, as pressing one does on every map a reader has used. Told\nrather than asked: a page that lists them in a panel instead connects with\n`clusterZoom: false`. Sent from the marker the cluster is drawn as, and\nbubbles through the frame to the page.",
|
|
3653
|
+
"name": "HelixMapClusterEvent",
|
|
3654
|
+
"members": [
|
|
3655
|
+
{
|
|
3656
|
+
"kind": "field",
|
|
3657
|
+
"name": "eventName",
|
|
3658
|
+
"type": {
|
|
3659
|
+
"text": "string"
|
|
3660
|
+
},
|
|
3661
|
+
"static": true,
|
|
3662
|
+
"readonly": true,
|
|
3663
|
+
"default": "'helix-map-cluster'"
|
|
3664
|
+
}
|
|
3665
|
+
],
|
|
3666
|
+
"superclass": {
|
|
3667
|
+
"name": "CustomEvent",
|
|
3668
|
+
"module": "src/events/events.ts"
|
|
3669
|
+
},
|
|
3670
|
+
"helix": {}
|
|
3671
|
+
},
|
|
3628
3672
|
{
|
|
3629
3673
|
"kind": "class",
|
|
3630
3674
|
"description": "A message is about to be pinned or unpinned, and can be refused.",
|
|
@@ -4378,6 +4422,22 @@
|
|
|
4378
4422
|
"module": "src/events/events.ts"
|
|
4379
4423
|
}
|
|
4380
4424
|
},
|
|
4425
|
+
{
|
|
4426
|
+
"kind": "js",
|
|
4427
|
+
"name": "HelixMapPartChangeEvent",
|
|
4428
|
+
"declaration": {
|
|
4429
|
+
"name": "HelixMapPartChangeEvent",
|
|
4430
|
+
"module": "src/events/events.ts"
|
|
4431
|
+
}
|
|
4432
|
+
},
|
|
4433
|
+
{
|
|
4434
|
+
"kind": "js",
|
|
4435
|
+
"name": "HelixMapClusterEvent",
|
|
4436
|
+
"declaration": {
|
|
4437
|
+
"name": "HelixMapClusterEvent",
|
|
4438
|
+
"module": "src/events/events.ts"
|
|
4439
|
+
}
|
|
4440
|
+
},
|
|
4381
4441
|
{
|
|
4382
4442
|
"kind": "js",
|
|
4383
4443
|
"name": "HelixBeforePinEvent",
|
|
@@ -4853,7 +4913,7 @@
|
|
|
4853
4913
|
"events": [],
|
|
4854
4914
|
"cssStates": [
|
|
4855
4915
|
{
|
|
4856
|
-
"description": "Set
|
|
4916
|
+
"description": "Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.",
|
|
4857
4917
|
"name": "settled"
|
|
4858
4918
|
}
|
|
4859
4919
|
],
|
|
@@ -5090,7 +5150,7 @@
|
|
|
5090
5150
|
"text": "boolean"
|
|
5091
5151
|
},
|
|
5092
5152
|
"default": "false",
|
|
5093
|
-
"description": "Whether the control is
|
|
5153
|
+
"description": "Whether the control is disabled and cannot be used.\n\nReflected, because the styled tier selects on it, and mirrored to\n`aria-disabled` rather than removing the element from the accessibility\ntree, so a screen reader can still announce that the control exists.\n\nThe mirror itself is in `willUpdate` below, here rather than in each\ncontrol, because here is where `disabled` is.",
|
|
5094
5154
|
"attribute": "disabled",
|
|
5095
5155
|
"reflects": true
|
|
5096
5156
|
},
|
|
@@ -5120,7 +5180,7 @@
|
|
|
5120
5180
|
}
|
|
5121
5181
|
}
|
|
5122
5182
|
],
|
|
5123
|
-
"description": "
|
|
5183
|
+
"description": "Called by the browser when an ancestor fieldset is disabled or enabled.\n\n**The argument is the effective state, and taking it whole is what latched\nevery control in the library.** The platform calls this for the element's\nown `disabled` as well as for a fieldset, and our own arrives here at the\nworst possible moment: reflecting `disabled` to the attribute happens\ninside Lit's `update()`, the UA fires this synchronously from that write,\nand a reactive write during an update is a change-in-update Lit does not\nre-render for. So `formDisabled` ran exactly one update behind forever.\n\nMeasured on Slider, logging what `render` saw:\n\n```\nset true disabled true formDisabled false isDisabled true\nset false disabled false formDisabled true isDisabled true <- stale\n(no third render)\n```\n\nThe host came out right every time, `disabled` false, `:disabled` not\nmatching, and the inner control kept the attribute, so a control disabled\nonce could never be re-enabled. It only shows when something re-enables,\nwhich is the same shape of bug `inheritDisabled` was written for.\n\nOur own half is already in `this.disabled` and `isDisabled` is an or, so\nthis records only what the fieldset adds. That also removes the write\nentirely on the own-disabled path rather than moving it.\n\nThe one case this cannot see is a control that is disabled itself *and*\ninside a disabled fieldset, whose own `disabled` is then removed: the\neffective state does not change, so the platform does not call again, and\nthe fieldset's hold is not recorded. There is no callback to learn it from\nand reading `:disabled` here would answer about the attribute we are in the\nmiddle of removing."
|
|
5124
5184
|
},
|
|
5125
5185
|
{
|
|
5126
5186
|
"kind": "method",
|
|
@@ -5130,7 +5190,7 @@
|
|
|
5130
5190
|
"text": "void"
|
|
5131
5191
|
}
|
|
5132
5192
|
},
|
|
5133
|
-
"description": "
|
|
5193
|
+
"description": "Called by the browser when the form is reset. It does nothing here, and\nevery override calls it.\n\n**A chain rather than a leaf**, because more than one layer owes a reset\nsomething: the value mixin its default, and the field mixin beneath it the\nforgetting of a reader's past attempt, whose message otherwise showed over\nthe emptied control the moment the form was reset."
|
|
5134
5194
|
},
|
|
5135
5195
|
{
|
|
5136
5196
|
"kind": "method",
|
|
@@ -5161,7 +5221,7 @@
|
|
|
5161
5221
|
"text": "string"
|
|
5162
5222
|
},
|
|
5163
5223
|
"default": "''",
|
|
5164
|
-
"description": "
|
|
5224
|
+
"description": "The name the control's value is submitted under.\n\n**Reflected, and it is the exception to \"reflect only what CSS selects\non\".** The platform builds a form's entry list from the `name` *content\nattribute*, not from the property, so a control named through the property\nsubmitted under no name at all and was silently dropped. Measured: two\ninputs in one form, one named by attribute and one by property, and the\nform carried a single entry.\n\nSafe for a React consumer, which is what the rule is protecting: React\nrenders a custom element's props as attributes on the server, so the name\nis already in the markup being hydrated and reflecting it writes what is\nthere. It is only a change to the markup when a consumer assigns it\nimperatively later, and nothing is hydrating by then.\n\nHere rather than on each control.",
|
|
5165
5225
|
"attribute": "name",
|
|
5166
5226
|
"reflects": true
|
|
5167
5227
|
},
|
|
@@ -5171,7 +5231,7 @@
|
|
|
5171
5231
|
"type": {
|
|
5172
5232
|
"text": "HTMLFormElement | null"
|
|
5173
5233
|
},
|
|
5174
|
-
"description": "The form
|
|
5234
|
+
"description": "The form the control belongs to, or `null`.",
|
|
5175
5235
|
"readonly": true,
|
|
5176
5236
|
"helix": {
|
|
5177
5237
|
"references": [
|
|
@@ -5188,7 +5248,7 @@
|
|
|
5188
5248
|
"type": {
|
|
5189
5249
|
"text": "NodeList"
|
|
5190
5250
|
},
|
|
5191
|
-
"description": "
|
|
5251
|
+
"description": "The labels associated with the control.",
|
|
5192
5252
|
"readonly": true,
|
|
5193
5253
|
"helix": {
|
|
5194
5254
|
"references": [
|
|
@@ -5532,7 +5592,7 @@
|
|
|
5532
5592
|
"text": "boolean"
|
|
5533
5593
|
},
|
|
5534
5594
|
"default": "false",
|
|
5535
|
-
"description": "Whether the control is
|
|
5595
|
+
"description": "Whether the control is disabled and cannot be used.\n\nReflected, because the styled tier selects on it, and mirrored to\n`aria-disabled` rather than removing the element from the accessibility\ntree, so a screen reader can still announce that the control exists.\n\nThe mirror itself is in `willUpdate` below, here rather than in each\ncontrol, because here is where `disabled` is.",
|
|
5536
5596
|
"fieldName": "disabled"
|
|
5537
5597
|
},
|
|
5538
5598
|
{
|
|
@@ -5541,7 +5601,7 @@
|
|
|
5541
5601
|
"text": "string"
|
|
5542
5602
|
},
|
|
5543
5603
|
"default": "''",
|
|
5544
|
-
"description": "
|
|
5604
|
+
"description": "The name the control's value is submitted under.\n\n**Reflected, and it is the exception to \"reflect only what CSS selects\non\".** The platform builds a form's entry list from the `name` *content\nattribute*, not from the property, so a control named through the property\nsubmitted under no name at all and was silently dropped. Measured: two\ninputs in one form, one named by attribute and one by property, and the\nform carried a single entry.\n\nSafe for a React consumer, which is what the rule is protecting: React\nrenders a custom element's props as attributes on the server, so the name\nis already in the markup being hydrated and reflecting it writes what is\nthere. It is only a change to the markup when a consumer assigns it\nimperatively later, and nothing is hydrating by then.\n\nHere rather than on each control.",
|
|
5545
5605
|
"fieldName": "name"
|
|
5546
5606
|
}
|
|
5547
5607
|
],
|
|
@@ -5558,7 +5618,7 @@
|
|
|
5558
5618
|
},
|
|
5559
5619
|
"cssStates": [
|
|
5560
5620
|
{
|
|
5561
|
-
"description": "Set
|
|
5621
|
+
"description": "Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.",
|
|
5562
5622
|
"name": "settled",
|
|
5563
5623
|
"inheritedFrom": {
|
|
5564
5624
|
"name": "HelixElement",
|
|
@@ -6352,6 +6412,14 @@
|
|
|
6352
6412
|
"module": "./events/events.js"
|
|
6353
6413
|
}
|
|
6354
6414
|
},
|
|
6415
|
+
{
|
|
6416
|
+
"kind": "js",
|
|
6417
|
+
"name": "HelixMapClusterEvent",
|
|
6418
|
+
"declaration": {
|
|
6419
|
+
"name": "HelixMapClusterEvent",
|
|
6420
|
+
"module": "./events/events.js"
|
|
6421
|
+
}
|
|
6422
|
+
},
|
|
6355
6423
|
{
|
|
6356
6424
|
"kind": "js",
|
|
6357
6425
|
"name": "HelixMapPanEvent",
|
|
@@ -6360,6 +6428,14 @@
|
|
|
6360
6428
|
"module": "./events/events.js"
|
|
6361
6429
|
}
|
|
6362
6430
|
},
|
|
6431
|
+
{
|
|
6432
|
+
"kind": "js",
|
|
6433
|
+
"name": "HelixMapPartChangeEvent",
|
|
6434
|
+
"declaration": {
|
|
6435
|
+
"name": "HelixMapPartChangeEvent",
|
|
6436
|
+
"module": "./events/events.js"
|
|
6437
|
+
}
|
|
6438
|
+
},
|
|
6363
6439
|
{
|
|
6364
6440
|
"kind": "js",
|
|
6365
6441
|
"name": "HelixMapZoomEvent",
|
|
@@ -6512,6 +6588,14 @@
|
|
|
6512
6588
|
"module": "./events/events.js"
|
|
6513
6589
|
}
|
|
6514
6590
|
},
|
|
6591
|
+
{
|
|
6592
|
+
"kind": "js",
|
|
6593
|
+
"name": "MapClusterDetail",
|
|
6594
|
+
"declaration": {
|
|
6595
|
+
"name": "MapClusterDetail",
|
|
6596
|
+
"module": "./events/events.js"
|
|
6597
|
+
}
|
|
6598
|
+
},
|
|
6515
6599
|
{
|
|
6516
6600
|
"kind": "js",
|
|
6517
6601
|
"name": "MapPanDetail",
|
|
@@ -6520,6 +6604,14 @@
|
|
|
6520
6604
|
"module": "./events/events.js"
|
|
6521
6605
|
}
|
|
6522
6606
|
},
|
|
6607
|
+
{
|
|
6608
|
+
"kind": "js",
|
|
6609
|
+
"name": "MapPartChangeDetail",
|
|
6610
|
+
"declaration": {
|
|
6611
|
+
"name": "MapPartChangeDetail",
|
|
6612
|
+
"module": "./events/events.js"
|
|
6613
|
+
}
|
|
6614
|
+
},
|
|
6523
6615
|
{
|
|
6524
6616
|
"kind": "js",
|
|
6525
6617
|
"name": "MapZoomDetail",
|
|
@@ -7723,7 +7815,7 @@
|
|
|
7723
7815
|
"name": "MixinChartSourceInterface",
|
|
7724
7816
|
"cssProperties": [
|
|
7725
7817
|
{
|
|
7726
|
-
"description": "The color of the mark
|
|
7818
|
+
"description": "The color of the mark it is set on. The component sets it, and the stylesheet reads it.",
|
|
7727
7819
|
"name": "--chart-series"
|
|
7728
7820
|
},
|
|
7729
7821
|
{
|
|
@@ -7838,7 +7930,7 @@
|
|
|
7838
7930
|
"type": {
|
|
7839
7931
|
"text": "string"
|
|
7840
7932
|
},
|
|
7841
|
-
"description": "The
|
|
7933
|
+
"description": "The chart's name, which starts the chart's text summary.\n\nAbsent falls back to the table's own caption, which is usually the right\nwords and is already written."
|
|
7842
7934
|
},
|
|
7843
7935
|
{
|
|
7844
7936
|
"kind": "field",
|
|
@@ -7846,7 +7938,7 @@
|
|
|
7846
7938
|
"type": {
|
|
7847
7939
|
"text": "Series[]"
|
|
7848
7940
|
},
|
|
7849
|
-
"description": "The columns
|
|
7941
|
+
"description": "The table's columns, one series each. Empty when there is no table.",
|
|
7850
7942
|
"readonly": true
|
|
7851
7943
|
},
|
|
7852
7944
|
{
|
|
@@ -7855,7 +7947,7 @@
|
|
|
7855
7947
|
"type": {
|
|
7856
7948
|
"text": "string"
|
|
7857
7949
|
},
|
|
7858
|
-
"description": "
|
|
7950
|
+
"description": "The chart's name: `label` when it is set, and the table's caption\notherwise.",
|
|
7859
7951
|
"readonly": true
|
|
7860
7952
|
},
|
|
7861
7953
|
{
|
|
@@ -7864,7 +7956,7 @@
|
|
|
7864
7956
|
"type": {
|
|
7865
7957
|
"text": "Row[]"
|
|
7866
7958
|
},
|
|
7867
|
-
"description": "Every row of the table, with each cell's text
|
|
7959
|
+
"description": "Every row of the table, with each cell's text and number.",
|
|
7868
7960
|
"readonly": true
|
|
7869
7961
|
},
|
|
7870
7962
|
{
|
|
@@ -7873,7 +7965,7 @@
|
|
|
7873
7965
|
"type": {
|
|
7874
7966
|
"text": "number[]"
|
|
7875
7967
|
},
|
|
7876
|
-
"description": "
|
|
7968
|
+
"description": "The positions of the cells in a row that hold numbers, in table order.",
|
|
7877
7969
|
"readonly": true
|
|
7878
7970
|
},
|
|
7879
7971
|
{
|
|
@@ -7892,7 +7984,7 @@
|
|
|
7892
7984
|
}
|
|
7893
7985
|
}
|
|
7894
7986
|
],
|
|
7895
|
-
"description": "The palette slot the cell at this
|
|
7987
|
+
"description": "The palette slot for the cell at this position in a row, or `undefined`\nwhen no series was read from that column."
|
|
7896
7988
|
},
|
|
7897
7989
|
{
|
|
7898
7990
|
"kind": "field",
|
|
@@ -7900,7 +7992,7 @@
|
|
|
7900
7992
|
"type": {
|
|
7901
7993
|
"text": "number"
|
|
7902
7994
|
},
|
|
7903
|
-
"description": "
|
|
7995
|
+
"description": "The number of readings, which the pointer position maps onto.",
|
|
7904
7996
|
"readonly": true
|
|
7905
7997
|
},
|
|
7906
7998
|
{
|
|
@@ -7909,7 +8001,7 @@
|
|
|
7909
8001
|
"type": {
|
|
7910
8002
|
"text": "ChartPointerController"
|
|
7911
8003
|
},
|
|
7912
|
-
"description": "
|
|
8004
|
+
"description": "Finds the reading nearest the pointer, so the tooltip can sit on it."
|
|
7913
8005
|
}
|
|
7914
8006
|
],
|
|
7915
8007
|
"helix": {}
|
|
@@ -7932,7 +8024,7 @@
|
|
|
7932
8024
|
"name": "pointer",
|
|
7933
8025
|
"readonly": true,
|
|
7934
8026
|
"default": "new ChartPointerController(this)",
|
|
7935
|
-
"description": "
|
|
8027
|
+
"description": "Finds the reading nearest the pointer, so the tooltip can sit on it.\n\nPublic for the same reason `series` and `named` are: a protected member\ncannot be cast onto across unrelated classes, so it would be invisible to\nevery chart that needs it. Reading where a pointer is resting is a fair\nthing to ask a chart anyway."
|
|
7936
8028
|
},
|
|
7937
8029
|
{
|
|
7938
8030
|
"kind": "field",
|
|
@@ -7951,7 +8043,7 @@
|
|
|
7951
8043
|
"text": "string"
|
|
7952
8044
|
},
|
|
7953
8045
|
"default": "''",
|
|
7954
|
-
"description": "The
|
|
8046
|
+
"description": "The chart's name, which starts the chart's text summary.\n\nAbsent falls back to the table's own caption, which is usually the right\nwords and is already written.",
|
|
7955
8047
|
"attribute": "label"
|
|
7956
8048
|
},
|
|
7957
8049
|
{
|
|
@@ -7960,7 +8052,7 @@
|
|
|
7960
8052
|
"type": {
|
|
7961
8053
|
"text": "Series[]"
|
|
7962
8054
|
},
|
|
7963
|
-
"description": "The columns
|
|
8055
|
+
"description": "The table's columns, one series each. Empty when there is no table.\n\nHeld by the controller between edits, so a render reading this five\ntimes parses the table once. See `SourceController.series`.",
|
|
7964
8056
|
"readonly": true
|
|
7965
8057
|
},
|
|
7966
8058
|
{
|
|
@@ -7969,7 +8061,7 @@
|
|
|
7969
8061
|
"type": {
|
|
7970
8062
|
"text": "string"
|
|
7971
8063
|
},
|
|
7972
|
-
"description": "
|
|
8064
|
+
"description": "The chart's name: `label` when it is set, and the table's caption\notherwise.\n\nThe fallback is the reason this is shared rather than copied: a caption is\nalready written, already the right words, and already the thing a reader\nof the table sees. A chart that made the consumer say it twice would be\nasking for the second one to drift.",
|
|
7973
8065
|
"readonly": true
|
|
7974
8066
|
},
|
|
7975
8067
|
{
|
|
@@ -7978,7 +8070,7 @@
|
|
|
7978
8070
|
"type": {
|
|
7979
8071
|
"text": "Row[]"
|
|
7980
8072
|
},
|
|
7981
|
-
"description": "Every row of the table, with each cell's text
|
|
8073
|
+
"description": "Every row of the table, with each cell's text and number.\n\nThis is where a tooltip's content comes from, and it is deliberately not\n`series`. A chart draws numbers; a reader resting a pointer on one wants\nwhat the table says, which is `$128k` and not `128000`, and often wants\nthe column beside it that nothing plotted at all.\n\n**Not `rows`.** It is the source table's rows, and `rows` on a chart is a\nname a chart wants for itself: `helix-heatmap` takes `rows=\"7\"` to mean a\ncalendar week, and declaring that against a base class whose `rows` is a\n`Row[]` getter is a type error at best. Name the member for what it holds\nrather than for the shortest word available.",
|
|
7982
8074
|
"readonly": true
|
|
7983
8075
|
},
|
|
7984
8076
|
{
|
|
@@ -7987,7 +8079,7 @@
|
|
|
7987
8079
|
"type": {
|
|
7988
8080
|
"text": "number[]"
|
|
7989
8081
|
},
|
|
7990
|
-
"description": "
|
|
8082
|
+
"description": "The positions of the cells in a row that hold numbers, in table order.\n\nThe same test `readSeries` applies when it drops a column of notes: a\ncolumn is a series where any row parses, so a series survives one blank\ncell and a column of words is never one.",
|
|
7991
8083
|
"readonly": true
|
|
7992
8084
|
},
|
|
7993
8085
|
{
|
|
@@ -8006,7 +8098,7 @@
|
|
|
8006
8098
|
}
|
|
8007
8099
|
}
|
|
8008
8100
|
],
|
|
8009
|
-
"description": "The palette slot the cell at this
|
|
8101
|
+
"description": "The palette slot for the cell at this position in a row.\n\n**A cell's place in its row is not its series' depth, and the tooltip\nspent a while assuming it was.** `readSeries` drops a column nothing\nparses and `readRows` keeps it, so one column of notes among the figures\nmoves every column after it one color along in the bubble: a row reading\n`Referral 1,080` wearing series three's green beside a legend that says\nseries three is something else, which is the one failure the dot exists\nto prevent.\n\nOverridden where a chart reads the table some other way. `ScatterChart`\nsplits the first plotted column off as the measure across, so its first\n*plotted* series is this table's second numeric column."
|
|
8010
8102
|
},
|
|
8011
8103
|
{
|
|
8012
8104
|
"kind": "field",
|
|
@@ -8014,7 +8106,7 @@
|
|
|
8014
8106
|
"type": {
|
|
8015
8107
|
"text": "number"
|
|
8016
8108
|
},
|
|
8017
|
-
"description": "
|
|
8109
|
+
"description": "The number of readings, which the pointer position maps onto.",
|
|
8018
8110
|
"readonly": true
|
|
8019
8111
|
}
|
|
8020
8112
|
],
|
|
@@ -8034,7 +8126,7 @@
|
|
|
8034
8126
|
"text": "string"
|
|
8035
8127
|
},
|
|
8036
8128
|
"default": "''",
|
|
8037
|
-
"description": "The
|
|
8129
|
+
"description": "The chart's name, which starts the chart's text summary.\n\nAbsent falls back to the table's own caption, which is usually the right\nwords and is already written.",
|
|
8038
8130
|
"fieldName": "label"
|
|
8039
8131
|
}
|
|
8040
8132
|
],
|
|
@@ -8122,7 +8214,7 @@
|
|
|
8122
8214
|
"type": {
|
|
8123
8215
|
"text": "boolean"
|
|
8124
8216
|
},
|
|
8125
|
-
"description": "Whether the rows are still
|
|
8217
|
+
"description": "Whether the rows are still loading."
|
|
8126
8218
|
},
|
|
8127
8219
|
{
|
|
8128
8220
|
"kind": "field",
|
|
@@ -8130,7 +8222,7 @@
|
|
|
8130
8222
|
"type": {
|
|
8131
8223
|
"text": "string"
|
|
8132
8224
|
},
|
|
8133
|
-
"description": "
|
|
8225
|
+
"description": "The text shown and announced while the rows load."
|
|
8134
8226
|
},
|
|
8135
8227
|
{
|
|
8136
8228
|
"kind": "field",
|
|
@@ -8138,7 +8230,7 @@
|
|
|
8138
8230
|
"type": {
|
|
8139
8231
|
"text": "string"
|
|
8140
8232
|
},
|
|
8141
|
-
"description": "
|
|
8233
|
+
"description": "The text shown and announced when there are no rows and none are loading."
|
|
8142
8234
|
},
|
|
8143
8235
|
{
|
|
8144
8236
|
"kind": "method",
|
|
@@ -8232,7 +8324,7 @@
|
|
|
8232
8324
|
"text": "string"
|
|
8233
8325
|
},
|
|
8234
8326
|
"default": "'Nothing to show'",
|
|
8235
|
-
"description": "
|
|
8327
|
+
"description": "The text shown and announced when there are no rows and none are loading.",
|
|
8236
8328
|
"attribute": "empty-text"
|
|
8237
8329
|
},
|
|
8238
8330
|
{
|
|
@@ -8242,7 +8334,7 @@
|
|
|
8242
8334
|
"text": "boolean"
|
|
8243
8335
|
},
|
|
8244
8336
|
"default": "false",
|
|
8245
|
-
"description": "Whether the rows are still
|
|
8337
|
+
"description": "Whether the rows are still loading.\n\nReflected, because a stylesheet needs it: the rows that are already there\nare dimmed rather than removed while a new set arrives, and only CSS can\nsay that without the component knowing what a row looks like.",
|
|
8246
8338
|
"attribute": "loading",
|
|
8247
8339
|
"reflects": true
|
|
8248
8340
|
},
|
|
@@ -8253,7 +8345,7 @@
|
|
|
8253
8345
|
"text": "string"
|
|
8254
8346
|
},
|
|
8255
8347
|
"default": "'Loading'",
|
|
8256
|
-
"description": "
|
|
8348
|
+
"description": "The text shown and announced while the rows load.",
|
|
8257
8349
|
"attribute": "loading-text"
|
|
8258
8350
|
},
|
|
8259
8351
|
{
|
|
@@ -8360,7 +8452,7 @@
|
|
|
8360
8452
|
"text": "string"
|
|
8361
8453
|
},
|
|
8362
8454
|
"default": "'Nothing to show'",
|
|
8363
|
-
"description": "
|
|
8455
|
+
"description": "The text shown and announced when there are no rows and none are loading.",
|
|
8364
8456
|
"fieldName": "emptyText"
|
|
8365
8457
|
},
|
|
8366
8458
|
{
|
|
@@ -8369,7 +8461,7 @@
|
|
|
8369
8461
|
"text": "boolean"
|
|
8370
8462
|
},
|
|
8371
8463
|
"default": "false",
|
|
8372
|
-
"description": "Whether the rows are still
|
|
8464
|
+
"description": "Whether the rows are still loading.\n\nReflected, because a stylesheet needs it: the rows that are already there\nare dimmed rather than removed while a new set arrives, and only CSS can\nsay that without the component knowing what a row looks like.",
|
|
8373
8465
|
"fieldName": "loading"
|
|
8374
8466
|
},
|
|
8375
8467
|
{
|
|
@@ -8378,7 +8470,7 @@
|
|
|
8378
8470
|
"text": "string"
|
|
8379
8471
|
},
|
|
8380
8472
|
"default": "'Loading'",
|
|
8381
|
-
"description": "
|
|
8473
|
+
"description": "The text shown and announced while the rows load.",
|
|
8382
8474
|
"fieldName": "loadingText"
|
|
8383
8475
|
}
|
|
8384
8476
|
],
|
|
@@ -8426,7 +8518,7 @@
|
|
|
8426
8518
|
"type": {
|
|
8427
8519
|
"text": "string"
|
|
8428
8520
|
},
|
|
8429
|
-
"description": "
|
|
8521
|
+
"description": "The `value` of the current item.\n\nReading gives the real one. Writing always applies, and is a seed and a\ncorrection rather than a claim of ownership: a consumer who wants the\ndecision refuses the `helix-before-activate`."
|
|
8430
8522
|
},
|
|
8431
8523
|
{
|
|
8432
8524
|
"kind": "field",
|
|
@@ -8434,7 +8526,7 @@
|
|
|
8434
8526
|
"type": {
|
|
8435
8527
|
"text": "string"
|
|
8436
8528
|
},
|
|
8437
|
-
"description": "
|
|
8529
|
+
"description": "The `value` of the item declared current in markup. Ignored once `active`\nis written."
|
|
8438
8530
|
},
|
|
8439
8531
|
{
|
|
8440
8532
|
"kind": "method",
|
|
@@ -8452,7 +8544,7 @@
|
|
|
8452
8544
|
}
|
|
8453
8545
|
}
|
|
8454
8546
|
],
|
|
8455
|
-
"description": "Requests a new current item, and
|
|
8547
|
+
"description": "Requests a new current item, and returns whether the change was applied."
|
|
8456
8548
|
},
|
|
8457
8549
|
{
|
|
8458
8550
|
"kind": "method",
|
|
@@ -8487,7 +8579,7 @@
|
|
|
8487
8579
|
"type": {
|
|
8488
8580
|
"text": "string"
|
|
8489
8581
|
},
|
|
8490
|
-
"description": "
|
|
8582
|
+
"description": "The `value` of the current item.\n\nNot `option.active`, which is the option the keyboard is on: that is a\ndifferent question from which one is chosen.\n\nWriting always applies, so `<helix-tabs active=\"one\">` starts on that\ntab, and `default-active` is how markup says where to start without\nnaming the current one.",
|
|
8491
8583
|
"attribute": "active"
|
|
8492
8584
|
},
|
|
8493
8585
|
{
|
|
@@ -8497,7 +8589,7 @@
|
|
|
8497
8589
|
"text": "string"
|
|
8498
8590
|
},
|
|
8499
8591
|
"default": "''",
|
|
8500
|
-
"description": "
|
|
8592
|
+
"description": "The `value` of the item declared current in markup.\n\nIgnored once `active` is written.",
|
|
8501
8593
|
"attribute": "default-active"
|
|
8502
8594
|
},
|
|
8503
8595
|
{
|
|
@@ -8526,7 +8618,7 @@
|
|
|
8526
8618
|
}
|
|
8527
8619
|
}
|
|
8528
8620
|
],
|
|
8529
|
-
"description": "Requests a new current item, and
|
|
8621
|
+
"description": "Requests a new current item, and returns whether the change was applied.\n\nAnnounces before it acts, so `preventDefault()` on the `helix-before-activate` is\na refusal and nothing moves. Unlike a native control, nothing has moved\nby the time this runs, so refusing is simply not writing: there is\nnothing to put back. Nobody refusing means the set updates itself,\nwhether or not a consumer declared `active`, a declared property being a\nseed and a correction."
|
|
8530
8622
|
},
|
|
8531
8623
|
{
|
|
8532
8624
|
"kind": "method",
|
|
@@ -8580,7 +8672,7 @@
|
|
|
8580
8672
|
"type": {
|
|
8581
8673
|
"text": "string"
|
|
8582
8674
|
},
|
|
8583
|
-
"description": "
|
|
8675
|
+
"description": "The `value` of the current item.\n\nNot `option.active`, which is the option the keyboard is on: that is a\ndifferent question from which one is chosen.\n\nWriting always applies, so `<helix-tabs active=\"one\">` starts on that\ntab, and `default-active` is how markup says where to start without\nnaming the current one.",
|
|
8584
8676
|
"fieldName": "active"
|
|
8585
8677
|
},
|
|
8586
8678
|
{
|
|
@@ -8589,7 +8681,7 @@
|
|
|
8589
8681
|
"text": "string"
|
|
8590
8682
|
},
|
|
8591
8683
|
"default": "''",
|
|
8592
|
-
"description": "
|
|
8684
|
+
"description": "The `value` of the item declared current in markup.\n\nIgnored once `active` is written.",
|
|
8593
8685
|
"fieldName": "defaultActive"
|
|
8594
8686
|
}
|
|
8595
8687
|
],
|
|
@@ -8645,7 +8737,7 @@
|
|
|
8645
8737
|
"type": {
|
|
8646
8738
|
"text": "boolean"
|
|
8647
8739
|
},
|
|
8648
|
-
"description": "Whether the
|
|
8740
|
+
"description": "Whether the control starts checked. A form reset returns it to this state."
|
|
8649
8741
|
},
|
|
8650
8742
|
{
|
|
8651
8743
|
"kind": "method",
|
|
@@ -8663,7 +8755,7 @@
|
|
|
8663
8755
|
}
|
|
8664
8756
|
}
|
|
8665
8757
|
],
|
|
8666
|
-
"description": "Requests a checked
|
|
8758
|
+
"description": "Requests a change to `checked`, and returns whether it was applied.\n\nAnnounces before it acts: a listener calling `preventDefault()` on the\n`helix-before-toggle` refuses the change, and nothing moves."
|
|
8667
8759
|
},
|
|
8668
8760
|
{
|
|
8669
8761
|
"kind": "method",
|
|
@@ -8709,7 +8801,7 @@
|
|
|
8709
8801
|
"text": "boolean"
|
|
8710
8802
|
},
|
|
8711
8803
|
"default": "false",
|
|
8712
|
-
"description": "Whether the
|
|
8804
|
+
"description": "Whether the control starts checked. A form reset returns it to this state.",
|
|
8713
8805
|
"attribute": "default-checked"
|
|
8714
8806
|
},
|
|
8715
8807
|
{
|
|
@@ -8738,7 +8830,7 @@
|
|
|
8738
8830
|
}
|
|
8739
8831
|
}
|
|
8740
8832
|
],
|
|
8741
|
-
"description": "Requests a checked
|
|
8833
|
+
"description": "Requests a change to `checked`, and returns whether it was applied.\n\nAnnounces before it acts, so `preventDefault()` on the\n`helix-before-toggle` is a refusal and nothing moves. Nobody refusing\nmeans the element updates itself, whether or not a consumer declared the\nproperty: a declared property is a seed and a correction, the way\n`<input value>` is, and a consumer who wants the change for themselves\nrefuses it and assigns their own."
|
|
8742
8834
|
},
|
|
8743
8835
|
{
|
|
8744
8836
|
"kind": "method",
|
|
@@ -8802,7 +8894,7 @@
|
|
|
8802
8894
|
"text": "boolean"
|
|
8803
8895
|
},
|
|
8804
8896
|
"default": "false",
|
|
8805
|
-
"description": "Whether the
|
|
8897
|
+
"description": "Whether the control starts checked. A form reset returns it to this state.",
|
|
8806
8898
|
"fieldName": "defaultChecked"
|
|
8807
8899
|
}
|
|
8808
8900
|
],
|
|
@@ -8850,7 +8942,7 @@
|
|
|
8850
8942
|
"type": {
|
|
8851
8943
|
"text": "boolean"
|
|
8852
8944
|
},
|
|
8853
|
-
"description": "Whether the
|
|
8945
|
+
"description": "Whether the element starts open. Ignored once `open` is written."
|
|
8854
8946
|
},
|
|
8855
8947
|
{
|
|
8856
8948
|
"kind": "field",
|
|
@@ -8876,7 +8968,7 @@
|
|
|
8876
8968
|
}
|
|
8877
8969
|
}
|
|
8878
8970
|
],
|
|
8879
|
-
"description": "Requests
|
|
8971
|
+
"description": "Requests that the element open or close, and returns whether the change was\napplied.\n\nAnnounces before it acts: a listener calling `preventDefault()` on the\n`helix-before-open` or `helix-before-close` refuses the change, and nothing moves."
|
|
8880
8972
|
},
|
|
8881
8973
|
{
|
|
8882
8974
|
"kind": "method",
|
|
@@ -8903,7 +8995,7 @@
|
|
|
8903
8995
|
"text": "boolean"
|
|
8904
8996
|
},
|
|
8905
8997
|
"default": "false",
|
|
8906
|
-
"description": "Whether the
|
|
8998
|
+
"description": "Whether the element starts open. Ignored once `open` is written.",
|
|
8907
8999
|
"attribute": "default-open"
|
|
8908
9000
|
},
|
|
8909
9001
|
{
|
|
@@ -8941,7 +9033,7 @@
|
|
|
8941
9033
|
}
|
|
8942
9034
|
}
|
|
8943
9035
|
],
|
|
8944
|
-
"description": "Requests
|
|
9036
|
+
"description": "Requests that the element open or close, and returns whether the change\nwas applied.\n\nAnnounces before it acts, so `preventDefault()` on the `helix-before-open` or\n`helix-before-close` is a refusal and nothing moves. Nobody refusing means the\nelement opens or closes itself, whether or not a consumer declared\n`open`: a declared property is a seed and a correction, and a consumer\nwho wants the decision for themselves refuses it and assigns their own."
|
|
8945
9037
|
},
|
|
8946
9038
|
{
|
|
8947
9039
|
"kind": "method",
|
|
@@ -8980,7 +9072,7 @@
|
|
|
8980
9072
|
"text": "boolean"
|
|
8981
9073
|
},
|
|
8982
9074
|
"default": "false",
|
|
8983
|
-
"description": "Whether the
|
|
9075
|
+
"description": "Whether the element starts open. Ignored once `open` is written.",
|
|
8984
9076
|
"fieldName": "defaultOpen"
|
|
8985
9077
|
},
|
|
8986
9078
|
{
|
|
@@ -9036,7 +9128,7 @@
|
|
|
9036
9128
|
"type": {
|
|
9037
9129
|
"text": "string"
|
|
9038
9130
|
},
|
|
9039
|
-
"description": "The value the
|
|
9131
|
+
"description": "The value the control starts with. A form reset returns it to this value.\n\nSeparate from `value`, which is where the control is now, and gone from the\nreader's view the moment they change anything."
|
|
9040
9132
|
},
|
|
9041
9133
|
{
|
|
9042
9134
|
"kind": "field",
|
|
@@ -9044,7 +9136,7 @@
|
|
|
9044
9136
|
"type": {
|
|
9045
9137
|
"text": "string"
|
|
9046
9138
|
},
|
|
9047
|
-
"description": "
|
|
9139
|
+
"description": "The control's current value, which its form submits.\n\nReading gives the real value. Writing always applies, and is a seed and a\ncorrection rather than a claim of ownership: a consumer who wants the\ndecision refuses the `helix-before-change`."
|
|
9048
9140
|
},
|
|
9049
9141
|
{
|
|
9050
9142
|
"kind": "field",
|
|
@@ -9072,7 +9164,7 @@
|
|
|
9072
9164
|
}
|
|
9073
9165
|
}
|
|
9074
9166
|
],
|
|
9075
|
-
"description": "Requests a new value, and
|
|
9167
|
+
"description": "Requests a new value, and returns whether the change was applied."
|
|
9076
9168
|
},
|
|
9077
9169
|
{
|
|
9078
9170
|
"kind": "method",
|
|
@@ -9082,7 +9174,7 @@
|
|
|
9082
9174
|
"text": "void"
|
|
9083
9175
|
}
|
|
9084
9176
|
},
|
|
9085
|
-
"description": "Returns the control to
|
|
9177
|
+
"description": "Returns the control to its `defaultValue`."
|
|
9086
9178
|
},
|
|
9087
9179
|
{
|
|
9088
9180
|
"kind": "method",
|
|
@@ -9117,7 +9209,7 @@
|
|
|
9117
9209
|
"text": "string"
|
|
9118
9210
|
},
|
|
9119
9211
|
"default": "''",
|
|
9120
|
-
"description": "The value the
|
|
9212
|
+
"description": "The value the control starts with. A form reset returns it to this value.",
|
|
9121
9213
|
"attribute": "default-value"
|
|
9122
9214
|
},
|
|
9123
9215
|
{
|
|
@@ -9126,7 +9218,7 @@
|
|
|
9126
9218
|
"type": {
|
|
9127
9219
|
"text": "string"
|
|
9128
9220
|
},
|
|
9129
|
-
"description": "
|
|
9221
|
+
"description": "The control's current value, which its form submits.\n\nOne property, not two, so `input.value` answers the question anyone\nasking it meant. Writing always applies; `<helix-input value=\"x\">` is the\nsame statement in markup, and `default-value` is how markup seeds a value\na reset should return to.",
|
|
9130
9222
|
"attribute": "value"
|
|
9131
9223
|
},
|
|
9132
9224
|
{
|
|
@@ -9177,7 +9269,7 @@
|
|
|
9177
9269
|
}
|
|
9178
9270
|
}
|
|
9179
9271
|
],
|
|
9180
|
-
"description": "Requests a new value, and
|
|
9272
|
+
"description": "Requests a new value, and returns whether the change was applied.\n\nAnnounces before it acts, so `preventDefault()` on the `helix-before-change` is\na refusal and nothing moves. Nobody refusing means the control updates\nitself, whether or not a consumer declared `value`: a declared property\nis a seed and a correction, the way `<input value>` is, and a consumer\nwho wants the change for themselves refuses it and assigns their own."
|
|
9181
9273
|
},
|
|
9182
9274
|
{
|
|
9183
9275
|
"kind": "method",
|
|
@@ -9187,7 +9279,7 @@
|
|
|
9187
9279
|
"text": "void"
|
|
9188
9280
|
}
|
|
9189
9281
|
},
|
|
9190
|
-
"description": "Returns the control to
|
|
9282
|
+
"description": "Returns the control to its `defaultValue`.\n\nBoth halves are dropped, the consumer's and the control's, because a\nreset means the form is as it was served. Clearing only the internal one\nwould leave a control that had been written to stuck at that value."
|
|
9191
9283
|
},
|
|
9192
9284
|
{
|
|
9193
9285
|
"kind": "method",
|
|
@@ -9215,7 +9307,7 @@
|
|
|
9215
9307
|
"text": "string"
|
|
9216
9308
|
},
|
|
9217
9309
|
"default": "''",
|
|
9218
|
-
"description": "The value the
|
|
9310
|
+
"description": "The value the control starts with. A form reset returns it to this value.",
|
|
9219
9311
|
"fieldName": "defaultValue"
|
|
9220
9312
|
},
|
|
9221
9313
|
{
|
|
@@ -9223,7 +9315,7 @@
|
|
|
9223
9315
|
"type": {
|
|
9224
9316
|
"text": "string"
|
|
9225
9317
|
},
|
|
9226
|
-
"description": "
|
|
9318
|
+
"description": "The control's current value, which its form submits.\n\nOne property, not two, so `input.value` answers the question anyone\nasking it meant. Writing always applies; `<helix-input value=\"x\">` is the\nsame statement in markup, and `default-value` is how markup seeds a value\na reset should return to.",
|
|
9227
9319
|
"fieldName": "value"
|
|
9228
9320
|
}
|
|
9229
9321
|
],
|
|
@@ -9271,7 +9363,7 @@
|
|
|
9271
9363
|
"type": {
|
|
9272
9364
|
"text": "boolean"
|
|
9273
9365
|
},
|
|
9274
|
-
"description": "Whether
|
|
9366
|
+
"description": "Whether the element shows a control that dismisses it."
|
|
9275
9367
|
},
|
|
9276
9368
|
{
|
|
9277
9369
|
"kind": "field",
|
|
@@ -9279,7 +9371,7 @@
|
|
|
9279
9371
|
"type": {
|
|
9280
9372
|
"text": "string"
|
|
9281
9373
|
},
|
|
9282
|
-
"description": "
|
|
9374
|
+
"description": "The dismiss control's label, read by screen readers."
|
|
9283
9375
|
},
|
|
9284
9376
|
{
|
|
9285
9377
|
"kind": "method",
|
|
@@ -9289,7 +9381,7 @@
|
|
|
9289
9381
|
"text": "boolean"
|
|
9290
9382
|
}
|
|
9291
9383
|
},
|
|
9292
|
-
"description": "
|
|
9384
|
+
"description": "Fires `helix-dismiss`, and returns `false` if a listener cancels it."
|
|
9293
9385
|
},
|
|
9294
9386
|
{
|
|
9295
9387
|
"kind": "method",
|
|
@@ -9317,7 +9409,7 @@
|
|
|
9317
9409
|
"text": "boolean"
|
|
9318
9410
|
},
|
|
9319
9411
|
"default": "false",
|
|
9320
|
-
"description": "Whether
|
|
9412
|
+
"description": "Whether the element shows a control that dismisses it.",
|
|
9321
9413
|
"attribute": "dismissible",
|
|
9322
9414
|
"reflects": true
|
|
9323
9415
|
},
|
|
@@ -9328,7 +9420,7 @@
|
|
|
9328
9420
|
"text": "string"
|
|
9329
9421
|
},
|
|
9330
9422
|
"default": "'Dismiss'",
|
|
9331
|
-
"description": "
|
|
9423
|
+
"description": "The dismiss control's label, read by screen readers.\n\n`attribute` is spelled out because Lit lowercases a property name to\nderive one rather than dash-casing it, so this would otherwise be\nreachable only as `dismisslabel`, which nobody would guess and no linter\nwould catch.",
|
|
9332
9424
|
"attribute": "dismiss-label"
|
|
9333
9425
|
},
|
|
9334
9426
|
{
|
|
@@ -9350,7 +9442,7 @@
|
|
|
9350
9442
|
"text": "boolean"
|
|
9351
9443
|
}
|
|
9352
9444
|
},
|
|
9353
|
-
"description": "
|
|
9445
|
+
"description": "Fires `helix-dismiss`, and returns `false` if a listener cancels it."
|
|
9354
9446
|
}
|
|
9355
9447
|
],
|
|
9356
9448
|
"attributes": [
|
|
@@ -9360,7 +9452,7 @@
|
|
|
9360
9452
|
"text": "boolean"
|
|
9361
9453
|
},
|
|
9362
9454
|
"default": "false",
|
|
9363
|
-
"description": "Whether
|
|
9455
|
+
"description": "Whether the element shows a control that dismisses it.",
|
|
9364
9456
|
"fieldName": "dismissible"
|
|
9365
9457
|
},
|
|
9366
9458
|
{
|
|
@@ -9369,7 +9461,7 @@
|
|
|
9369
9461
|
"text": "string"
|
|
9370
9462
|
},
|
|
9371
9463
|
"default": "'Dismiss'",
|
|
9372
|
-
"description": "
|
|
9464
|
+
"description": "The dismiss control's label, read by screen readers.\n\n`attribute` is spelled out because Lit lowercases a property name to\nderive one rather than dash-casing it, so this would otherwise be\nreachable only as `dismisslabel`, which nobody would guess and no linter\nwould catch.",
|
|
9373
9465
|
"fieldName": "dismissLabel"
|
|
9374
9466
|
}
|
|
9375
9467
|
],
|
|
@@ -9445,7 +9537,7 @@
|
|
|
9445
9537
|
"type": {
|
|
9446
9538
|
"text": "string"
|
|
9447
9539
|
},
|
|
9448
|
-
"description": "Help under the control
|
|
9540
|
+
"description": "Help text shown under the control. A validation message replaces it.\n\nFallback content for the `hint` slot, so anything richer replaces it."
|
|
9449
9541
|
},
|
|
9450
9542
|
{
|
|
9451
9543
|
"kind": "field",
|
|
@@ -9462,7 +9554,7 @@
|
|
|
9462
9554
|
"type": {
|
|
9463
9555
|
"text": "string"
|
|
9464
9556
|
},
|
|
9465
|
-
"description": "
|
|
9557
|
+
"description": "The validation message shown under the control. It replaces the browser's\nmessage.\n\nOverrides the platform's message. Left empty, the platform's own is shown\nonce the reader has had a go at the field, never before. Either way it\ntakes the hint's place rather than appearing under it."
|
|
9466
9558
|
},
|
|
9467
9559
|
{
|
|
9468
9560
|
"kind": "field",
|
|
@@ -9470,7 +9562,7 @@
|
|
|
9470
9562
|
"type": {
|
|
9471
9563
|
"text": "string"
|
|
9472
9564
|
},
|
|
9473
|
-
"description": "The
|
|
9565
|
+
"description": "The field's label, which is also its accessible name. Content in the\n`label` slot replaces it.\n\nContent rather than configuration, so it is the slot's fallback and never a\nsecond thing rendered beside it."
|
|
9474
9566
|
},
|
|
9475
9567
|
{
|
|
9476
9568
|
"kind": "method",
|
|
@@ -9533,7 +9625,7 @@
|
|
|
9533
9625
|
"type": {
|
|
9534
9626
|
"text": "boolean"
|
|
9535
9627
|
},
|
|
9536
|
-
"description": "Whether the
|
|
9628
|
+
"description": "Whether the field needs a value before the form can submit."
|
|
9537
9629
|
},
|
|
9538
9630
|
{
|
|
9539
9631
|
"kind": "method",
|
|
@@ -9603,7 +9695,7 @@
|
|
|
9603
9695
|
"text": "string"
|
|
9604
9696
|
},
|
|
9605
9697
|
"readonly": true,
|
|
9606
|
-
"description": "The message
|
|
9698
|
+
"description": "The validation message shown: yours, the browser's, or none."
|
|
9607
9699
|
},
|
|
9608
9700
|
{
|
|
9609
9701
|
"kind": "field",
|
|
@@ -9611,7 +9703,7 @@
|
|
|
9611
9703
|
"type": {
|
|
9612
9704
|
"text": "string | undefined"
|
|
9613
9705
|
},
|
|
9614
|
-
"description": "
|
|
9706
|
+
"description": "The message shown when the field is required and empty."
|
|
9615
9707
|
}
|
|
9616
9708
|
],
|
|
9617
9709
|
"helix": {}
|
|
@@ -9658,7 +9750,7 @@
|
|
|
9658
9750
|
"text": "string"
|
|
9659
9751
|
},
|
|
9660
9752
|
"default": "''",
|
|
9661
|
-
"description": "
|
|
9753
|
+
"description": "The validation message shown under the control. It replaces the\nbrowser's message.",
|
|
9662
9754
|
"attribute": "feedback"
|
|
9663
9755
|
},
|
|
9664
9756
|
{
|
|
@@ -9668,7 +9760,7 @@
|
|
|
9668
9760
|
"text": "string"
|
|
9669
9761
|
},
|
|
9670
9762
|
"default": "''",
|
|
9671
|
-
"description": "Help under the control
|
|
9763
|
+
"description": "Help text shown under the control. A validation message replaces it.",
|
|
9672
9764
|
"attribute": "hint"
|
|
9673
9765
|
},
|
|
9674
9766
|
{
|
|
@@ -9678,7 +9770,7 @@
|
|
|
9678
9770
|
"text": "string"
|
|
9679
9771
|
},
|
|
9680
9772
|
"default": "''",
|
|
9681
|
-
"description": "The
|
|
9773
|
+
"description": "The field's label, which is also its accessible name. Content in the\n`label` slot replaces it.",
|
|
9682
9774
|
"attribute": "label"
|
|
9683
9775
|
},
|
|
9684
9776
|
{
|
|
@@ -9688,7 +9780,7 @@
|
|
|
9688
9780
|
"text": "boolean"
|
|
9689
9781
|
},
|
|
9690
9782
|
"default": "false",
|
|
9691
|
-
"description": "Whether the
|
|
9783
|
+
"description": "Whether the field needs a value before the form can submit.",
|
|
9692
9784
|
"attribute": "required",
|
|
9693
9785
|
"reflects": true
|
|
9694
9786
|
},
|
|
@@ -9698,7 +9790,7 @@
|
|
|
9698
9790
|
"type": {
|
|
9699
9791
|
"text": "string | undefined"
|
|
9700
9792
|
},
|
|
9701
|
-
"description": "
|
|
9793
|
+
"description": "The message shown when the field is required and empty.\n\n**Absent, or empty, is the control's own sentence**, \"Choose one to continue.\" on a\nset and the browser's own on a text field, which the browser writes in\nthe reader's language. Every other word a control speaks is a property,\nand this one was the English a form in another language still spoke in\nthe bubble it raises on submit: `feedback` replaces the message under\nthe field and does not reach that one.",
|
|
9702
9794
|
"attribute": "value-missing-message"
|
|
9703
9795
|
},
|
|
9704
9796
|
{
|
|
@@ -9855,7 +9947,7 @@
|
|
|
9855
9947
|
"text": "void"
|
|
9856
9948
|
}
|
|
9857
9949
|
},
|
|
9858
|
-
"description": "
|
|
9950
|
+
"description": "Clears the record of the user's edits along with the value, so the field\nshows no error until they edit it again.\n\nThrough the base's prototype rather than `super`, because the base this\ngrafts onto is any element and only a form element has the hook."
|
|
9859
9951
|
}
|
|
9860
9952
|
],
|
|
9861
9953
|
"attributes": [
|
|
@@ -9865,7 +9957,7 @@
|
|
|
9865
9957
|
"text": "string"
|
|
9866
9958
|
},
|
|
9867
9959
|
"default": "''",
|
|
9868
|
-
"description": "
|
|
9960
|
+
"description": "The validation message shown under the control. It replaces the\nbrowser's message.",
|
|
9869
9961
|
"fieldName": "feedback"
|
|
9870
9962
|
},
|
|
9871
9963
|
{
|
|
@@ -9874,7 +9966,7 @@
|
|
|
9874
9966
|
"text": "string"
|
|
9875
9967
|
},
|
|
9876
9968
|
"default": "''",
|
|
9877
|
-
"description": "Help under the control
|
|
9969
|
+
"description": "Help text shown under the control. A validation message replaces it.",
|
|
9878
9970
|
"fieldName": "hint"
|
|
9879
9971
|
},
|
|
9880
9972
|
{
|
|
@@ -9883,7 +9975,7 @@
|
|
|
9883
9975
|
"text": "string"
|
|
9884
9976
|
},
|
|
9885
9977
|
"default": "''",
|
|
9886
|
-
"description": "The
|
|
9978
|
+
"description": "The field's label, which is also its accessible name. Content in the\n`label` slot replaces it.",
|
|
9887
9979
|
"fieldName": "label"
|
|
9888
9980
|
},
|
|
9889
9981
|
{
|
|
@@ -9892,7 +9984,7 @@
|
|
|
9892
9984
|
"text": "boolean"
|
|
9893
9985
|
},
|
|
9894
9986
|
"default": "false",
|
|
9895
|
-
"description": "Whether the
|
|
9987
|
+
"description": "Whether the field needs a value before the form can submit.",
|
|
9896
9988
|
"fieldName": "required"
|
|
9897
9989
|
},
|
|
9898
9990
|
{
|
|
@@ -9900,7 +9992,7 @@
|
|
|
9900
9992
|
"type": {
|
|
9901
9993
|
"text": "string | undefined"
|
|
9902
9994
|
},
|
|
9903
|
-
"description": "
|
|
9995
|
+
"description": "The message shown when the field is required and empty.\n\n**Absent, or empty, is the control's own sentence**, \"Choose one to continue.\" on a\nset and the browser's own on a text field, which the browser writes in\nthe reader's language. Every other word a control speaks is a property,\nand this one was the English a form in another language still spoke in\nthe bubble it raises on submit: `feedback` replaces the message under\nthe field and does not reach that one.",
|
|
9904
9996
|
"fieldName": "valueMissingMessage"
|
|
9905
9997
|
}
|
|
9906
9998
|
],
|
|
@@ -9977,7 +10069,7 @@
|
|
|
9977
10069
|
"type": {
|
|
9978
10070
|
"text": "boolean"
|
|
9979
10071
|
},
|
|
9980
|
-
"description": "Whether the
|
|
10072
|
+
"description": "Whether the value is locked. A read-only control still submits its value."
|
|
9981
10073
|
},
|
|
9982
10074
|
{
|
|
9983
10075
|
"kind": "method",
|
|
@@ -9995,7 +10087,7 @@
|
|
|
9995
10087
|
}
|
|
9996
10088
|
}
|
|
9997
10089
|
],
|
|
9998
|
-
"description": "
|
|
10090
|
+
"description": "Requests a new value. While `readOnly` is set, nothing changes and it\nreturns `false`."
|
|
9999
10091
|
}
|
|
10000
10092
|
],
|
|
10001
10093
|
"helix": {}
|
|
@@ -10012,7 +10104,7 @@
|
|
|
10012
10104
|
"text": "boolean"
|
|
10013
10105
|
},
|
|
10014
10106
|
"default": "false",
|
|
10015
|
-
"description": "Whether the
|
|
10107
|
+
"description": "Whether the value is locked. A read-only control still submits its value.\n\n**Enforced by refusing every request in one place**, which is the seam this\ncomponent already has: `requestValue` is what every path here comes through,\nand gating it once is what stops the next call site from being written\nwithout the check.\n\nNot `disabled`, which is the confusion worth naming: a disabled control\nsubmits nothing and leaves the tab order, and a read-only one submits its\nvalue and stays reachable, which is what a form showing a value somebody\nelse set needs.",
|
|
10016
10108
|
"attribute": "readonly",
|
|
10017
10109
|
"reflects": true
|
|
10018
10110
|
},
|
|
@@ -10042,7 +10134,7 @@
|
|
|
10042
10134
|
}
|
|
10043
10135
|
}
|
|
10044
10136
|
],
|
|
10045
|
-
"description": "
|
|
10137
|
+
"description": "Requests a new value. While `readOnly` is set, nothing changes and it\nreturns `false`."
|
|
10046
10138
|
},
|
|
10047
10139
|
{
|
|
10048
10140
|
"kind": "field",
|
|
@@ -10066,7 +10158,7 @@
|
|
|
10066
10158
|
"text": "boolean"
|
|
10067
10159
|
},
|
|
10068
10160
|
"default": "false",
|
|
10069
|
-
"description": "Whether the
|
|
10161
|
+
"description": "Whether the value is locked. A read-only control still submits its value.\n\n**Enforced by refusing every request in one place**, which is the seam this\ncomponent already has: `requestValue` is what every path here comes through,\nand gating it once is what stops the next call site from being written\nwithout the check.\n\nNot `disabled`, which is the confusion worth naming: a disabled control\nsubmits nothing and leaves the tab order, and a read-only one submits its\nvalue and stays reachable, which is what a form showing a value somebody\nelse set needs.",
|
|
10070
10162
|
"fieldName": "readOnly"
|
|
10071
10163
|
}
|
|
10072
10164
|
],
|
|
@@ -10114,7 +10206,7 @@
|
|
|
10114
10206
|
"type": {
|
|
10115
10207
|
"text": "string | undefined"
|
|
10116
10208
|
},
|
|
10117
|
-
"description": "
|
|
10209
|
+
"description": "The message shown when the field holds text the picker cannot read."
|
|
10118
10210
|
},
|
|
10119
10211
|
{
|
|
10120
10212
|
"kind": "field",
|
|
@@ -10173,7 +10265,7 @@
|
|
|
10173
10265
|
}
|
|
10174
10266
|
}
|
|
10175
10267
|
],
|
|
10176
|
-
"description": "Puts the caret in the field,
|
|
10268
|
+
"description": "Puts the caret in the field, as clicking its label does."
|
|
10177
10269
|
},
|
|
10178
10270
|
{
|
|
10179
10271
|
"kind": "field",
|
|
@@ -10281,7 +10373,7 @@
|
|
|
10281
10373
|
"type": {
|
|
10282
10374
|
"text": "string | undefined"
|
|
10283
10375
|
},
|
|
10284
|
-
"description": "
|
|
10376
|
+
"description": "The message shown when the field holds text the picker cannot read as a\ndate, a time, or a color.\n\n**Every sentence a control raises in the browser's bubble is a\nproperty**, named for the validity flag it reports, so a form in another\nlanguage speaks it. Absent is the family's own sentence, in English,\nwhich says what the value should look like.",
|
|
10285
10377
|
"attribute": "bad-input-message"
|
|
10286
10378
|
},
|
|
10287
10379
|
{
|
|
@@ -10429,7 +10521,7 @@
|
|
|
10429
10521
|
}
|
|
10430
10522
|
}
|
|
10431
10523
|
],
|
|
10432
|
-
"description": "Puts the caret in the field,
|
|
10524
|
+
"description": "Puts the caret in the field, as clicking its label does."
|
|
10433
10525
|
}
|
|
10434
10526
|
],
|
|
10435
10527
|
"attributes": [
|
|
@@ -10438,7 +10530,7 @@
|
|
|
10438
10530
|
"type": {
|
|
10439
10531
|
"text": "string | undefined"
|
|
10440
10532
|
},
|
|
10441
|
-
"description": "
|
|
10533
|
+
"description": "The message shown when the field holds text the picker cannot read as a\ndate, a time, or a color.\n\n**Every sentence a control raises in the browser's bubble is a\nproperty**, named for the validity flag it reports, so a form in another\nlanguage speaks it. Absent is the family's own sentence, in English,\nwhich says what the value should look like.",
|
|
10442
10534
|
"fieldName": "badInputMessage"
|
|
10443
10535
|
}
|
|
10444
10536
|
],
|
|
@@ -10486,7 +10578,7 @@
|
|
|
10486
10578
|
"type": {
|
|
10487
10579
|
"text": "boolean"
|
|
10488
10580
|
},
|
|
10489
|
-
"description": "Whether
|
|
10581
|
+
"description": "Whether the item is disabled and cannot be chosen."
|
|
10490
10582
|
},
|
|
10491
10583
|
{
|
|
10492
10584
|
"kind": "method",
|
|
@@ -10496,7 +10588,7 @@
|
|
|
10496
10588
|
"text": "void"
|
|
10497
10589
|
}
|
|
10498
10590
|
},
|
|
10499
|
-
"description": "Moves focus to the control
|
|
10591
|
+
"description": "Moves focus to the item's control, for the set's arrow keys."
|
|
10500
10592
|
},
|
|
10501
10593
|
{
|
|
10502
10594
|
"kind": "field",
|
|
@@ -10515,7 +10607,7 @@
|
|
|
10515
10607
|
"text": "boolean"
|
|
10516
10608
|
}
|
|
10517
10609
|
},
|
|
10518
|
-
"description": "
|
|
10610
|
+
"description": "Selects the item and fires `helix-select`. Returns `false` if the item is\ndisabled or a listener cancels the event.\n\n`MixinDismissible.dismiss` next door has the same shape and for the same\nreason: a mixin has no family, so the answer to a cancelable event it\ndispatches is read at the dispatch or nowhere. The set acting on the choice\noffers the second refusal on its own root."
|
|
10519
10611
|
},
|
|
10520
10612
|
{
|
|
10521
10613
|
"kind": "field",
|
|
@@ -10523,7 +10615,7 @@
|
|
|
10523
10615
|
"type": {
|
|
10524
10616
|
"text": "boolean"
|
|
10525
10617
|
},
|
|
10526
|
-
"description": "Whether
|
|
10618
|
+
"description": "Whether the item is selected. The parent set updates it."
|
|
10527
10619
|
},
|
|
10528
10620
|
{
|
|
10529
10621
|
"kind": "field",
|
|
@@ -10531,7 +10623,7 @@
|
|
|
10531
10623
|
"type": {
|
|
10532
10624
|
"text": "string"
|
|
10533
10625
|
},
|
|
10534
|
-
"description": "
|
|
10626
|
+
"description": "The item's value, which identifies it in its set and is what a form\nsubmits."
|
|
10535
10627
|
}
|
|
10536
10628
|
],
|
|
10537
10629
|
"helix": {}
|
|
@@ -10548,7 +10640,7 @@
|
|
|
10548
10640
|
"text": "boolean"
|
|
10549
10641
|
},
|
|
10550
10642
|
"default": "false",
|
|
10551
|
-
"description": "Whether
|
|
10643
|
+
"description": "Whether the item is disabled and cannot be chosen.",
|
|
10552
10644
|
"attribute": "disabled",
|
|
10553
10645
|
"reflects": true
|
|
10554
10646
|
},
|
|
@@ -10559,7 +10651,7 @@
|
|
|
10559
10651
|
"text": "boolean"
|
|
10560
10652
|
},
|
|
10561
10653
|
"default": "false",
|
|
10562
|
-
"description": "Whether
|
|
10654
|
+
"description": "Whether the item is selected.\n\nWritten by the set rather than by a consumer, which is why it takes no\ndefault from an attribute here: a family whose selection a consumer\ndeclares in markup carries `defaultSelected` of its own to say so.",
|
|
10563
10655
|
"attribute": "selected"
|
|
10564
10656
|
},
|
|
10565
10657
|
{
|
|
@@ -10569,7 +10661,7 @@
|
|
|
10569
10661
|
"text": "string"
|
|
10570
10662
|
},
|
|
10571
10663
|
"default": "''",
|
|
10572
|
-
"description": "
|
|
10664
|
+
"description": "The item's value, which identifies it in its set and is what a form\nsubmits.",
|
|
10573
10665
|
"attribute": "value"
|
|
10574
10666
|
},
|
|
10575
10667
|
{
|
|
@@ -10590,7 +10682,7 @@
|
|
|
10590
10682
|
"text": "void"
|
|
10591
10683
|
}
|
|
10592
10684
|
},
|
|
10593
|
-
"description": "Moves focus to the control
|
|
10685
|
+
"description": "Moves focus to the item's control, for the set's arrow keys.\n\nThe set drives the keys and cannot reach the control itself, which is\ninside this shadow root, so the intent is a method and the internals stay\nthe item's."
|
|
10594
10686
|
},
|
|
10595
10687
|
{
|
|
10596
10688
|
"kind": "method",
|
|
@@ -10600,7 +10692,7 @@
|
|
|
10600
10692
|
"text": "boolean"
|
|
10601
10693
|
}
|
|
10602
10694
|
},
|
|
10603
|
-
"description": "
|
|
10695
|
+
"description": "Selects the item and fires `helix-select`. Returns `false` if the item is\ndisabled or a listener cancels the event."
|
|
10604
10696
|
}
|
|
10605
10697
|
],
|
|
10606
10698
|
"attributes": [
|
|
@@ -10610,7 +10702,7 @@
|
|
|
10610
10702
|
"text": "boolean"
|
|
10611
10703
|
},
|
|
10612
10704
|
"default": "false",
|
|
10613
|
-
"description": "Whether
|
|
10705
|
+
"description": "Whether the item is disabled and cannot be chosen.",
|
|
10614
10706
|
"fieldName": "disabled"
|
|
10615
10707
|
},
|
|
10616
10708
|
{
|
|
@@ -10619,7 +10711,7 @@
|
|
|
10619
10711
|
"text": "boolean"
|
|
10620
10712
|
},
|
|
10621
10713
|
"default": "false",
|
|
10622
|
-
"description": "Whether
|
|
10714
|
+
"description": "Whether the item is selected.\n\nWritten by the set rather than by a consumer, which is why it takes no\ndefault from an attribute here: a family whose selection a consumer\ndeclares in markup carries `defaultSelected` of its own to say so.",
|
|
10623
10715
|
"fieldName": "selected"
|
|
10624
10716
|
},
|
|
10625
10717
|
{
|
|
@@ -10628,7 +10720,7 @@
|
|
|
10628
10720
|
"text": "string"
|
|
10629
10721
|
},
|
|
10630
10722
|
"default": "''",
|
|
10631
|
-
"description": "
|
|
10723
|
+
"description": "The item's value, which identifies it in its set and is what a form\nsubmits.",
|
|
10632
10724
|
"fieldName": "value"
|
|
10633
10725
|
}
|
|
10634
10726
|
],
|
|
@@ -10684,7 +10776,7 @@
|
|
|
10684
10776
|
"type": {
|
|
10685
10777
|
"text": "boolean"
|
|
10686
10778
|
},
|
|
10687
|
-
"description": "Whether the count is a
|
|
10779
|
+
"description": "Whether the count is a button that shows the hidden tokens.\n\n**Off by default, and that is about focus rather than caution.** The count\nbecomes a real button when this is set, which is a new stop in the tab\norder inside the field. Combobox's whole arrangement is that focus stays in\nthe text while the arrows work the list, so a button appearing between the\ntags and the caret is a change to its keyboard model and not a detail. A\nhost that wants it asks.\n\nLeft off, the count stays the `<span>` it has always been: no tab stop, no\nbehavior, and nothing a consumer is holding changes."
|
|
10688
10780
|
},
|
|
10689
10781
|
{
|
|
10690
10782
|
"kind": "field",
|
|
@@ -10692,7 +10784,7 @@
|
|
|
10692
10784
|
"type": {
|
|
10693
10785
|
"text": "string"
|
|
10694
10786
|
},
|
|
10695
|
-
"description": "
|
|
10787
|
+
"description": "The count button's label, read by screen readers. Its visible text, such\nas `+3`, does not say what it does."
|
|
10696
10788
|
},
|
|
10697
10789
|
{
|
|
10698
10790
|
"kind": "field",
|
|
@@ -10700,7 +10792,7 @@
|
|
|
10700
10792
|
"type": {
|
|
10701
10793
|
"text": "string"
|
|
10702
10794
|
},
|
|
10703
|
-
"description": "
|
|
10795
|
+
"description": "The button's label, read by screen readers, once every token is showing.\n\n**The name and not the words on it**, which are a caret: expanded there is\nno longer a number to show, and a phrase in its place would translate badly\nand change the control's width as it was pressed. The mark is the same size\neither way and this is what says what pressing it does."
|
|
10704
10796
|
},
|
|
10705
10797
|
{
|
|
10706
10798
|
"kind": "field",
|
|
@@ -10807,7 +10899,7 @@
|
|
|
10807
10899
|
"text": "string"
|
|
10808
10900
|
},
|
|
10809
10901
|
"default": "'Show fewer'",
|
|
10810
|
-
"description": "
|
|
10902
|
+
"description": "The button's label, read by screen readers, once every token is showing.",
|
|
10811
10903
|
"attribute": "collapse-label"
|
|
10812
10904
|
},
|
|
10813
10905
|
{
|
|
@@ -10817,7 +10909,7 @@
|
|
|
10817
10909
|
"text": "boolean"
|
|
10818
10910
|
},
|
|
10819
10911
|
"default": "false",
|
|
10820
|
-
"description": "Whether the count is a
|
|
10912
|
+
"description": "Whether the count is a button that shows the hidden tokens.",
|
|
10821
10913
|
"attribute": "expandable"
|
|
10822
10914
|
},
|
|
10823
10915
|
{
|
|
@@ -10827,7 +10919,7 @@
|
|
|
10827
10919
|
"text": "string"
|
|
10828
10920
|
},
|
|
10829
10921
|
"default": "'Show all'",
|
|
10830
|
-
"description": "
|
|
10922
|
+
"description": "The count button's label, read by screen readers. Its visible text, such\nas `+3`, does not say what it does.",
|
|
10831
10923
|
"attribute": "expand-label"
|
|
10832
10924
|
},
|
|
10833
10925
|
{
|
|
@@ -10969,7 +11061,7 @@
|
|
|
10969
11061
|
"text": "string"
|
|
10970
11062
|
},
|
|
10971
11063
|
"default": "'Show fewer'",
|
|
10972
|
-
"description": "
|
|
11064
|
+
"description": "The button's label, read by screen readers, once every token is showing.",
|
|
10973
11065
|
"fieldName": "collapseLabel"
|
|
10974
11066
|
},
|
|
10975
11067
|
{
|
|
@@ -10978,7 +11070,7 @@
|
|
|
10978
11070
|
"text": "boolean"
|
|
10979
11071
|
},
|
|
10980
11072
|
"default": "false",
|
|
10981
|
-
"description": "Whether the count is a
|
|
11073
|
+
"description": "Whether the count is a button that shows the hidden tokens.",
|
|
10982
11074
|
"fieldName": "expandable"
|
|
10983
11075
|
},
|
|
10984
11076
|
{
|
|
@@ -10987,7 +11079,7 @@
|
|
|
10987
11079
|
"text": "string"
|
|
10988
11080
|
},
|
|
10989
11081
|
"default": "'Show all'",
|
|
10990
|
-
"description": "
|
|
11082
|
+
"description": "The count button's label, read by screen readers. Its visible text, such\nas `+3`, does not say what it does.",
|
|
10991
11083
|
"fieldName": "expandLabel"
|
|
10992
11084
|
},
|
|
10993
11085
|
{
|
|
@@ -11044,7 +11136,7 @@
|
|
|
11044
11136
|
"type": {
|
|
11045
11137
|
"text": "string | undefined"
|
|
11046
11138
|
},
|
|
11047
|
-
"description": "Which
|
|
11139
|
+
"description": "Which controls to show, as a list of `pan`, `zoom`, and `fullscreen`, or `none`."
|
|
11048
11140
|
},
|
|
11049
11141
|
{
|
|
11050
11142
|
"kind": "field",
|
|
@@ -11060,7 +11152,7 @@
|
|
|
11060
11152
|
"type": {
|
|
11061
11153
|
"text": "string"
|
|
11062
11154
|
},
|
|
11063
|
-
"description": "
|
|
11155
|
+
"description": "The fullscreen button's label."
|
|
11064
11156
|
},
|
|
11065
11157
|
{
|
|
11066
11158
|
"kind": "field",
|
|
@@ -11068,7 +11160,7 @@
|
|
|
11068
11160
|
"type": {
|
|
11069
11161
|
"text": "number"
|
|
11070
11162
|
},
|
|
11071
|
-
"description": "How long the
|
|
11163
|
+
"description": "How long, in milliseconds, before the header and footer hide when the user is inactive. `0` keeps them visible."
|
|
11072
11164
|
},
|
|
11073
11165
|
{
|
|
11074
11166
|
"kind": "field",
|
|
@@ -11076,7 +11168,7 @@
|
|
|
11076
11168
|
"type": {
|
|
11077
11169
|
"text": "string"
|
|
11078
11170
|
},
|
|
11079
|
-
"description": "
|
|
11171
|
+
"description": "The pan down button's label."
|
|
11080
11172
|
},
|
|
11081
11173
|
{
|
|
11082
11174
|
"kind": "field",
|
|
@@ -11084,7 +11176,7 @@
|
|
|
11084
11176
|
"type": {
|
|
11085
11177
|
"text": "string"
|
|
11086
11178
|
},
|
|
11087
|
-
"description": "
|
|
11179
|
+
"description": "The pan left button's label."
|
|
11088
11180
|
},
|
|
11089
11181
|
{
|
|
11090
11182
|
"kind": "field",
|
|
@@ -11092,7 +11184,7 @@
|
|
|
11092
11184
|
"type": {
|
|
11093
11185
|
"text": "string"
|
|
11094
11186
|
},
|
|
11095
|
-
"description": "
|
|
11187
|
+
"description": "The pan right button's label."
|
|
11096
11188
|
},
|
|
11097
11189
|
{
|
|
11098
11190
|
"kind": "field",
|
|
@@ -11100,7 +11192,7 @@
|
|
|
11100
11192
|
"type": {
|
|
11101
11193
|
"text": "number"
|
|
11102
11194
|
},
|
|
11103
|
-
"description": "How far one press
|
|
11195
|
+
"description": "How far one press pans the view, as a fraction of its size."
|
|
11104
11196
|
},
|
|
11105
11197
|
{
|
|
11106
11198
|
"kind": "field",
|
|
@@ -11108,7 +11200,7 @@
|
|
|
11108
11200
|
"type": {
|
|
11109
11201
|
"text": "string"
|
|
11110
11202
|
},
|
|
11111
|
-
"description": "
|
|
11203
|
+
"description": "The pan up button's label."
|
|
11112
11204
|
},
|
|
11113
11205
|
{
|
|
11114
11206
|
"kind": "field",
|
|
@@ -11116,7 +11208,7 @@
|
|
|
11116
11208
|
"type": {
|
|
11117
11209
|
"text": "string"
|
|
11118
11210
|
},
|
|
11119
|
-
"description": "
|
|
11211
|
+
"description": "The zoom in button's label."
|
|
11120
11212
|
},
|
|
11121
11213
|
{
|
|
11122
11214
|
"kind": "field",
|
|
@@ -11124,7 +11216,7 @@
|
|
|
11124
11216
|
"type": {
|
|
11125
11217
|
"text": "string"
|
|
11126
11218
|
},
|
|
11127
|
-
"description": "
|
|
11219
|
+
"description": "The zoom out button's label."
|
|
11128
11220
|
},
|
|
11129
11221
|
{
|
|
11130
11222
|
"kind": "method",
|
|
@@ -11142,7 +11234,7 @@
|
|
|
11142
11234
|
}
|
|
11143
11235
|
}
|
|
11144
11236
|
],
|
|
11145
|
-
"description": "
|
|
11237
|
+
"description": "Pans the view one step in a direction."
|
|
11146
11238
|
},
|
|
11147
11239
|
{
|
|
11148
11240
|
"kind": "method",
|
|
@@ -11160,7 +11252,7 @@
|
|
|
11160
11252
|
}
|
|
11161
11253
|
}
|
|
11162
11254
|
],
|
|
11163
|
-
"description": "
|
|
11255
|
+
"description": "Zooms the view one step: `1` zooms in and `-1` zooms out."
|
|
11164
11256
|
},
|
|
11165
11257
|
{
|
|
11166
11258
|
"kind": "method",
|
|
@@ -11170,7 +11262,7 @@
|
|
|
11170
11262
|
"text": "void"
|
|
11171
11263
|
}
|
|
11172
11264
|
},
|
|
11173
|
-
"description": "
|
|
11265
|
+
"description": "Turns fullscreen on or off."
|
|
11174
11266
|
},
|
|
11175
11267
|
{
|
|
11176
11268
|
"kind": "field",
|
|
@@ -11225,7 +11317,7 @@
|
|
|
11225
11317
|
"type": {
|
|
11226
11318
|
"text": "string | undefined"
|
|
11227
11319
|
},
|
|
11228
|
-
"description": "
|
|
11320
|
+
"description": "The name of the group of controls, read by screen readers."
|
|
11229
11321
|
},
|
|
11230
11322
|
{
|
|
11231
11323
|
"kind": "field",
|
|
@@ -11320,7 +11412,7 @@
|
|
|
11320
11412
|
"type": {
|
|
11321
11413
|
"text": "string | undefined"
|
|
11322
11414
|
},
|
|
11323
|
-
"description": "Which
|
|
11415
|
+
"description": "Which controls to show, as a list of `pan`, `zoom`, and `fullscreen`, or `none`.\n\n**A list rather than a switch, because the overlap is not symmetric.** A\nsurface a consumer brings often has zoom controls of its own and almost\nnever has pan buttons, so a single switch would make them choose between\na duplicate and nothing.\n\n`none` draws none of them, which is the right answer where what was\nslotted already has controls a reader can find: what this argues for is\nthat *a* findable control exists, never that it is ours. The methods stay\npublic either way, so a consumer drawing their own chrome can still drive\nthe surface.\n\nAbsent is whatever the family rests at, which is this library's rule that\na resting value is an attribute's absence: all three for a map, whose\nreader may have no other way to move it, and zoom and fullscreen for a\nboard, which a reader drags and whose pad took a third of the frame. The\nstylesheet lays the cluster out by which buttons are in it rather than by\nthis attribute, so the two defaults need no rule each.",
|
|
11324
11416
|
"attribute": "controls",
|
|
11325
11417
|
"reflects": true
|
|
11326
11418
|
},
|
|
@@ -11330,7 +11422,7 @@
|
|
|
11330
11422
|
"type": {
|
|
11331
11423
|
"text": "string | undefined"
|
|
11332
11424
|
},
|
|
11333
|
-
"description": "
|
|
11425
|
+
"description": "The name of the group of controls, read by screen readers.\n\nAbsent is the family's own name for it, \"Map controls\" or \"Board\ncontrols\", which names what the controls drive rather than the\nmechanism. Written here to say it in another language, which every other\nstring this surface speaks already allowed and this one did not.",
|
|
11334
11426
|
"attribute": "controls-label"
|
|
11335
11427
|
},
|
|
11336
11428
|
{
|
|
@@ -11350,7 +11442,7 @@
|
|
|
11350
11442
|
"text": "string"
|
|
11351
11443
|
},
|
|
11352
11444
|
"default": "'Fill the screen'",
|
|
11353
|
-
"description": "
|
|
11445
|
+
"description": "The fullscreen button's label.",
|
|
11354
11446
|
"attribute": "fullscreen-label"
|
|
11355
11447
|
},
|
|
11356
11448
|
{
|
|
@@ -11360,7 +11452,7 @@
|
|
|
11360
11452
|
"text": "number"
|
|
11361
11453
|
},
|
|
11362
11454
|
"default": "0",
|
|
11363
|
-
"description": "How long the
|
|
11455
|
+
"description": "How long, in milliseconds, before the header and footer hide when the user is inactive. `0` keeps them visible.\n\nZero keeps it up, which is the default: these controls are how a keyboard\nreader operates the surface, and chrome that hid itself by default would\nbe the component undoing its own argument. Set it for a display nobody\ndrives.",
|
|
11364
11456
|
"attribute": "idle-delay"
|
|
11365
11457
|
},
|
|
11366
11458
|
{
|
|
@@ -11370,7 +11462,7 @@
|
|
|
11370
11462
|
"text": "string"
|
|
11371
11463
|
},
|
|
11372
11464
|
"default": "'Pan down'",
|
|
11373
|
-
"description": "
|
|
11465
|
+
"description": "The pan down button's label.\n\n**A label for each way rather than one with the way filled in**, which is\nwhat this was: `Pan {way}` filled in with `left`, so a page that said it\nin French read out \"Déplacer left\". The word for a direction is as much\nthe translator's as the word for panning, and a language can put it\nanywhere in the phrase.",
|
|
11374
11466
|
"attribute": "pan-down-label"
|
|
11375
11467
|
},
|
|
11376
11468
|
{
|
|
@@ -11380,7 +11472,7 @@
|
|
|
11380
11472
|
"text": "string"
|
|
11381
11473
|
},
|
|
11382
11474
|
"default": "'Pan left'",
|
|
11383
|
-
"description": "
|
|
11475
|
+
"description": "The pan left button's label.",
|
|
11384
11476
|
"attribute": "pan-left-label"
|
|
11385
11477
|
},
|
|
11386
11478
|
{
|
|
@@ -11390,7 +11482,7 @@
|
|
|
11390
11482
|
"text": "string"
|
|
11391
11483
|
},
|
|
11392
11484
|
"default": "'Pan right'",
|
|
11393
|
-
"description": "
|
|
11485
|
+
"description": "The pan right button's label.",
|
|
11394
11486
|
"attribute": "pan-right-label"
|
|
11395
11487
|
},
|
|
11396
11488
|
{
|
|
@@ -11400,7 +11492,7 @@
|
|
|
11400
11492
|
"text": "number"
|
|
11401
11493
|
},
|
|
11402
11494
|
"default": "0.25",
|
|
11403
|
-
"description": "How far one press
|
|
11495
|
+
"description": "How far one press pans the view, as a fraction of its size.\n\nA fraction rather than a distance, because this surface does not know the\nscale of what is inside it: a quarter of the viewport is the same gesture\nat any zoom, and a consumer who wants their own units multiplies by them.",
|
|
11404
11496
|
"attribute": "pan-step"
|
|
11405
11497
|
},
|
|
11406
11498
|
{
|
|
@@ -11410,7 +11502,7 @@
|
|
|
11410
11502
|
"text": "string"
|
|
11411
11503
|
},
|
|
11412
11504
|
"default": "'Pan up'",
|
|
11413
|
-
"description": "
|
|
11505
|
+
"description": "The pan up button's label.",
|
|
11414
11506
|
"attribute": "pan-up-label"
|
|
11415
11507
|
},
|
|
11416
11508
|
{
|
|
@@ -11420,7 +11512,7 @@
|
|
|
11420
11512
|
"text": "string"
|
|
11421
11513
|
},
|
|
11422
11514
|
"default": "'Zoom in'",
|
|
11423
|
-
"description": "
|
|
11515
|
+
"description": "The zoom in button's label.",
|
|
11424
11516
|
"attribute": "zoom-in-label"
|
|
11425
11517
|
},
|
|
11426
11518
|
{
|
|
@@ -11464,7 +11556,7 @@
|
|
|
11464
11556
|
"text": "string"
|
|
11465
11557
|
},
|
|
11466
11558
|
"default": "'Zoom out'",
|
|
11467
|
-
"description": "
|
|
11559
|
+
"description": "The zoom out button's label.",
|
|
11468
11560
|
"attribute": "zoom-out-label"
|
|
11469
11561
|
},
|
|
11470
11562
|
{
|
|
@@ -11531,7 +11623,7 @@
|
|
|
11531
11623
|
}
|
|
11532
11624
|
}
|
|
11533
11625
|
],
|
|
11534
|
-
"description": "
|
|
11626
|
+
"description": "Pans the view one step in a direction."
|
|
11535
11627
|
},
|
|
11536
11628
|
{
|
|
11537
11629
|
"kind": "method",
|
|
@@ -11549,7 +11641,7 @@
|
|
|
11549
11641
|
}
|
|
11550
11642
|
}
|
|
11551
11643
|
],
|
|
11552
|
-
"description": "
|
|
11644
|
+
"description": "Zooms the view one step: `1` zooms in and `-1` zooms out."
|
|
11553
11645
|
},
|
|
11554
11646
|
{
|
|
11555
11647
|
"kind": "method",
|
|
@@ -11559,7 +11651,7 @@
|
|
|
11559
11651
|
"text": "void"
|
|
11560
11652
|
}
|
|
11561
11653
|
},
|
|
11562
|
-
"description": "
|
|
11654
|
+
"description": "Turns fullscreen on or off."
|
|
11563
11655
|
},
|
|
11564
11656
|
{
|
|
11565
11657
|
"kind": "field",
|
|
@@ -11692,7 +11784,7 @@
|
|
|
11692
11784
|
"type": {
|
|
11693
11785
|
"text": "string | undefined"
|
|
11694
11786
|
},
|
|
11695
|
-
"description": "Which
|
|
11787
|
+
"description": "Which controls to show, as a list of `pan`, `zoom`, and `fullscreen`, or `none`.\n\n**A list rather than a switch, because the overlap is not symmetric.** A\nsurface a consumer brings often has zoom controls of its own and almost\nnever has pan buttons, so a single switch would make them choose between\na duplicate and nothing.\n\n`none` draws none of them, which is the right answer where what was\nslotted already has controls a reader can find: what this argues for is\nthat *a* findable control exists, never that it is ours. The methods stay\npublic either way, so a consumer drawing their own chrome can still drive\nthe surface.\n\nAbsent is whatever the family rests at, which is this library's rule that\na resting value is an attribute's absence: all three for a map, whose\nreader may have no other way to move it, and zoom and fullscreen for a\nboard, which a reader drags and whose pad took a third of the frame. The\nstylesheet lays the cluster out by which buttons are in it rather than by\nthis attribute, so the two defaults need no rule each.",
|
|
11696
11788
|
"fieldName": "controls"
|
|
11697
11789
|
},
|
|
11698
11790
|
{
|
|
@@ -11700,7 +11792,7 @@
|
|
|
11700
11792
|
"type": {
|
|
11701
11793
|
"text": "string | undefined"
|
|
11702
11794
|
},
|
|
11703
|
-
"description": "
|
|
11795
|
+
"description": "The name of the group of controls, read by screen readers.\n\nAbsent is the family's own name for it, \"Map controls\" or \"Board\ncontrols\", which names what the controls drive rather than the\nmechanism. Written here to say it in another language, which every other\nstring this surface speaks already allowed and this one did not.",
|
|
11704
11796
|
"fieldName": "controlsLabel"
|
|
11705
11797
|
},
|
|
11706
11798
|
{
|
|
@@ -11717,7 +11809,7 @@
|
|
|
11717
11809
|
"text": "string"
|
|
11718
11810
|
},
|
|
11719
11811
|
"default": "'Fill the screen'",
|
|
11720
|
-
"description": "
|
|
11812
|
+
"description": "The fullscreen button's label.",
|
|
11721
11813
|
"fieldName": "fullscreenLabel"
|
|
11722
11814
|
},
|
|
11723
11815
|
{
|
|
@@ -11726,7 +11818,7 @@
|
|
|
11726
11818
|
"text": "number"
|
|
11727
11819
|
},
|
|
11728
11820
|
"default": "0",
|
|
11729
|
-
"description": "How long the
|
|
11821
|
+
"description": "How long, in milliseconds, before the header and footer hide when the user is inactive. `0` keeps them visible.\n\nZero keeps it up, which is the default: these controls are how a keyboard\nreader operates the surface, and chrome that hid itself by default would\nbe the component undoing its own argument. Set it for a display nobody\ndrives.",
|
|
11730
11822
|
"fieldName": "idleDelay"
|
|
11731
11823
|
},
|
|
11732
11824
|
{
|
|
@@ -11735,7 +11827,7 @@
|
|
|
11735
11827
|
"text": "string"
|
|
11736
11828
|
},
|
|
11737
11829
|
"default": "'Pan down'",
|
|
11738
|
-
"description": "
|
|
11830
|
+
"description": "The pan down button's label.\n\n**A label for each way rather than one with the way filled in**, which is\nwhat this was: `Pan {way}` filled in with `left`, so a page that said it\nin French read out \"Déplacer left\". The word for a direction is as much\nthe translator's as the word for panning, and a language can put it\nanywhere in the phrase.",
|
|
11739
11831
|
"fieldName": "panDownLabel"
|
|
11740
11832
|
},
|
|
11741
11833
|
{
|
|
@@ -11744,7 +11836,7 @@
|
|
|
11744
11836
|
"text": "string"
|
|
11745
11837
|
},
|
|
11746
11838
|
"default": "'Pan left'",
|
|
11747
|
-
"description": "
|
|
11839
|
+
"description": "The pan left button's label.",
|
|
11748
11840
|
"fieldName": "panLeftLabel"
|
|
11749
11841
|
},
|
|
11750
11842
|
{
|
|
@@ -11753,7 +11845,7 @@
|
|
|
11753
11845
|
"text": "string"
|
|
11754
11846
|
},
|
|
11755
11847
|
"default": "'Pan right'",
|
|
11756
|
-
"description": "
|
|
11848
|
+
"description": "The pan right button's label.",
|
|
11757
11849
|
"fieldName": "panRightLabel"
|
|
11758
11850
|
},
|
|
11759
11851
|
{
|
|
@@ -11762,7 +11854,7 @@
|
|
|
11762
11854
|
"text": "number"
|
|
11763
11855
|
},
|
|
11764
11856
|
"default": "0.25",
|
|
11765
|
-
"description": "How far one press
|
|
11857
|
+
"description": "How far one press pans the view, as a fraction of its size.\n\nA fraction rather than a distance, because this surface does not know the\nscale of what is inside it: a quarter of the viewport is the same gesture\nat any zoom, and a consumer who wants their own units multiplies by them.",
|
|
11766
11858
|
"fieldName": "panStep"
|
|
11767
11859
|
},
|
|
11768
11860
|
{
|
|
@@ -11771,7 +11863,7 @@
|
|
|
11771
11863
|
"text": "string"
|
|
11772
11864
|
},
|
|
11773
11865
|
"default": "'Pan up'",
|
|
11774
|
-
"description": "
|
|
11866
|
+
"description": "The pan up button's label.",
|
|
11775
11867
|
"fieldName": "panUpLabel"
|
|
11776
11868
|
},
|
|
11777
11869
|
{
|
|
@@ -11780,7 +11872,7 @@
|
|
|
11780
11872
|
"text": "string"
|
|
11781
11873
|
},
|
|
11782
11874
|
"default": "'Zoom in'",
|
|
11783
|
-
"description": "
|
|
11875
|
+
"description": "The zoom in button's label.",
|
|
11784
11876
|
"fieldName": "zoomInLabel"
|
|
11785
11877
|
},
|
|
11786
11878
|
{
|
|
@@ -11789,7 +11881,7 @@
|
|
|
11789
11881
|
"text": "string"
|
|
11790
11882
|
},
|
|
11791
11883
|
"default": "'Zoom out'",
|
|
11792
|
-
"description": "
|
|
11884
|
+
"description": "The zoom out button's label.",
|
|
11793
11885
|
"fieldName": "zoomOutLabel"
|
|
11794
11886
|
}
|
|
11795
11887
|
],
|