@fusion.dev/helix-core 0.104.1 → 0.106.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 +475 -174
- package/dist/controllers/floating-controller/floating-controller.d.ts +3 -3
- package/dist/events/events.d.ts +83 -0
- package/dist/events/events.js +48 -0
- package/dist/helix-element/helix-element.d.ts +10 -9
- package/dist/helix-form-element/helix-form-element.d.ts +13 -14
- 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 +24 -14
- package/dist/mixins/mixin-viewport/mixin-viewport.js +27 -15
- 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,94 @@
|
|
|
3625
3625
|
},
|
|
3626
3626
|
"helix": {}
|
|
3627
3627
|
},
|
|
3628
|
+
{
|
|
3629
|
+
"kind": "class",
|
|
3630
|
+
"description": "The user asked the map to rotate, from a rotate button or key. Turn your map\nin response. Not cancelable, because the frame moves nothing itself.",
|
|
3631
|
+
"name": "HelixMapRotateEvent",
|
|
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-rotate'"
|
|
3642
|
+
}
|
|
3643
|
+
],
|
|
3644
|
+
"superclass": {
|
|
3645
|
+
"name": "CustomEvent",
|
|
3646
|
+
"module": "src/events/events.ts"
|
|
3647
|
+
},
|
|
3648
|
+
"helix": {}
|
|
3649
|
+
},
|
|
3650
|
+
{
|
|
3651
|
+
"kind": "class",
|
|
3652
|
+
"description": "The user asked the map to tilt, from a tilt button or key. Tilt your map in\nresponse. Not cancelable, because the frame moves nothing itself.",
|
|
3653
|
+
"name": "HelixMapTiltEvent",
|
|
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-tilt'"
|
|
3664
|
+
}
|
|
3665
|
+
],
|
|
3666
|
+
"superclass": {
|
|
3667
|
+
"name": "CustomEvent",
|
|
3668
|
+
"module": "src/events/events.ts"
|
|
3669
|
+
},
|
|
3670
|
+
"helix": {}
|
|
3671
|
+
},
|
|
3672
|
+
{
|
|
3673
|
+
"kind": "class",
|
|
3674
|
+
"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.",
|
|
3675
|
+
"name": "HelixMapPartChangeEvent",
|
|
3676
|
+
"members": [
|
|
3677
|
+
{
|
|
3678
|
+
"kind": "field",
|
|
3679
|
+
"name": "eventName",
|
|
3680
|
+
"type": {
|
|
3681
|
+
"text": "string"
|
|
3682
|
+
},
|
|
3683
|
+
"static": true,
|
|
3684
|
+
"readonly": true,
|
|
3685
|
+
"default": "'helix-map-part-change'"
|
|
3686
|
+
}
|
|
3687
|
+
],
|
|
3688
|
+
"superclass": {
|
|
3689
|
+
"name": "CustomEvent",
|
|
3690
|
+
"module": "src/events/events.ts"
|
|
3691
|
+
},
|
|
3692
|
+
"helix": {}
|
|
3693
|
+
},
|
|
3694
|
+
{
|
|
3695
|
+
"kind": "class",
|
|
3696
|
+
"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.",
|
|
3697
|
+
"name": "HelixMapClusterEvent",
|
|
3698
|
+
"members": [
|
|
3699
|
+
{
|
|
3700
|
+
"kind": "field",
|
|
3701
|
+
"name": "eventName",
|
|
3702
|
+
"type": {
|
|
3703
|
+
"text": "string"
|
|
3704
|
+
},
|
|
3705
|
+
"static": true,
|
|
3706
|
+
"readonly": true,
|
|
3707
|
+
"default": "'helix-map-cluster'"
|
|
3708
|
+
}
|
|
3709
|
+
],
|
|
3710
|
+
"superclass": {
|
|
3711
|
+
"name": "CustomEvent",
|
|
3712
|
+
"module": "src/events/events.ts"
|
|
3713
|
+
},
|
|
3714
|
+
"helix": {}
|
|
3715
|
+
},
|
|
3628
3716
|
{
|
|
3629
3717
|
"kind": "class",
|
|
3630
3718
|
"description": "A message is about to be pinned or unpinned, and can be refused.",
|
|
@@ -4378,6 +4466,38 @@
|
|
|
4378
4466
|
"module": "src/events/events.ts"
|
|
4379
4467
|
}
|
|
4380
4468
|
},
|
|
4469
|
+
{
|
|
4470
|
+
"kind": "js",
|
|
4471
|
+
"name": "HelixMapRotateEvent",
|
|
4472
|
+
"declaration": {
|
|
4473
|
+
"name": "HelixMapRotateEvent",
|
|
4474
|
+
"module": "src/events/events.ts"
|
|
4475
|
+
}
|
|
4476
|
+
},
|
|
4477
|
+
{
|
|
4478
|
+
"kind": "js",
|
|
4479
|
+
"name": "HelixMapTiltEvent",
|
|
4480
|
+
"declaration": {
|
|
4481
|
+
"name": "HelixMapTiltEvent",
|
|
4482
|
+
"module": "src/events/events.ts"
|
|
4483
|
+
}
|
|
4484
|
+
},
|
|
4485
|
+
{
|
|
4486
|
+
"kind": "js",
|
|
4487
|
+
"name": "HelixMapPartChangeEvent",
|
|
4488
|
+
"declaration": {
|
|
4489
|
+
"name": "HelixMapPartChangeEvent",
|
|
4490
|
+
"module": "src/events/events.ts"
|
|
4491
|
+
}
|
|
4492
|
+
},
|
|
4493
|
+
{
|
|
4494
|
+
"kind": "js",
|
|
4495
|
+
"name": "HelixMapClusterEvent",
|
|
4496
|
+
"declaration": {
|
|
4497
|
+
"name": "HelixMapClusterEvent",
|
|
4498
|
+
"module": "src/events/events.ts"
|
|
4499
|
+
}
|
|
4500
|
+
},
|
|
4381
4501
|
{
|
|
4382
4502
|
"kind": "js",
|
|
4383
4503
|
"name": "HelixBeforePinEvent",
|
|
@@ -4594,7 +4714,7 @@
|
|
|
4594
4714
|
"declarations": [
|
|
4595
4715
|
{
|
|
4596
4716
|
"kind": "class",
|
|
4597
|
-
"description": "
|
|
4717
|
+
"description": "Handles only what every component needs: it sets `box-sizing` inside the\nshadow root, so component CSS can rely on border-box on both sides of the\nboundary.\n\nThere is no `emit(name, detail)` helper. The manifest analyzer cannot name an\nevent dispatched through a generic helper, so components dispatch the\nconcrete event classes from `events.ts`, which the analyzer and TypeScript\ncan both read.",
|
|
4598
4718
|
"name": "HelixElement",
|
|
4599
4719
|
"members": [
|
|
4600
4720
|
{
|
|
@@ -4853,7 +4973,7 @@
|
|
|
4853
4973
|
"events": [],
|
|
4854
4974
|
"cssStates": [
|
|
4855
4975
|
{
|
|
4856
|
-
"description": "Set
|
|
4976
|
+
"description": "Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.",
|
|
4857
4977
|
"name": "settled"
|
|
4858
4978
|
}
|
|
4859
4979
|
],
|
|
@@ -5069,7 +5189,7 @@
|
|
|
5069
5189
|
"declarations": [
|
|
5070
5190
|
{
|
|
5071
5191
|
"kind": "class",
|
|
5072
|
-
"description": "
|
|
5192
|
+
"description": "`HelixFormElement` is a class because the browser reads `formAssociated` from\nthe constructor during element upgrade, and a mixin or controller cannot\nsupply it.\n\n`internals` comes from `HelixElement`, which attaches it for every component.\n`attachInternals()` throws on a second call, so only one class attaches it.\n\nThe class carries only what every form participant needs. `value`, validity,\nand the reset and restore callbacks are added with the first input component.",
|
|
5073
5193
|
"name": "HelixFormElement",
|
|
5074
5194
|
"members": [
|
|
5075
5195
|
{
|
|
@@ -5090,7 +5210,7 @@
|
|
|
5090
5210
|
"text": "boolean"
|
|
5091
5211
|
},
|
|
5092
5212
|
"default": "false",
|
|
5093
|
-
"description": "Whether the control is
|
|
5213
|
+
"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
5214
|
"attribute": "disabled",
|
|
5095
5215
|
"reflects": true
|
|
5096
5216
|
},
|
|
@@ -5120,7 +5240,7 @@
|
|
|
5120
5240
|
}
|
|
5121
5241
|
}
|
|
5122
5242
|
],
|
|
5123
|
-
"description": "
|
|
5243
|
+
"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
5244
|
},
|
|
5125
5245
|
{
|
|
5126
5246
|
"kind": "method",
|
|
@@ -5130,7 +5250,7 @@
|
|
|
5130
5250
|
"text": "void"
|
|
5131
5251
|
}
|
|
5132
5252
|
},
|
|
5133
|
-
"description": "
|
|
5253
|
+
"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
5254
|
},
|
|
5135
5255
|
{
|
|
5136
5256
|
"kind": "method",
|
|
@@ -5161,7 +5281,7 @@
|
|
|
5161
5281
|
"text": "string"
|
|
5162
5282
|
},
|
|
5163
5283
|
"default": "''",
|
|
5164
|
-
"description": "
|
|
5284
|
+
"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
5285
|
"attribute": "name",
|
|
5166
5286
|
"reflects": true
|
|
5167
5287
|
},
|
|
@@ -5171,7 +5291,7 @@
|
|
|
5171
5291
|
"type": {
|
|
5172
5292
|
"text": "HTMLFormElement | null"
|
|
5173
5293
|
},
|
|
5174
|
-
"description": "The form
|
|
5294
|
+
"description": "The form the control belongs to, or `null`.",
|
|
5175
5295
|
"readonly": true,
|
|
5176
5296
|
"helix": {
|
|
5177
5297
|
"references": [
|
|
@@ -5188,7 +5308,7 @@
|
|
|
5188
5308
|
"type": {
|
|
5189
5309
|
"text": "NodeList"
|
|
5190
5310
|
},
|
|
5191
|
-
"description": "
|
|
5311
|
+
"description": "The labels associated with the control.",
|
|
5192
5312
|
"readonly": true,
|
|
5193
5313
|
"helix": {
|
|
5194
5314
|
"references": [
|
|
@@ -5532,7 +5652,7 @@
|
|
|
5532
5652
|
"text": "boolean"
|
|
5533
5653
|
},
|
|
5534
5654
|
"default": "false",
|
|
5535
|
-
"description": "Whether the control is
|
|
5655
|
+
"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
5656
|
"fieldName": "disabled"
|
|
5537
5657
|
},
|
|
5538
5658
|
{
|
|
@@ -5541,7 +5661,7 @@
|
|
|
5541
5661
|
"text": "string"
|
|
5542
5662
|
},
|
|
5543
5663
|
"default": "''",
|
|
5544
|
-
"description": "
|
|
5664
|
+
"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
5665
|
"fieldName": "name"
|
|
5546
5666
|
}
|
|
5547
5667
|
],
|
|
@@ -5558,7 +5678,7 @@
|
|
|
5558
5678
|
},
|
|
5559
5679
|
"cssStates": [
|
|
5560
5680
|
{
|
|
5561
|
-
"description": "Set
|
|
5681
|
+
"description": "Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.",
|
|
5562
5682
|
"name": "settled",
|
|
5563
5683
|
"inheritedFrom": {
|
|
5564
5684
|
"name": "HelixElement",
|
|
@@ -6352,6 +6472,14 @@
|
|
|
6352
6472
|
"module": "./events/events.js"
|
|
6353
6473
|
}
|
|
6354
6474
|
},
|
|
6475
|
+
{
|
|
6476
|
+
"kind": "js",
|
|
6477
|
+
"name": "HelixMapClusterEvent",
|
|
6478
|
+
"declaration": {
|
|
6479
|
+
"name": "HelixMapClusterEvent",
|
|
6480
|
+
"module": "./events/events.js"
|
|
6481
|
+
}
|
|
6482
|
+
},
|
|
6355
6483
|
{
|
|
6356
6484
|
"kind": "js",
|
|
6357
6485
|
"name": "HelixMapPanEvent",
|
|
@@ -6360,6 +6488,30 @@
|
|
|
6360
6488
|
"module": "./events/events.js"
|
|
6361
6489
|
}
|
|
6362
6490
|
},
|
|
6491
|
+
{
|
|
6492
|
+
"kind": "js",
|
|
6493
|
+
"name": "HelixMapPartChangeEvent",
|
|
6494
|
+
"declaration": {
|
|
6495
|
+
"name": "HelixMapPartChangeEvent",
|
|
6496
|
+
"module": "./events/events.js"
|
|
6497
|
+
}
|
|
6498
|
+
},
|
|
6499
|
+
{
|
|
6500
|
+
"kind": "js",
|
|
6501
|
+
"name": "HelixMapRotateEvent",
|
|
6502
|
+
"declaration": {
|
|
6503
|
+
"name": "HelixMapRotateEvent",
|
|
6504
|
+
"module": "./events/events.js"
|
|
6505
|
+
}
|
|
6506
|
+
},
|
|
6507
|
+
{
|
|
6508
|
+
"kind": "js",
|
|
6509
|
+
"name": "HelixMapTiltEvent",
|
|
6510
|
+
"declaration": {
|
|
6511
|
+
"name": "HelixMapTiltEvent",
|
|
6512
|
+
"module": "./events/events.js"
|
|
6513
|
+
}
|
|
6514
|
+
},
|
|
6363
6515
|
{
|
|
6364
6516
|
"kind": "js",
|
|
6365
6517
|
"name": "HelixMapZoomEvent",
|
|
@@ -6512,6 +6664,14 @@
|
|
|
6512
6664
|
"module": "./events/events.js"
|
|
6513
6665
|
}
|
|
6514
6666
|
},
|
|
6667
|
+
{
|
|
6668
|
+
"kind": "js",
|
|
6669
|
+
"name": "MapClusterDetail",
|
|
6670
|
+
"declaration": {
|
|
6671
|
+
"name": "MapClusterDetail",
|
|
6672
|
+
"module": "./events/events.js"
|
|
6673
|
+
}
|
|
6674
|
+
},
|
|
6515
6675
|
{
|
|
6516
6676
|
"kind": "js",
|
|
6517
6677
|
"name": "MapPanDetail",
|
|
@@ -6520,6 +6680,30 @@
|
|
|
6520
6680
|
"module": "./events/events.js"
|
|
6521
6681
|
}
|
|
6522
6682
|
},
|
|
6683
|
+
{
|
|
6684
|
+
"kind": "js",
|
|
6685
|
+
"name": "MapPartChangeDetail",
|
|
6686
|
+
"declaration": {
|
|
6687
|
+
"name": "MapPartChangeDetail",
|
|
6688
|
+
"module": "./events/events.js"
|
|
6689
|
+
}
|
|
6690
|
+
},
|
|
6691
|
+
{
|
|
6692
|
+
"kind": "js",
|
|
6693
|
+
"name": "MapRotateDetail",
|
|
6694
|
+
"declaration": {
|
|
6695
|
+
"name": "MapRotateDetail",
|
|
6696
|
+
"module": "./events/events.js"
|
|
6697
|
+
}
|
|
6698
|
+
},
|
|
6699
|
+
{
|
|
6700
|
+
"kind": "js",
|
|
6701
|
+
"name": "MapTiltDetail",
|
|
6702
|
+
"declaration": {
|
|
6703
|
+
"name": "MapTiltDetail",
|
|
6704
|
+
"module": "./events/events.js"
|
|
6705
|
+
}
|
|
6706
|
+
},
|
|
6523
6707
|
{
|
|
6524
6708
|
"kind": "js",
|
|
6525
6709
|
"name": "MapZoomDetail",
|
|
@@ -7723,7 +7907,7 @@
|
|
|
7723
7907
|
"name": "MixinChartSourceInterface",
|
|
7724
7908
|
"cssProperties": [
|
|
7725
7909
|
{
|
|
7726
|
-
"description": "The color of the mark
|
|
7910
|
+
"description": "The color of the mark it is set on. The component sets it, and the stylesheet reads it.",
|
|
7727
7911
|
"name": "--chart-series"
|
|
7728
7912
|
},
|
|
7729
7913
|
{
|
|
@@ -7838,7 +8022,7 @@
|
|
|
7838
8022
|
"type": {
|
|
7839
8023
|
"text": "string"
|
|
7840
8024
|
},
|
|
7841
|
-
"description": "The
|
|
8025
|
+
"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
8026
|
},
|
|
7843
8027
|
{
|
|
7844
8028
|
"kind": "field",
|
|
@@ -7846,7 +8030,7 @@
|
|
|
7846
8030
|
"type": {
|
|
7847
8031
|
"text": "Series[]"
|
|
7848
8032
|
},
|
|
7849
|
-
"description": "The columns
|
|
8033
|
+
"description": "The table's columns, one series each. Empty when there is no table.",
|
|
7850
8034
|
"readonly": true
|
|
7851
8035
|
},
|
|
7852
8036
|
{
|
|
@@ -7855,7 +8039,7 @@
|
|
|
7855
8039
|
"type": {
|
|
7856
8040
|
"text": "string"
|
|
7857
8041
|
},
|
|
7858
|
-
"description": "
|
|
8042
|
+
"description": "The chart's name: `label` when it is set, and the table's caption\notherwise.",
|
|
7859
8043
|
"readonly": true
|
|
7860
8044
|
},
|
|
7861
8045
|
{
|
|
@@ -7864,7 +8048,7 @@
|
|
|
7864
8048
|
"type": {
|
|
7865
8049
|
"text": "Row[]"
|
|
7866
8050
|
},
|
|
7867
|
-
"description": "Every row of the table, with each cell's text
|
|
8051
|
+
"description": "Every row of the table, with each cell's text and number.",
|
|
7868
8052
|
"readonly": true
|
|
7869
8053
|
},
|
|
7870
8054
|
{
|
|
@@ -7873,7 +8057,7 @@
|
|
|
7873
8057
|
"type": {
|
|
7874
8058
|
"text": "number[]"
|
|
7875
8059
|
},
|
|
7876
|
-
"description": "
|
|
8060
|
+
"description": "The positions of the cells in a row that hold numbers, in table order.",
|
|
7877
8061
|
"readonly": true
|
|
7878
8062
|
},
|
|
7879
8063
|
{
|
|
@@ -7892,7 +8076,7 @@
|
|
|
7892
8076
|
}
|
|
7893
8077
|
}
|
|
7894
8078
|
],
|
|
7895
|
-
"description": "The palette slot the cell at this
|
|
8079
|
+
"description": "The palette slot for the cell at this position in a row, or `undefined`\nwhen no series was read from that column."
|
|
7896
8080
|
},
|
|
7897
8081
|
{
|
|
7898
8082
|
"kind": "field",
|
|
@@ -7900,7 +8084,7 @@
|
|
|
7900
8084
|
"type": {
|
|
7901
8085
|
"text": "number"
|
|
7902
8086
|
},
|
|
7903
|
-
"description": "
|
|
8087
|
+
"description": "The number of readings, which the pointer position maps onto.",
|
|
7904
8088
|
"readonly": true
|
|
7905
8089
|
},
|
|
7906
8090
|
{
|
|
@@ -7909,7 +8093,7 @@
|
|
|
7909
8093
|
"type": {
|
|
7910
8094
|
"text": "ChartPointerController"
|
|
7911
8095
|
},
|
|
7912
|
-
"description": "
|
|
8096
|
+
"description": "Finds the reading nearest the pointer, so the tooltip can sit on it."
|
|
7913
8097
|
}
|
|
7914
8098
|
],
|
|
7915
8099
|
"helix": {}
|
|
@@ -7932,7 +8116,7 @@
|
|
|
7932
8116
|
"name": "pointer",
|
|
7933
8117
|
"readonly": true,
|
|
7934
8118
|
"default": "new ChartPointerController(this)",
|
|
7935
|
-
"description": "
|
|
8119
|
+
"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
8120
|
},
|
|
7937
8121
|
{
|
|
7938
8122
|
"kind": "field",
|
|
@@ -7951,7 +8135,7 @@
|
|
|
7951
8135
|
"text": "string"
|
|
7952
8136
|
},
|
|
7953
8137
|
"default": "''",
|
|
7954
|
-
"description": "The
|
|
8138
|
+
"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
8139
|
"attribute": "label"
|
|
7956
8140
|
},
|
|
7957
8141
|
{
|
|
@@ -7960,7 +8144,7 @@
|
|
|
7960
8144
|
"type": {
|
|
7961
8145
|
"text": "Series[]"
|
|
7962
8146
|
},
|
|
7963
|
-
"description": "The columns
|
|
8147
|
+
"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
8148
|
"readonly": true
|
|
7965
8149
|
},
|
|
7966
8150
|
{
|
|
@@ -7969,7 +8153,7 @@
|
|
|
7969
8153
|
"type": {
|
|
7970
8154
|
"text": "string"
|
|
7971
8155
|
},
|
|
7972
|
-
"description": "
|
|
8156
|
+
"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
8157
|
"readonly": true
|
|
7974
8158
|
},
|
|
7975
8159
|
{
|
|
@@ -7978,7 +8162,7 @@
|
|
|
7978
8162
|
"type": {
|
|
7979
8163
|
"text": "Row[]"
|
|
7980
8164
|
},
|
|
7981
|
-
"description": "Every row of the table, with each cell's text
|
|
8165
|
+
"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
8166
|
"readonly": true
|
|
7983
8167
|
},
|
|
7984
8168
|
{
|
|
@@ -7987,7 +8171,7 @@
|
|
|
7987
8171
|
"type": {
|
|
7988
8172
|
"text": "number[]"
|
|
7989
8173
|
},
|
|
7990
|
-
"description": "
|
|
8174
|
+
"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
8175
|
"readonly": true
|
|
7992
8176
|
},
|
|
7993
8177
|
{
|
|
@@ -8006,7 +8190,7 @@
|
|
|
8006
8190
|
}
|
|
8007
8191
|
}
|
|
8008
8192
|
],
|
|
8009
|
-
"description": "The palette slot the cell at this
|
|
8193
|
+
"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
8194
|
},
|
|
8011
8195
|
{
|
|
8012
8196
|
"kind": "field",
|
|
@@ -8014,7 +8198,7 @@
|
|
|
8014
8198
|
"type": {
|
|
8015
8199
|
"text": "number"
|
|
8016
8200
|
},
|
|
8017
|
-
"description": "
|
|
8201
|
+
"description": "The number of readings, which the pointer position maps onto.",
|
|
8018
8202
|
"readonly": true
|
|
8019
8203
|
}
|
|
8020
8204
|
],
|
|
@@ -8034,7 +8218,7 @@
|
|
|
8034
8218
|
"text": "string"
|
|
8035
8219
|
},
|
|
8036
8220
|
"default": "''",
|
|
8037
|
-
"description": "The
|
|
8221
|
+
"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
8222
|
"fieldName": "label"
|
|
8039
8223
|
}
|
|
8040
8224
|
],
|
|
@@ -8122,7 +8306,7 @@
|
|
|
8122
8306
|
"type": {
|
|
8123
8307
|
"text": "boolean"
|
|
8124
8308
|
},
|
|
8125
|
-
"description": "Whether the rows are still
|
|
8309
|
+
"description": "Whether the rows are still loading."
|
|
8126
8310
|
},
|
|
8127
8311
|
{
|
|
8128
8312
|
"kind": "field",
|
|
@@ -8130,7 +8314,7 @@
|
|
|
8130
8314
|
"type": {
|
|
8131
8315
|
"text": "string"
|
|
8132
8316
|
},
|
|
8133
|
-
"description": "
|
|
8317
|
+
"description": "The text shown and announced while the rows load."
|
|
8134
8318
|
},
|
|
8135
8319
|
{
|
|
8136
8320
|
"kind": "field",
|
|
@@ -8138,7 +8322,7 @@
|
|
|
8138
8322
|
"type": {
|
|
8139
8323
|
"text": "string"
|
|
8140
8324
|
},
|
|
8141
|
-
"description": "
|
|
8325
|
+
"description": "The text shown and announced when there are no rows and none are loading."
|
|
8142
8326
|
},
|
|
8143
8327
|
{
|
|
8144
8328
|
"kind": "method",
|
|
@@ -8232,7 +8416,7 @@
|
|
|
8232
8416
|
"text": "string"
|
|
8233
8417
|
},
|
|
8234
8418
|
"default": "'Nothing to show'",
|
|
8235
|
-
"description": "
|
|
8419
|
+
"description": "The text shown and announced when there are no rows and none are loading.",
|
|
8236
8420
|
"attribute": "empty-text"
|
|
8237
8421
|
},
|
|
8238
8422
|
{
|
|
@@ -8242,7 +8426,7 @@
|
|
|
8242
8426
|
"text": "boolean"
|
|
8243
8427
|
},
|
|
8244
8428
|
"default": "false",
|
|
8245
|
-
"description": "Whether the rows are still
|
|
8429
|
+
"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
8430
|
"attribute": "loading",
|
|
8247
8431
|
"reflects": true
|
|
8248
8432
|
},
|
|
@@ -8253,7 +8437,7 @@
|
|
|
8253
8437
|
"text": "string"
|
|
8254
8438
|
},
|
|
8255
8439
|
"default": "'Loading'",
|
|
8256
|
-
"description": "
|
|
8440
|
+
"description": "The text shown and announced while the rows load.",
|
|
8257
8441
|
"attribute": "loading-text"
|
|
8258
8442
|
},
|
|
8259
8443
|
{
|
|
@@ -8360,7 +8544,7 @@
|
|
|
8360
8544
|
"text": "string"
|
|
8361
8545
|
},
|
|
8362
8546
|
"default": "'Nothing to show'",
|
|
8363
|
-
"description": "
|
|
8547
|
+
"description": "The text shown and announced when there are no rows and none are loading.",
|
|
8364
8548
|
"fieldName": "emptyText"
|
|
8365
8549
|
},
|
|
8366
8550
|
{
|
|
@@ -8369,7 +8553,7 @@
|
|
|
8369
8553
|
"text": "boolean"
|
|
8370
8554
|
},
|
|
8371
8555
|
"default": "false",
|
|
8372
|
-
"description": "Whether the rows are still
|
|
8556
|
+
"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
8557
|
"fieldName": "loading"
|
|
8374
8558
|
},
|
|
8375
8559
|
{
|
|
@@ -8378,7 +8562,7 @@
|
|
|
8378
8562
|
"text": "string"
|
|
8379
8563
|
},
|
|
8380
8564
|
"default": "'Loading'",
|
|
8381
|
-
"description": "
|
|
8565
|
+
"description": "The text shown and announced while the rows load.",
|
|
8382
8566
|
"fieldName": "loadingText"
|
|
8383
8567
|
}
|
|
8384
8568
|
],
|
|
@@ -8426,7 +8610,7 @@
|
|
|
8426
8610
|
"type": {
|
|
8427
8611
|
"text": "string"
|
|
8428
8612
|
},
|
|
8429
|
-
"description": "
|
|
8613
|
+
"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
8614
|
},
|
|
8431
8615
|
{
|
|
8432
8616
|
"kind": "field",
|
|
@@ -8434,7 +8618,7 @@
|
|
|
8434
8618
|
"type": {
|
|
8435
8619
|
"text": "string"
|
|
8436
8620
|
},
|
|
8437
|
-
"description": "
|
|
8621
|
+
"description": "The `value` of the item declared current in markup. Ignored once `active`\nis written."
|
|
8438
8622
|
},
|
|
8439
8623
|
{
|
|
8440
8624
|
"kind": "method",
|
|
@@ -8452,7 +8636,7 @@
|
|
|
8452
8636
|
}
|
|
8453
8637
|
}
|
|
8454
8638
|
],
|
|
8455
|
-
"description": "Requests a new current item, and
|
|
8639
|
+
"description": "Requests a new current item, and returns whether the change was applied."
|
|
8456
8640
|
},
|
|
8457
8641
|
{
|
|
8458
8642
|
"kind": "method",
|
|
@@ -8487,7 +8671,7 @@
|
|
|
8487
8671
|
"type": {
|
|
8488
8672
|
"text": "string"
|
|
8489
8673
|
},
|
|
8490
|
-
"description": "
|
|
8674
|
+
"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
8675
|
"attribute": "active"
|
|
8492
8676
|
},
|
|
8493
8677
|
{
|
|
@@ -8497,7 +8681,7 @@
|
|
|
8497
8681
|
"text": "string"
|
|
8498
8682
|
},
|
|
8499
8683
|
"default": "''",
|
|
8500
|
-
"description": "
|
|
8684
|
+
"description": "The `value` of the item declared current in markup.\n\nIgnored once `active` is written.",
|
|
8501
8685
|
"attribute": "default-active"
|
|
8502
8686
|
},
|
|
8503
8687
|
{
|
|
@@ -8526,7 +8710,7 @@
|
|
|
8526
8710
|
}
|
|
8527
8711
|
}
|
|
8528
8712
|
],
|
|
8529
|
-
"description": "Requests a new current item, and
|
|
8713
|
+
"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
8714
|
},
|
|
8531
8715
|
{
|
|
8532
8716
|
"kind": "method",
|
|
@@ -8580,7 +8764,7 @@
|
|
|
8580
8764
|
"type": {
|
|
8581
8765
|
"text": "string"
|
|
8582
8766
|
},
|
|
8583
|
-
"description": "
|
|
8767
|
+
"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
8768
|
"fieldName": "active"
|
|
8585
8769
|
},
|
|
8586
8770
|
{
|
|
@@ -8589,7 +8773,7 @@
|
|
|
8589
8773
|
"text": "string"
|
|
8590
8774
|
},
|
|
8591
8775
|
"default": "''",
|
|
8592
|
-
"description": "
|
|
8776
|
+
"description": "The `value` of the item declared current in markup.\n\nIgnored once `active` is written.",
|
|
8593
8777
|
"fieldName": "defaultActive"
|
|
8594
8778
|
}
|
|
8595
8779
|
],
|
|
@@ -8645,7 +8829,7 @@
|
|
|
8645
8829
|
"type": {
|
|
8646
8830
|
"text": "boolean"
|
|
8647
8831
|
},
|
|
8648
|
-
"description": "Whether the
|
|
8832
|
+
"description": "Whether the control starts checked. A form reset returns it to this state."
|
|
8649
8833
|
},
|
|
8650
8834
|
{
|
|
8651
8835
|
"kind": "method",
|
|
@@ -8663,7 +8847,7 @@
|
|
|
8663
8847
|
}
|
|
8664
8848
|
}
|
|
8665
8849
|
],
|
|
8666
|
-
"description": "Requests a checked
|
|
8850
|
+
"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
8851
|
},
|
|
8668
8852
|
{
|
|
8669
8853
|
"kind": "method",
|
|
@@ -8709,7 +8893,7 @@
|
|
|
8709
8893
|
"text": "boolean"
|
|
8710
8894
|
},
|
|
8711
8895
|
"default": "false",
|
|
8712
|
-
"description": "Whether the
|
|
8896
|
+
"description": "Whether the control starts checked. A form reset returns it to this state.",
|
|
8713
8897
|
"attribute": "default-checked"
|
|
8714
8898
|
},
|
|
8715
8899
|
{
|
|
@@ -8738,7 +8922,7 @@
|
|
|
8738
8922
|
}
|
|
8739
8923
|
}
|
|
8740
8924
|
],
|
|
8741
|
-
"description": "Requests a checked
|
|
8925
|
+
"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
8926
|
},
|
|
8743
8927
|
{
|
|
8744
8928
|
"kind": "method",
|
|
@@ -8802,7 +8986,7 @@
|
|
|
8802
8986
|
"text": "boolean"
|
|
8803
8987
|
},
|
|
8804
8988
|
"default": "false",
|
|
8805
|
-
"description": "Whether the
|
|
8989
|
+
"description": "Whether the control starts checked. A form reset returns it to this state.",
|
|
8806
8990
|
"fieldName": "defaultChecked"
|
|
8807
8991
|
}
|
|
8808
8992
|
],
|
|
@@ -8850,7 +9034,7 @@
|
|
|
8850
9034
|
"type": {
|
|
8851
9035
|
"text": "boolean"
|
|
8852
9036
|
},
|
|
8853
|
-
"description": "Whether the
|
|
9037
|
+
"description": "Whether the element starts open. Ignored once `open` is written."
|
|
8854
9038
|
},
|
|
8855
9039
|
{
|
|
8856
9040
|
"kind": "field",
|
|
@@ -8876,7 +9060,7 @@
|
|
|
8876
9060
|
}
|
|
8877
9061
|
}
|
|
8878
9062
|
],
|
|
8879
|
-
"description": "Requests
|
|
9063
|
+
"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
9064
|
},
|
|
8881
9065
|
{
|
|
8882
9066
|
"kind": "method",
|
|
@@ -8903,7 +9087,7 @@
|
|
|
8903
9087
|
"text": "boolean"
|
|
8904
9088
|
},
|
|
8905
9089
|
"default": "false",
|
|
8906
|
-
"description": "Whether the
|
|
9090
|
+
"description": "Whether the element starts open. Ignored once `open` is written.",
|
|
8907
9091
|
"attribute": "default-open"
|
|
8908
9092
|
},
|
|
8909
9093
|
{
|
|
@@ -8941,7 +9125,7 @@
|
|
|
8941
9125
|
}
|
|
8942
9126
|
}
|
|
8943
9127
|
],
|
|
8944
|
-
"description": "Requests
|
|
9128
|
+
"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
9129
|
},
|
|
8946
9130
|
{
|
|
8947
9131
|
"kind": "method",
|
|
@@ -8980,7 +9164,7 @@
|
|
|
8980
9164
|
"text": "boolean"
|
|
8981
9165
|
},
|
|
8982
9166
|
"default": "false",
|
|
8983
|
-
"description": "Whether the
|
|
9167
|
+
"description": "Whether the element starts open. Ignored once `open` is written.",
|
|
8984
9168
|
"fieldName": "defaultOpen"
|
|
8985
9169
|
},
|
|
8986
9170
|
{
|
|
@@ -9036,7 +9220,7 @@
|
|
|
9036
9220
|
"type": {
|
|
9037
9221
|
"text": "string"
|
|
9038
9222
|
},
|
|
9039
|
-
"description": "The value the
|
|
9223
|
+
"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
9224
|
},
|
|
9041
9225
|
{
|
|
9042
9226
|
"kind": "field",
|
|
@@ -9044,7 +9228,7 @@
|
|
|
9044
9228
|
"type": {
|
|
9045
9229
|
"text": "string"
|
|
9046
9230
|
},
|
|
9047
|
-
"description": "
|
|
9231
|
+
"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
9232
|
},
|
|
9049
9233
|
{
|
|
9050
9234
|
"kind": "field",
|
|
@@ -9072,7 +9256,7 @@
|
|
|
9072
9256
|
}
|
|
9073
9257
|
}
|
|
9074
9258
|
],
|
|
9075
|
-
"description": "Requests a new value, and
|
|
9259
|
+
"description": "Requests a new value, and returns whether the change was applied."
|
|
9076
9260
|
},
|
|
9077
9261
|
{
|
|
9078
9262
|
"kind": "method",
|
|
@@ -9082,7 +9266,7 @@
|
|
|
9082
9266
|
"text": "void"
|
|
9083
9267
|
}
|
|
9084
9268
|
},
|
|
9085
|
-
"description": "Returns the control to
|
|
9269
|
+
"description": "Returns the control to its `defaultValue`."
|
|
9086
9270
|
},
|
|
9087
9271
|
{
|
|
9088
9272
|
"kind": "method",
|
|
@@ -9117,7 +9301,7 @@
|
|
|
9117
9301
|
"text": "string"
|
|
9118
9302
|
},
|
|
9119
9303
|
"default": "''",
|
|
9120
|
-
"description": "The value the
|
|
9304
|
+
"description": "The value the control starts with. A form reset returns it to this value.",
|
|
9121
9305
|
"attribute": "default-value"
|
|
9122
9306
|
},
|
|
9123
9307
|
{
|
|
@@ -9126,7 +9310,7 @@
|
|
|
9126
9310
|
"type": {
|
|
9127
9311
|
"text": "string"
|
|
9128
9312
|
},
|
|
9129
|
-
"description": "
|
|
9313
|
+
"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
9314
|
"attribute": "value"
|
|
9131
9315
|
},
|
|
9132
9316
|
{
|
|
@@ -9177,7 +9361,7 @@
|
|
|
9177
9361
|
}
|
|
9178
9362
|
}
|
|
9179
9363
|
],
|
|
9180
|
-
"description": "Requests a new value, and
|
|
9364
|
+
"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
9365
|
},
|
|
9182
9366
|
{
|
|
9183
9367
|
"kind": "method",
|
|
@@ -9187,7 +9371,7 @@
|
|
|
9187
9371
|
"text": "void"
|
|
9188
9372
|
}
|
|
9189
9373
|
},
|
|
9190
|
-
"description": "Returns the control to
|
|
9374
|
+
"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
9375
|
},
|
|
9192
9376
|
{
|
|
9193
9377
|
"kind": "method",
|
|
@@ -9215,7 +9399,7 @@
|
|
|
9215
9399
|
"text": "string"
|
|
9216
9400
|
},
|
|
9217
9401
|
"default": "''",
|
|
9218
|
-
"description": "The value the
|
|
9402
|
+
"description": "The value the control starts with. A form reset returns it to this value.",
|
|
9219
9403
|
"fieldName": "defaultValue"
|
|
9220
9404
|
},
|
|
9221
9405
|
{
|
|
@@ -9223,7 +9407,7 @@
|
|
|
9223
9407
|
"type": {
|
|
9224
9408
|
"text": "string"
|
|
9225
9409
|
},
|
|
9226
|
-
"description": "
|
|
9410
|
+
"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
9411
|
"fieldName": "value"
|
|
9228
9412
|
}
|
|
9229
9413
|
],
|
|
@@ -9271,7 +9455,7 @@
|
|
|
9271
9455
|
"type": {
|
|
9272
9456
|
"text": "boolean"
|
|
9273
9457
|
},
|
|
9274
|
-
"description": "Whether
|
|
9458
|
+
"description": "Whether the element shows a control that dismisses it."
|
|
9275
9459
|
},
|
|
9276
9460
|
{
|
|
9277
9461
|
"kind": "field",
|
|
@@ -9279,7 +9463,7 @@
|
|
|
9279
9463
|
"type": {
|
|
9280
9464
|
"text": "string"
|
|
9281
9465
|
},
|
|
9282
|
-
"description": "
|
|
9466
|
+
"description": "The dismiss control's label, read by screen readers."
|
|
9283
9467
|
},
|
|
9284
9468
|
{
|
|
9285
9469
|
"kind": "method",
|
|
@@ -9289,7 +9473,7 @@
|
|
|
9289
9473
|
"text": "boolean"
|
|
9290
9474
|
}
|
|
9291
9475
|
},
|
|
9292
|
-
"description": "
|
|
9476
|
+
"description": "Fires `helix-dismiss`, and returns `false` if a listener cancels it."
|
|
9293
9477
|
},
|
|
9294
9478
|
{
|
|
9295
9479
|
"kind": "method",
|
|
@@ -9317,7 +9501,7 @@
|
|
|
9317
9501
|
"text": "boolean"
|
|
9318
9502
|
},
|
|
9319
9503
|
"default": "false",
|
|
9320
|
-
"description": "Whether
|
|
9504
|
+
"description": "Whether the element shows a control that dismisses it.",
|
|
9321
9505
|
"attribute": "dismissible",
|
|
9322
9506
|
"reflects": true
|
|
9323
9507
|
},
|
|
@@ -9328,7 +9512,7 @@
|
|
|
9328
9512
|
"text": "string"
|
|
9329
9513
|
},
|
|
9330
9514
|
"default": "'Dismiss'",
|
|
9331
|
-
"description": "
|
|
9515
|
+
"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
9516
|
"attribute": "dismiss-label"
|
|
9333
9517
|
},
|
|
9334
9518
|
{
|
|
@@ -9350,7 +9534,7 @@
|
|
|
9350
9534
|
"text": "boolean"
|
|
9351
9535
|
}
|
|
9352
9536
|
},
|
|
9353
|
-
"description": "
|
|
9537
|
+
"description": "Fires `helix-dismiss`, and returns `false` if a listener cancels it."
|
|
9354
9538
|
}
|
|
9355
9539
|
],
|
|
9356
9540
|
"attributes": [
|
|
@@ -9360,7 +9544,7 @@
|
|
|
9360
9544
|
"text": "boolean"
|
|
9361
9545
|
},
|
|
9362
9546
|
"default": "false",
|
|
9363
|
-
"description": "Whether
|
|
9547
|
+
"description": "Whether the element shows a control that dismisses it.",
|
|
9364
9548
|
"fieldName": "dismissible"
|
|
9365
9549
|
},
|
|
9366
9550
|
{
|
|
@@ -9369,7 +9553,7 @@
|
|
|
9369
9553
|
"text": "string"
|
|
9370
9554
|
},
|
|
9371
9555
|
"default": "'Dismiss'",
|
|
9372
|
-
"description": "
|
|
9556
|
+
"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
9557
|
"fieldName": "dismissLabel"
|
|
9374
9558
|
}
|
|
9375
9559
|
],
|
|
@@ -9445,7 +9629,7 @@
|
|
|
9445
9629
|
"type": {
|
|
9446
9630
|
"text": "string"
|
|
9447
9631
|
},
|
|
9448
|
-
"description": "Help under the control
|
|
9632
|
+
"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
9633
|
},
|
|
9450
9634
|
{
|
|
9451
9635
|
"kind": "field",
|
|
@@ -9462,7 +9646,7 @@
|
|
|
9462
9646
|
"type": {
|
|
9463
9647
|
"text": "string"
|
|
9464
9648
|
},
|
|
9465
|
-
"description": "
|
|
9649
|
+
"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
9650
|
},
|
|
9467
9651
|
{
|
|
9468
9652
|
"kind": "field",
|
|
@@ -9470,7 +9654,7 @@
|
|
|
9470
9654
|
"type": {
|
|
9471
9655
|
"text": "string"
|
|
9472
9656
|
},
|
|
9473
|
-
"description": "The
|
|
9657
|
+
"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
9658
|
},
|
|
9475
9659
|
{
|
|
9476
9660
|
"kind": "method",
|
|
@@ -9533,7 +9717,7 @@
|
|
|
9533
9717
|
"type": {
|
|
9534
9718
|
"text": "boolean"
|
|
9535
9719
|
},
|
|
9536
|
-
"description": "Whether the
|
|
9720
|
+
"description": "Whether the field needs a value before the form can submit."
|
|
9537
9721
|
},
|
|
9538
9722
|
{
|
|
9539
9723
|
"kind": "method",
|
|
@@ -9603,7 +9787,7 @@
|
|
|
9603
9787
|
"text": "string"
|
|
9604
9788
|
},
|
|
9605
9789
|
"readonly": true,
|
|
9606
|
-
"description": "The message
|
|
9790
|
+
"description": "The validation message shown: yours, the browser's, or none."
|
|
9607
9791
|
},
|
|
9608
9792
|
{
|
|
9609
9793
|
"kind": "field",
|
|
@@ -9611,7 +9795,7 @@
|
|
|
9611
9795
|
"type": {
|
|
9612
9796
|
"text": "string | undefined"
|
|
9613
9797
|
},
|
|
9614
|
-
"description": "
|
|
9798
|
+
"description": "The message shown when the field is required and empty."
|
|
9615
9799
|
}
|
|
9616
9800
|
],
|
|
9617
9801
|
"helix": {}
|
|
@@ -9658,7 +9842,7 @@
|
|
|
9658
9842
|
"text": "string"
|
|
9659
9843
|
},
|
|
9660
9844
|
"default": "''",
|
|
9661
|
-
"description": "
|
|
9845
|
+
"description": "The validation message shown under the control. It replaces the\nbrowser's message.",
|
|
9662
9846
|
"attribute": "feedback"
|
|
9663
9847
|
},
|
|
9664
9848
|
{
|
|
@@ -9668,7 +9852,7 @@
|
|
|
9668
9852
|
"text": "string"
|
|
9669
9853
|
},
|
|
9670
9854
|
"default": "''",
|
|
9671
|
-
"description": "Help under the control
|
|
9855
|
+
"description": "Help text shown under the control. A validation message replaces it.",
|
|
9672
9856
|
"attribute": "hint"
|
|
9673
9857
|
},
|
|
9674
9858
|
{
|
|
@@ -9678,7 +9862,7 @@
|
|
|
9678
9862
|
"text": "string"
|
|
9679
9863
|
},
|
|
9680
9864
|
"default": "''",
|
|
9681
|
-
"description": "The
|
|
9865
|
+
"description": "The field's label, which is also its accessible name. Content in the\n`label` slot replaces it.",
|
|
9682
9866
|
"attribute": "label"
|
|
9683
9867
|
},
|
|
9684
9868
|
{
|
|
@@ -9688,7 +9872,7 @@
|
|
|
9688
9872
|
"text": "boolean"
|
|
9689
9873
|
},
|
|
9690
9874
|
"default": "false",
|
|
9691
|
-
"description": "Whether the
|
|
9875
|
+
"description": "Whether the field needs a value before the form can submit.",
|
|
9692
9876
|
"attribute": "required",
|
|
9693
9877
|
"reflects": true
|
|
9694
9878
|
},
|
|
@@ -9698,7 +9882,7 @@
|
|
|
9698
9882
|
"type": {
|
|
9699
9883
|
"text": "string | undefined"
|
|
9700
9884
|
},
|
|
9701
|
-
"description": "
|
|
9885
|
+
"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
9886
|
"attribute": "value-missing-message"
|
|
9703
9887
|
},
|
|
9704
9888
|
{
|
|
@@ -9855,7 +10039,7 @@
|
|
|
9855
10039
|
"text": "void"
|
|
9856
10040
|
}
|
|
9857
10041
|
},
|
|
9858
|
-
"description": "
|
|
10042
|
+
"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
10043
|
}
|
|
9860
10044
|
],
|
|
9861
10045
|
"attributes": [
|
|
@@ -9865,7 +10049,7 @@
|
|
|
9865
10049
|
"text": "string"
|
|
9866
10050
|
},
|
|
9867
10051
|
"default": "''",
|
|
9868
|
-
"description": "
|
|
10052
|
+
"description": "The validation message shown under the control. It replaces the\nbrowser's message.",
|
|
9869
10053
|
"fieldName": "feedback"
|
|
9870
10054
|
},
|
|
9871
10055
|
{
|
|
@@ -9874,7 +10058,7 @@
|
|
|
9874
10058
|
"text": "string"
|
|
9875
10059
|
},
|
|
9876
10060
|
"default": "''",
|
|
9877
|
-
"description": "Help under the control
|
|
10061
|
+
"description": "Help text shown under the control. A validation message replaces it.",
|
|
9878
10062
|
"fieldName": "hint"
|
|
9879
10063
|
},
|
|
9880
10064
|
{
|
|
@@ -9883,7 +10067,7 @@
|
|
|
9883
10067
|
"text": "string"
|
|
9884
10068
|
},
|
|
9885
10069
|
"default": "''",
|
|
9886
|
-
"description": "The
|
|
10070
|
+
"description": "The field's label, which is also its accessible name. Content in the\n`label` slot replaces it.",
|
|
9887
10071
|
"fieldName": "label"
|
|
9888
10072
|
},
|
|
9889
10073
|
{
|
|
@@ -9892,7 +10076,7 @@
|
|
|
9892
10076
|
"text": "boolean"
|
|
9893
10077
|
},
|
|
9894
10078
|
"default": "false",
|
|
9895
|
-
"description": "Whether the
|
|
10079
|
+
"description": "Whether the field needs a value before the form can submit.",
|
|
9896
10080
|
"fieldName": "required"
|
|
9897
10081
|
},
|
|
9898
10082
|
{
|
|
@@ -9900,7 +10084,7 @@
|
|
|
9900
10084
|
"type": {
|
|
9901
10085
|
"text": "string | undefined"
|
|
9902
10086
|
},
|
|
9903
|
-
"description": "
|
|
10087
|
+
"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
10088
|
"fieldName": "valueMissingMessage"
|
|
9905
10089
|
}
|
|
9906
10090
|
],
|
|
@@ -9977,7 +10161,7 @@
|
|
|
9977
10161
|
"type": {
|
|
9978
10162
|
"text": "boolean"
|
|
9979
10163
|
},
|
|
9980
|
-
"description": "Whether the
|
|
10164
|
+
"description": "Whether the value is locked. A read-only control still submits its value."
|
|
9981
10165
|
},
|
|
9982
10166
|
{
|
|
9983
10167
|
"kind": "method",
|
|
@@ -9995,7 +10179,7 @@
|
|
|
9995
10179
|
}
|
|
9996
10180
|
}
|
|
9997
10181
|
],
|
|
9998
|
-
"description": "
|
|
10182
|
+
"description": "Requests a new value. While `readOnly` is set, nothing changes and it\nreturns `false`."
|
|
9999
10183
|
}
|
|
10000
10184
|
],
|
|
10001
10185
|
"helix": {}
|
|
@@ -10012,7 +10196,7 @@
|
|
|
10012
10196
|
"text": "boolean"
|
|
10013
10197
|
},
|
|
10014
10198
|
"default": "false",
|
|
10015
|
-
"description": "Whether the
|
|
10199
|
+
"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
10200
|
"attribute": "readonly",
|
|
10017
10201
|
"reflects": true
|
|
10018
10202
|
},
|
|
@@ -10042,7 +10226,7 @@
|
|
|
10042
10226
|
}
|
|
10043
10227
|
}
|
|
10044
10228
|
],
|
|
10045
|
-
"description": "
|
|
10229
|
+
"description": "Requests a new value. While `readOnly` is set, nothing changes and it\nreturns `false`."
|
|
10046
10230
|
},
|
|
10047
10231
|
{
|
|
10048
10232
|
"kind": "field",
|
|
@@ -10066,7 +10250,7 @@
|
|
|
10066
10250
|
"text": "boolean"
|
|
10067
10251
|
},
|
|
10068
10252
|
"default": "false",
|
|
10069
|
-
"description": "Whether the
|
|
10253
|
+
"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
10254
|
"fieldName": "readOnly"
|
|
10071
10255
|
}
|
|
10072
10256
|
],
|
|
@@ -10114,7 +10298,7 @@
|
|
|
10114
10298
|
"type": {
|
|
10115
10299
|
"text": "string | undefined"
|
|
10116
10300
|
},
|
|
10117
|
-
"description": "
|
|
10301
|
+
"description": "The message shown when the field holds text the picker cannot read."
|
|
10118
10302
|
},
|
|
10119
10303
|
{
|
|
10120
10304
|
"kind": "field",
|
|
@@ -10173,7 +10357,7 @@
|
|
|
10173
10357
|
}
|
|
10174
10358
|
}
|
|
10175
10359
|
],
|
|
10176
|
-
"description": "Puts the caret in the field,
|
|
10360
|
+
"description": "Puts the caret in the field, as clicking its label does."
|
|
10177
10361
|
},
|
|
10178
10362
|
{
|
|
10179
10363
|
"kind": "field",
|
|
@@ -10281,7 +10465,7 @@
|
|
|
10281
10465
|
"type": {
|
|
10282
10466
|
"text": "string | undefined"
|
|
10283
10467
|
},
|
|
10284
|
-
"description": "
|
|
10468
|
+
"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
10469
|
"attribute": "bad-input-message"
|
|
10286
10470
|
},
|
|
10287
10471
|
{
|
|
@@ -10429,7 +10613,7 @@
|
|
|
10429
10613
|
}
|
|
10430
10614
|
}
|
|
10431
10615
|
],
|
|
10432
|
-
"description": "Puts the caret in the field,
|
|
10616
|
+
"description": "Puts the caret in the field, as clicking its label does."
|
|
10433
10617
|
}
|
|
10434
10618
|
],
|
|
10435
10619
|
"attributes": [
|
|
@@ -10438,7 +10622,7 @@
|
|
|
10438
10622
|
"type": {
|
|
10439
10623
|
"text": "string | undefined"
|
|
10440
10624
|
},
|
|
10441
|
-
"description": "
|
|
10625
|
+
"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
10626
|
"fieldName": "badInputMessage"
|
|
10443
10627
|
}
|
|
10444
10628
|
],
|
|
@@ -10486,7 +10670,7 @@
|
|
|
10486
10670
|
"type": {
|
|
10487
10671
|
"text": "boolean"
|
|
10488
10672
|
},
|
|
10489
|
-
"description": "Whether
|
|
10673
|
+
"description": "Whether the item is disabled and cannot be chosen."
|
|
10490
10674
|
},
|
|
10491
10675
|
{
|
|
10492
10676
|
"kind": "method",
|
|
@@ -10496,7 +10680,7 @@
|
|
|
10496
10680
|
"text": "void"
|
|
10497
10681
|
}
|
|
10498
10682
|
},
|
|
10499
|
-
"description": "Moves focus to the control
|
|
10683
|
+
"description": "Moves focus to the item's control, for the set's arrow keys."
|
|
10500
10684
|
},
|
|
10501
10685
|
{
|
|
10502
10686
|
"kind": "field",
|
|
@@ -10515,7 +10699,7 @@
|
|
|
10515
10699
|
"text": "boolean"
|
|
10516
10700
|
}
|
|
10517
10701
|
},
|
|
10518
|
-
"description": "
|
|
10702
|
+
"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
10703
|
},
|
|
10520
10704
|
{
|
|
10521
10705
|
"kind": "field",
|
|
@@ -10523,7 +10707,7 @@
|
|
|
10523
10707
|
"type": {
|
|
10524
10708
|
"text": "boolean"
|
|
10525
10709
|
},
|
|
10526
|
-
"description": "Whether
|
|
10710
|
+
"description": "Whether the item is selected. The parent set updates it."
|
|
10527
10711
|
},
|
|
10528
10712
|
{
|
|
10529
10713
|
"kind": "field",
|
|
@@ -10531,7 +10715,7 @@
|
|
|
10531
10715
|
"type": {
|
|
10532
10716
|
"text": "string"
|
|
10533
10717
|
},
|
|
10534
|
-
"description": "
|
|
10718
|
+
"description": "The item's value, which identifies it in its set and is what a form\nsubmits."
|
|
10535
10719
|
}
|
|
10536
10720
|
],
|
|
10537
10721
|
"helix": {}
|
|
@@ -10548,7 +10732,7 @@
|
|
|
10548
10732
|
"text": "boolean"
|
|
10549
10733
|
},
|
|
10550
10734
|
"default": "false",
|
|
10551
|
-
"description": "Whether
|
|
10735
|
+
"description": "Whether the item is disabled and cannot be chosen.",
|
|
10552
10736
|
"attribute": "disabled",
|
|
10553
10737
|
"reflects": true
|
|
10554
10738
|
},
|
|
@@ -10559,7 +10743,7 @@
|
|
|
10559
10743
|
"text": "boolean"
|
|
10560
10744
|
},
|
|
10561
10745
|
"default": "false",
|
|
10562
|
-
"description": "Whether
|
|
10746
|
+
"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
10747
|
"attribute": "selected"
|
|
10564
10748
|
},
|
|
10565
10749
|
{
|
|
@@ -10569,7 +10753,7 @@
|
|
|
10569
10753
|
"text": "string"
|
|
10570
10754
|
},
|
|
10571
10755
|
"default": "''",
|
|
10572
|
-
"description": "
|
|
10756
|
+
"description": "The item's value, which identifies it in its set and is what a form\nsubmits.",
|
|
10573
10757
|
"attribute": "value"
|
|
10574
10758
|
},
|
|
10575
10759
|
{
|
|
@@ -10590,7 +10774,7 @@
|
|
|
10590
10774
|
"text": "void"
|
|
10591
10775
|
}
|
|
10592
10776
|
},
|
|
10593
|
-
"description": "Moves focus to the control
|
|
10777
|
+
"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
10778
|
},
|
|
10595
10779
|
{
|
|
10596
10780
|
"kind": "method",
|
|
@@ -10600,7 +10784,7 @@
|
|
|
10600
10784
|
"text": "boolean"
|
|
10601
10785
|
}
|
|
10602
10786
|
},
|
|
10603
|
-
"description": "
|
|
10787
|
+
"description": "Selects the item and fires `helix-select`. Returns `false` if the item is\ndisabled or a listener cancels the event."
|
|
10604
10788
|
}
|
|
10605
10789
|
],
|
|
10606
10790
|
"attributes": [
|
|
@@ -10610,7 +10794,7 @@
|
|
|
10610
10794
|
"text": "boolean"
|
|
10611
10795
|
},
|
|
10612
10796
|
"default": "false",
|
|
10613
|
-
"description": "Whether
|
|
10797
|
+
"description": "Whether the item is disabled and cannot be chosen.",
|
|
10614
10798
|
"fieldName": "disabled"
|
|
10615
10799
|
},
|
|
10616
10800
|
{
|
|
@@ -10619,7 +10803,7 @@
|
|
|
10619
10803
|
"text": "boolean"
|
|
10620
10804
|
},
|
|
10621
10805
|
"default": "false",
|
|
10622
|
-
"description": "Whether
|
|
10806
|
+
"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
10807
|
"fieldName": "selected"
|
|
10624
10808
|
},
|
|
10625
10809
|
{
|
|
@@ -10628,7 +10812,7 @@
|
|
|
10628
10812
|
"text": "string"
|
|
10629
10813
|
},
|
|
10630
10814
|
"default": "''",
|
|
10631
|
-
"description": "
|
|
10815
|
+
"description": "The item's value, which identifies it in its set and is what a form\nsubmits.",
|
|
10632
10816
|
"fieldName": "value"
|
|
10633
10817
|
}
|
|
10634
10818
|
],
|
|
@@ -10684,7 +10868,7 @@
|
|
|
10684
10868
|
"type": {
|
|
10685
10869
|
"text": "boolean"
|
|
10686
10870
|
},
|
|
10687
|
-
"description": "Whether the count is a
|
|
10871
|
+
"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
10872
|
},
|
|
10689
10873
|
{
|
|
10690
10874
|
"kind": "field",
|
|
@@ -10692,7 +10876,7 @@
|
|
|
10692
10876
|
"type": {
|
|
10693
10877
|
"text": "string"
|
|
10694
10878
|
},
|
|
10695
|
-
"description": "
|
|
10879
|
+
"description": "The count button's label, read by screen readers. Its visible text, such\nas `+3`, does not say what it does."
|
|
10696
10880
|
},
|
|
10697
10881
|
{
|
|
10698
10882
|
"kind": "field",
|
|
@@ -10700,7 +10884,7 @@
|
|
|
10700
10884
|
"type": {
|
|
10701
10885
|
"text": "string"
|
|
10702
10886
|
},
|
|
10703
|
-
"description": "
|
|
10887
|
+
"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
10888
|
},
|
|
10705
10889
|
{
|
|
10706
10890
|
"kind": "field",
|
|
@@ -10807,7 +10991,7 @@
|
|
|
10807
10991
|
"text": "string"
|
|
10808
10992
|
},
|
|
10809
10993
|
"default": "'Show fewer'",
|
|
10810
|
-
"description": "
|
|
10994
|
+
"description": "The button's label, read by screen readers, once every token is showing.",
|
|
10811
10995
|
"attribute": "collapse-label"
|
|
10812
10996
|
},
|
|
10813
10997
|
{
|
|
@@ -10817,7 +11001,7 @@
|
|
|
10817
11001
|
"text": "boolean"
|
|
10818
11002
|
},
|
|
10819
11003
|
"default": "false",
|
|
10820
|
-
"description": "Whether the count is a
|
|
11004
|
+
"description": "Whether the count is a button that shows the hidden tokens.",
|
|
10821
11005
|
"attribute": "expandable"
|
|
10822
11006
|
},
|
|
10823
11007
|
{
|
|
@@ -10827,7 +11011,7 @@
|
|
|
10827
11011
|
"text": "string"
|
|
10828
11012
|
},
|
|
10829
11013
|
"default": "'Show all'",
|
|
10830
|
-
"description": "
|
|
11014
|
+
"description": "The count button's label, read by screen readers. Its visible text, such\nas `+3`, does not say what it does.",
|
|
10831
11015
|
"attribute": "expand-label"
|
|
10832
11016
|
},
|
|
10833
11017
|
{
|
|
@@ -10969,7 +11153,7 @@
|
|
|
10969
11153
|
"text": "string"
|
|
10970
11154
|
},
|
|
10971
11155
|
"default": "'Show fewer'",
|
|
10972
|
-
"description": "
|
|
11156
|
+
"description": "The button's label, read by screen readers, once every token is showing.",
|
|
10973
11157
|
"fieldName": "collapseLabel"
|
|
10974
11158
|
},
|
|
10975
11159
|
{
|
|
@@ -10978,7 +11162,7 @@
|
|
|
10978
11162
|
"text": "boolean"
|
|
10979
11163
|
},
|
|
10980
11164
|
"default": "false",
|
|
10981
|
-
"description": "Whether the count is a
|
|
11165
|
+
"description": "Whether the count is a button that shows the hidden tokens.",
|
|
10982
11166
|
"fieldName": "expandable"
|
|
10983
11167
|
},
|
|
10984
11168
|
{
|
|
@@ -10987,7 +11171,7 @@
|
|
|
10987
11171
|
"text": "string"
|
|
10988
11172
|
},
|
|
10989
11173
|
"default": "'Show all'",
|
|
10990
|
-
"description": "
|
|
11174
|
+
"description": "The count button's label, read by screen readers. Its visible text, such\nas `+3`, does not say what it does.",
|
|
10991
11175
|
"fieldName": "expandLabel"
|
|
10992
11176
|
},
|
|
10993
11177
|
{
|
|
@@ -11044,7 +11228,7 @@
|
|
|
11044
11228
|
"type": {
|
|
11045
11229
|
"text": "string | undefined"
|
|
11046
11230
|
},
|
|
11047
|
-
"description": "Which
|
|
11231
|
+
"description": "Which controls to show, as a list such as `pan zoom fullscreen`, or `none`. A family adds words of its own."
|
|
11048
11232
|
},
|
|
11049
11233
|
{
|
|
11050
11234
|
"kind": "field",
|
|
@@ -11060,7 +11244,7 @@
|
|
|
11060
11244
|
"type": {
|
|
11061
11245
|
"text": "string"
|
|
11062
11246
|
},
|
|
11063
|
-
"description": "
|
|
11247
|
+
"description": "The fullscreen button's label."
|
|
11064
11248
|
},
|
|
11065
11249
|
{
|
|
11066
11250
|
"kind": "field",
|
|
@@ -11068,7 +11252,7 @@
|
|
|
11068
11252
|
"type": {
|
|
11069
11253
|
"text": "number"
|
|
11070
11254
|
},
|
|
11071
|
-
"description": "How long the
|
|
11255
|
+
"description": "How long, in milliseconds, before the header and footer hide when the user is inactive. `0` keeps them visible."
|
|
11072
11256
|
},
|
|
11073
11257
|
{
|
|
11074
11258
|
"kind": "field",
|
|
@@ -11076,7 +11260,7 @@
|
|
|
11076
11260
|
"type": {
|
|
11077
11261
|
"text": "string"
|
|
11078
11262
|
},
|
|
11079
|
-
"description": "
|
|
11263
|
+
"description": "The pan down button's label."
|
|
11080
11264
|
},
|
|
11081
11265
|
{
|
|
11082
11266
|
"kind": "field",
|
|
@@ -11084,7 +11268,7 @@
|
|
|
11084
11268
|
"type": {
|
|
11085
11269
|
"text": "string"
|
|
11086
11270
|
},
|
|
11087
|
-
"description": "
|
|
11271
|
+
"description": "The pan left button's label."
|
|
11088
11272
|
},
|
|
11089
11273
|
{
|
|
11090
11274
|
"kind": "field",
|
|
@@ -11092,7 +11276,7 @@
|
|
|
11092
11276
|
"type": {
|
|
11093
11277
|
"text": "string"
|
|
11094
11278
|
},
|
|
11095
|
-
"description": "
|
|
11279
|
+
"description": "The pan right button's label."
|
|
11096
11280
|
},
|
|
11097
11281
|
{
|
|
11098
11282
|
"kind": "field",
|
|
@@ -11100,7 +11284,7 @@
|
|
|
11100
11284
|
"type": {
|
|
11101
11285
|
"text": "number"
|
|
11102
11286
|
},
|
|
11103
|
-
"description": "How far one press
|
|
11287
|
+
"description": "How far one press pans the view, as a fraction of its size."
|
|
11104
11288
|
},
|
|
11105
11289
|
{
|
|
11106
11290
|
"kind": "field",
|
|
@@ -11108,7 +11292,7 @@
|
|
|
11108
11292
|
"type": {
|
|
11109
11293
|
"text": "string"
|
|
11110
11294
|
},
|
|
11111
|
-
"description": "
|
|
11295
|
+
"description": "The pan up button's label."
|
|
11112
11296
|
},
|
|
11113
11297
|
{
|
|
11114
11298
|
"kind": "field",
|
|
@@ -11116,7 +11300,7 @@
|
|
|
11116
11300
|
"type": {
|
|
11117
11301
|
"text": "string"
|
|
11118
11302
|
},
|
|
11119
|
-
"description": "
|
|
11303
|
+
"description": "The zoom in button's label."
|
|
11120
11304
|
},
|
|
11121
11305
|
{
|
|
11122
11306
|
"kind": "field",
|
|
@@ -11124,7 +11308,7 @@
|
|
|
11124
11308
|
"type": {
|
|
11125
11309
|
"text": "string"
|
|
11126
11310
|
},
|
|
11127
|
-
"description": "
|
|
11311
|
+
"description": "The zoom out button's label."
|
|
11128
11312
|
},
|
|
11129
11313
|
{
|
|
11130
11314
|
"kind": "method",
|
|
@@ -11142,7 +11326,7 @@
|
|
|
11142
11326
|
}
|
|
11143
11327
|
}
|
|
11144
11328
|
],
|
|
11145
|
-
"description": "
|
|
11329
|
+
"description": "Pans the view one step in a direction."
|
|
11146
11330
|
},
|
|
11147
11331
|
{
|
|
11148
11332
|
"kind": "method",
|
|
@@ -11160,7 +11344,7 @@
|
|
|
11160
11344
|
}
|
|
11161
11345
|
}
|
|
11162
11346
|
],
|
|
11163
|
-
"description": "
|
|
11347
|
+
"description": "Zooms the view one step: `1` zooms in and `-1` zooms out."
|
|
11164
11348
|
},
|
|
11165
11349
|
{
|
|
11166
11350
|
"kind": "method",
|
|
@@ -11170,7 +11354,7 @@
|
|
|
11170
11354
|
"text": "void"
|
|
11171
11355
|
}
|
|
11172
11356
|
},
|
|
11173
|
-
"description": "
|
|
11357
|
+
"description": "Turns fullscreen on or off."
|
|
11174
11358
|
},
|
|
11175
11359
|
{
|
|
11176
11360
|
"kind": "field",
|
|
@@ -11225,7 +11409,7 @@
|
|
|
11225
11409
|
"type": {
|
|
11226
11410
|
"text": "string | undefined"
|
|
11227
11411
|
},
|
|
11228
|
-
"description": "
|
|
11412
|
+
"description": "The name of the group of controls, read by screen readers."
|
|
11229
11413
|
},
|
|
11230
11414
|
{
|
|
11231
11415
|
"kind": "field",
|
|
@@ -11305,6 +11489,93 @@
|
|
|
11305
11489
|
"privacy": "protected",
|
|
11306
11490
|
"description": "Which controls the surface draws while `controls` is absent.",
|
|
11307
11491
|
"readonly": true
|
|
11492
|
+
},
|
|
11493
|
+
{
|
|
11494
|
+
"kind": "method",
|
|
11495
|
+
"name": "drawsControls",
|
|
11496
|
+
"privacy": "protected",
|
|
11497
|
+
"return": {
|
|
11498
|
+
"type": {
|
|
11499
|
+
"text": "boolean"
|
|
11500
|
+
}
|
|
11501
|
+
},
|
|
11502
|
+
"parameters": [
|
|
11503
|
+
{
|
|
11504
|
+
"name": "group",
|
|
11505
|
+
"type": {
|
|
11506
|
+
"text": "string"
|
|
11507
|
+
}
|
|
11508
|
+
}
|
|
11509
|
+
],
|
|
11510
|
+
"description": "Whether `controls`, or the resting controls, names a group."
|
|
11511
|
+
},
|
|
11512
|
+
{
|
|
11513
|
+
"kind": "method",
|
|
11514
|
+
"name": "renderMoreControls",
|
|
11515
|
+
"privacy": "protected",
|
|
11516
|
+
"return": {
|
|
11517
|
+
"type": {
|
|
11518
|
+
"text": "TemplateResult | typeof nothing"
|
|
11519
|
+
}
|
|
11520
|
+
},
|
|
11521
|
+
"description": "More buttons for the group of controls, after zoom, for a family that adds its own."
|
|
11522
|
+
},
|
|
11523
|
+
{
|
|
11524
|
+
"kind": "method",
|
|
11525
|
+
"name": "handleMoreKeys",
|
|
11526
|
+
"privacy": "protected",
|
|
11527
|
+
"return": {
|
|
11528
|
+
"type": {
|
|
11529
|
+
"text": "boolean"
|
|
11530
|
+
}
|
|
11531
|
+
},
|
|
11532
|
+
"parameters": [
|
|
11533
|
+
{
|
|
11534
|
+
"name": "event",
|
|
11535
|
+
"type": {
|
|
11536
|
+
"text": "KeyboardEvent"
|
|
11537
|
+
}
|
|
11538
|
+
}
|
|
11539
|
+
],
|
|
11540
|
+
"description": "Answers a key the family adds, and says whether it did."
|
|
11541
|
+
},
|
|
11542
|
+
{
|
|
11543
|
+
"kind": "method",
|
|
11544
|
+
"name": "panLabel",
|
|
11545
|
+
"privacy": "protected",
|
|
11546
|
+
"return": {
|
|
11547
|
+
"type": {
|
|
11548
|
+
"text": "string"
|
|
11549
|
+
}
|
|
11550
|
+
},
|
|
11551
|
+
"parameters": [
|
|
11552
|
+
{
|
|
11553
|
+
"name": "way",
|
|
11554
|
+
"type": {
|
|
11555
|
+
"text": "ViewportWay"
|
|
11556
|
+
}
|
|
11557
|
+
}
|
|
11558
|
+
],
|
|
11559
|
+
"description": "What one pan control is called, for a family that draws its own."
|
|
11560
|
+
},
|
|
11561
|
+
{
|
|
11562
|
+
"kind": "method",
|
|
11563
|
+
"name": "panGlyph",
|
|
11564
|
+
"privacy": "protected",
|
|
11565
|
+
"return": {
|
|
11566
|
+
"type": {
|
|
11567
|
+
"text": "string"
|
|
11568
|
+
}
|
|
11569
|
+
},
|
|
11570
|
+
"parameters": [
|
|
11571
|
+
{
|
|
11572
|
+
"name": "way",
|
|
11573
|
+
"type": {
|
|
11574
|
+
"text": "ViewportWay"
|
|
11575
|
+
}
|
|
11576
|
+
}
|
|
11577
|
+
],
|
|
11578
|
+
"description": "The arrow drawn on one pan control, for a family that draws its own."
|
|
11308
11579
|
}
|
|
11309
11580
|
],
|
|
11310
11581
|
"helix": {}
|
|
@@ -11320,7 +11591,7 @@
|
|
|
11320
11591
|
"type": {
|
|
11321
11592
|
"text": "string | undefined"
|
|
11322
11593
|
},
|
|
11323
|
-
"description": "Which
|
|
11594
|
+
"description": "Which controls to show, as a list such as `pan zoom fullscreen`, or\n`none`. A family can add words of its own.\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: zoom, the compass and\nfullscreen for a map, whose pan buttons a page asks for, and zoom and\nfullscreen for a board, which a reader drags and whose pad took a third\nof 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
11595
|
"attribute": "controls",
|
|
11325
11596
|
"reflects": true
|
|
11326
11597
|
},
|
|
@@ -11330,7 +11601,7 @@
|
|
|
11330
11601
|
"type": {
|
|
11331
11602
|
"text": "string | undefined"
|
|
11332
11603
|
},
|
|
11333
|
-
"description": "
|
|
11604
|
+
"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
11605
|
"attribute": "controls-label"
|
|
11335
11606
|
},
|
|
11336
11607
|
{
|
|
@@ -11350,7 +11621,7 @@
|
|
|
11350
11621
|
"text": "string"
|
|
11351
11622
|
},
|
|
11352
11623
|
"default": "'Fill the screen'",
|
|
11353
|
-
"description": "
|
|
11624
|
+
"description": "The fullscreen button's label.",
|
|
11354
11625
|
"attribute": "fullscreen-label"
|
|
11355
11626
|
},
|
|
11356
11627
|
{
|
|
@@ -11360,7 +11631,7 @@
|
|
|
11360
11631
|
"text": "number"
|
|
11361
11632
|
},
|
|
11362
11633
|
"default": "0",
|
|
11363
|
-
"description": "How long the
|
|
11634
|
+
"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
11635
|
"attribute": "idle-delay"
|
|
11365
11636
|
},
|
|
11366
11637
|
{
|
|
@@ -11370,7 +11641,7 @@
|
|
|
11370
11641
|
"text": "string"
|
|
11371
11642
|
},
|
|
11372
11643
|
"default": "'Pan down'",
|
|
11373
|
-
"description": "
|
|
11644
|
+
"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
11645
|
"attribute": "pan-down-label"
|
|
11375
11646
|
},
|
|
11376
11647
|
{
|
|
@@ -11380,7 +11651,7 @@
|
|
|
11380
11651
|
"text": "string"
|
|
11381
11652
|
},
|
|
11382
11653
|
"default": "'Pan left'",
|
|
11383
|
-
"description": "
|
|
11654
|
+
"description": "The pan left button's label.",
|
|
11384
11655
|
"attribute": "pan-left-label"
|
|
11385
11656
|
},
|
|
11386
11657
|
{
|
|
@@ -11390,7 +11661,7 @@
|
|
|
11390
11661
|
"text": "string"
|
|
11391
11662
|
},
|
|
11392
11663
|
"default": "'Pan right'",
|
|
11393
|
-
"description": "
|
|
11664
|
+
"description": "The pan right button's label.",
|
|
11394
11665
|
"attribute": "pan-right-label"
|
|
11395
11666
|
},
|
|
11396
11667
|
{
|
|
@@ -11400,7 +11671,7 @@
|
|
|
11400
11671
|
"text": "number"
|
|
11401
11672
|
},
|
|
11402
11673
|
"default": "0.25",
|
|
11403
|
-
"description": "How far one press
|
|
11674
|
+
"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
11675
|
"attribute": "pan-step"
|
|
11405
11676
|
},
|
|
11406
11677
|
{
|
|
@@ -11410,7 +11681,7 @@
|
|
|
11410
11681
|
"text": "string"
|
|
11411
11682
|
},
|
|
11412
11683
|
"default": "'Pan up'",
|
|
11413
|
-
"description": "
|
|
11684
|
+
"description": "The pan up button's label.",
|
|
11414
11685
|
"attribute": "pan-up-label"
|
|
11415
11686
|
},
|
|
11416
11687
|
{
|
|
@@ -11420,7 +11691,7 @@
|
|
|
11420
11691
|
"text": "string"
|
|
11421
11692
|
},
|
|
11422
11693
|
"default": "'Zoom in'",
|
|
11423
|
-
"description": "
|
|
11694
|
+
"description": "The zoom in button's label.",
|
|
11424
11695
|
"attribute": "zoom-in-label"
|
|
11425
11696
|
},
|
|
11426
11697
|
{
|
|
@@ -11464,7 +11735,7 @@
|
|
|
11464
11735
|
"text": "string"
|
|
11465
11736
|
},
|
|
11466
11737
|
"default": "'Zoom out'",
|
|
11467
|
-
"description": "
|
|
11738
|
+
"description": "The zoom out button's label.",
|
|
11468
11739
|
"attribute": "zoom-out-label"
|
|
11469
11740
|
},
|
|
11470
11741
|
{
|
|
@@ -11531,7 +11802,7 @@
|
|
|
11531
11802
|
}
|
|
11532
11803
|
}
|
|
11533
11804
|
],
|
|
11534
|
-
"description": "
|
|
11805
|
+
"description": "Pans the view one step in a direction."
|
|
11535
11806
|
},
|
|
11536
11807
|
{
|
|
11537
11808
|
"kind": "method",
|
|
@@ -11549,7 +11820,7 @@
|
|
|
11549
11820
|
}
|
|
11550
11821
|
}
|
|
11551
11822
|
],
|
|
11552
|
-
"description": "
|
|
11823
|
+
"description": "Zooms the view one step: `1` zooms in and `-1` zooms out."
|
|
11553
11824
|
},
|
|
11554
11825
|
{
|
|
11555
11826
|
"kind": "method",
|
|
@@ -11559,7 +11830,7 @@
|
|
|
11559
11830
|
"text": "void"
|
|
11560
11831
|
}
|
|
11561
11832
|
},
|
|
11562
|
-
"description": "
|
|
11833
|
+
"description": "Turns fullscreen on or off."
|
|
11563
11834
|
},
|
|
11564
11835
|
{
|
|
11565
11836
|
"kind": "field",
|
|
@@ -11573,8 +11844,8 @@
|
|
|
11573
11844
|
},
|
|
11574
11845
|
{
|
|
11575
11846
|
"kind": "method",
|
|
11576
|
-
"name": "
|
|
11577
|
-
"privacy": "
|
|
11847
|
+
"name": "drawsControls",
|
|
11848
|
+
"privacy": "protected",
|
|
11578
11849
|
"return": {
|
|
11579
11850
|
"type": {
|
|
11580
11851
|
"text": "boolean"
|
|
@@ -11584,11 +11855,41 @@
|
|
|
11584
11855
|
{
|
|
11585
11856
|
"name": "group",
|
|
11586
11857
|
"type": {
|
|
11587
|
-
"text": "
|
|
11858
|
+
"text": "string"
|
|
11859
|
+
}
|
|
11860
|
+
}
|
|
11861
|
+
],
|
|
11862
|
+
"description": "Whether `controls`, or the resting controls, names a group."
|
|
11863
|
+
},
|
|
11864
|
+
{
|
|
11865
|
+
"kind": "method",
|
|
11866
|
+
"name": "renderMoreControls",
|
|
11867
|
+
"privacy": "protected",
|
|
11868
|
+
"return": {
|
|
11869
|
+
"type": {
|
|
11870
|
+
"text": "TemplateResult | typeof nothing"
|
|
11871
|
+
}
|
|
11872
|
+
},
|
|
11873
|
+
"description": "More buttons for the group of controls, after zoom. None here; a family adds its own."
|
|
11874
|
+
},
|
|
11875
|
+
{
|
|
11876
|
+
"kind": "method",
|
|
11877
|
+
"name": "handleMoreKeys",
|
|
11878
|
+
"privacy": "protected",
|
|
11879
|
+
"return": {
|
|
11880
|
+
"type": {
|
|
11881
|
+
"text": "boolean"
|
|
11882
|
+
}
|
|
11883
|
+
},
|
|
11884
|
+
"parameters": [
|
|
11885
|
+
{
|
|
11886
|
+
"name": "_event",
|
|
11887
|
+
"type": {
|
|
11888
|
+
"text": "KeyboardEvent"
|
|
11588
11889
|
}
|
|
11589
11890
|
}
|
|
11590
11891
|
],
|
|
11591
|
-
"description": "
|
|
11892
|
+
"description": "Answers a key the family adds, and says whether it did. None here."
|
|
11592
11893
|
},
|
|
11593
11894
|
{
|
|
11594
11895
|
"kind": "method",
|
|
@@ -11621,8 +11922,8 @@
|
|
|
11621
11922
|
},
|
|
11622
11923
|
{
|
|
11623
11924
|
"kind": "method",
|
|
11624
|
-
"name": "
|
|
11625
|
-
"privacy": "
|
|
11925
|
+
"name": "panLabel",
|
|
11926
|
+
"privacy": "protected",
|
|
11626
11927
|
"return": {
|
|
11627
11928
|
"type": {
|
|
11628
11929
|
"text": "string"
|
|
@@ -11640,8 +11941,8 @@
|
|
|
11640
11941
|
},
|
|
11641
11942
|
{
|
|
11642
11943
|
"kind": "method",
|
|
11643
|
-
"name": "
|
|
11644
|
-
"privacy": "
|
|
11944
|
+
"name": "panGlyph",
|
|
11945
|
+
"privacy": "protected",
|
|
11645
11946
|
"return": {
|
|
11646
11947
|
"type": {
|
|
11647
11948
|
"text": "string"
|
|
@@ -11692,7 +11993,7 @@
|
|
|
11692
11993
|
"type": {
|
|
11693
11994
|
"text": "string | undefined"
|
|
11694
11995
|
},
|
|
11695
|
-
"description": "Which
|
|
11996
|
+
"description": "Which controls to show, as a list such as `pan zoom fullscreen`, or\n`none`. A family can add words of its own.\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: zoom, the compass and\nfullscreen for a map, whose pan buttons a page asks for, and zoom and\nfullscreen for a board, which a reader drags and whose pad took a third\nof 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
11997
|
"fieldName": "controls"
|
|
11697
11998
|
},
|
|
11698
11999
|
{
|
|
@@ -11700,7 +12001,7 @@
|
|
|
11700
12001
|
"type": {
|
|
11701
12002
|
"text": "string | undefined"
|
|
11702
12003
|
},
|
|
11703
|
-
"description": "
|
|
12004
|
+
"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
12005
|
"fieldName": "controlsLabel"
|
|
11705
12006
|
},
|
|
11706
12007
|
{
|
|
@@ -11717,7 +12018,7 @@
|
|
|
11717
12018
|
"text": "string"
|
|
11718
12019
|
},
|
|
11719
12020
|
"default": "'Fill the screen'",
|
|
11720
|
-
"description": "
|
|
12021
|
+
"description": "The fullscreen button's label.",
|
|
11721
12022
|
"fieldName": "fullscreenLabel"
|
|
11722
12023
|
},
|
|
11723
12024
|
{
|
|
@@ -11726,7 +12027,7 @@
|
|
|
11726
12027
|
"text": "number"
|
|
11727
12028
|
},
|
|
11728
12029
|
"default": "0",
|
|
11729
|
-
"description": "How long the
|
|
12030
|
+
"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
12031
|
"fieldName": "idleDelay"
|
|
11731
12032
|
},
|
|
11732
12033
|
{
|
|
@@ -11735,7 +12036,7 @@
|
|
|
11735
12036
|
"text": "string"
|
|
11736
12037
|
},
|
|
11737
12038
|
"default": "'Pan down'",
|
|
11738
|
-
"description": "
|
|
12039
|
+
"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
12040
|
"fieldName": "panDownLabel"
|
|
11740
12041
|
},
|
|
11741
12042
|
{
|
|
@@ -11744,7 +12045,7 @@
|
|
|
11744
12045
|
"text": "string"
|
|
11745
12046
|
},
|
|
11746
12047
|
"default": "'Pan left'",
|
|
11747
|
-
"description": "
|
|
12048
|
+
"description": "The pan left button's label.",
|
|
11748
12049
|
"fieldName": "panLeftLabel"
|
|
11749
12050
|
},
|
|
11750
12051
|
{
|
|
@@ -11753,7 +12054,7 @@
|
|
|
11753
12054
|
"text": "string"
|
|
11754
12055
|
},
|
|
11755
12056
|
"default": "'Pan right'",
|
|
11756
|
-
"description": "
|
|
12057
|
+
"description": "The pan right button's label.",
|
|
11757
12058
|
"fieldName": "panRightLabel"
|
|
11758
12059
|
},
|
|
11759
12060
|
{
|
|
@@ -11762,7 +12063,7 @@
|
|
|
11762
12063
|
"text": "number"
|
|
11763
12064
|
},
|
|
11764
12065
|
"default": "0.25",
|
|
11765
|
-
"description": "How far one press
|
|
12066
|
+
"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
12067
|
"fieldName": "panStep"
|
|
11767
12068
|
},
|
|
11768
12069
|
{
|
|
@@ -11771,7 +12072,7 @@
|
|
|
11771
12072
|
"text": "string"
|
|
11772
12073
|
},
|
|
11773
12074
|
"default": "'Pan up'",
|
|
11774
|
-
"description": "
|
|
12075
|
+
"description": "The pan up button's label.",
|
|
11775
12076
|
"fieldName": "panUpLabel"
|
|
11776
12077
|
},
|
|
11777
12078
|
{
|
|
@@ -11780,7 +12081,7 @@
|
|
|
11780
12081
|
"text": "string"
|
|
11781
12082
|
},
|
|
11782
12083
|
"default": "'Zoom in'",
|
|
11783
|
-
"description": "
|
|
12084
|
+
"description": "The zoom in button's label.",
|
|
11784
12085
|
"fieldName": "zoomInLabel"
|
|
11785
12086
|
},
|
|
11786
12087
|
{
|
|
@@ -11789,7 +12090,7 @@
|
|
|
11789
12090
|
"text": "string"
|
|
11790
12091
|
},
|
|
11791
12092
|
"default": "'Zoom out'",
|
|
11792
|
-
"description": "
|
|
12093
|
+
"description": "The zoom out button's label.",
|
|
11793
12094
|
"fieldName": "zoomOutLabel"
|
|
11794
12095
|
}
|
|
11795
12096
|
],
|