@fusion.dev/helix 0.116.0 → 0.118.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 +3631 -468
- package/dist/canvas/root/canvas-root.css.js +4 -0
- package/dist/element-events.generated.js +9 -0
- package/dist/graph/index.d.ts +1 -0
- package/dist/graph/index.js +1 -0
- package/dist/graph/root/graph-root.css.d.ts +1 -0
- package/dist/graph/root/graph-root.css.js +208 -0
- package/dist/graph/root/graph-root.d.ts +31 -0
- package/dist/graph/root/graph-root.js +18 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/dist/map/root/map-root.css.js +0 -37
- package/dist/shared/viewport/viewport.css.js +37 -0
- package/package.json +6 -6
- package/types/jsx.d.ts +1355 -108
- package/types/svelte.d.ts +1 -0
- package/types/vue.d.ts +385 -37
package/custom-elements.json
CHANGED
|
@@ -14451,6 +14451,19 @@
|
|
|
14451
14451
|
"attribute": "separation",
|
|
14452
14452
|
"reflects": true
|
|
14453
14453
|
},
|
|
14454
|
+
{
|
|
14455
|
+
"kind": "field",
|
|
14456
|
+
"name": "activateHintLabel",
|
|
14457
|
+
"type": {
|
|
14458
|
+
"text": "string | undefined"
|
|
14459
|
+
},
|
|
14460
|
+
"description": "The hint shown when a surface waiting to be pressed is scrolled or\nswiped over, with `gestures=\"activate\"`. Absent is the family's own.",
|
|
14461
|
+
"attribute": "activate-hint-label",
|
|
14462
|
+
"inheritedFrom": {
|
|
14463
|
+
"name": "MixinViewport",
|
|
14464
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14465
|
+
}
|
|
14466
|
+
},
|
|
14454
14467
|
{
|
|
14455
14468
|
"kind": "field",
|
|
14456
14469
|
"name": "controls",
|
|
@@ -14506,6 +14519,19 @@
|
|
|
14506
14519
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14507
14520
|
}
|
|
14508
14521
|
},
|
|
14522
|
+
{
|
|
14523
|
+
"kind": "field",
|
|
14524
|
+
"name": "gestures",
|
|
14525
|
+
"type": {
|
|
14526
|
+
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
14527
|
+
},
|
|
14528
|
+
"description": "Which gestures the surface takes from the page.\n\n- `always`: the surface takes the wheel and one finger, for a surface\n that is the page, such as a full-screen view. A map rests here.\n- Unset is the family's own: `always` for a map, and for a board, a\n drag and a pinch, with the plain wheel left to the page until the\n board fills the screen.\n- `cooperative`: the wheel and one finger scroll the page, and the\n surface takes Ctrl or ⌘ with the wheel, and two fingers. The frame\n says so when a gesture passes to the page. Best for a surface embedded\n in a page.\n- `activate`: the surface takes nothing until it is pressed, and gives it\n back on Escape, when the pointer leaves it, or on a press elsewhere.\n\nThe keyboard and the frame's buttons work in every mode.\n\n**Unreflected and without a default**, because a default that reflected\nwould write an attribute onto every host that no server sent, and the\nhydration that followed would disagree with it.",
|
|
14529
|
+
"attribute": "gestures",
|
|
14530
|
+
"inheritedFrom": {
|
|
14531
|
+
"name": "MixinViewport",
|
|
14532
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14533
|
+
}
|
|
14534
|
+
},
|
|
14509
14535
|
{
|
|
14510
14536
|
"kind": "field",
|
|
14511
14537
|
"name": "idleDelay",
|
|
@@ -14590,6 +14616,45 @@
|
|
|
14590
14616
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14591
14617
|
}
|
|
14592
14618
|
},
|
|
14619
|
+
{
|
|
14620
|
+
"kind": "field",
|
|
14621
|
+
"name": "twoFingerHintLabel",
|
|
14622
|
+
"type": {
|
|
14623
|
+
"text": "string | undefined"
|
|
14624
|
+
},
|
|
14625
|
+
"description": "The hint shown when one finger swipes over a surface with\n`gestures=\"cooperative\"`. Absent is the family's own.",
|
|
14626
|
+
"attribute": "two-finger-hint-label",
|
|
14627
|
+
"inheritedFrom": {
|
|
14628
|
+
"name": "MixinViewport",
|
|
14629
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14630
|
+
}
|
|
14631
|
+
},
|
|
14632
|
+
{
|
|
14633
|
+
"kind": "field",
|
|
14634
|
+
"name": "usingLabel",
|
|
14635
|
+
"type": {
|
|
14636
|
+
"text": "string | undefined"
|
|
14637
|
+
},
|
|
14638
|
+
"description": "The line shown while a surface with `gestures=\"activate\"` has the\ngestures. Absent is the family's own.",
|
|
14639
|
+
"attribute": "using-label",
|
|
14640
|
+
"inheritedFrom": {
|
|
14641
|
+
"name": "MixinViewport",
|
|
14642
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14643
|
+
}
|
|
14644
|
+
},
|
|
14645
|
+
{
|
|
14646
|
+
"kind": "field",
|
|
14647
|
+
"name": "wheelHintLabel",
|
|
14648
|
+
"type": {
|
|
14649
|
+
"text": "string | undefined"
|
|
14650
|
+
},
|
|
14651
|
+
"description": "The hint shown when the wheel scrolls past a surface with\n`gestures=\"cooperative\"`, with `{key}`, which is ⌘ on a Mac and Ctrl\nelsewhere. Absent is the family's own.",
|
|
14652
|
+
"attribute": "wheel-hint-label",
|
|
14653
|
+
"inheritedFrom": {
|
|
14654
|
+
"name": "MixinViewport",
|
|
14655
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14656
|
+
}
|
|
14657
|
+
},
|
|
14593
14658
|
{
|
|
14594
14659
|
"kind": "field",
|
|
14595
14660
|
"name": "zoomInLabel",
|
|
@@ -14632,6 +14697,73 @@
|
|
|
14632
14697
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14633
14698
|
}
|
|
14634
14699
|
},
|
|
14700
|
+
{
|
|
14701
|
+
"kind": "field",
|
|
14702
|
+
"name": "gesturesTaken",
|
|
14703
|
+
"type": {
|
|
14704
|
+
"text": "boolean"
|
|
14705
|
+
},
|
|
14706
|
+
"privacy": "protected",
|
|
14707
|
+
"default": "false",
|
|
14708
|
+
"description": "Whether an `activate` surface has been pressed, and has the gestures.",
|
|
14709
|
+
"inheritedFrom": {
|
|
14710
|
+
"name": "MixinViewport",
|
|
14711
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14712
|
+
}
|
|
14713
|
+
},
|
|
14714
|
+
{
|
|
14715
|
+
"kind": "field",
|
|
14716
|
+
"name": "hint",
|
|
14717
|
+
"type": {
|
|
14718
|
+
"text": "string"
|
|
14719
|
+
},
|
|
14720
|
+
"privacy": "private",
|
|
14721
|
+
"default": "''",
|
|
14722
|
+
"description": "The hint over the surface while one shows, put there by a gesture it let pass.",
|
|
14723
|
+
"inheritedFrom": {
|
|
14724
|
+
"name": "MixinViewport",
|
|
14725
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14726
|
+
}
|
|
14727
|
+
},
|
|
14728
|
+
{
|
|
14729
|
+
"kind": "field",
|
|
14730
|
+
"name": "hinting",
|
|
14731
|
+
"type": {
|
|
14732
|
+
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
14733
|
+
},
|
|
14734
|
+
"privacy": "private",
|
|
14735
|
+
"description": "When the hint goes.",
|
|
14736
|
+
"inheritedFrom": {
|
|
14737
|
+
"name": "MixinViewport",
|
|
14738
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14739
|
+
}
|
|
14740
|
+
},
|
|
14741
|
+
{
|
|
14742
|
+
"kind": "field",
|
|
14743
|
+
"name": "hintAt",
|
|
14744
|
+
"type": {
|
|
14745
|
+
"text": "{ x: number; y: number } | undefined"
|
|
14746
|
+
},
|
|
14747
|
+
"privacy": "private",
|
|
14748
|
+
"description": "Where the gesture was, in the viewport's box, which the hint is shown\nat: where the reader is looking, and on the surface wherever a page laid\nits own content over the rest of it.",
|
|
14749
|
+
"inheritedFrom": {
|
|
14750
|
+
"name": "MixinViewport",
|
|
14751
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14752
|
+
}
|
|
14753
|
+
},
|
|
14754
|
+
{
|
|
14755
|
+
"kind": "field",
|
|
14756
|
+
"name": "takenBy",
|
|
14757
|
+
"type": {
|
|
14758
|
+
"text": "Event | undefined"
|
|
14759
|
+
},
|
|
14760
|
+
"privacy": "private",
|
|
14761
|
+
"description": "The press that took the gestures, which is not also the first gesture.",
|
|
14762
|
+
"inheritedFrom": {
|
|
14763
|
+
"name": "MixinViewport",
|
|
14764
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14765
|
+
}
|
|
14766
|
+
},
|
|
14635
14767
|
{
|
|
14636
14768
|
"kind": "field",
|
|
14637
14769
|
"name": "fullscreen",
|
|
@@ -14682,6 +14814,180 @@
|
|
|
14682
14814
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14683
14815
|
}
|
|
14684
14816
|
},
|
|
14817
|
+
{
|
|
14818
|
+
"kind": "field",
|
|
14819
|
+
"name": "restingGestureLabels",
|
|
14820
|
+
"type": {
|
|
14821
|
+
"text": "ViewportGestureLabels"
|
|
14822
|
+
},
|
|
14823
|
+
"privacy": "protected",
|
|
14824
|
+
"description": "What the surface says about its gestures where the page does not say\nit, which a family overrides to name what it is: \"Press the map to use\nit\" reads better than a word that fits every surface.",
|
|
14825
|
+
"readonly": true,
|
|
14826
|
+
"inheritedFrom": {
|
|
14827
|
+
"name": "MixinViewport",
|
|
14828
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14829
|
+
}
|
|
14830
|
+
},
|
|
14831
|
+
{
|
|
14832
|
+
"kind": "method",
|
|
14833
|
+
"name": "gestureAllowed",
|
|
14834
|
+
"privacy": "protected",
|
|
14835
|
+
"return": {
|
|
14836
|
+
"type": {
|
|
14837
|
+
"text": "boolean"
|
|
14838
|
+
}
|
|
14839
|
+
},
|
|
14840
|
+
"parameters": [
|
|
14841
|
+
{
|
|
14842
|
+
"name": "event",
|
|
14843
|
+
"type": {
|
|
14844
|
+
"text": "Event"
|
|
14845
|
+
}
|
|
14846
|
+
}
|
|
14847
|
+
],
|
|
14848
|
+
"description": "Whether a gesture that started with this event is the surface's to\nanswer, for a family that answers gestures itself. Never while an\n`activate` surface waits, and never on the press that ended the wait:\nthat press hands over the gestures and moves nothing.",
|
|
14849
|
+
"inheritedFrom": {
|
|
14850
|
+
"name": "MixinViewport",
|
|
14851
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14852
|
+
}
|
|
14853
|
+
},
|
|
14854
|
+
{
|
|
14855
|
+
"kind": "method",
|
|
14856
|
+
"name": "gesturesChanged",
|
|
14857
|
+
"privacy": "protected",
|
|
14858
|
+
"return": {
|
|
14859
|
+
"type": {
|
|
14860
|
+
"text": "void"
|
|
14861
|
+
}
|
|
14862
|
+
},
|
|
14863
|
+
"description": "Says that `gestureMode` changed. Nothing here; a family whose renderer\nis told through a connector says it with its own event.",
|
|
14864
|
+
"inheritedFrom": {
|
|
14865
|
+
"name": "MixinViewport",
|
|
14866
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14867
|
+
}
|
|
14868
|
+
},
|
|
14869
|
+
{
|
|
14870
|
+
"kind": "method",
|
|
14871
|
+
"name": "showHint",
|
|
14872
|
+
"privacy": "private",
|
|
14873
|
+
"return": {
|
|
14874
|
+
"type": {
|
|
14875
|
+
"text": "void"
|
|
14876
|
+
}
|
|
14877
|
+
},
|
|
14878
|
+
"parameters": [
|
|
14879
|
+
{
|
|
14880
|
+
"name": "words",
|
|
14881
|
+
"type": {
|
|
14882
|
+
"text": "string"
|
|
14883
|
+
}
|
|
14884
|
+
},
|
|
14885
|
+
{
|
|
14886
|
+
"name": "at",
|
|
14887
|
+
"optional": true,
|
|
14888
|
+
"type": {
|
|
14889
|
+
"text": "{ clientX: number; clientY: number }"
|
|
14890
|
+
}
|
|
14891
|
+
}
|
|
14892
|
+
],
|
|
14893
|
+
"description": "Shows a hint over the surface for a moment, where the gesture was.",
|
|
14894
|
+
"inheritedFrom": {
|
|
14895
|
+
"name": "MixinViewport",
|
|
14896
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14897
|
+
}
|
|
14898
|
+
},
|
|
14899
|
+
{
|
|
14900
|
+
"kind": "field",
|
|
14901
|
+
"name": "handleGestureWheel",
|
|
14902
|
+
"privacy": "private",
|
|
14903
|
+
"readonly": true,
|
|
14904
|
+
"description": "A wheel the surface let pass to the page, which is said: a reader\nscrolling the page past a surface that did not zoom is told why, and how\nto zoom it. **Ctrl or ⌘ with the wheel is the surface's**, and is what a\ntrackpad's pinch arrives as.",
|
|
14905
|
+
"inheritedFrom": {
|
|
14906
|
+
"name": "MixinViewport",
|
|
14907
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14908
|
+
}
|
|
14909
|
+
},
|
|
14910
|
+
{
|
|
14911
|
+
"kind": "field",
|
|
14912
|
+
"name": "handleGestureTouch",
|
|
14913
|
+
"privacy": "private",
|
|
14914
|
+
"readonly": true,
|
|
14915
|
+
"description": "One finger moving over the surface, which scrolls the page, and is said.",
|
|
14916
|
+
"inheritedFrom": {
|
|
14917
|
+
"name": "MixinViewport",
|
|
14918
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14919
|
+
}
|
|
14920
|
+
},
|
|
14921
|
+
{
|
|
14922
|
+
"kind": "field",
|
|
14923
|
+
"name": "handleTake",
|
|
14924
|
+
"privacy": "private",
|
|
14925
|
+
"readonly": true,
|
|
14926
|
+
"description": "A press on the surface itself, which hands a waiting surface the gestures.",
|
|
14927
|
+
"inheritedFrom": {
|
|
14928
|
+
"name": "MixinViewport",
|
|
14929
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14930
|
+
}
|
|
14931
|
+
},
|
|
14932
|
+
{
|
|
14933
|
+
"kind": "field",
|
|
14934
|
+
"name": "handleGiveBackKey",
|
|
14935
|
+
"privacy": "private",
|
|
14936
|
+
"readonly": true,
|
|
14937
|
+
"description": "Escape, which gives the page its scroll back.",
|
|
14938
|
+
"inheritedFrom": {
|
|
14939
|
+
"name": "MixinViewport",
|
|
14940
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14941
|
+
}
|
|
14942
|
+
},
|
|
14943
|
+
{
|
|
14944
|
+
"kind": "field",
|
|
14945
|
+
"name": "handleGiveBackOutside",
|
|
14946
|
+
"privacy": "private",
|
|
14947
|
+
"readonly": true,
|
|
14948
|
+
"description": "A press anywhere else on the page, which gives it its scroll back.",
|
|
14949
|
+
"inheritedFrom": {
|
|
14950
|
+
"name": "MixinViewport",
|
|
14951
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14952
|
+
}
|
|
14953
|
+
},
|
|
14954
|
+
{
|
|
14955
|
+
"kind": "field",
|
|
14956
|
+
"name": "handleGiveBackBlur",
|
|
14957
|
+
"privacy": "private",
|
|
14958
|
+
"readonly": true,
|
|
14959
|
+
"description": "The window losing focus, as a reader switching away does.",
|
|
14960
|
+
"inheritedFrom": {
|
|
14961
|
+
"name": "MixinViewport",
|
|
14962
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14963
|
+
}
|
|
14964
|
+
},
|
|
14965
|
+
{
|
|
14966
|
+
"kind": "field",
|
|
14967
|
+
"name": "handlePointerLeave",
|
|
14968
|
+
"privacy": "protected",
|
|
14969
|
+
"readonly": true,
|
|
14970
|
+
"description": "The pointer leaving the frame, which the family binds on its region.\n**Heard on the frame and not the drawing**, which a pointer resting on\nsomething raised over it has left. **A mouse or a pen and never a\nfinger**, whose `pointerleave` is the finger lifting: a tap took the\nsurface and gave it back in one.",
|
|
14971
|
+
"inheritedFrom": {
|
|
14972
|
+
"name": "MixinViewport",
|
|
14973
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14974
|
+
}
|
|
14975
|
+
},
|
|
14976
|
+
{
|
|
14977
|
+
"kind": "method",
|
|
14978
|
+
"name": "renderGestures",
|
|
14979
|
+
"privacy": "protected",
|
|
14980
|
+
"return": {
|
|
14981
|
+
"type": {
|
|
14982
|
+
"text": "TemplateResult"
|
|
14983
|
+
}
|
|
14984
|
+
},
|
|
14985
|
+
"description": "The hint over the surface and the line while it is in use, which the\nfamily draws inside its viewport, over what was slotted. The parts are\nwritten out, as the controls' are, so the manifest sees them.",
|
|
14986
|
+
"inheritedFrom": {
|
|
14987
|
+
"name": "MixinViewport",
|
|
14988
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14989
|
+
}
|
|
14990
|
+
},
|
|
14685
14991
|
{
|
|
14686
14992
|
"kind": "method",
|
|
14687
14993
|
"name": "panEvent",
|
|
@@ -16768,6 +17074,17 @@
|
|
|
16768
17074
|
"module": "src/canvas/root/canvas-root.ts"
|
|
16769
17075
|
}
|
|
16770
17076
|
},
|
|
17077
|
+
{
|
|
17078
|
+
"kind": "field",
|
|
17079
|
+
"name": "handleTouchStart",
|
|
17080
|
+
"privacy": "private",
|
|
17081
|
+
"readonly": true,
|
|
17082
|
+
"description": "A second finger on a cooperative board, which would otherwise go on\nscrolling the page the first finger started: stopped at the start, so\nthe two fingers pinch and move the board. **Not passive**, which is the\nonly way a start can be stopped.",
|
|
17083
|
+
"inheritedFrom": {
|
|
17084
|
+
"name": "HelixHeadlessCanvas",
|
|
17085
|
+
"module": "src/canvas/root/canvas-root.ts"
|
|
17086
|
+
}
|
|
17087
|
+
},
|
|
16771
17088
|
{
|
|
16772
17089
|
"kind": "field",
|
|
16773
17090
|
"name": "handleStopKeydown",
|
|
@@ -17725,6 +18042,18 @@
|
|
|
17725
18042
|
"description": "How the board is set apart from the page. `plain` draws no frame.\n\nFramed is where it rests. Plain is for a board that fills a panel or an\napp's working area, where the container is already the frame.",
|
|
17726
18043
|
"fieldName": "separation"
|
|
17727
18044
|
},
|
|
18045
|
+
{
|
|
18046
|
+
"name": "activate-hint-label",
|
|
18047
|
+
"type": {
|
|
18048
|
+
"text": "string | undefined"
|
|
18049
|
+
},
|
|
18050
|
+
"description": "The hint shown when a surface waiting to be pressed is scrolled or\nswiped over, with `gestures=\"activate\"`. Absent is the family's own.",
|
|
18051
|
+
"fieldName": "activateHintLabel",
|
|
18052
|
+
"inheritedFrom": {
|
|
18053
|
+
"name": "MixinViewport",
|
|
18054
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
18055
|
+
}
|
|
18056
|
+
},
|
|
17728
18057
|
{
|
|
17729
18058
|
"name": "controls",
|
|
17730
18059
|
"type": {
|
|
@@ -17774,6 +18103,18 @@
|
|
|
17774
18103
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
17775
18104
|
}
|
|
17776
18105
|
},
|
|
18106
|
+
{
|
|
18107
|
+
"name": "gestures",
|
|
18108
|
+
"type": {
|
|
18109
|
+
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
18110
|
+
},
|
|
18111
|
+
"description": "Which gestures the surface takes from the page.\n\n- `always`: the surface takes the wheel and one finger, for a surface\n that is the page, such as a full-screen view. A map rests here.\n- Unset is the family's own: `always` for a map, and for a board, a\n drag and a pinch, with the plain wheel left to the page until the\n board fills the screen.\n- `cooperative`: the wheel and one finger scroll the page, and the\n surface takes Ctrl or ⌘ with the wheel, and two fingers. The frame\n says so when a gesture passes to the page. Best for a surface embedded\n in a page.\n- `activate`: the surface takes nothing until it is pressed, and gives it\n back on Escape, when the pointer leaves it, or on a press elsewhere.\n\nThe keyboard and the frame's buttons work in every mode.\n\n**Unreflected and without a default**, because a default that reflected\nwould write an attribute onto every host that no server sent, and the\nhydration that followed would disagree with it.",
|
|
18112
|
+
"fieldName": "gestures",
|
|
18113
|
+
"inheritedFrom": {
|
|
18114
|
+
"name": "MixinViewport",
|
|
18115
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
18116
|
+
}
|
|
18117
|
+
},
|
|
17777
18118
|
{
|
|
17778
18119
|
"name": "idle-delay",
|
|
17779
18120
|
"type": {
|
|
@@ -17852,6 +18193,42 @@
|
|
|
17852
18193
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
17853
18194
|
}
|
|
17854
18195
|
},
|
|
18196
|
+
{
|
|
18197
|
+
"name": "two-finger-hint-label",
|
|
18198
|
+
"type": {
|
|
18199
|
+
"text": "string | undefined"
|
|
18200
|
+
},
|
|
18201
|
+
"description": "The hint shown when one finger swipes over a surface with\n`gestures=\"cooperative\"`. Absent is the family's own.",
|
|
18202
|
+
"fieldName": "twoFingerHintLabel",
|
|
18203
|
+
"inheritedFrom": {
|
|
18204
|
+
"name": "MixinViewport",
|
|
18205
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
18206
|
+
}
|
|
18207
|
+
},
|
|
18208
|
+
{
|
|
18209
|
+
"name": "using-label",
|
|
18210
|
+
"type": {
|
|
18211
|
+
"text": "string | undefined"
|
|
18212
|
+
},
|
|
18213
|
+
"description": "The line shown while a surface with `gestures=\"activate\"` has the\ngestures. Absent is the family's own.",
|
|
18214
|
+
"fieldName": "usingLabel",
|
|
18215
|
+
"inheritedFrom": {
|
|
18216
|
+
"name": "MixinViewport",
|
|
18217
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
18218
|
+
}
|
|
18219
|
+
},
|
|
18220
|
+
{
|
|
18221
|
+
"name": "wheel-hint-label",
|
|
18222
|
+
"type": {
|
|
18223
|
+
"text": "string | undefined"
|
|
18224
|
+
},
|
|
18225
|
+
"description": "The hint shown when the wheel scrolls past a surface with\n`gestures=\"cooperative\"`, with `{key}`, which is ⌘ on a Mac and Ctrl\nelsewhere. Absent is the family's own.",
|
|
18226
|
+
"fieldName": "wheelHintLabel",
|
|
18227
|
+
"inheritedFrom": {
|
|
18228
|
+
"name": "MixinViewport",
|
|
18229
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
18230
|
+
}
|
|
18231
|
+
},
|
|
17855
18232
|
{
|
|
17856
18233
|
"name": "zoom-in-label",
|
|
17857
18234
|
"type": {
|
|
@@ -18218,6 +18595,22 @@
|
|
|
18218
18595
|
"module": "src/canvas/root/canvas-root.ts"
|
|
18219
18596
|
}
|
|
18220
18597
|
},
|
|
18598
|
+
{
|
|
18599
|
+
"description": "Words over the board for a moment when it lets a gesture pass to the page, such as how to zoom it.",
|
|
18600
|
+
"name": "gesture-hint",
|
|
18601
|
+
"inheritedFrom": {
|
|
18602
|
+
"name": "HelixHeadlessCanvas",
|
|
18603
|
+
"module": "src/canvas/root/canvas-root.ts"
|
|
18604
|
+
}
|
|
18605
|
+
},
|
|
18606
|
+
{
|
|
18607
|
+
"description": "The line shown while a board with `gestures=\"activate\"` has the gestures.",
|
|
18608
|
+
"name": "gesture-status",
|
|
18609
|
+
"inheritedFrom": {
|
|
18610
|
+
"name": "HelixHeadlessCanvas",
|
|
18611
|
+
"module": "src/canvas/root/canvas-root.ts"
|
|
18612
|
+
}
|
|
18613
|
+
},
|
|
18221
18614
|
{
|
|
18222
18615
|
"description": "The strip above the board.",
|
|
18223
18616
|
"name": "header",
|
|
@@ -18538,6 +18931,22 @@
|
|
|
18538
18931
|
"module": "src/canvas/root/canvas-root.ts"
|
|
18539
18932
|
}
|
|
18540
18933
|
},
|
|
18934
|
+
{
|
|
18935
|
+
"description": "The page keeps the plain wheel and one finger, with `gestures=\"cooperative\"` or while a board with `gestures=\"activate\"` waits to be pressed.",
|
|
18936
|
+
"name": "sharing",
|
|
18937
|
+
"inheritedFrom": {
|
|
18938
|
+
"name": "HelixHeadlessCanvas",
|
|
18939
|
+
"module": "src/canvas/root/canvas-root.ts"
|
|
18940
|
+
}
|
|
18941
|
+
},
|
|
18942
|
+
{
|
|
18943
|
+
"description": "A board with `gestures=\"activate\"` has been pressed and has the gestures.",
|
|
18944
|
+
"name": "using",
|
|
18945
|
+
"inheritedFrom": {
|
|
18946
|
+
"name": "HelixHeadlessCanvas",
|
|
18947
|
+
"module": "src/canvas/root/canvas-root.ts"
|
|
18948
|
+
}
|
|
18949
|
+
},
|
|
18541
18950
|
{
|
|
18542
18951
|
"description": "Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.",
|
|
18543
18952
|
"name": "settled",
|
|
@@ -61523,22 +61932,22 @@
|
|
|
61523
61932
|
},
|
|
61524
61933
|
{
|
|
61525
61934
|
"kind": "javascript-module",
|
|
61526
|
-
"path": "src/
|
|
61935
|
+
"path": "src/graph/index.ts",
|
|
61527
61936
|
"declarations": [],
|
|
61528
61937
|
"exports": [
|
|
61529
61938
|
{
|
|
61530
61939
|
"kind": "js",
|
|
61531
|
-
"name": "
|
|
61940
|
+
"name": "HelixGraph",
|
|
61532
61941
|
"declaration": {
|
|
61533
|
-
"name": "
|
|
61534
|
-
"module": "
|
|
61942
|
+
"name": "HelixGraph",
|
|
61943
|
+
"module": "./root/graph-root.js"
|
|
61535
61944
|
}
|
|
61536
61945
|
}
|
|
61537
61946
|
]
|
|
61538
61947
|
},
|
|
61539
61948
|
{
|
|
61540
61949
|
"kind": "javascript-module",
|
|
61541
|
-
"path": "src/
|
|
61950
|
+
"path": "src/graph/root/graph-root.css.ts",
|
|
61542
61951
|
"declarations": [
|
|
61543
61952
|
{
|
|
61544
61953
|
"kind": "variable",
|
|
@@ -61551,328 +61960,2994 @@
|
|
|
61551
61960
|
"name": "styles",
|
|
61552
61961
|
"declaration": {
|
|
61553
61962
|
"name": "styles",
|
|
61554
|
-
"module": "src/
|
|
61963
|
+
"module": "src/graph/root/graph-root.css.ts"
|
|
61555
61964
|
}
|
|
61556
61965
|
}
|
|
61557
61966
|
]
|
|
61558
61967
|
},
|
|
61559
61968
|
{
|
|
61560
61969
|
"kind": "javascript-module",
|
|
61561
|
-
"path": "src/
|
|
61970
|
+
"path": "src/graph/root/graph-root.ts",
|
|
61562
61971
|
"declarations": [
|
|
61563
61972
|
{
|
|
61564
61973
|
"kind": "class",
|
|
61565
|
-
"description": "
|
|
61566
|
-
"name": "
|
|
61974
|
+
"description": "The styled frame: the drawing with its zoom and fullscreen buttons, and the\nlist of notes beside it, which moves below the drawing where the frame is\nnarrower than 40rem. The selected note leads the list on a surface of its\nown, and the notes linked to it are named by how they link.",
|
|
61975
|
+
"name": "HelixGraph",
|
|
61567
61976
|
"cssProperties": [
|
|
61568
61977
|
{
|
|
61569
|
-
"description": "
|
|
61570
|
-
"name": "--
|
|
61571
|
-
}
|
|
61572
|
-
],
|
|
61573
|
-
"slots": [
|
|
61978
|
+
"description": "The color behind the drawing while it loads.",
|
|
61979
|
+
"name": "--graph-background-color"
|
|
61980
|
+
},
|
|
61574
61981
|
{
|
|
61575
|
-
"description": "The
|
|
61576
|
-
"name": ""
|
|
61982
|
+
"description": "The frame's height, as a length.",
|
|
61983
|
+
"name": "--graph-block-size"
|
|
61984
|
+
},
|
|
61985
|
+
{
|
|
61986
|
+
"description": "The frame's border color.",
|
|
61987
|
+
"name": "--graph-border-color"
|
|
61988
|
+
},
|
|
61989
|
+
{
|
|
61990
|
+
"description": "The list's width beside the drawing.",
|
|
61991
|
+
"name": "--graph-panel-size"
|
|
61992
|
+
},
|
|
61993
|
+
{
|
|
61994
|
+
"description": "The background of the zoom and fullscreen buttons. Map and Canvas use the same property.",
|
|
61995
|
+
"name": "--viewport-control-background-color"
|
|
61577
61996
|
}
|
|
61578
61997
|
],
|
|
61579
61998
|
"members": [
|
|
61580
61999
|
{
|
|
61581
62000
|
"kind": "field",
|
|
61582
|
-
"name": "
|
|
62001
|
+
"name": "activateHintLabel",
|
|
61583
62002
|
"type": {
|
|
61584
|
-
"text": "
|
|
62003
|
+
"text": "string | undefined"
|
|
61585
62004
|
},
|
|
61586
|
-
"description": "
|
|
61587
|
-
"attribute": "
|
|
61588
|
-
"
|
|
62005
|
+
"description": "The hint shown when a surface waiting to be pressed is scrolled or\nswiped over, with `gestures=\"activate\"`. Absent is the family's own.",
|
|
62006
|
+
"attribute": "activate-hint-label",
|
|
62007
|
+
"inheritedFrom": {
|
|
62008
|
+
"name": "MixinViewport",
|
|
62009
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62010
|
+
}
|
|
61589
62011
|
},
|
|
61590
62012
|
{
|
|
61591
62013
|
"kind": "field",
|
|
61592
|
-
"name": "
|
|
62014
|
+
"name": "controls",
|
|
61593
62015
|
"type": {
|
|
61594
|
-
"text": "
|
|
62016
|
+
"text": "string | undefined"
|
|
61595
62017
|
},
|
|
61596
|
-
"description": "A
|
|
61597
|
-
"attribute": "
|
|
61598
|
-
"reflects": true
|
|
62018
|
+
"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.",
|
|
62019
|
+
"attribute": "controls",
|
|
62020
|
+
"reflects": true,
|
|
62021
|
+
"inheritedFrom": {
|
|
62022
|
+
"name": "MixinViewport",
|
|
62023
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62024
|
+
}
|
|
61599
62025
|
},
|
|
61600
62026
|
{
|
|
61601
62027
|
"kind": "field",
|
|
61602
|
-
"name": "
|
|
62028
|
+
"name": "controlsLabel",
|
|
61603
62029
|
"type": {
|
|
61604
|
-
"text": "
|
|
62030
|
+
"text": "string | undefined"
|
|
61605
62031
|
},
|
|
61606
|
-
"description": "The
|
|
61607
|
-
"attribute": "
|
|
61608
|
-
"
|
|
62032
|
+
"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.",
|
|
62033
|
+
"attribute": "controls-label",
|
|
62034
|
+
"inheritedFrom": {
|
|
62035
|
+
"name": "MixinViewport",
|
|
62036
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62037
|
+
}
|
|
61609
62038
|
},
|
|
61610
62039
|
{
|
|
61611
62040
|
"kind": "field",
|
|
61612
|
-
"name": "
|
|
62041
|
+
"name": "controlsPlacement",
|
|
62042
|
+
"type": {
|
|
62043
|
+
"text": "'top-start' | 'top-end' | 'bottom-start' | 'bottom-end' | undefined"
|
|
62044
|
+
},
|
|
62045
|
+
"description": "Which corner the controls sit in.\n\n**Configurable because there is no safe default**, which is a collision\nrather than a taste: whatever a consumer slots may put its own controls\nin any corner, and every library that draws some made this a setting for\nthe same reason.\n\nLogical corners rather than left and right, so a right-to-left page moves\nthem without a consumer writing a second rule. Absent is the top end, a\nresting value being an attribute's absence: a default that reflected\nwould write an attribute onto every host that no server sent.",
|
|
62046
|
+
"attribute": "controls-placement",
|
|
62047
|
+
"reflects": true,
|
|
62048
|
+
"inheritedFrom": {
|
|
62049
|
+
"name": "MixinViewport",
|
|
62050
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62051
|
+
}
|
|
62052
|
+
},
|
|
62053
|
+
{
|
|
62054
|
+
"kind": "field",
|
|
62055
|
+
"name": "fullscreenLabel",
|
|
61613
62056
|
"type": {
|
|
61614
62057
|
"text": "string"
|
|
61615
62058
|
},
|
|
61616
|
-
"default": "''",
|
|
61617
|
-
"description": "The
|
|
61618
|
-
"attribute": "
|
|
62059
|
+
"default": "'Fill the screen'",
|
|
62060
|
+
"description": "The fullscreen button's label.",
|
|
62061
|
+
"attribute": "fullscreen-label",
|
|
62062
|
+
"inheritedFrom": {
|
|
62063
|
+
"name": "MixinViewport",
|
|
62064
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62065
|
+
}
|
|
61619
62066
|
},
|
|
61620
62067
|
{
|
|
61621
|
-
"kind": "
|
|
61622
|
-
"name": "
|
|
61623
|
-
"
|
|
61624
|
-
|
|
61625
|
-
"type": {
|
|
61626
|
-
"text": "void"
|
|
61627
|
-
}
|
|
62068
|
+
"kind": "field",
|
|
62069
|
+
"name": "gestures",
|
|
62070
|
+
"type": {
|
|
62071
|
+
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
61628
62072
|
},
|
|
61629
|
-
"description": "
|
|
62073
|
+
"description": "Which gestures the surface takes from the page.\n\n- `always`: the surface takes the wheel and one finger, for a surface\n that is the page, such as a full-screen view. A map rests here.\n- Unset is the family's own: `always` for a map, and for a board, a\n drag and a pinch, with the plain wheel left to the page until the\n board fills the screen.\n- `cooperative`: the wheel and one finger scroll the page, and the\n surface takes Ctrl or ⌘ with the wheel, and two fingers. The frame\n says so when a gesture passes to the page. Best for a surface embedded\n in a page.\n- `activate`: the surface takes nothing until it is pressed, and gives it\n back on Escape, when the pointer leaves it, or on a press elsewhere.\n\nThe keyboard and the frame's buttons work in every mode.\n\n**Unreflected and without a default**, because a default that reflected\nwould write an attribute onto every host that no server sent, and the\nhydration that followed would disagree with it.",
|
|
62074
|
+
"attribute": "gestures",
|
|
62075
|
+
"inheritedFrom": {
|
|
62076
|
+
"name": "MixinViewport",
|
|
62077
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62078
|
+
}
|
|
61630
62079
|
},
|
|
61631
62080
|
{
|
|
61632
62081
|
"kind": "field",
|
|
61633
|
-
"name": "
|
|
62082
|
+
"name": "idleDelay",
|
|
62083
|
+
"type": {
|
|
62084
|
+
"text": "number"
|
|
62085
|
+
},
|
|
62086
|
+
"default": "0",
|
|
62087
|
+
"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.",
|
|
62088
|
+
"attribute": "idle-delay",
|
|
62089
|
+
"inheritedFrom": {
|
|
62090
|
+
"name": "MixinViewport",
|
|
62091
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62092
|
+
}
|
|
62093
|
+
},
|
|
62094
|
+
{
|
|
62095
|
+
"kind": "field",
|
|
62096
|
+
"name": "panDownLabel",
|
|
61634
62097
|
"type": {
|
|
61635
62098
|
"text": "string"
|
|
61636
62099
|
},
|
|
61637
|
-
"
|
|
61638
|
-
"
|
|
61639
|
-
"
|
|
62100
|
+
"default": "'Pan down'",
|
|
62101
|
+
"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.",
|
|
62102
|
+
"attribute": "pan-down-label",
|
|
61640
62103
|
"inheritedFrom": {
|
|
61641
|
-
"name": "
|
|
61642
|
-
"module": "src/
|
|
62104
|
+
"name": "MixinViewport",
|
|
62105
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
61643
62106
|
}
|
|
61644
62107
|
},
|
|
61645
62108
|
{
|
|
61646
|
-
"kind": "
|
|
61647
|
-
"name": "
|
|
61648
|
-
"
|
|
61649
|
-
|
|
61650
|
-
"type": {
|
|
61651
|
-
"text": "StaticValue"
|
|
61652
|
-
}
|
|
62109
|
+
"kind": "field",
|
|
62110
|
+
"name": "panLeftLabel",
|
|
62111
|
+
"type": {
|
|
62112
|
+
"text": "string"
|
|
61653
62113
|
},
|
|
61654
|
-
"
|
|
61655
|
-
|
|
61656
|
-
|
|
61657
|
-
"type": {
|
|
61658
|
-
"text": "string"
|
|
61659
|
-
}
|
|
61660
|
-
}
|
|
61661
|
-
],
|
|
61662
|
-
"description": "One composed tag, as a static value a template can interpolate.\n\n`unsafeStatic` is safe by construction: the name is a literal in our own\nsource and the prefix is one of two strings this class defines. Called per\nrender and not cached, which costs nothing, because `static-html` keys its\ntemplate cache on the joined string rather than on the object.",
|
|
62114
|
+
"default": "'Pan left'",
|
|
62115
|
+
"description": "The pan left button's label.",
|
|
62116
|
+
"attribute": "pan-left-label",
|
|
61663
62117
|
"inheritedFrom": {
|
|
61664
|
-
"name": "
|
|
61665
|
-
"module": "src/
|
|
62118
|
+
"name": "MixinViewport",
|
|
62119
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
61666
62120
|
}
|
|
61667
62121
|
},
|
|
61668
62122
|
{
|
|
61669
|
-
"kind": "
|
|
61670
|
-
"name": "
|
|
61671
|
-
"
|
|
61672
|
-
|
|
61673
|
-
"type": {
|
|
61674
|
-
"text": "T | null"
|
|
61675
|
-
}
|
|
62123
|
+
"kind": "field",
|
|
62124
|
+
"name": "panRightLabel",
|
|
62125
|
+
"type": {
|
|
62126
|
+
"text": "string"
|
|
61676
62127
|
},
|
|
61677
|
-
"
|
|
61678
|
-
|
|
61679
|
-
|
|
61680
|
-
"type": {
|
|
61681
|
-
"text": "string"
|
|
61682
|
-
}
|
|
61683
|
-
}
|
|
61684
|
-
],
|
|
61685
|
-
"description": "One of this element's own parts, by name, or null where it is not rendered.\n\nNot `part`, which every element already has: `Element.part` is the\n`DOMTokenList` of the names the element itself carries, and a method under\nthat name is a type error on every subclass.\n\n**One guard for every lookup.** Lit's server shim has no `querySelector`\non the render root, so a lookup reached during a server render, from a\ngetter a template reads or from `willUpdate`, throws there and nowhere\nelse. Four spellings of the same guard had grown across the library, and\na fifth site with none. Null on the server, which is what the rest of the\ncode already treats a part that has not rendered as.\n\n**`~=` and not `=`.** A part drawn in a state carries a second name while\nthe state holds, `part=\"page page-current\"`, and an exact match stops\nfinding it for exactly as long as it is the one that matters.\n\n`helix component`'s `selectors` reads these calls the way it reads a\n`querySelector('[part=\"x\"]')`, so a name nothing renders is a finding\nrather than a null an optional chain swallows.",
|
|
62128
|
+
"default": "'Pan right'",
|
|
62129
|
+
"description": "The pan right button's label.",
|
|
62130
|
+
"attribute": "pan-right-label",
|
|
61686
62131
|
"inheritedFrom": {
|
|
61687
|
-
"name": "
|
|
61688
|
-
"module": "src/
|
|
62132
|
+
"name": "MixinViewport",
|
|
62133
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
61689
62134
|
}
|
|
61690
62135
|
},
|
|
61691
62136
|
{
|
|
61692
62137
|
"kind": "field",
|
|
61693
|
-
"name": "
|
|
62138
|
+
"name": "panStep",
|
|
61694
62139
|
"type": {
|
|
61695
|
-
"text": "
|
|
62140
|
+
"text": "number"
|
|
61696
62141
|
},
|
|
61697
|
-
"
|
|
61698
|
-
"
|
|
61699
|
-
"
|
|
62142
|
+
"default": "0.25",
|
|
62143
|
+
"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.",
|
|
62144
|
+
"attribute": "pan-step",
|
|
61700
62145
|
"inheritedFrom": {
|
|
61701
|
-
"name": "
|
|
61702
|
-
"module": "src/
|
|
62146
|
+
"name": "MixinViewport",
|
|
62147
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
61703
62148
|
}
|
|
61704
62149
|
},
|
|
61705
62150
|
{
|
|
61706
|
-
"kind": "
|
|
61707
|
-
"name": "
|
|
61708
|
-
"
|
|
61709
|
-
|
|
61710
|
-
"type": {
|
|
61711
|
-
"text": "void"
|
|
61712
|
-
}
|
|
62151
|
+
"kind": "field",
|
|
62152
|
+
"name": "panUpLabel",
|
|
62153
|
+
"type": {
|
|
62154
|
+
"text": "string"
|
|
61713
62155
|
},
|
|
61714
|
-
"
|
|
61715
|
-
|
|
61716
|
-
|
|
61717
|
-
"type": {
|
|
61718
|
-
"text": "string"
|
|
61719
|
-
}
|
|
61720
|
-
},
|
|
61721
|
-
{
|
|
61722
|
-
"name": "on",
|
|
61723
|
-
"type": {
|
|
61724
|
-
"text": "boolean"
|
|
61725
|
-
}
|
|
61726
|
-
}
|
|
61727
|
-
],
|
|
61728
|
-
"description": "Records a boolean fact about this element as a custom state.\n\n**The host belongs to whoever rendered it, and a component's own\nbookkeeping may not be kept there.** An attribute written on the first\nupdate is markup a consumer's server never sent, so a React consumer\nhydrates a DOM that has gained attributes since and reports a mismatch it\nwill not patch up. A custom state is not in the DOM at all: it carries the\nfact to a stylesheet through `:state()` and leaves the markup alone, so the\nserver's output and the client's agree by construction.\n\n`SETTLED` carries the long version of that argument; `checked`, `open`,\n`invalid` and `has-label` are recorded the same way, each of them a state a\n`default-*` attribute resolves before React reaches the node.\n\n**Deferring the definitions is not a fix and could not be.** Importing them\nfrom an effect so the upgrades fall the other side of hydration works only\nwhile hydration is one pass: anything that splits it, a streamed segment or\na suspended boundary, puts an upgrade back inside the window. Timing cannot\nbe the guarantee when the fact is kept somewhere React reconciles.\n\nFeature-tested rather than assumed, the way `hostAria` tests element\nreferences. An engine without `CustomStateSet` records nothing and keeps\nwhatever the resting rule draws, which is the safe direction to fail.\n\n**The engines the test is for are browsers**: Safari below 17.4 and Firefox\nbelow 126, where the write is a `TypeError`, so a component bypassing this\nfails to render rather than rendering without whatever the state draws.\nLit's server shim sets `states`, so the guard passes there and records a\nstate nothing reads, which is harmless.",
|
|
62156
|
+
"default": "'Pan up'",
|
|
62157
|
+
"description": "The pan up button's label.",
|
|
62158
|
+
"attribute": "pan-up-label",
|
|
61729
62159
|
"inheritedFrom": {
|
|
61730
|
-
"name": "
|
|
61731
|
-
"module": "src/
|
|
62160
|
+
"name": "MixinViewport",
|
|
62161
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
61732
62162
|
}
|
|
61733
62163
|
},
|
|
61734
62164
|
{
|
|
61735
62165
|
"kind": "field",
|
|
61736
|
-
"name": "
|
|
62166
|
+
"name": "twoFingerHintLabel",
|
|
61737
62167
|
"type": {
|
|
61738
|
-
"text": "
|
|
62168
|
+
"text": "string | undefined"
|
|
61739
62169
|
},
|
|
61740
|
-
"
|
|
61741
|
-
"
|
|
61742
|
-
"default": "new Promise<void>((resolve) => { this.resolveSettled = resolve })",
|
|
62170
|
+
"description": "The hint shown when one finger swipes over a surface with\n`gestures=\"cooperative\"`. Absent is the family's own.",
|
|
62171
|
+
"attribute": "two-finger-hint-label",
|
|
61743
62172
|
"inheritedFrom": {
|
|
61744
|
-
"name": "
|
|
61745
|
-
"module": "src/
|
|
62173
|
+
"name": "MixinViewport",
|
|
62174
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
61746
62175
|
}
|
|
61747
62176
|
},
|
|
61748
62177
|
{
|
|
61749
62178
|
"kind": "field",
|
|
61750
|
-
"name": "
|
|
62179
|
+
"name": "usingLabel",
|
|
61751
62180
|
"type": {
|
|
61752
|
-
"text": "
|
|
62181
|
+
"text": "string | undefined"
|
|
61753
62182
|
},
|
|
61754
|
-
"
|
|
61755
|
-
"
|
|
62183
|
+
"description": "The line shown while a surface with `gestures=\"activate\"` has the\ngestures. Absent is the family's own.",
|
|
62184
|
+
"attribute": "using-label",
|
|
61756
62185
|
"inheritedFrom": {
|
|
61757
|
-
"name": "
|
|
61758
|
-
"module": "src/
|
|
62186
|
+
"name": "MixinViewport",
|
|
62187
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
61759
62188
|
}
|
|
61760
62189
|
},
|
|
61761
62190
|
{
|
|
61762
62191
|
"kind": "field",
|
|
61763
|
-
"name": "
|
|
62192
|
+
"name": "wheelHintLabel",
|
|
62193
|
+
"type": {
|
|
62194
|
+
"text": "string | undefined"
|
|
62195
|
+
},
|
|
62196
|
+
"description": "The hint shown when the wheel scrolls past a surface with\n`gestures=\"cooperative\"`, with `{key}`, which is ⌘ on a Mac and Ctrl\nelsewhere. Absent is the family's own.",
|
|
62197
|
+
"attribute": "wheel-hint-label",
|
|
62198
|
+
"inheritedFrom": {
|
|
62199
|
+
"name": "MixinViewport",
|
|
62200
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62201
|
+
}
|
|
62202
|
+
},
|
|
62203
|
+
{
|
|
62204
|
+
"kind": "field",
|
|
62205
|
+
"name": "zoomInLabel",
|
|
62206
|
+
"type": {
|
|
62207
|
+
"text": "string"
|
|
62208
|
+
},
|
|
62209
|
+
"default": "'Zoom in'",
|
|
62210
|
+
"description": "The zoom in button's label.",
|
|
62211
|
+
"attribute": "zoom-in-label",
|
|
62212
|
+
"inheritedFrom": {
|
|
62213
|
+
"name": "MixinViewport",
|
|
62214
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62215
|
+
}
|
|
62216
|
+
},
|
|
62217
|
+
{
|
|
62218
|
+
"kind": "field",
|
|
62219
|
+
"name": "resting",
|
|
61764
62220
|
"type": {
|
|
61765
62221
|
"text": "boolean"
|
|
61766
62222
|
},
|
|
61767
|
-
"privacy": "
|
|
62223
|
+
"privacy": "protected",
|
|
61768
62224
|
"default": "false",
|
|
61769
|
-
"description": "Whether the
|
|
62225
|
+
"description": "Whether the reader has been still long enough to hide the chrome.",
|
|
61770
62226
|
"inheritedFrom": {
|
|
61771
|
-
"name": "
|
|
61772
|
-
"module": "src/
|
|
62227
|
+
"name": "MixinViewport",
|
|
62228
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
61773
62229
|
}
|
|
61774
62230
|
},
|
|
61775
62231
|
{
|
|
61776
62232
|
"kind": "field",
|
|
61777
|
-
"name": "
|
|
62233
|
+
"name": "filled",
|
|
61778
62234
|
"type": {
|
|
61779
62235
|
"text": "boolean"
|
|
61780
62236
|
},
|
|
61781
62237
|
"privacy": "protected",
|
|
61782
|
-
"
|
|
61783
|
-
"
|
|
62238
|
+
"default": "false",
|
|
62239
|
+
"description": "Whether the surface is filling the screen.",
|
|
61784
62240
|
"inheritedFrom": {
|
|
61785
|
-
"name": "
|
|
61786
|
-
"module": "src/
|
|
62241
|
+
"name": "MixinViewport",
|
|
62242
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
61787
62243
|
}
|
|
61788
62244
|
},
|
|
61789
62245
|
{
|
|
61790
62246
|
"kind": "field",
|
|
61791
|
-
"name": "
|
|
62247
|
+
"name": "gesturesTaken",
|
|
61792
62248
|
"type": {
|
|
61793
62249
|
"text": "boolean"
|
|
61794
62250
|
},
|
|
61795
62251
|
"privacy": "protected",
|
|
61796
|
-
"
|
|
61797
|
-
"
|
|
62252
|
+
"default": "false",
|
|
62253
|
+
"description": "Whether an `activate` surface has been pressed, and has the gestures.",
|
|
61798
62254
|
"inheritedFrom": {
|
|
61799
|
-
"name": "
|
|
61800
|
-
"module": "src/
|
|
62255
|
+
"name": "MixinViewport",
|
|
62256
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
61801
62257
|
}
|
|
61802
62258
|
},
|
|
61803
62259
|
{
|
|
61804
|
-
"kind": "
|
|
61805
|
-
"name": "
|
|
61806
|
-
"
|
|
61807
|
-
|
|
61808
|
-
"type": {
|
|
61809
|
-
"text": "void"
|
|
61810
|
-
}
|
|
62260
|
+
"kind": "field",
|
|
62261
|
+
"name": "hint",
|
|
62262
|
+
"type": {
|
|
62263
|
+
"text": "string"
|
|
61811
62264
|
},
|
|
61812
|
-
"
|
|
62265
|
+
"privacy": "private",
|
|
62266
|
+
"default": "''",
|
|
62267
|
+
"description": "The hint over the surface while one shows, put there by a gesture it let pass.",
|
|
61813
62268
|
"inheritedFrom": {
|
|
61814
|
-
"name": "
|
|
61815
|
-
"module": "src/
|
|
62269
|
+
"name": "MixinViewport",
|
|
62270
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
61816
62271
|
}
|
|
61817
62272
|
},
|
|
61818
62273
|
{
|
|
61819
62274
|
"kind": "field",
|
|
61820
|
-
"name": "
|
|
62275
|
+
"name": "hinting",
|
|
61821
62276
|
"type": {
|
|
61822
|
-
"text": "
|
|
62277
|
+
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
62278
|
+
},
|
|
62279
|
+
"privacy": "private",
|
|
62280
|
+
"description": "When the hint goes.",
|
|
62281
|
+
"inheritedFrom": {
|
|
62282
|
+
"name": "MixinViewport",
|
|
62283
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62284
|
+
}
|
|
62285
|
+
},
|
|
62286
|
+
{
|
|
62287
|
+
"kind": "field",
|
|
62288
|
+
"name": "hintAt",
|
|
62289
|
+
"type": {
|
|
62290
|
+
"text": "{ x: number; y: number } | undefined"
|
|
62291
|
+
},
|
|
62292
|
+
"privacy": "private",
|
|
62293
|
+
"description": "Where the gesture was, in the viewport's box, which the hint is shown\nat: where the reader is looking, and on the surface wherever a page laid\nits own content over the rest of it.",
|
|
62294
|
+
"inheritedFrom": {
|
|
62295
|
+
"name": "MixinViewport",
|
|
62296
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62297
|
+
}
|
|
62298
|
+
},
|
|
62299
|
+
{
|
|
62300
|
+
"kind": "field",
|
|
62301
|
+
"name": "takenBy",
|
|
62302
|
+
"type": {
|
|
62303
|
+
"text": "Event | undefined"
|
|
61823
62304
|
},
|
|
62305
|
+
"privacy": "private",
|
|
62306
|
+
"description": "The press that took the gestures, which is not also the first gesture.",
|
|
62307
|
+
"inheritedFrom": {
|
|
62308
|
+
"name": "MixinViewport",
|
|
62309
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62310
|
+
}
|
|
62311
|
+
},
|
|
62312
|
+
{
|
|
62313
|
+
"kind": "field",
|
|
62314
|
+
"name": "fullscreen",
|
|
61824
62315
|
"privacy": "protected",
|
|
61825
|
-
"description": "Whether this render can know the children.\n\nA server cannot: its element shim carries attributes and no tree, so\n`children` is undefined there. A render hydrating what a server sent must\nnot, because it has to be the server's render. Anywhere else it can. A\ncomponent whose render depends on its children reads them through\n`knownChildren`, and treats \"not known\" as its own answer rather than as\n\"none\": a list that renders its empty state because nobody has looked yet is\nthe one thing an empty state must never do.",
|
|
61826
62316
|
"readonly": true,
|
|
62317
|
+
"default": "new FullscreenController(this, (full) => { this.filled = full })",
|
|
61827
62318
|
"inheritedFrom": {
|
|
61828
|
-
"name": "
|
|
61829
|
-
"module": "src/
|
|
62319
|
+
"name": "MixinViewport",
|
|
62320
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
61830
62321
|
}
|
|
61831
62322
|
},
|
|
61832
62323
|
{
|
|
61833
62324
|
"kind": "field",
|
|
61834
|
-
"name": "
|
|
62325
|
+
"name": "idle",
|
|
62326
|
+
"privacy": "protected",
|
|
62327
|
+
"readonly": true,
|
|
62328
|
+
"default": "new IdleController( this, () => this.idleDelay, (resting) => { this.resting = resting }, )",
|
|
62329
|
+
"inheritedFrom": {
|
|
62330
|
+
"name": "MixinViewport",
|
|
62331
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62332
|
+
}
|
|
62333
|
+
},
|
|
62334
|
+
{
|
|
62335
|
+
"kind": "field",
|
|
62336
|
+
"name": "zoomOutLabel",
|
|
61835
62337
|
"type": {
|
|
61836
|
-
"text": "
|
|
62338
|
+
"text": "string"
|
|
62339
|
+
},
|
|
62340
|
+
"default": "'Zoom out'",
|
|
62341
|
+
"description": "The zoom out button's label.",
|
|
62342
|
+
"attribute": "zoom-out-label",
|
|
62343
|
+
"inheritedFrom": {
|
|
62344
|
+
"name": "MixinViewport",
|
|
62345
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62346
|
+
}
|
|
62347
|
+
},
|
|
62348
|
+
{
|
|
62349
|
+
"kind": "field",
|
|
62350
|
+
"name": "restingControlsLabel",
|
|
62351
|
+
"type": {
|
|
62352
|
+
"text": "string"
|
|
61837
62353
|
},
|
|
61838
62354
|
"privacy": "protected",
|
|
61839
|
-
"description": "
|
|
62355
|
+
"description": "What the group of controls is called where the page does not say.\n\nA getter a family overrides rather than a default on the property, the\nway `restingControls` is: a default would reflect nothing and still be\none value for every family composing this.",
|
|
61840
62356
|
"readonly": true,
|
|
61841
62357
|
"inheritedFrom": {
|
|
61842
|
-
"name": "
|
|
61843
|
-
"module": "src/
|
|
62358
|
+
"name": "MixinViewport",
|
|
62359
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
61844
62360
|
}
|
|
61845
62361
|
},
|
|
61846
62362
|
{
|
|
61847
62363
|
"kind": "field",
|
|
61848
|
-
"name": "
|
|
62364
|
+
"name": "restingGestureLabels",
|
|
61849
62365
|
"type": {
|
|
61850
|
-
"text": "
|
|
62366
|
+
"text": "ViewportGestureLabels"
|
|
61851
62367
|
},
|
|
61852
62368
|
"privacy": "protected",
|
|
61853
|
-
"description": "
|
|
62369
|
+
"description": "What the surface says about its gestures where the page does not say\nit, which a family overrides to name what it is: \"Press the map to use\nit\" reads better than a word that fits every surface.",
|
|
61854
62370
|
"readonly": true,
|
|
61855
62371
|
"inheritedFrom": {
|
|
61856
|
-
"name": "
|
|
61857
|
-
"module": "src/
|
|
62372
|
+
"name": "MixinViewport",
|
|
62373
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
61858
62374
|
}
|
|
61859
62375
|
},
|
|
61860
62376
|
{
|
|
61861
62377
|
"kind": "method",
|
|
61862
|
-
"name": "
|
|
62378
|
+
"name": "gestureAllowed",
|
|
61863
62379
|
"privacy": "protected",
|
|
61864
62380
|
"return": {
|
|
61865
62381
|
"type": {
|
|
61866
|
-
"text": "
|
|
62382
|
+
"text": "boolean"
|
|
61867
62383
|
}
|
|
61868
62384
|
},
|
|
61869
62385
|
"parameters": [
|
|
61870
62386
|
{
|
|
61871
|
-
"name": "
|
|
62387
|
+
"name": "event",
|
|
61872
62388
|
"type": {
|
|
61873
|
-
"text": "
|
|
62389
|
+
"text": "Event"
|
|
61874
62390
|
}
|
|
61875
|
-
}
|
|
62391
|
+
}
|
|
62392
|
+
],
|
|
62393
|
+
"description": "Whether a gesture that started with this event is the surface's to\nanswer, for a family that answers gestures itself. Never while an\n`activate` surface waits, and never on the press that ended the wait:\nthat press hands over the gestures and moves nothing.",
|
|
62394
|
+
"inheritedFrom": {
|
|
62395
|
+
"name": "MixinViewport",
|
|
62396
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62397
|
+
}
|
|
62398
|
+
},
|
|
62399
|
+
{
|
|
62400
|
+
"kind": "method",
|
|
62401
|
+
"name": "gesturesChanged",
|
|
62402
|
+
"privacy": "protected",
|
|
62403
|
+
"return": {
|
|
62404
|
+
"type": {
|
|
62405
|
+
"text": "void"
|
|
62406
|
+
}
|
|
62407
|
+
},
|
|
62408
|
+
"description": "Says that `gestureMode` changed. Nothing here; a family whose renderer\nis told through a connector says it with its own event.",
|
|
62409
|
+
"inheritedFrom": {
|
|
62410
|
+
"name": "MixinViewport",
|
|
62411
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62412
|
+
}
|
|
62413
|
+
},
|
|
62414
|
+
{
|
|
62415
|
+
"kind": "method",
|
|
62416
|
+
"name": "showHint",
|
|
62417
|
+
"privacy": "private",
|
|
62418
|
+
"return": {
|
|
62419
|
+
"type": {
|
|
62420
|
+
"text": "void"
|
|
62421
|
+
}
|
|
62422
|
+
},
|
|
62423
|
+
"parameters": [
|
|
62424
|
+
{
|
|
62425
|
+
"name": "words",
|
|
62426
|
+
"type": {
|
|
62427
|
+
"text": "string"
|
|
62428
|
+
}
|
|
62429
|
+
},
|
|
62430
|
+
{
|
|
62431
|
+
"name": "at",
|
|
62432
|
+
"optional": true,
|
|
62433
|
+
"type": {
|
|
62434
|
+
"text": "{ clientX: number; clientY: number }"
|
|
62435
|
+
}
|
|
62436
|
+
}
|
|
62437
|
+
],
|
|
62438
|
+
"description": "Shows a hint over the surface for a moment, where the gesture was.",
|
|
62439
|
+
"inheritedFrom": {
|
|
62440
|
+
"name": "MixinViewport",
|
|
62441
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62442
|
+
}
|
|
62443
|
+
},
|
|
62444
|
+
{
|
|
62445
|
+
"kind": "field",
|
|
62446
|
+
"name": "handleGestureWheel",
|
|
62447
|
+
"privacy": "private",
|
|
62448
|
+
"readonly": true,
|
|
62449
|
+
"description": "A wheel the surface let pass to the page, which is said: a reader\nscrolling the page past a surface that did not zoom is told why, and how\nto zoom it. **Ctrl or ⌘ with the wheel is the surface's**, and is what a\ntrackpad's pinch arrives as.",
|
|
62450
|
+
"inheritedFrom": {
|
|
62451
|
+
"name": "MixinViewport",
|
|
62452
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62453
|
+
}
|
|
62454
|
+
},
|
|
62455
|
+
{
|
|
62456
|
+
"kind": "field",
|
|
62457
|
+
"name": "handleGestureTouch",
|
|
62458
|
+
"privacy": "private",
|
|
62459
|
+
"readonly": true,
|
|
62460
|
+
"description": "One finger moving over the surface, which scrolls the page, and is said.",
|
|
62461
|
+
"inheritedFrom": {
|
|
62462
|
+
"name": "MixinViewport",
|
|
62463
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62464
|
+
}
|
|
62465
|
+
},
|
|
62466
|
+
{
|
|
62467
|
+
"kind": "field",
|
|
62468
|
+
"name": "handleTake",
|
|
62469
|
+
"privacy": "private",
|
|
62470
|
+
"readonly": true,
|
|
62471
|
+
"description": "A press on the surface itself, which hands a waiting surface the gestures.",
|
|
62472
|
+
"inheritedFrom": {
|
|
62473
|
+
"name": "MixinViewport",
|
|
62474
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62475
|
+
}
|
|
62476
|
+
},
|
|
62477
|
+
{
|
|
62478
|
+
"kind": "field",
|
|
62479
|
+
"name": "handleGiveBackKey",
|
|
62480
|
+
"privacy": "private",
|
|
62481
|
+
"readonly": true,
|
|
62482
|
+
"description": "Escape, which gives the page its scroll back.",
|
|
62483
|
+
"inheritedFrom": {
|
|
62484
|
+
"name": "MixinViewport",
|
|
62485
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62486
|
+
}
|
|
62487
|
+
},
|
|
62488
|
+
{
|
|
62489
|
+
"kind": "field",
|
|
62490
|
+
"name": "handleGiveBackOutside",
|
|
62491
|
+
"privacy": "private",
|
|
62492
|
+
"readonly": true,
|
|
62493
|
+
"description": "A press anywhere else on the page, which gives it its scroll back.",
|
|
62494
|
+
"inheritedFrom": {
|
|
62495
|
+
"name": "MixinViewport",
|
|
62496
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62497
|
+
}
|
|
62498
|
+
},
|
|
62499
|
+
{
|
|
62500
|
+
"kind": "field",
|
|
62501
|
+
"name": "handleGiveBackBlur",
|
|
62502
|
+
"privacy": "private",
|
|
62503
|
+
"readonly": true,
|
|
62504
|
+
"description": "The window losing focus, as a reader switching away does.",
|
|
62505
|
+
"inheritedFrom": {
|
|
62506
|
+
"name": "MixinViewport",
|
|
62507
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62508
|
+
}
|
|
62509
|
+
},
|
|
62510
|
+
{
|
|
62511
|
+
"kind": "field",
|
|
62512
|
+
"name": "handlePointerLeave",
|
|
62513
|
+
"privacy": "protected",
|
|
62514
|
+
"readonly": true,
|
|
62515
|
+
"description": "The pointer leaving the frame, which the family binds on its region.\n**Heard on the frame and not the drawing**, which a pointer resting on\nsomething raised over it has left. **A mouse or a pen and never a\nfinger**, whose `pointerleave` is the finger lifting: a tap took the\nsurface and gave it back in one.",
|
|
62516
|
+
"inheritedFrom": {
|
|
62517
|
+
"name": "MixinViewport",
|
|
62518
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62519
|
+
}
|
|
62520
|
+
},
|
|
62521
|
+
{
|
|
62522
|
+
"kind": "method",
|
|
62523
|
+
"name": "renderGestures",
|
|
62524
|
+
"privacy": "protected",
|
|
62525
|
+
"return": {
|
|
62526
|
+
"type": {
|
|
62527
|
+
"text": "TemplateResult"
|
|
62528
|
+
}
|
|
62529
|
+
},
|
|
62530
|
+
"description": "The hint over the surface and the line while it is in use, which the\nfamily draws inside its viewport, over what was slotted. The parts are\nwritten out, as the controls' are, so the manifest sees them.",
|
|
62531
|
+
"inheritedFrom": {
|
|
62532
|
+
"name": "MixinViewport",
|
|
62533
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62534
|
+
}
|
|
62535
|
+
},
|
|
62536
|
+
{
|
|
62537
|
+
"kind": "method",
|
|
62538
|
+
"name": "panEvent",
|
|
62539
|
+
"privacy": "protected",
|
|
62540
|
+
"return": {
|
|
62541
|
+
"type": {
|
|
62542
|
+
"text": "Event"
|
|
62543
|
+
}
|
|
62544
|
+
},
|
|
62545
|
+
"parameters": [
|
|
62546
|
+
{
|
|
62547
|
+
"name": "_detail",
|
|
62548
|
+
"type": {
|
|
62549
|
+
"text": "ViewportPanDetail"
|
|
62550
|
+
}
|
|
62551
|
+
}
|
|
62552
|
+
],
|
|
62553
|
+
"description": "The pan event, which the family names and this one does not.\n\n**No default, and the analyzer is why as much as the taste is.** A mixin\nthat built a `helix-map-pan` would put it in the manifest of every family\nthat composed the surface, since a mixin's code is resolved into its\nusers: a canvas would be documented as dispatching a map's event, and a\nconsumer reading the reference page would believe it. So the surface\ncarries no event name at all, and a family that forgets to name one hears\nabout it the first time a reader presses an arrow.",
|
|
62554
|
+
"inheritedFrom": {
|
|
62555
|
+
"name": "MixinViewport",
|
|
62556
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62557
|
+
}
|
|
62558
|
+
},
|
|
62559
|
+
{
|
|
62560
|
+
"kind": "method",
|
|
62561
|
+
"name": "zoomEvent",
|
|
62562
|
+
"privacy": "protected",
|
|
62563
|
+
"return": {
|
|
62564
|
+
"type": {
|
|
62565
|
+
"text": "Event"
|
|
62566
|
+
}
|
|
62567
|
+
},
|
|
62568
|
+
"parameters": [
|
|
62569
|
+
{
|
|
62570
|
+
"name": "_detail",
|
|
62571
|
+
"type": {
|
|
62572
|
+
"text": "ViewportZoomDetail"
|
|
62573
|
+
}
|
|
62574
|
+
}
|
|
62575
|
+
],
|
|
62576
|
+
"description": "The zoom event, which the family names, for the same reason.",
|
|
62577
|
+
"inheritedFrom": {
|
|
62578
|
+
"name": "MixinViewport",
|
|
62579
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62580
|
+
}
|
|
62581
|
+
},
|
|
62582
|
+
{
|
|
62583
|
+
"kind": "method",
|
|
62584
|
+
"name": "pan",
|
|
62585
|
+
"return": {
|
|
62586
|
+
"type": {
|
|
62587
|
+
"text": "void"
|
|
62588
|
+
}
|
|
62589
|
+
},
|
|
62590
|
+
"parameters": [
|
|
62591
|
+
{
|
|
62592
|
+
"name": "to",
|
|
62593
|
+
"type": {
|
|
62594
|
+
"text": "ViewportWay"
|
|
62595
|
+
}
|
|
62596
|
+
}
|
|
62597
|
+
],
|
|
62598
|
+
"description": "Pans the view one step in a direction.",
|
|
62599
|
+
"inheritedFrom": {
|
|
62600
|
+
"name": "MixinViewport",
|
|
62601
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62602
|
+
},
|
|
62603
|
+
"type": {
|
|
62604
|
+
"text": "pan(to: ViewportWay) => void"
|
|
62605
|
+
}
|
|
62606
|
+
},
|
|
62607
|
+
{
|
|
62608
|
+
"kind": "method",
|
|
62609
|
+
"name": "zoom",
|
|
62610
|
+
"return": {
|
|
62611
|
+
"type": {
|
|
62612
|
+
"text": "void"
|
|
62613
|
+
}
|
|
62614
|
+
},
|
|
62615
|
+
"parameters": [
|
|
62616
|
+
{
|
|
62617
|
+
"name": "by",
|
|
62618
|
+
"type": {
|
|
62619
|
+
"text": "number"
|
|
62620
|
+
}
|
|
62621
|
+
}
|
|
62622
|
+
],
|
|
62623
|
+
"description": "Zooms the view one step: `1` zooms in and `-1` zooms out.",
|
|
62624
|
+
"inheritedFrom": {
|
|
62625
|
+
"name": "MixinViewport",
|
|
62626
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62627
|
+
},
|
|
62628
|
+
"type": {
|
|
62629
|
+
"text": "zoom(by: number) => void"
|
|
62630
|
+
}
|
|
62631
|
+
},
|
|
62632
|
+
{
|
|
62633
|
+
"kind": "method",
|
|
62634
|
+
"name": "toggleFullscreen",
|
|
62635
|
+
"return": {
|
|
62636
|
+
"type": {
|
|
62637
|
+
"text": "void"
|
|
62638
|
+
}
|
|
62639
|
+
},
|
|
62640
|
+
"description": "Turns fullscreen on or off.",
|
|
62641
|
+
"inheritedFrom": {
|
|
62642
|
+
"name": "MixinViewport",
|
|
62643
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62644
|
+
},
|
|
62645
|
+
"type": {
|
|
62646
|
+
"text": "toggleFullscreen() => void"
|
|
62647
|
+
}
|
|
62648
|
+
},
|
|
62649
|
+
{
|
|
62650
|
+
"kind": "field",
|
|
62651
|
+
"name": "restingControls",
|
|
62652
|
+
"type": {
|
|
62653
|
+
"text": "string"
|
|
62654
|
+
},
|
|
62655
|
+
"privacy": "protected",
|
|
62656
|
+
"description": "Which controls the surface draws while `controls` is absent.\n\nAll three here, and a family overrides it where its reader has a better\nway to do one of them already.",
|
|
62657
|
+
"readonly": true,
|
|
62658
|
+
"inheritedFrom": {
|
|
62659
|
+
"name": "MixinViewport",
|
|
62660
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62661
|
+
}
|
|
62662
|
+
},
|
|
62663
|
+
{
|
|
62664
|
+
"kind": "method",
|
|
62665
|
+
"name": "drawsControls",
|
|
62666
|
+
"privacy": "protected",
|
|
62667
|
+
"return": {
|
|
62668
|
+
"type": {
|
|
62669
|
+
"text": "boolean"
|
|
62670
|
+
}
|
|
62671
|
+
},
|
|
62672
|
+
"parameters": [
|
|
62673
|
+
{
|
|
62674
|
+
"name": "group",
|
|
62675
|
+
"type": {
|
|
62676
|
+
"text": "string"
|
|
62677
|
+
}
|
|
62678
|
+
}
|
|
62679
|
+
],
|
|
62680
|
+
"description": "Whether `controls`, or the resting controls, names a group.",
|
|
62681
|
+
"inheritedFrom": {
|
|
62682
|
+
"name": "MixinViewport",
|
|
62683
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62684
|
+
}
|
|
62685
|
+
},
|
|
62686
|
+
{
|
|
62687
|
+
"kind": "method",
|
|
62688
|
+
"name": "renderMoreControls",
|
|
62689
|
+
"privacy": "protected",
|
|
62690
|
+
"return": {
|
|
62691
|
+
"type": {
|
|
62692
|
+
"text": "TemplateResult | typeof nothing"
|
|
62693
|
+
}
|
|
62694
|
+
},
|
|
62695
|
+
"description": "More buttons for the group of controls, after zoom. None here; a family adds its own.",
|
|
62696
|
+
"inheritedFrom": {
|
|
62697
|
+
"name": "MixinViewport",
|
|
62698
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62699
|
+
}
|
|
62700
|
+
},
|
|
62701
|
+
{
|
|
62702
|
+
"kind": "method",
|
|
62703
|
+
"name": "handleMoreKeys",
|
|
62704
|
+
"privacy": "protected",
|
|
62705
|
+
"return": {
|
|
62706
|
+
"type": {
|
|
62707
|
+
"text": "boolean"
|
|
62708
|
+
}
|
|
62709
|
+
},
|
|
62710
|
+
"parameters": [
|
|
62711
|
+
{
|
|
62712
|
+
"name": "_event",
|
|
62713
|
+
"type": {
|
|
62714
|
+
"text": "KeyboardEvent"
|
|
62715
|
+
}
|
|
62716
|
+
}
|
|
62717
|
+
],
|
|
62718
|
+
"description": "Answers a key the family adds, and says whether it did. None here.",
|
|
62719
|
+
"inheritedFrom": {
|
|
62720
|
+
"name": "MixinViewport",
|
|
62721
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62722
|
+
}
|
|
62723
|
+
},
|
|
62724
|
+
{
|
|
62725
|
+
"kind": "method",
|
|
62726
|
+
"name": "sideOf",
|
|
62727
|
+
"privacy": "protected",
|
|
62728
|
+
"return": {
|
|
62729
|
+
"type": {
|
|
62730
|
+
"text": "string"
|
|
62731
|
+
}
|
|
62732
|
+
},
|
|
62733
|
+
"parameters": [
|
|
62734
|
+
{
|
|
62735
|
+
"name": "way",
|
|
62736
|
+
"type": {
|
|
62737
|
+
"text": "ViewportWay"
|
|
62738
|
+
}
|
|
62739
|
+
}
|
|
62740
|
+
],
|
|
62741
|
+
"description": "The side of the screen a reading-order way is on, left or right.\n\n**Start is left only where the text runs that way.** The pad's grid is\nlaid out in reading order, so on a right-to-left page the start button\nsits on the right, and it said \"left\" and pointed left from there.",
|
|
62742
|
+
"inheritedFrom": {
|
|
62743
|
+
"name": "MixinViewport",
|
|
62744
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62745
|
+
}
|
|
62746
|
+
},
|
|
62747
|
+
{
|
|
62748
|
+
"kind": "field",
|
|
62749
|
+
"name": "rightToLeft",
|
|
62750
|
+
"type": {
|
|
62751
|
+
"text": "boolean"
|
|
62752
|
+
},
|
|
62753
|
+
"privacy": "private",
|
|
62754
|
+
"description": "Whether the page runs right to left, as far as this render may say.\n\n**Not while hydrating.** A server cannot measure direction, so it drew\nthe left-to-right pad; Lit hydrates by keeping what the server drew and\nrecording the client's value unwritten, so a right-to-left answer in the\nhydrating render would never reach the page. It answers once hydration\nis over, and `firstUpdated` asks for that render.",
|
|
62755
|
+
"readonly": true,
|
|
62756
|
+
"inheritedFrom": {
|
|
62757
|
+
"name": "MixinViewport",
|
|
62758
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62759
|
+
}
|
|
62760
|
+
},
|
|
62761
|
+
{
|
|
62762
|
+
"kind": "method",
|
|
62763
|
+
"name": "panLabel",
|
|
62764
|
+
"privacy": "protected",
|
|
62765
|
+
"return": {
|
|
62766
|
+
"type": {
|
|
62767
|
+
"text": "string"
|
|
62768
|
+
}
|
|
62769
|
+
},
|
|
62770
|
+
"parameters": [
|
|
62771
|
+
{
|
|
62772
|
+
"name": "way",
|
|
62773
|
+
"type": {
|
|
62774
|
+
"text": "ViewportWay"
|
|
62775
|
+
}
|
|
62776
|
+
}
|
|
62777
|
+
],
|
|
62778
|
+
"description": "What one pan control is called, with the way it goes filled in.\n\nLeft and right rather than start and end, because the label is read aloud\nand a reader knows which way left is. The event keeps the reading-order\nname, which is the one a right-to-left page needs.",
|
|
62779
|
+
"inheritedFrom": {
|
|
62780
|
+
"name": "MixinViewport",
|
|
62781
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62782
|
+
}
|
|
62783
|
+
},
|
|
62784
|
+
{
|
|
62785
|
+
"kind": "method",
|
|
62786
|
+
"name": "panGlyph",
|
|
62787
|
+
"privacy": "protected",
|
|
62788
|
+
"return": {
|
|
62789
|
+
"type": {
|
|
62790
|
+
"text": "string"
|
|
62791
|
+
}
|
|
62792
|
+
},
|
|
62793
|
+
"parameters": [
|
|
62794
|
+
{
|
|
62795
|
+
"name": "way",
|
|
62796
|
+
"type": {
|
|
62797
|
+
"text": "ViewportWay"
|
|
62798
|
+
}
|
|
62799
|
+
}
|
|
62800
|
+
],
|
|
62801
|
+
"description": "The arrow drawn on a pan control, pointing the way it goes on screen.",
|
|
62802
|
+
"inheritedFrom": {
|
|
62803
|
+
"name": "MixinViewport",
|
|
62804
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62805
|
+
}
|
|
62806
|
+
},
|
|
62807
|
+
{
|
|
62808
|
+
"kind": "field",
|
|
62809
|
+
"name": "handleKeydown",
|
|
62810
|
+
"privacy": "protected",
|
|
62811
|
+
"readonly": true,
|
|
62812
|
+
"description": "The arrow keys, which are the second way rather than the only one.\n\n`inlineStep` rather than a test against `ArrowLeft`, so the reader on a\nright-to-left page moves the way their text runs, which is what the pan\ncontrols say too.\n\n**Only from the surface's own frame, and that is the difference between\none move and two.** What a consumer slots may answer the arrow keys\nitself, and a press relayed from inside it moves their view once on its\nown and once more on the event this would send. The rule is the region\nand the controls rather than the whole shadow root, because a family with\nits own focusable content in there, a list of notes beside a canvas,\nwould otherwise pan the surface out from under a reader arrowing through\nit.",
|
|
62813
|
+
"inheritedFrom": {
|
|
62814
|
+
"name": "MixinViewport",
|
|
62815
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62816
|
+
}
|
|
62817
|
+
},
|
|
62818
|
+
{
|
|
62819
|
+
"kind": "field",
|
|
62820
|
+
"name": "controlsElement",
|
|
62821
|
+
"type": {
|
|
62822
|
+
"text": "Element | null"
|
|
62823
|
+
},
|
|
62824
|
+
"privacy": "protected",
|
|
62825
|
+
"description": "The group of controls as drawn, or nothing where none are.\n\n**Here, because this is what renders it.** A family that measures the\ncluster, as a board does to keep its fit clear of the buttons, would\notherwise look up a part its own template never writes, and a lookup\nlike that is one a later edit to this template breaks without a word.",
|
|
62826
|
+
"readonly": true,
|
|
62827
|
+
"inheritedFrom": {
|
|
62828
|
+
"name": "MixinViewport",
|
|
62829
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62830
|
+
}
|
|
62831
|
+
},
|
|
62832
|
+
{
|
|
62833
|
+
"kind": "method",
|
|
62834
|
+
"name": "renderControls",
|
|
62835
|
+
"privacy": "protected",
|
|
62836
|
+
"return": {
|
|
62837
|
+
"type": {
|
|
62838
|
+
"text": "TemplateResult | typeof nothing"
|
|
62839
|
+
}
|
|
62840
|
+
},
|
|
62841
|
+
"description": "The controls, or nothing where a consumer kept none of them.\n\n**Written out rather than generated**, because a part name behind an\ninterpolation is a part the manifest cannot see: a loop would publish\n`pan-` and a consumer's `::part(pan-up)` would match nothing.",
|
|
62842
|
+
"inheritedFrom": {
|
|
62843
|
+
"name": "MixinViewport",
|
|
62844
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
62845
|
+
}
|
|
62846
|
+
},
|
|
62847
|
+
{
|
|
62848
|
+
"kind": "field",
|
|
62849
|
+
"name": "active",
|
|
62850
|
+
"type": {
|
|
62851
|
+
"text": "string"
|
|
62852
|
+
},
|
|
62853
|
+
"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.",
|
|
62854
|
+
"attribute": "active",
|
|
62855
|
+
"inheritedFrom": {
|
|
62856
|
+
"name": "MixinControllerActive",
|
|
62857
|
+
"module": "src/mixins/mixin-controller-active/mixin-controller-active.ts"
|
|
62858
|
+
}
|
|
62859
|
+
},
|
|
62860
|
+
{
|
|
62861
|
+
"kind": "field",
|
|
62862
|
+
"name": "defaultActive",
|
|
62863
|
+
"type": {
|
|
62864
|
+
"text": "string"
|
|
62865
|
+
},
|
|
62866
|
+
"default": "''",
|
|
62867
|
+
"description": "The `value` of the item declared current in markup.\n\nIgnored once `active` is written.",
|
|
62868
|
+
"attribute": "default-active",
|
|
62869
|
+
"inheritedFrom": {
|
|
62870
|
+
"name": "MixinControllerActive",
|
|
62871
|
+
"module": "src/mixins/mixin-controller-active/mixin-controller-active.ts"
|
|
62872
|
+
}
|
|
62873
|
+
},
|
|
62874
|
+
{
|
|
62875
|
+
"kind": "field",
|
|
62876
|
+
"name": "activeState",
|
|
62877
|
+
"type": {
|
|
62878
|
+
"text": "string | undefined"
|
|
62879
|
+
},
|
|
62880
|
+
"privacy": "private",
|
|
62881
|
+
"default": "undefined",
|
|
62882
|
+
"description": "The state, whoever set it, and `undefined` until somebody has.\n\nOne field and not two. Writing always applies, the way a native control\ndoes when a script assigns to it.",
|
|
62883
|
+
"inheritedFrom": {
|
|
62884
|
+
"name": "MixinControllerActive",
|
|
62885
|
+
"module": "src/mixins/mixin-controller-active/mixin-controller-active.ts"
|
|
62886
|
+
}
|
|
62887
|
+
},
|
|
62888
|
+
{
|
|
62889
|
+
"kind": "method",
|
|
62890
|
+
"name": "requestActive",
|
|
62891
|
+
"return": {
|
|
62892
|
+
"type": {
|
|
62893
|
+
"text": "boolean"
|
|
62894
|
+
}
|
|
62895
|
+
},
|
|
62896
|
+
"parameters": [
|
|
62897
|
+
{
|
|
62898
|
+
"name": "next",
|
|
62899
|
+
"type": {
|
|
62900
|
+
"text": "string"
|
|
62901
|
+
}
|
|
62902
|
+
}
|
|
62903
|
+
],
|
|
62904
|
+
"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.",
|
|
62905
|
+
"inheritedFrom": {
|
|
62906
|
+
"name": "MixinControllerActive",
|
|
62907
|
+
"module": "src/mixins/mixin-controller-active/mixin-controller-active.ts"
|
|
62908
|
+
},
|
|
62909
|
+
"type": {
|
|
62910
|
+
"text": "requestActive(next: string) => boolean"
|
|
62911
|
+
}
|
|
62912
|
+
},
|
|
62913
|
+
{
|
|
62914
|
+
"kind": "method",
|
|
62915
|
+
"name": "announceActivated",
|
|
62916
|
+
"privacy": "private",
|
|
62917
|
+
"return": {
|
|
62918
|
+
"type": {
|
|
62919
|
+
"text": "void"
|
|
62920
|
+
}
|
|
62921
|
+
},
|
|
62922
|
+
"parameters": [
|
|
62923
|
+
{
|
|
62924
|
+
"name": "value",
|
|
62925
|
+
"type": {
|
|
62926
|
+
"text": "string"
|
|
62927
|
+
}
|
|
62928
|
+
}
|
|
62929
|
+
],
|
|
62930
|
+
"description": "Says the current child moved, once it has.\n\n`helix-activate` rather than a native word: nothing on the platform means\n\"a set chose a different member\", and borrowing `change` would be a lie\nabout what moved.\n\nA consumer who only wants to know which child is current cannot use\n`helix-before-activate` for it, that one firing *before* `apply`, so\n`currentTarget.active` is the previous value inside the handler and\n`detail.value` is a proposal another listener may refuse. `helix-select`\nis no substitute either: it fires when an item is *chosen* and not when\n`active` is assigned.\n\n**After `apply`, which is the whole reason it is a second event**, so the\nstate is on the element by the time a handler reads it. Not cancelable:\nthe decision was taken by the event before this one, and two refusable\nevents for one transition are two answers to one question.",
|
|
62931
|
+
"inheritedFrom": {
|
|
62932
|
+
"name": "MixinControllerActive",
|
|
62933
|
+
"module": "src/mixins/mixin-controller-active/mixin-controller-active.ts"
|
|
62934
|
+
}
|
|
62935
|
+
},
|
|
62936
|
+
{
|
|
62937
|
+
"kind": "method",
|
|
62938
|
+
"name": "resolveActive",
|
|
62939
|
+
"privacy": "protected",
|
|
62940
|
+
"return": {
|
|
62941
|
+
"type": {
|
|
62942
|
+
"text": "Item | undefined"
|
|
62943
|
+
}
|
|
62944
|
+
},
|
|
62945
|
+
"parameters": [
|
|
62946
|
+
{
|
|
62947
|
+
"name": "items",
|
|
62948
|
+
"type": {
|
|
62949
|
+
"text": "Item[]"
|
|
62950
|
+
}
|
|
62951
|
+
}
|
|
62952
|
+
],
|
|
62953
|
+
"description": "Which item is current, given what there is to choose from.\n\nThe first enabled one when `active` names nothing, which is a set before\nits consumer has chosen and a set whose current item has just been\nremoved. Disabled items are skipped in the fallback but not in the match:\na consumer who names a disabled item meant it, and quietly moving to\nanother would be the component overruling them.",
|
|
62954
|
+
"inheritedFrom": {
|
|
62955
|
+
"name": "MixinControllerActive",
|
|
62956
|
+
"module": "src/mixins/mixin-controller-active/mixin-controller-active.ts"
|
|
62957
|
+
}
|
|
62958
|
+
},
|
|
62959
|
+
{
|
|
62960
|
+
"kind": "field",
|
|
62961
|
+
"name": "countLabel",
|
|
62962
|
+
"type": {
|
|
62963
|
+
"text": "string"
|
|
62964
|
+
},
|
|
62965
|
+
"default": "'{count} notes'",
|
|
62966
|
+
"description": "What the list says of a note's count, with `{count}`.",
|
|
62967
|
+
"attribute": "count-label",
|
|
62968
|
+
"inheritedFrom": {
|
|
62969
|
+
"name": "HelixHeadlessGraph",
|
|
62970
|
+
"module": "src/graph/root/graph-root.ts"
|
|
62971
|
+
}
|
|
62972
|
+
},
|
|
62973
|
+
{
|
|
62974
|
+
"kind": "field",
|
|
62975
|
+
"name": "depth",
|
|
62976
|
+
"type": {
|
|
62977
|
+
"text": "number | undefined"
|
|
62978
|
+
},
|
|
62979
|
+
"description": "How many links from the selected note to show, for its local graph. Unset\nshows every note. The list holds what the drawing shows.",
|
|
62980
|
+
"attribute": "depth",
|
|
62981
|
+
"inheritedFrom": {
|
|
62982
|
+
"name": "HelixHeadlessGraph",
|
|
62983
|
+
"module": "src/graph/root/graph-root.ts"
|
|
62984
|
+
}
|
|
62985
|
+
},
|
|
62986
|
+
{
|
|
62987
|
+
"kind": "field",
|
|
62988
|
+
"name": "label",
|
|
62989
|
+
"type": {
|
|
62990
|
+
"text": "string"
|
|
62991
|
+
},
|
|
62992
|
+
"default": "''",
|
|
62993
|
+
"description": "The graph's name, read by screen readers, such as \"Research notes\".\nRequired.",
|
|
62994
|
+
"attribute": "label",
|
|
62995
|
+
"inheritedFrom": {
|
|
62996
|
+
"name": "HelixHeadlessGraph",
|
|
62997
|
+
"module": "src/graph/root/graph-root.ts"
|
|
62998
|
+
}
|
|
62999
|
+
},
|
|
63000
|
+
{
|
|
63001
|
+
"kind": "field",
|
|
63002
|
+
"name": "linkedBothLabel",
|
|
63003
|
+
"type": {
|
|
63004
|
+
"text": "string"
|
|
63005
|
+
},
|
|
63006
|
+
"default": "'Linked both ways with {note}'",
|
|
63007
|
+
"description": "How a note linked both to and from the selected one is described, with `{note}`.",
|
|
63008
|
+
"attribute": "linked-both-label",
|
|
63009
|
+
"inheritedFrom": {
|
|
63010
|
+
"name": "HelixHeadlessGraph",
|
|
63011
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63012
|
+
}
|
|
63013
|
+
},
|
|
63014
|
+
{
|
|
63015
|
+
"kind": "field",
|
|
63016
|
+
"name": "linkedFromLabel",
|
|
63017
|
+
"type": {
|
|
63018
|
+
"text": "string"
|
|
63019
|
+
},
|
|
63020
|
+
"default": "'Linked from {note}'",
|
|
63021
|
+
"description": "How a note the selected one links to is described, with `{note}`, the selected note's name.",
|
|
63022
|
+
"attribute": "linked-from-label",
|
|
63023
|
+
"inheritedFrom": {
|
|
63024
|
+
"name": "HelixHeadlessGraph",
|
|
63025
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63026
|
+
}
|
|
63027
|
+
},
|
|
63028
|
+
{
|
|
63029
|
+
"kind": "field",
|
|
63030
|
+
"name": "links",
|
|
63031
|
+
"type": {
|
|
63032
|
+
"text": "readonly GraphLink[]"
|
|
63033
|
+
},
|
|
63034
|
+
"default": "[]",
|
|
63035
|
+
"description": "The links between notes, each from `source` to `target`. A property, never an attribute.",
|
|
63036
|
+
"inheritedFrom": {
|
|
63037
|
+
"name": "HelixHeadlessGraph",
|
|
63038
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63039
|
+
}
|
|
63040
|
+
},
|
|
63041
|
+
{
|
|
63042
|
+
"kind": "field",
|
|
63043
|
+
"name": "linksToLabel",
|
|
63044
|
+
"type": {
|
|
63045
|
+
"text": "string"
|
|
63046
|
+
},
|
|
63047
|
+
"default": "'Links to {note}'",
|
|
63048
|
+
"description": "How a note that links to the selected one is described, with `{note}`.",
|
|
63049
|
+
"attribute": "links-to-label",
|
|
63050
|
+
"inheritedFrom": {
|
|
63051
|
+
"name": "HelixHeadlessGraph",
|
|
63052
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63053
|
+
}
|
|
63054
|
+
},
|
|
63055
|
+
{
|
|
63056
|
+
"kind": "field",
|
|
63057
|
+
"name": "nodes",
|
|
63058
|
+
"type": {
|
|
63059
|
+
"text": "readonly GraphNode[]"
|
|
63060
|
+
},
|
|
63061
|
+
"default": "[]",
|
|
63062
|
+
"description": "The notes. A property, never an attribute.",
|
|
63063
|
+
"inheritedFrom": {
|
|
63064
|
+
"name": "HelixHeadlessGraph",
|
|
63065
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63066
|
+
}
|
|
63067
|
+
},
|
|
63068
|
+
{
|
|
63069
|
+
"kind": "field",
|
|
63070
|
+
"name": "notesLabel",
|
|
63071
|
+
"type": {
|
|
63072
|
+
"text": "string"
|
|
63073
|
+
},
|
|
63074
|
+
"default": "'Notes'",
|
|
63075
|
+
"description": "The list's name, read by screen readers.",
|
|
63076
|
+
"attribute": "notes-label",
|
|
63077
|
+
"inheritedFrom": {
|
|
63078
|
+
"name": "HelixHeadlessGraph",
|
|
63079
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63080
|
+
}
|
|
63081
|
+
},
|
|
63082
|
+
{
|
|
63083
|
+
"kind": "field",
|
|
63084
|
+
"name": "searchLabel",
|
|
63085
|
+
"type": {
|
|
63086
|
+
"text": "string"
|
|
63087
|
+
},
|
|
63088
|
+
"default": "'Find a note'",
|
|
63089
|
+
"description": "The search field's name.",
|
|
63090
|
+
"attribute": "search-label",
|
|
63091
|
+
"inheritedFrom": {
|
|
63092
|
+
"name": "HelixHeadlessGraph",
|
|
63093
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63094
|
+
}
|
|
63095
|
+
},
|
|
63096
|
+
{
|
|
63097
|
+
"kind": "field",
|
|
63098
|
+
"name": "selectedLabel",
|
|
63099
|
+
"type": {
|
|
63100
|
+
"text": "string"
|
|
63101
|
+
},
|
|
63102
|
+
"default": "'Selected'",
|
|
63103
|
+
"description": "How the selected note is described in the list.",
|
|
63104
|
+
"attribute": "selected-label",
|
|
63105
|
+
"inheritedFrom": {
|
|
63106
|
+
"name": "HelixHeadlessGraph",
|
|
63107
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63108
|
+
}
|
|
63109
|
+
},
|
|
63110
|
+
{
|
|
63111
|
+
"kind": "field",
|
|
63112
|
+
"name": "query",
|
|
63113
|
+
"type": {
|
|
63114
|
+
"text": "string"
|
|
63115
|
+
},
|
|
63116
|
+
"privacy": "private",
|
|
63117
|
+
"default": "''",
|
|
63118
|
+
"description": "What the search field holds.",
|
|
63119
|
+
"inheritedFrom": {
|
|
63120
|
+
"name": "HelixHeadlessGraph",
|
|
63121
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63122
|
+
}
|
|
63123
|
+
},
|
|
63124
|
+
{
|
|
63125
|
+
"kind": "field",
|
|
63126
|
+
"name": "cursor",
|
|
63127
|
+
"type": {
|
|
63128
|
+
"text": "number"
|
|
63129
|
+
},
|
|
63130
|
+
"privacy": "private",
|
|
63131
|
+
"default": "0",
|
|
63132
|
+
"description": "The row the keyboard is on, as an index into the list.",
|
|
63133
|
+
"inheritedFrom": {
|
|
63134
|
+
"name": "HelixHeadlessGraph",
|
|
63135
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63136
|
+
}
|
|
63137
|
+
},
|
|
63138
|
+
{
|
|
63139
|
+
"kind": "field",
|
|
63140
|
+
"name": "adjacency",
|
|
63141
|
+
"type": {
|
|
63142
|
+
"text": "Adjacency"
|
|
63143
|
+
},
|
|
63144
|
+
"privacy": "private",
|
|
63145
|
+
"default": "new Map()",
|
|
63146
|
+
"description": "Which notes link to and from each, read again when `links` changes.",
|
|
63147
|
+
"inheritedFrom": {
|
|
63148
|
+
"name": "HelixHeadlessGraph",
|
|
63149
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63150
|
+
}
|
|
63151
|
+
},
|
|
63152
|
+
{
|
|
63153
|
+
"kind": "field",
|
|
63154
|
+
"name": "sorted",
|
|
63155
|
+
"type": {
|
|
63156
|
+
"text": "GraphNode[]"
|
|
63157
|
+
},
|
|
63158
|
+
"privacy": "private",
|
|
63159
|
+
"default": "[]",
|
|
63160
|
+
"description": "The notes in the order of their names, read again when `nodes` changes.",
|
|
63161
|
+
"inheritedFrom": {
|
|
63162
|
+
"name": "HelixHeadlessGraph",
|
|
63163
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63164
|
+
}
|
|
63165
|
+
},
|
|
63166
|
+
{
|
|
63167
|
+
"kind": "field",
|
|
63168
|
+
"name": "entries",
|
|
63169
|
+
"type": {
|
|
63170
|
+
"text": "Entry[]"
|
|
63171
|
+
},
|
|
63172
|
+
"privacy": "private",
|
|
63173
|
+
"default": "[]",
|
|
63174
|
+
"description": "The list's rows, read again when anything they come from changes.",
|
|
63175
|
+
"inheritedFrom": {
|
|
63176
|
+
"name": "HelixHeadlessGraph",
|
|
63177
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63178
|
+
}
|
|
63179
|
+
},
|
|
63180
|
+
{
|
|
63181
|
+
"kind": "field",
|
|
63182
|
+
"name": "kept",
|
|
63183
|
+
"type": {
|
|
63184
|
+
"text": "Set<string> | undefined"
|
|
63185
|
+
},
|
|
63186
|
+
"privacy": "private",
|
|
63187
|
+
"description": "The notes the local graph keeps, or every note where there is no `depth`.",
|
|
63188
|
+
"inheritedFrom": {
|
|
63189
|
+
"name": "HelixHeadlessGraph",
|
|
63190
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63191
|
+
}
|
|
63192
|
+
},
|
|
63193
|
+
{
|
|
63194
|
+
"kind": "field",
|
|
63195
|
+
"name": "whole",
|
|
63196
|
+
"type": {
|
|
63197
|
+
"text": "boolean"
|
|
63198
|
+
},
|
|
63199
|
+
"privacy": "private",
|
|
63200
|
+
"default": "false",
|
|
63201
|
+
"description": "Whether the graph has been drawn whole, which `drawn()` says.",
|
|
63202
|
+
"inheritedFrom": {
|
|
63203
|
+
"name": "HelixHeadlessGraph",
|
|
63204
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63205
|
+
}
|
|
63206
|
+
},
|
|
63207
|
+
{
|
|
63208
|
+
"kind": "field",
|
|
63209
|
+
"name": "said",
|
|
63210
|
+
"type": {
|
|
63211
|
+
"text": "string"
|
|
63212
|
+
},
|
|
63213
|
+
"privacy": "private",
|
|
63214
|
+
"default": "''",
|
|
63215
|
+
"description": "How many notes there were when the count was last said.",
|
|
63216
|
+
"inheritedFrom": {
|
|
63217
|
+
"name": "HelixHeadlessGraph",
|
|
63218
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63219
|
+
}
|
|
63220
|
+
},
|
|
63221
|
+
{
|
|
63222
|
+
"kind": "field",
|
|
63223
|
+
"name": "virtualize",
|
|
63224
|
+
"privacy": "private",
|
|
63225
|
+
"readonly": true,
|
|
63226
|
+
"default": "new VirtualizeController(this, { container: () => this.partNamed('list'), count: () => this.entries.length, estimate: () => 32, rows: () => [...(this.renderRoot.querySelectorAll?.('[data-index]') ?? [])].map((element) => ({ element: element as HTMLElement, index: Number((element as HTMLElement).dataset.index), })), })",
|
|
63227
|
+
"inheritedFrom": {
|
|
63228
|
+
"name": "HelixHeadlessGraph",
|
|
63229
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63230
|
+
}
|
|
63231
|
+
},
|
|
63232
|
+
{
|
|
63233
|
+
"kind": "field",
|
|
63234
|
+
"name": "ready",
|
|
63235
|
+
"type": {
|
|
63236
|
+
"text": "boolean"
|
|
63237
|
+
},
|
|
63238
|
+
"description": "Whether the graph has been drawn whole. For code that runs after `helix-graph-ready`.",
|
|
63239
|
+
"readonly": true,
|
|
63240
|
+
"inheritedFrom": {
|
|
63241
|
+
"name": "HelixHeadlessGraph",
|
|
63242
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63243
|
+
}
|
|
63244
|
+
},
|
|
63245
|
+
{
|
|
63246
|
+
"kind": "method",
|
|
63247
|
+
"name": "drawn",
|
|
63248
|
+
"return": {
|
|
63249
|
+
"type": {
|
|
63250
|
+
"text": "void"
|
|
63251
|
+
}
|
|
63252
|
+
},
|
|
63253
|
+
"parameters": [
|
|
63254
|
+
{
|
|
63255
|
+
"name": "whole",
|
|
63256
|
+
"default": "true"
|
|
63257
|
+
}
|
|
63258
|
+
],
|
|
63259
|
+
"description": "Says the graph has been drawn whole, or with `false`, that it no longer\nis. Called by `connectGraph` once its layout has settled; a page drawing\nits own graph calls it when that graph is finished. The first call after\nthe graph was not drawn sends `helix-graph-ready` and turns on\n`:state(ready)`.",
|
|
63260
|
+
"type": {
|
|
63261
|
+
"text": "drawn(whole = true) => void"
|
|
63262
|
+
},
|
|
63263
|
+
"inheritedFrom": {
|
|
63264
|
+
"name": "HelixHeadlessGraph",
|
|
63265
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63266
|
+
}
|
|
63267
|
+
},
|
|
63268
|
+
{
|
|
63269
|
+
"kind": "method",
|
|
63270
|
+
"name": "laidOut",
|
|
63271
|
+
"return": {
|
|
63272
|
+
"type": {
|
|
63273
|
+
"text": "void"
|
|
63274
|
+
}
|
|
63275
|
+
},
|
|
63276
|
+
"parameters": [
|
|
63277
|
+
{
|
|
63278
|
+
"name": "positions",
|
|
63279
|
+
"type": {
|
|
63280
|
+
"text": "Record<string, { x: number; y: number }>"
|
|
63281
|
+
}
|
|
63282
|
+
}
|
|
63283
|
+
],
|
|
63284
|
+
"description": "Says where a layout put each note, by its `id`: sends\n`helix-graph-layout` for the page to keep. Called by `connectGraph` once\nits layout has settled; a page laying out its own graph calls it the same\nway.",
|
|
63285
|
+
"type": {
|
|
63286
|
+
"text": "laidOut(positions: Record<string, { x: number; y: number }>) => void"
|
|
63287
|
+
},
|
|
63288
|
+
"inheritedFrom": {
|
|
63289
|
+
"name": "HelixHeadlessGraph",
|
|
63290
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63291
|
+
}
|
|
63292
|
+
},
|
|
63293
|
+
{
|
|
63294
|
+
"kind": "method",
|
|
63295
|
+
"name": "countText",
|
|
63296
|
+
"privacy": "private",
|
|
63297
|
+
"return": {
|
|
63298
|
+
"type": {
|
|
63299
|
+
"text": "string"
|
|
63300
|
+
}
|
|
63301
|
+
},
|
|
63302
|
+
"description": "How many notes the list holds, in the page's numbers.",
|
|
63303
|
+
"inheritedFrom": {
|
|
63304
|
+
"name": "HelixHeadlessGraph",
|
|
63305
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63306
|
+
}
|
|
63307
|
+
},
|
|
63308
|
+
{
|
|
63309
|
+
"kind": "method",
|
|
63310
|
+
"name": "relationText",
|
|
63311
|
+
"privacy": "private",
|
|
63312
|
+
"return": {
|
|
63313
|
+
"type": {
|
|
63314
|
+
"text": "string"
|
|
63315
|
+
}
|
|
63316
|
+
},
|
|
63317
|
+
"parameters": [
|
|
63318
|
+
{
|
|
63319
|
+
"name": "entry",
|
|
63320
|
+
"type": {
|
|
63321
|
+
"text": "Entry"
|
|
63322
|
+
}
|
|
63323
|
+
}
|
|
63324
|
+
],
|
|
63325
|
+
"description": "How a row stands to the selected note, in words, or nothing where it does not.",
|
|
63326
|
+
"inheritedFrom": {
|
|
63327
|
+
"name": "HelixHeadlessGraph",
|
|
63328
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63329
|
+
}
|
|
63330
|
+
},
|
|
63331
|
+
{
|
|
63332
|
+
"kind": "method",
|
|
63333
|
+
"name": "choose",
|
|
63334
|
+
"privacy": "private",
|
|
63335
|
+
"return": {
|
|
63336
|
+
"type": {
|
|
63337
|
+
"text": "void"
|
|
63338
|
+
}
|
|
63339
|
+
},
|
|
63340
|
+
"parameters": [
|
|
63341
|
+
{
|
|
63342
|
+
"name": "index",
|
|
63343
|
+
"type": {
|
|
63344
|
+
"text": "number"
|
|
63345
|
+
}
|
|
63346
|
+
}
|
|
63347
|
+
],
|
|
63348
|
+
"description": "Selects the note a row names, through the request a page can refuse.",
|
|
63349
|
+
"inheritedFrom": {
|
|
63350
|
+
"name": "HelixHeadlessGraph",
|
|
63351
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63352
|
+
}
|
|
63353
|
+
},
|
|
63354
|
+
{
|
|
63355
|
+
"kind": "method",
|
|
63356
|
+
"name": "moveTo",
|
|
63357
|
+
"privacy": "private",
|
|
63358
|
+
"return": {
|
|
63359
|
+
"type": {
|
|
63360
|
+
"text": "void"
|
|
63361
|
+
}
|
|
63362
|
+
},
|
|
63363
|
+
"parameters": [
|
|
63364
|
+
{
|
|
63365
|
+
"name": "index",
|
|
63366
|
+
"type": {
|
|
63367
|
+
"text": "number"
|
|
63368
|
+
}
|
|
63369
|
+
}
|
|
63370
|
+
],
|
|
63371
|
+
"description": "Moves the keyboard to a row, and the list to show it.\n\n**Scrolled by the row's own box where it is drawn, and by the estimate\nwhere it is not**, so a jump to the end of ten thousand notes lands there\nand the row is drawn by the update the scroll asks for.",
|
|
63372
|
+
"inheritedFrom": {
|
|
63373
|
+
"name": "HelixHeadlessGraph",
|
|
63374
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63375
|
+
}
|
|
63376
|
+
},
|
|
63377
|
+
{
|
|
63378
|
+
"kind": "field",
|
|
63379
|
+
"name": "handleListKeydown",
|
|
63380
|
+
"privacy": "private",
|
|
63381
|
+
"readonly": true,
|
|
63382
|
+
"description": "The keys in the list. **Kept from the frame**, whose arrows pan the\ndrawing: a reader moving through the list was moving the graph under it.",
|
|
63383
|
+
"inheritedFrom": {
|
|
63384
|
+
"name": "HelixHeadlessGraph",
|
|
63385
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63386
|
+
}
|
|
63387
|
+
},
|
|
63388
|
+
{
|
|
63389
|
+
"kind": "field",
|
|
63390
|
+
"name": "handleSearchKeydown",
|
|
63391
|
+
"privacy": "private",
|
|
63392
|
+
"readonly": true,
|
|
63393
|
+
"description": "The search field's keys, which belong to the field and never pan the\ngraph. Escape empties a search that has words in it, and passes through\nan empty one to whatever the page does with it.",
|
|
63394
|
+
"inheritedFrom": {
|
|
63395
|
+
"name": "HelixHeadlessGraph",
|
|
63396
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63397
|
+
}
|
|
63398
|
+
},
|
|
63399
|
+
{
|
|
63400
|
+
"kind": "field",
|
|
63401
|
+
"name": "handleSearch",
|
|
63402
|
+
"privacy": "private",
|
|
63403
|
+
"readonly": true,
|
|
63404
|
+
"inheritedFrom": {
|
|
63405
|
+
"name": "HelixHeadlessGraph",
|
|
63406
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63407
|
+
}
|
|
63408
|
+
},
|
|
63409
|
+
{
|
|
63410
|
+
"kind": "method",
|
|
63411
|
+
"name": "renderFilterIcon",
|
|
63412
|
+
"privacy": "protected",
|
|
63413
|
+
"return": {
|
|
63414
|
+
"type": {
|
|
63415
|
+
"text": "TemplateResult"
|
|
63416
|
+
}
|
|
63417
|
+
},
|
|
63418
|
+
"description": "The mark in the search field, behind a seam: a slot for the page, and a\nmethod for the tier above, as the listbox's filter has.",
|
|
63419
|
+
"inheritedFrom": {
|
|
63420
|
+
"name": "HelixHeadlessGraph",
|
|
63421
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63422
|
+
}
|
|
63423
|
+
},
|
|
63424
|
+
{
|
|
63425
|
+
"kind": "method",
|
|
63426
|
+
"name": "renderRows",
|
|
63427
|
+
"privacy": "private",
|
|
63428
|
+
"return": {
|
|
63429
|
+
"type": {
|
|
63430
|
+
"text": "TemplateResult[]"
|
|
63431
|
+
}
|
|
63432
|
+
},
|
|
63433
|
+
"inheritedFrom": {
|
|
63434
|
+
"name": "HelixHeadlessGraph",
|
|
63435
|
+
"module": "src/graph/root/graph-root.ts"
|
|
63436
|
+
}
|
|
63437
|
+
},
|
|
63438
|
+
{
|
|
63439
|
+
"kind": "field",
|
|
63440
|
+
"name": "tier",
|
|
63441
|
+
"type": {
|
|
63442
|
+
"text": "string"
|
|
63443
|
+
},
|
|
63444
|
+
"static": true,
|
|
63445
|
+
"default": "'helix-headless-'",
|
|
63446
|
+
"description": "The prefix this tier registers its elements under.\n\n**A component that renders another renders its own tier's version of it**,\nso `helix-headless-pagination-size` composes `helix-headless-select` and\n`helix-pagination-size` composes `helix-select`. One template says\n`${this.tag('select')}` and each tier answers with its own name.\n\n**The public tag may not be the composed one, in either tier.** Using it\ncosts three things: the name means two different things depending on what a\nconsumer imported, the headless tier composes an element it does not ship,\nand the composition cannot be tested there at all, because there is no\n`helix-select` on that tier to test it against.\n\n**A prefix rather than an override per composition**, which was the first\nplan and does not compile. An override re-renders the fragment from the\nsubclass, and the fragment reads members the base keeps private:\n`PaginationSize` alone would have had to widen `options`, `current` and\n`handleChange` to `protected` so a subclass could say the same thing again.\nSixteen families of that is a lot of encapsulation spent on saying one\nword differently.",
|
|
63447
|
+
"inheritedFrom": {
|
|
63448
|
+
"name": "HelixElement",
|
|
63449
|
+
"module": "src/helix-element/helix-element.ts"
|
|
63450
|
+
}
|
|
63451
|
+
},
|
|
63452
|
+
{
|
|
63453
|
+
"kind": "method",
|
|
63454
|
+
"name": "tag",
|
|
63455
|
+
"privacy": "protected",
|
|
63456
|
+
"return": {
|
|
63457
|
+
"type": {
|
|
63458
|
+
"text": "StaticValue"
|
|
63459
|
+
}
|
|
63460
|
+
},
|
|
63461
|
+
"parameters": [
|
|
63462
|
+
{
|
|
63463
|
+
"name": "name",
|
|
63464
|
+
"type": {
|
|
63465
|
+
"text": "string"
|
|
63466
|
+
}
|
|
63467
|
+
}
|
|
63468
|
+
],
|
|
63469
|
+
"description": "One composed tag, as a static value a template can interpolate.\n\n`unsafeStatic` is safe by construction: the name is a literal in our own\nsource and the prefix is one of two strings this class defines. Called per\nrender and not cached, which costs nothing, because `static-html` keys its\ntemplate cache on the joined string rather than on the object.",
|
|
63470
|
+
"inheritedFrom": {
|
|
63471
|
+
"name": "HelixElement",
|
|
63472
|
+
"module": "src/helix-element/helix-element.ts"
|
|
63473
|
+
}
|
|
63474
|
+
},
|
|
63475
|
+
{
|
|
63476
|
+
"kind": "method",
|
|
63477
|
+
"name": "partNamed",
|
|
63478
|
+
"privacy": "protected",
|
|
63479
|
+
"return": {
|
|
63480
|
+
"type": {
|
|
63481
|
+
"text": "T | null"
|
|
63482
|
+
}
|
|
63483
|
+
},
|
|
63484
|
+
"parameters": [
|
|
63485
|
+
{
|
|
63486
|
+
"name": "name",
|
|
63487
|
+
"type": {
|
|
63488
|
+
"text": "string"
|
|
63489
|
+
}
|
|
63490
|
+
}
|
|
63491
|
+
],
|
|
63492
|
+
"description": "One of this element's own parts, by name, or null where it is not rendered.\n\nNot `part`, which every element already has: `Element.part` is the\n`DOMTokenList` of the names the element itself carries, and a method under\nthat name is a type error on every subclass.\n\n**One guard for every lookup.** Lit's server shim has no `querySelector`\non the render root, so a lookup reached during a server render, from a\ngetter a template reads or from `willUpdate`, throws there and nowhere\nelse. Four spellings of the same guard had grown across the library, and\na fifth site with none. Null on the server, which is what the rest of the\ncode already treats a part that has not rendered as.\n\n**`~=` and not `=`.** A part drawn in a state carries a second name while\nthe state holds, `part=\"page page-current\"`, and an exact match stops\nfinding it for exactly as long as it is the one that matters.\n\n`helix component`'s `selectors` reads these calls the way it reads a\n`querySelector('[part=\"x\"]')`, so a name nothing renders is a finding\nrather than a null an optional chain swallows.",
|
|
63493
|
+
"inheritedFrom": {
|
|
63494
|
+
"name": "HelixElement",
|
|
63495
|
+
"module": "src/helix-element/helix-element.ts"
|
|
63496
|
+
}
|
|
63497
|
+
},
|
|
63498
|
+
{
|
|
63499
|
+
"kind": "field",
|
|
63500
|
+
"name": "internals",
|
|
63501
|
+
"type": {
|
|
63502
|
+
"text": "ElementInternals"
|
|
63503
|
+
},
|
|
63504
|
+
"privacy": "protected",
|
|
63505
|
+
"readonly": true,
|
|
63506
|
+
"description": "The element's semantics, set without touching the DOM.\n\n`ElementInternals` sets the implicit role, which an author's own `role`\nattribute still overrides, and it writes no attribute. Setting `role` on the\nhost directly would: that is an attribute the element gives itself after it\nupgrades, which a React consumer's server markup never had, and hydration\nreports it as a mismatch.\n\nAvailable during server rendering. Lit's shim implements `attachInternals`,\nso nothing here needs a guard.",
|
|
63507
|
+
"inheritedFrom": {
|
|
63508
|
+
"name": "HelixElement",
|
|
63509
|
+
"module": "src/helix-element/helix-element.ts"
|
|
63510
|
+
}
|
|
63511
|
+
},
|
|
63512
|
+
{
|
|
63513
|
+
"kind": "method",
|
|
63514
|
+
"name": "toggleState",
|
|
63515
|
+
"privacy": "protected",
|
|
63516
|
+
"return": {
|
|
63517
|
+
"type": {
|
|
63518
|
+
"text": "void"
|
|
63519
|
+
}
|
|
63520
|
+
},
|
|
63521
|
+
"parameters": [
|
|
63522
|
+
{
|
|
63523
|
+
"name": "name",
|
|
63524
|
+
"type": {
|
|
63525
|
+
"text": "string"
|
|
63526
|
+
}
|
|
63527
|
+
},
|
|
63528
|
+
{
|
|
63529
|
+
"name": "on",
|
|
63530
|
+
"type": {
|
|
63531
|
+
"text": "boolean"
|
|
63532
|
+
}
|
|
63533
|
+
}
|
|
63534
|
+
],
|
|
63535
|
+
"description": "Records a boolean fact about this element as a custom state.\n\n**The host belongs to whoever rendered it, and a component's own\nbookkeeping may not be kept there.** An attribute written on the first\nupdate is markup a consumer's server never sent, so a React consumer\nhydrates a DOM that has gained attributes since and reports a mismatch it\nwill not patch up. A custom state is not in the DOM at all: it carries the\nfact to a stylesheet through `:state()` and leaves the markup alone, so the\nserver's output and the client's agree by construction.\n\n`SETTLED` carries the long version of that argument; `checked`, `open`,\n`invalid` and `has-label` are recorded the same way, each of them a state a\n`default-*` attribute resolves before React reaches the node.\n\n**Deferring the definitions is not a fix and could not be.** Importing them\nfrom an effect so the upgrades fall the other side of hydration works only\nwhile hydration is one pass: anything that splits it, a streamed segment or\na suspended boundary, puts an upgrade back inside the window. Timing cannot\nbe the guarantee when the fact is kept somewhere React reconciles.\n\nFeature-tested rather than assumed, the way `hostAria` tests element\nreferences. An engine without `CustomStateSet` records nothing and keeps\nwhatever the resting rule draws, which is the safe direction to fail.\n\n**The engines the test is for are browsers**: Safari below 17.4 and Firefox\nbelow 126, where the write is a `TypeError`, so a component bypassing this\nfails to render rather than rendering without whatever the state draws.\nLit's server shim sets `states`, so the guard passes there and records a\nstate nothing reads, which is harmless.",
|
|
63536
|
+
"inheritedFrom": {
|
|
63537
|
+
"name": "HelixElement",
|
|
63538
|
+
"module": "src/helix-element/helix-element.ts"
|
|
63539
|
+
}
|
|
63540
|
+
},
|
|
63541
|
+
{
|
|
63542
|
+
"kind": "field",
|
|
63543
|
+
"name": "whenSettled",
|
|
63544
|
+
"type": {
|
|
63545
|
+
"text": "Promise<void>"
|
|
63546
|
+
},
|
|
63547
|
+
"readonly": true,
|
|
63548
|
+
"description": "Resolves a frame after the first update, when transitions are switched on.\n\n**Named `whenSettled` because `settled` is taken four times over**, by\nImage, Splitter and both color controls, none of them about transitions. A\nbase class takes the name every subclass then cannot use.\n\n**The state it reports cannot be watched, which is why this exists.** A\ncustom state is deliberately not in the DOM, so there is no\n`MutationObserver` equivalent for `ElementInternals.states`. Await this\ninstead.\n\nSeparate from `updateComplete`, which resolves in the microtask checkpoint\nthe suppression is still active in. That is the distinction `readyToMove`\nin `@fusion.dev/helix-testing` is written around.\n\nIt never resolves where `requestAnimationFrame` never fires, which is a\nserver, a hidden tab, and happy-dom. Callers that must not hang there race\nit against a timeout, as the happy-dom harness's `readyToMove` does. The\nbrowser harness's awaits it alone: a browser always runs the frame, and a\ntimer beside it was a bet on how long one takes, which a busy run lost.",
|
|
63549
|
+
"default": "new Promise<void>((resolve) => { this.resolveSettled = resolve })",
|
|
63550
|
+
"inheritedFrom": {
|
|
63551
|
+
"name": "HelixElement",
|
|
63552
|
+
"module": "src/helix-element/helix-element.ts"
|
|
63553
|
+
}
|
|
63554
|
+
},
|
|
63555
|
+
{
|
|
63556
|
+
"kind": "field",
|
|
63557
|
+
"name": "resolveSettled",
|
|
63558
|
+
"type": {
|
|
63559
|
+
"text": "() => void"
|
|
63560
|
+
},
|
|
63561
|
+
"privacy": "private",
|
|
63562
|
+
"description": "Resolves `whenSettled`, once, from the frame that records the state.",
|
|
63563
|
+
"inheritedFrom": {
|
|
63564
|
+
"name": "HelixElement",
|
|
63565
|
+
"module": "src/helix-element/helix-element.ts"
|
|
63566
|
+
}
|
|
63567
|
+
},
|
|
63568
|
+
{
|
|
63569
|
+
"kind": "field",
|
|
63570
|
+
"name": "fromServer",
|
|
63571
|
+
"type": {
|
|
63572
|
+
"text": "boolean"
|
|
63573
|
+
},
|
|
63574
|
+
"privacy": "private",
|
|
63575
|
+
"default": "false",
|
|
63576
|
+
"description": "Whether the shadow root was a server's, parsed from declarative shadow DOM.",
|
|
63577
|
+
"inheritedFrom": {
|
|
63578
|
+
"name": "HelixElement",
|
|
63579
|
+
"module": "src/helix-element/helix-element.ts"
|
|
63580
|
+
}
|
|
63581
|
+
},
|
|
63582
|
+
{
|
|
63583
|
+
"kind": "field",
|
|
63584
|
+
"name": "hydrating",
|
|
63585
|
+
"type": {
|
|
63586
|
+
"text": "boolean"
|
|
63587
|
+
},
|
|
63588
|
+
"privacy": "protected",
|
|
63589
|
+
"description": "Whether this update is hydrating a server's markup, and so has to render\nexactly what the server rendered.\n\n**Lit hydrates by assuming the markup already shows the first render.** A\nvalue that differs is recorded and never written, so the page keeps the\nserver's, and a template that differs throws. The server has no children,\nso anything a component reads from its children waits for the update after\nhydration, which `finishHydration` asks for. Without a server's markup the\nfirst render reads them and there is one render.",
|
|
63590
|
+
"readonly": true,
|
|
63591
|
+
"inheritedFrom": {
|
|
63592
|
+
"name": "HelixElement",
|
|
63593
|
+
"module": "src/helix-element/helix-element.ts"
|
|
63594
|
+
}
|
|
63595
|
+
},
|
|
63596
|
+
{
|
|
63597
|
+
"kind": "field",
|
|
63598
|
+
"name": "serverRendered",
|
|
63599
|
+
"type": {
|
|
63600
|
+
"text": "boolean"
|
|
63601
|
+
},
|
|
63602
|
+
"privacy": "protected",
|
|
63603
|
+
"description": "Whether this element hydrated a server's markup rather than rendering its own.\n\nFor what happened before hydration and cannot be heard after it: an image\nthe parser fetched fires `load` or `error` before any listener exists, so a\ncomponent asks the image instead, once, when this is true.",
|
|
63604
|
+
"readonly": true,
|
|
63605
|
+
"inheritedFrom": {
|
|
63606
|
+
"name": "HelixElement",
|
|
63607
|
+
"module": "src/helix-element/helix-element.ts"
|
|
63608
|
+
}
|
|
63609
|
+
},
|
|
63610
|
+
{
|
|
63611
|
+
"kind": "method",
|
|
63612
|
+
"name": "finishHydration",
|
|
63613
|
+
"privacy": "protected",
|
|
63614
|
+
"return": {
|
|
63615
|
+
"type": {
|
|
63616
|
+
"text": "void"
|
|
63617
|
+
}
|
|
63618
|
+
},
|
|
63619
|
+
"description": "Asks for the update a hydration put off, so the reads it skipped happen.\n\nCalled from `firstUpdated`, the end of the hydrating update. The render it\nschedules can only follow that one, which is the exception Lit's\nchange-in-update warning names, and it happens only on a page a server\nrendered.",
|
|
63620
|
+
"inheritedFrom": {
|
|
63621
|
+
"name": "HelixElement",
|
|
63622
|
+
"module": "src/helix-element/helix-element.ts"
|
|
63623
|
+
}
|
|
63624
|
+
},
|
|
63625
|
+
{
|
|
63626
|
+
"kind": "field",
|
|
63627
|
+
"name": "childrenKnown",
|
|
63628
|
+
"type": {
|
|
63629
|
+
"text": "boolean"
|
|
63630
|
+
},
|
|
63631
|
+
"privacy": "protected",
|
|
63632
|
+
"description": "Whether this render can know the children.\n\nA server cannot: its element shim carries attributes and no tree, so\n`children` is undefined there. A render hydrating what a server sent must\nnot, because it has to be the server's render. Anywhere else it can. A\ncomponent whose render depends on its children reads them through\n`knownChildren`, and treats \"not known\" as its own answer rather than as\n\"none\": a list that renders its empty state because nobody has looked yet is\nthe one thing an empty state must never do.",
|
|
63633
|
+
"readonly": true,
|
|
63634
|
+
"inheritedFrom": {
|
|
63635
|
+
"name": "HelixElement",
|
|
63636
|
+
"module": "src/helix-element/helix-element.ts"
|
|
63637
|
+
}
|
|
63638
|
+
},
|
|
63639
|
+
{
|
|
63640
|
+
"kind": "field",
|
|
63641
|
+
"name": "knownChildren",
|
|
63642
|
+
"type": {
|
|
63643
|
+
"text": "Element[]"
|
|
63644
|
+
},
|
|
63645
|
+
"privacy": "protected",
|
|
63646
|
+
"description": "The children a render may read: all of them where they are known, and none otherwise.",
|
|
63647
|
+
"readonly": true,
|
|
63648
|
+
"inheritedFrom": {
|
|
63649
|
+
"name": "HelixElement",
|
|
63650
|
+
"module": "src/helix-element/helix-element.ts"
|
|
63651
|
+
}
|
|
63652
|
+
},
|
|
63653
|
+
{
|
|
63654
|
+
"kind": "field",
|
|
63655
|
+
"name": "assignsByName",
|
|
63656
|
+
"type": {
|
|
63657
|
+
"text": "boolean"
|
|
63658
|
+
},
|
|
63659
|
+
"privacy": "protected",
|
|
63660
|
+
"description": "Whether this element's slots route by name although it asked to assign them\nby hand.\n\n**A declarative shadow root is always the by-name kind.** HTML has no way to\nask for manual assignment, so a component that assigns by hand and hydrates\na server's root gets one where `slot.assign()` does nothing, and its\nchildren land wherever their `slot` attribute sends them. The way through is\nto write that attribute, which is what `route` does. Only there: on a root\nthis element made, assignment stays manual and the consumer's markup is\nnever touched, which is what a React consumer's hydration requires.",
|
|
63661
|
+
"readonly": true,
|
|
63662
|
+
"inheritedFrom": {
|
|
63663
|
+
"name": "HelixElement",
|
|
63664
|
+
"module": "src/helix-element/helix-element.ts"
|
|
63665
|
+
}
|
|
63666
|
+
},
|
|
63667
|
+
{
|
|
63668
|
+
"kind": "method",
|
|
63669
|
+
"name": "route",
|
|
63670
|
+
"privacy": "protected",
|
|
63671
|
+
"return": {
|
|
63672
|
+
"type": {
|
|
63673
|
+
"text": "void"
|
|
63674
|
+
}
|
|
63675
|
+
},
|
|
63676
|
+
"parameters": [
|
|
63677
|
+
{
|
|
63678
|
+
"name": "child",
|
|
63679
|
+
"type": {
|
|
63680
|
+
"text": "Element"
|
|
63681
|
+
}
|
|
63682
|
+
},
|
|
63683
|
+
{
|
|
63684
|
+
"name": "name",
|
|
63685
|
+
"type": {
|
|
63686
|
+
"text": "string | undefined"
|
|
63687
|
+
}
|
|
63688
|
+
}
|
|
63689
|
+
],
|
|
63690
|
+
"description": "Sends a child to a slot by name, on a root that routes by name.\n\n`undefined` is the default slot. Written only when it differs, so routing\nthe same child again on every update writes nothing.",
|
|
63691
|
+
"inheritedFrom": {
|
|
63692
|
+
"name": "HelixElement",
|
|
63693
|
+
"module": "src/helix-element/helix-element.ts"
|
|
63694
|
+
}
|
|
63695
|
+
},
|
|
63696
|
+
{
|
|
63697
|
+
"kind": "field",
|
|
63698
|
+
"name": "stopInner",
|
|
63699
|
+
"privacy": "protected",
|
|
63700
|
+
"readonly": true,
|
|
63701
|
+
"description": "Stops an inner control's own announcement at this element's boundary.\n\n**A composed control is one control to a consumer, and the natives had no\nequivalent of the stop the prefixed events already get.** `<helix-select>`\nrenders a `<helix-listbox>`, and both announce: the listbox dispatches\n`input` and `change` from its own host, `input` is composed by\nspecification, and a consumer listening on the select therefore heard one\nchoice twice. Measured before this existed, on the styled tier, one choice\non the inner listbox: select `input` twice and `change` three times,\ncombobox, date input, time input and color input twice each. `Command` was\nthe only one that was right, because it happened to reach for\n`stopImmediatePropagation` for a different reason.\n\nBound on the child in the parent's template, so it runs while the event is\nstill at the child and before it can cross. The guard is for the case where\na component binds this on itself: an element must never stop its own\nannouncement, which is the one it exists to make.\n\nThis is the same job the `helix-before-*` handlers do with their own\n`stopPropagation`, and it is separate rather than folded into them because\na consumer may legitimately refuse a request without the notification ever\nhappening: the two travel at different times and one can be absent.",
|
|
63702
|
+
"inheritedFrom": {
|
|
63703
|
+
"name": "HelixElement",
|
|
63704
|
+
"module": "src/helix-element/helix-element.ts"
|
|
63705
|
+
}
|
|
63706
|
+
},
|
|
63707
|
+
{
|
|
63708
|
+
"kind": "method",
|
|
63709
|
+
"name": "relayNativeEvent",
|
|
63710
|
+
"privacy": "protected",
|
|
63711
|
+
"return": {
|
|
63712
|
+
"type": {
|
|
63713
|
+
"text": "void"
|
|
63714
|
+
}
|
|
63715
|
+
},
|
|
63716
|
+
"parameters": [
|
|
63717
|
+
{
|
|
63718
|
+
"name": "event",
|
|
63719
|
+
"type": {
|
|
63720
|
+
"text": "Event"
|
|
63721
|
+
}
|
|
63722
|
+
},
|
|
63723
|
+
{
|
|
63724
|
+
"name": "init",
|
|
63725
|
+
"optional": true,
|
|
63726
|
+
"type": {
|
|
63727
|
+
"text": "EventInit"
|
|
63728
|
+
}
|
|
63729
|
+
}
|
|
63730
|
+
],
|
|
63731
|
+
"description": "Re-emits a native event from the host, under its own name.\n\nA native event fired by an inner `<input>` or `<textarea>` is not composed,\nso it stops at the shadow boundary and a consumer listening on\n`<helix-input>` hears nothing. Re-dispatching it from the host is what\nmakes the component behave like the control it wraps.\n\nThe relayed event keeps the native name deliberately. `change` is `change`,\nwhich is what a consumer already knows to listen for, and it is what\nreaches React: its synthetic system claims `onChange` and wires it to that\nname, so a prefixed one would never arrive.\n\n`composed` is not forced. It defaults to the original event's own value, so\na relayed `change` stops at the next shadow boundary exactly as a native\none would. Pass it explicitly only where escaping is the intent, and say so\nwhere you do.",
|
|
63732
|
+
"inheritedFrom": {
|
|
63733
|
+
"name": "HelixElement",
|
|
63734
|
+
"module": "src/helix-element/helix-element.ts"
|
|
63735
|
+
}
|
|
63736
|
+
},
|
|
63737
|
+
{
|
|
63738
|
+
"kind": "method",
|
|
63739
|
+
"name": "finalizeStyles",
|
|
63740
|
+
"privacy": "protected",
|
|
63741
|
+
"static": true,
|
|
63742
|
+
"return": {
|
|
63743
|
+
"type": {
|
|
63744
|
+
"text": "CSSResultOrNative[]"
|
|
63745
|
+
}
|
|
63746
|
+
},
|
|
63747
|
+
"parameters": [
|
|
63748
|
+
{
|
|
63749
|
+
"name": "styles",
|
|
63750
|
+
"optional": true,
|
|
63751
|
+
"type": {
|
|
63752
|
+
"text": "CSSResultOrNative | CSSResultOrNative[]"
|
|
63753
|
+
}
|
|
63754
|
+
}
|
|
63755
|
+
],
|
|
63756
|
+
"description": "Prepends the shadow-root reset to every subclass's styles, so no component\nhas to remember to include it.",
|
|
63757
|
+
"inheritedFrom": {
|
|
63758
|
+
"name": "HelixElement",
|
|
63759
|
+
"module": "src/helix-element/helix-element.ts"
|
|
63760
|
+
}
|
|
63761
|
+
}
|
|
63762
|
+
],
|
|
63763
|
+
"superclass": {
|
|
63764
|
+
"name": "HelixHeadlessGraph",
|
|
63765
|
+
"package": "@fusion.dev/helix-headless/graph"
|
|
63766
|
+
},
|
|
63767
|
+
"summary": "A frame around a graph of notes drawn by another library, and the list that makes it readable.",
|
|
63768
|
+
"helix": {
|
|
63769
|
+
"category": "media",
|
|
63770
|
+
"since": "0.116.0",
|
|
63771
|
+
"status": "experimental",
|
|
63772
|
+
"documentation": "https://fusion.dev/helix/components/graph",
|
|
63773
|
+
"aliases": [
|
|
63774
|
+
"Knowledge graph",
|
|
63775
|
+
"Network",
|
|
63776
|
+
"Note graph",
|
|
63777
|
+
"Second brain"
|
|
63778
|
+
],
|
|
63779
|
+
"tier": "styled",
|
|
63780
|
+
"group": "Graph",
|
|
63781
|
+
"part": "Root",
|
|
63782
|
+
"examples": [
|
|
63783
|
+
{
|
|
63784
|
+
"description": "A graph of linked notes, with the selected note's links and backlinks listed first.",
|
|
63785
|
+
"slug": "preview"
|
|
63786
|
+
}
|
|
63787
|
+
],
|
|
63788
|
+
"source": "helix/styled/src/graph"
|
|
63789
|
+
},
|
|
63790
|
+
"tagName": "helix-graph",
|
|
63791
|
+
"customElement": true,
|
|
63792
|
+
"attributes": [
|
|
63793
|
+
{
|
|
63794
|
+
"name": "activate-hint-label",
|
|
63795
|
+
"type": {
|
|
63796
|
+
"text": "string | undefined"
|
|
63797
|
+
},
|
|
63798
|
+
"description": "The hint shown when a surface waiting to be pressed is scrolled or\nswiped over, with `gestures=\"activate\"`. Absent is the family's own.",
|
|
63799
|
+
"fieldName": "activateHintLabel",
|
|
63800
|
+
"inheritedFrom": {
|
|
63801
|
+
"name": "MixinViewport",
|
|
63802
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63803
|
+
}
|
|
63804
|
+
},
|
|
63805
|
+
{
|
|
63806
|
+
"name": "controls",
|
|
63807
|
+
"type": {
|
|
63808
|
+
"text": "string | undefined"
|
|
63809
|
+
},
|
|
63810
|
+
"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.",
|
|
63811
|
+
"fieldName": "controls",
|
|
63812
|
+
"inheritedFrom": {
|
|
63813
|
+
"name": "MixinViewport",
|
|
63814
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63815
|
+
}
|
|
63816
|
+
},
|
|
63817
|
+
{
|
|
63818
|
+
"name": "controls-label",
|
|
63819
|
+
"type": {
|
|
63820
|
+
"text": "string | undefined"
|
|
63821
|
+
},
|
|
63822
|
+
"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.",
|
|
63823
|
+
"fieldName": "controlsLabel",
|
|
63824
|
+
"inheritedFrom": {
|
|
63825
|
+
"name": "MixinViewport",
|
|
63826
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63827
|
+
}
|
|
63828
|
+
},
|
|
63829
|
+
{
|
|
63830
|
+
"name": "controls-placement",
|
|
63831
|
+
"type": {
|
|
63832
|
+
"text": "'top-start' | 'top-end' | 'bottom-start' | 'bottom-end' | undefined"
|
|
63833
|
+
},
|
|
63834
|
+
"description": "Which corner the controls sit in.\n\n**Configurable because there is no safe default**, which is a collision\nrather than a taste: whatever a consumer slots may put its own controls\nin any corner, and every library that draws some made this a setting for\nthe same reason.\n\nLogical corners rather than left and right, so a right-to-left page moves\nthem without a consumer writing a second rule. Absent is the top end, a\nresting value being an attribute's absence: a default that reflected\nwould write an attribute onto every host that no server sent.",
|
|
63835
|
+
"fieldName": "controlsPlacement",
|
|
63836
|
+
"inheritedFrom": {
|
|
63837
|
+
"name": "MixinViewport",
|
|
63838
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63839
|
+
}
|
|
63840
|
+
},
|
|
63841
|
+
{
|
|
63842
|
+
"name": "fullscreen-label",
|
|
63843
|
+
"type": {
|
|
63844
|
+
"text": "string"
|
|
63845
|
+
},
|
|
63846
|
+
"default": "'Fill the screen'",
|
|
63847
|
+
"description": "The fullscreen button's label.",
|
|
63848
|
+
"fieldName": "fullscreenLabel",
|
|
63849
|
+
"inheritedFrom": {
|
|
63850
|
+
"name": "MixinViewport",
|
|
63851
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63852
|
+
}
|
|
63853
|
+
},
|
|
63854
|
+
{
|
|
63855
|
+
"name": "gestures",
|
|
63856
|
+
"type": {
|
|
63857
|
+
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
63858
|
+
},
|
|
63859
|
+
"description": "Which gestures the surface takes from the page.\n\n- `always`: the surface takes the wheel and one finger, for a surface\n that is the page, such as a full-screen view. A map rests here.\n- Unset is the family's own: `always` for a map, and for a board, a\n drag and a pinch, with the plain wheel left to the page until the\n board fills the screen.\n- `cooperative`: the wheel and one finger scroll the page, and the\n surface takes Ctrl or ⌘ with the wheel, and two fingers. The frame\n says so when a gesture passes to the page. Best for a surface embedded\n in a page.\n- `activate`: the surface takes nothing until it is pressed, and gives it\n back on Escape, when the pointer leaves it, or on a press elsewhere.\n\nThe keyboard and the frame's buttons work in every mode.\n\n**Unreflected and without a default**, because a default that reflected\nwould write an attribute onto every host that no server sent, and the\nhydration that followed would disagree with it.",
|
|
63860
|
+
"fieldName": "gestures",
|
|
63861
|
+
"inheritedFrom": {
|
|
63862
|
+
"name": "MixinViewport",
|
|
63863
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63864
|
+
}
|
|
63865
|
+
},
|
|
63866
|
+
{
|
|
63867
|
+
"name": "idle-delay",
|
|
63868
|
+
"type": {
|
|
63869
|
+
"text": "number"
|
|
63870
|
+
},
|
|
63871
|
+
"default": "0",
|
|
63872
|
+
"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.",
|
|
63873
|
+
"fieldName": "idleDelay",
|
|
63874
|
+
"inheritedFrom": {
|
|
63875
|
+
"name": "MixinViewport",
|
|
63876
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63877
|
+
}
|
|
63878
|
+
},
|
|
63879
|
+
{
|
|
63880
|
+
"name": "pan-down-label",
|
|
63881
|
+
"type": {
|
|
63882
|
+
"text": "string"
|
|
63883
|
+
},
|
|
63884
|
+
"default": "'Pan down'",
|
|
63885
|
+
"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.",
|
|
63886
|
+
"fieldName": "panDownLabel",
|
|
63887
|
+
"inheritedFrom": {
|
|
63888
|
+
"name": "MixinViewport",
|
|
63889
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63890
|
+
}
|
|
63891
|
+
},
|
|
63892
|
+
{
|
|
63893
|
+
"name": "pan-left-label",
|
|
63894
|
+
"type": {
|
|
63895
|
+
"text": "string"
|
|
63896
|
+
},
|
|
63897
|
+
"default": "'Pan left'",
|
|
63898
|
+
"description": "The pan left button's label.",
|
|
63899
|
+
"fieldName": "panLeftLabel",
|
|
63900
|
+
"inheritedFrom": {
|
|
63901
|
+
"name": "MixinViewport",
|
|
63902
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63903
|
+
}
|
|
63904
|
+
},
|
|
63905
|
+
{
|
|
63906
|
+
"name": "pan-right-label",
|
|
63907
|
+
"type": {
|
|
63908
|
+
"text": "string"
|
|
63909
|
+
},
|
|
63910
|
+
"default": "'Pan right'",
|
|
63911
|
+
"description": "The pan right button's label.",
|
|
63912
|
+
"fieldName": "panRightLabel",
|
|
63913
|
+
"inheritedFrom": {
|
|
63914
|
+
"name": "MixinViewport",
|
|
63915
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63916
|
+
}
|
|
63917
|
+
},
|
|
63918
|
+
{
|
|
63919
|
+
"name": "pan-step",
|
|
63920
|
+
"type": {
|
|
63921
|
+
"text": "number"
|
|
63922
|
+
},
|
|
63923
|
+
"default": "0.25",
|
|
63924
|
+
"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.",
|
|
63925
|
+
"fieldName": "panStep",
|
|
63926
|
+
"inheritedFrom": {
|
|
63927
|
+
"name": "MixinViewport",
|
|
63928
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63929
|
+
}
|
|
63930
|
+
},
|
|
63931
|
+
{
|
|
63932
|
+
"name": "pan-up-label",
|
|
63933
|
+
"type": {
|
|
63934
|
+
"text": "string"
|
|
63935
|
+
},
|
|
63936
|
+
"default": "'Pan up'",
|
|
63937
|
+
"description": "The pan up button's label.",
|
|
63938
|
+
"fieldName": "panUpLabel",
|
|
63939
|
+
"inheritedFrom": {
|
|
63940
|
+
"name": "MixinViewport",
|
|
63941
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63942
|
+
}
|
|
63943
|
+
},
|
|
63944
|
+
{
|
|
63945
|
+
"name": "two-finger-hint-label",
|
|
63946
|
+
"type": {
|
|
63947
|
+
"text": "string | undefined"
|
|
63948
|
+
},
|
|
63949
|
+
"description": "The hint shown when one finger swipes over a surface with\n`gestures=\"cooperative\"`. Absent is the family's own.",
|
|
63950
|
+
"fieldName": "twoFingerHintLabel",
|
|
63951
|
+
"inheritedFrom": {
|
|
63952
|
+
"name": "MixinViewport",
|
|
63953
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63954
|
+
}
|
|
63955
|
+
},
|
|
63956
|
+
{
|
|
63957
|
+
"name": "using-label",
|
|
63958
|
+
"type": {
|
|
63959
|
+
"text": "string | undefined"
|
|
63960
|
+
},
|
|
63961
|
+
"description": "The line shown while a surface with `gestures=\"activate\"` has the\ngestures. Absent is the family's own.",
|
|
63962
|
+
"fieldName": "usingLabel",
|
|
63963
|
+
"inheritedFrom": {
|
|
63964
|
+
"name": "MixinViewport",
|
|
63965
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63966
|
+
}
|
|
63967
|
+
},
|
|
63968
|
+
{
|
|
63969
|
+
"name": "wheel-hint-label",
|
|
63970
|
+
"type": {
|
|
63971
|
+
"text": "string | undefined"
|
|
63972
|
+
},
|
|
63973
|
+
"description": "The hint shown when the wheel scrolls past a surface with\n`gestures=\"cooperative\"`, with `{key}`, which is ⌘ on a Mac and Ctrl\nelsewhere. Absent is the family's own.",
|
|
63974
|
+
"fieldName": "wheelHintLabel",
|
|
63975
|
+
"inheritedFrom": {
|
|
63976
|
+
"name": "MixinViewport",
|
|
63977
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63978
|
+
}
|
|
63979
|
+
},
|
|
63980
|
+
{
|
|
63981
|
+
"name": "zoom-in-label",
|
|
63982
|
+
"type": {
|
|
63983
|
+
"text": "string"
|
|
63984
|
+
},
|
|
63985
|
+
"default": "'Zoom in'",
|
|
63986
|
+
"description": "The zoom in button's label.",
|
|
63987
|
+
"fieldName": "zoomInLabel",
|
|
63988
|
+
"inheritedFrom": {
|
|
63989
|
+
"name": "MixinViewport",
|
|
63990
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
63991
|
+
}
|
|
63992
|
+
},
|
|
63993
|
+
{
|
|
63994
|
+
"name": "zoom-out-label",
|
|
63995
|
+
"type": {
|
|
63996
|
+
"text": "string"
|
|
63997
|
+
},
|
|
63998
|
+
"default": "'Zoom out'",
|
|
63999
|
+
"description": "The zoom out button's label.",
|
|
64000
|
+
"fieldName": "zoomOutLabel",
|
|
64001
|
+
"inheritedFrom": {
|
|
64002
|
+
"name": "MixinViewport",
|
|
64003
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
64004
|
+
}
|
|
64005
|
+
},
|
|
64006
|
+
{
|
|
64007
|
+
"name": "active",
|
|
64008
|
+
"type": {
|
|
64009
|
+
"text": "string"
|
|
64010
|
+
},
|
|
64011
|
+
"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.",
|
|
64012
|
+
"fieldName": "active",
|
|
64013
|
+
"inheritedFrom": {
|
|
64014
|
+
"name": "MixinControllerActive",
|
|
64015
|
+
"module": "src/mixins/mixin-controller-active/mixin-controller-active.ts"
|
|
64016
|
+
}
|
|
64017
|
+
},
|
|
64018
|
+
{
|
|
64019
|
+
"name": "default-active",
|
|
64020
|
+
"type": {
|
|
64021
|
+
"text": "string"
|
|
64022
|
+
},
|
|
64023
|
+
"default": "''",
|
|
64024
|
+
"description": "The `value` of the item declared current in markup.\n\nIgnored once `active` is written.",
|
|
64025
|
+
"fieldName": "defaultActive",
|
|
64026
|
+
"inheritedFrom": {
|
|
64027
|
+
"name": "MixinControllerActive",
|
|
64028
|
+
"module": "src/mixins/mixin-controller-active/mixin-controller-active.ts"
|
|
64029
|
+
}
|
|
64030
|
+
},
|
|
64031
|
+
{
|
|
64032
|
+
"name": "count-label",
|
|
64033
|
+
"type": {
|
|
64034
|
+
"text": "string"
|
|
64035
|
+
},
|
|
64036
|
+
"default": "'{count} notes'",
|
|
64037
|
+
"description": "What the list says of a note's count, with `{count}`.",
|
|
64038
|
+
"fieldName": "countLabel",
|
|
64039
|
+
"inheritedFrom": {
|
|
64040
|
+
"name": "HelixHeadlessGraph",
|
|
64041
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64042
|
+
}
|
|
64043
|
+
},
|
|
64044
|
+
{
|
|
64045
|
+
"name": "depth",
|
|
64046
|
+
"type": {
|
|
64047
|
+
"text": "number | undefined"
|
|
64048
|
+
},
|
|
64049
|
+
"description": "How many links from the selected note to show, for its local graph. Unset\nshows every note. The list holds what the drawing shows.",
|
|
64050
|
+
"fieldName": "depth",
|
|
64051
|
+
"inheritedFrom": {
|
|
64052
|
+
"name": "HelixHeadlessGraph",
|
|
64053
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64054
|
+
}
|
|
64055
|
+
},
|
|
64056
|
+
{
|
|
64057
|
+
"name": "label",
|
|
64058
|
+
"type": {
|
|
64059
|
+
"text": "string"
|
|
64060
|
+
},
|
|
64061
|
+
"default": "''",
|
|
64062
|
+
"description": "The graph's name, read by screen readers, such as \"Research notes\".\nRequired.",
|
|
64063
|
+
"fieldName": "label",
|
|
64064
|
+
"inheritedFrom": {
|
|
64065
|
+
"name": "HelixHeadlessGraph",
|
|
64066
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64067
|
+
}
|
|
64068
|
+
},
|
|
64069
|
+
{
|
|
64070
|
+
"name": "linked-both-label",
|
|
64071
|
+
"type": {
|
|
64072
|
+
"text": "string"
|
|
64073
|
+
},
|
|
64074
|
+
"default": "'Linked both ways with {note}'",
|
|
64075
|
+
"description": "How a note linked both to and from the selected one is described, with `{note}`.",
|
|
64076
|
+
"fieldName": "linkedBothLabel",
|
|
64077
|
+
"inheritedFrom": {
|
|
64078
|
+
"name": "HelixHeadlessGraph",
|
|
64079
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64080
|
+
}
|
|
64081
|
+
},
|
|
64082
|
+
{
|
|
64083
|
+
"name": "linked-from-label",
|
|
64084
|
+
"type": {
|
|
64085
|
+
"text": "string"
|
|
64086
|
+
},
|
|
64087
|
+
"default": "'Linked from {note}'",
|
|
64088
|
+
"description": "How a note the selected one links to is described, with `{note}`, the selected note's name.",
|
|
64089
|
+
"fieldName": "linkedFromLabel",
|
|
64090
|
+
"inheritedFrom": {
|
|
64091
|
+
"name": "HelixHeadlessGraph",
|
|
64092
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64093
|
+
}
|
|
64094
|
+
},
|
|
64095
|
+
{
|
|
64096
|
+
"name": "links-to-label",
|
|
64097
|
+
"type": {
|
|
64098
|
+
"text": "string"
|
|
64099
|
+
},
|
|
64100
|
+
"default": "'Links to {note}'",
|
|
64101
|
+
"description": "How a note that links to the selected one is described, with `{note}`.",
|
|
64102
|
+
"fieldName": "linksToLabel",
|
|
64103
|
+
"inheritedFrom": {
|
|
64104
|
+
"name": "HelixHeadlessGraph",
|
|
64105
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64106
|
+
}
|
|
64107
|
+
},
|
|
64108
|
+
{
|
|
64109
|
+
"name": "notes-label",
|
|
64110
|
+
"type": {
|
|
64111
|
+
"text": "string"
|
|
64112
|
+
},
|
|
64113
|
+
"default": "'Notes'",
|
|
64114
|
+
"description": "The list's name, read by screen readers.",
|
|
64115
|
+
"fieldName": "notesLabel",
|
|
64116
|
+
"inheritedFrom": {
|
|
64117
|
+
"name": "HelixHeadlessGraph",
|
|
64118
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64119
|
+
}
|
|
64120
|
+
},
|
|
64121
|
+
{
|
|
64122
|
+
"name": "search-label",
|
|
64123
|
+
"type": {
|
|
64124
|
+
"text": "string"
|
|
64125
|
+
},
|
|
64126
|
+
"default": "'Find a note'",
|
|
64127
|
+
"description": "The search field's name.",
|
|
64128
|
+
"fieldName": "searchLabel",
|
|
64129
|
+
"inheritedFrom": {
|
|
64130
|
+
"name": "HelixHeadlessGraph",
|
|
64131
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64132
|
+
}
|
|
64133
|
+
},
|
|
64134
|
+
{
|
|
64135
|
+
"name": "selected-label",
|
|
64136
|
+
"type": {
|
|
64137
|
+
"text": "string"
|
|
64138
|
+
},
|
|
64139
|
+
"default": "'Selected'",
|
|
64140
|
+
"description": "How the selected note is described in the list.",
|
|
64141
|
+
"fieldName": "selectedLabel",
|
|
64142
|
+
"inheritedFrom": {
|
|
64143
|
+
"name": "HelixHeadlessGraph",
|
|
64144
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64145
|
+
}
|
|
64146
|
+
}
|
|
64147
|
+
],
|
|
64148
|
+
"events": [
|
|
64149
|
+
{
|
|
64150
|
+
"type": {
|
|
64151
|
+
"text": "HelixActivateEvent"
|
|
64152
|
+
},
|
|
64153
|
+
"description": "A note was selected, in the list or in the drawing. The detail's `value` is its `id`.",
|
|
64154
|
+
"name": "helix-activate",
|
|
64155
|
+
"reactProp": "onhelix-activate",
|
|
64156
|
+
"inheritedFrom": {
|
|
64157
|
+
"name": "HelixHeadlessGraph",
|
|
64158
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64159
|
+
}
|
|
64160
|
+
},
|
|
64161
|
+
{
|
|
64162
|
+
"type": {
|
|
64163
|
+
"text": "HelixBeforeActivateEvent"
|
|
64164
|
+
},
|
|
64165
|
+
"description": "A note is about to be selected. Cancelable: cancel it to keep the selection in your own state.",
|
|
64166
|
+
"name": "helix-before-activate",
|
|
64167
|
+
"reactProp": "onhelix-before-activate",
|
|
64168
|
+
"inheritedFrom": {
|
|
64169
|
+
"name": "HelixHeadlessGraph",
|
|
64170
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64171
|
+
}
|
|
64172
|
+
},
|
|
64173
|
+
{
|
|
64174
|
+
"type": {
|
|
64175
|
+
"text": "HelixGraphLayoutEvent"
|
|
64176
|
+
},
|
|
64177
|
+
"description": "A layout settled, with where it put each note, sent by `laidOut()`. Keep the positions and pass them back as each note's `x` and `y`.",
|
|
64178
|
+
"name": "helix-graph-layout",
|
|
64179
|
+
"reactProp": "onhelix-graph-layout",
|
|
64180
|
+
"inheritedFrom": {
|
|
64181
|
+
"name": "HelixHeadlessGraph",
|
|
64182
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64183
|
+
}
|
|
64184
|
+
},
|
|
64185
|
+
{
|
|
64186
|
+
"type": {
|
|
64187
|
+
"text": "HelixGraphPanEvent"
|
|
64188
|
+
},
|
|
64189
|
+
"description": "A pan button or arrow key was pressed. `connectGraph` moves the drawing.",
|
|
64190
|
+
"name": "helix-graph-pan",
|
|
64191
|
+
"reactProp": "onhelix-graph-pan",
|
|
64192
|
+
"inheritedFrom": {
|
|
64193
|
+
"name": "HelixHeadlessGraph",
|
|
64194
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64195
|
+
}
|
|
64196
|
+
},
|
|
64197
|
+
{
|
|
64198
|
+
"type": {
|
|
64199
|
+
"text": "HelixGraphPartChangeEvent"
|
|
64200
|
+
},
|
|
64201
|
+
"description": "The notes, the links, the selection, the depth or the gestures changed. Used by `connectGraph`; pages do not need to listen for it.",
|
|
64202
|
+
"name": "helix-graph-part-change",
|
|
64203
|
+
"reactProp": "onhelix-graph-part-change",
|
|
64204
|
+
"inheritedFrom": {
|
|
64205
|
+
"name": "HelixHeadlessGraph",
|
|
64206
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64207
|
+
}
|
|
64208
|
+
},
|
|
64209
|
+
{
|
|
64210
|
+
"type": {
|
|
64211
|
+
"text": "HelixGraphReadyEvent"
|
|
64212
|
+
},
|
|
64213
|
+
"description": "The graph has been drawn whole, laid out and settled. Sent each time `drawn()` says it is drawn after it was not.",
|
|
64214
|
+
"name": "helix-graph-ready",
|
|
64215
|
+
"reactProp": "onhelix-graph-ready",
|
|
64216
|
+
"inheritedFrom": {
|
|
64217
|
+
"name": "HelixHeadlessGraph",
|
|
64218
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64219
|
+
}
|
|
64220
|
+
},
|
|
64221
|
+
{
|
|
64222
|
+
"type": {
|
|
64223
|
+
"text": "HelixGraphZoomEvent"
|
|
64224
|
+
},
|
|
64225
|
+
"description": "A zoom button or key was pressed. `connectGraph` zooms the drawing.",
|
|
64226
|
+
"name": "helix-graph-zoom",
|
|
64227
|
+
"reactProp": "onhelix-graph-zoom",
|
|
64228
|
+
"inheritedFrom": {
|
|
64229
|
+
"name": "HelixHeadlessGraph",
|
|
64230
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64231
|
+
}
|
|
64232
|
+
}
|
|
64233
|
+
],
|
|
64234
|
+
"slots": [
|
|
64235
|
+
{
|
|
64236
|
+
"description": "The renderer's box, which the drawing is made in.",
|
|
64237
|
+
"name": "",
|
|
64238
|
+
"inheritedFrom": {
|
|
64239
|
+
"name": "HelixHeadlessGraph",
|
|
64240
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64241
|
+
}
|
|
64242
|
+
},
|
|
64243
|
+
{
|
|
64244
|
+
"description": "The icon in the search field. Defaults to a magnifying glass.",
|
|
64245
|
+
"name": "filter-icon",
|
|
64246
|
+
"inheritedFrom": {
|
|
64247
|
+
"name": "HelixHeadlessGraph",
|
|
64248
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64249
|
+
}
|
|
64250
|
+
},
|
|
64251
|
+
{
|
|
64252
|
+
"description": "Content below the graph.",
|
|
64253
|
+
"name": "footer",
|
|
64254
|
+
"inheritedFrom": {
|
|
64255
|
+
"name": "HelixHeadlessGraph",
|
|
64256
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64257
|
+
}
|
|
64258
|
+
},
|
|
64259
|
+
{
|
|
64260
|
+
"description": "Content above the graph.",
|
|
64261
|
+
"name": "header",
|
|
64262
|
+
"inheritedFrom": {
|
|
64263
|
+
"name": "HelixHeadlessGraph",
|
|
64264
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64265
|
+
}
|
|
64266
|
+
}
|
|
64267
|
+
],
|
|
64268
|
+
"cssParts": [
|
|
64269
|
+
{
|
|
64270
|
+
"description": "The room the notes after those drawn would take, so the list scrolls its whole length.",
|
|
64271
|
+
"name": "after",
|
|
64272
|
+
"inheritedFrom": {
|
|
64273
|
+
"name": "HelixHeadlessGraph",
|
|
64274
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64275
|
+
}
|
|
64276
|
+
},
|
|
64277
|
+
{
|
|
64278
|
+
"description": "The room the notes before those drawn would take.",
|
|
64279
|
+
"name": "before",
|
|
64280
|
+
"inheritedFrom": {
|
|
64281
|
+
"name": "HelixHeadlessGraph",
|
|
64282
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64283
|
+
}
|
|
64284
|
+
},
|
|
64285
|
+
{
|
|
64286
|
+
"description": "The drawing beside the list, or above it where the frame is narrow.",
|
|
64287
|
+
"name": "body",
|
|
64288
|
+
"inheritedFrom": {
|
|
64289
|
+
"name": "HelixHeadlessGraph",
|
|
64290
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64291
|
+
}
|
|
64292
|
+
},
|
|
64293
|
+
{
|
|
64294
|
+
"description": "The group the pan and zoom buttons sit in.",
|
|
64295
|
+
"name": "controls",
|
|
64296
|
+
"inheritedFrom": {
|
|
64297
|
+
"name": "HelixHeadlessGraph",
|
|
64298
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64299
|
+
}
|
|
64300
|
+
},
|
|
64301
|
+
{
|
|
64302
|
+
"description": "How many notes the list holds, which a search narrows, at the end of the search bar.",
|
|
64303
|
+
"name": "count",
|
|
64304
|
+
"inheritedFrom": {
|
|
64305
|
+
"name": "HelixHeadlessGraph",
|
|
64306
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64307
|
+
}
|
|
64308
|
+
},
|
|
64309
|
+
{
|
|
64310
|
+
"description": "The icon beside the search field.",
|
|
64311
|
+
"name": "filter-icon",
|
|
64312
|
+
"inheritedFrom": {
|
|
64313
|
+
"name": "HelixHeadlessGraph",
|
|
64314
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64315
|
+
}
|
|
64316
|
+
},
|
|
64317
|
+
{
|
|
64318
|
+
"description": "The default icon beside the search field, shown when none is slotted.",
|
|
64319
|
+
"name": "filter-mark",
|
|
64320
|
+
"inheritedFrom": {
|
|
64321
|
+
"name": "HelixHeadlessGraph",
|
|
64322
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64323
|
+
}
|
|
64324
|
+
},
|
|
64325
|
+
{
|
|
64326
|
+
"description": "The strip below the graph.",
|
|
64327
|
+
"name": "footer",
|
|
64328
|
+
"inheritedFrom": {
|
|
64329
|
+
"name": "HelixHeadlessGraph",
|
|
64330
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64331
|
+
}
|
|
64332
|
+
},
|
|
64333
|
+
{
|
|
64334
|
+
"description": "The button that makes the graph fill the screen.",
|
|
64335
|
+
"name": "fullscreen",
|
|
64336
|
+
"inheritedFrom": {
|
|
64337
|
+
"name": "HelixHeadlessGraph",
|
|
64338
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64339
|
+
}
|
|
64340
|
+
},
|
|
64341
|
+
{
|
|
64342
|
+
"description": "Words over the graph for a moment when it lets a gesture pass to the page, such as how to zoom it.",
|
|
64343
|
+
"name": "gesture-hint",
|
|
64344
|
+
"inheritedFrom": {
|
|
64345
|
+
"name": "HelixHeadlessGraph",
|
|
64346
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64347
|
+
}
|
|
64348
|
+
},
|
|
64349
|
+
{
|
|
64350
|
+
"description": "The line shown while a graph with `gestures=\"activate\"` has the gestures.",
|
|
64351
|
+
"name": "gesture-status",
|
|
64352
|
+
"inheritedFrom": {
|
|
64353
|
+
"name": "HelixHeadlessGraph",
|
|
64354
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64355
|
+
}
|
|
64356
|
+
},
|
|
64357
|
+
{
|
|
64358
|
+
"description": "The strip above the graph.",
|
|
64359
|
+
"name": "header",
|
|
64360
|
+
"inheritedFrom": {
|
|
64361
|
+
"name": "HelixHeadlessGraph",
|
|
64362
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64363
|
+
}
|
|
64364
|
+
},
|
|
64365
|
+
{
|
|
64366
|
+
"description": "The list of notes, which draws only the rows in view.",
|
|
64367
|
+
"name": "list",
|
|
64368
|
+
"inheritedFrom": {
|
|
64369
|
+
"name": "HelixHeadlessGraph",
|
|
64370
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64371
|
+
}
|
|
64372
|
+
},
|
|
64373
|
+
{
|
|
64374
|
+
"description": "What screen readers hear when a search changes how many notes there are.",
|
|
64375
|
+
"name": "live",
|
|
64376
|
+
"inheritedFrom": {
|
|
64377
|
+
"name": "HelixHeadlessGraph",
|
|
64378
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64379
|
+
}
|
|
64380
|
+
},
|
|
64381
|
+
{
|
|
64382
|
+
"description": "One note in the list.",
|
|
64383
|
+
"name": "note",
|
|
64384
|
+
"inheritedFrom": {
|
|
64385
|
+
"name": "HelixHeadlessGraph",
|
|
64386
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64387
|
+
}
|
|
64388
|
+
},
|
|
64389
|
+
{
|
|
64390
|
+
"description": "The note the keyboard is on in the list.",
|
|
64391
|
+
"name": "note-cursor",
|
|
64392
|
+
"inheritedFrom": {
|
|
64393
|
+
"name": "HelixHeadlessGraph",
|
|
64394
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64395
|
+
}
|
|
64396
|
+
},
|
|
64397
|
+
{
|
|
64398
|
+
"description": "A note linked to or from the selected one.",
|
|
64399
|
+
"name": "note-linked",
|
|
64400
|
+
"inheritedFrom": {
|
|
64401
|
+
"name": "HelixHeadlessGraph",
|
|
64402
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64403
|
+
}
|
|
64404
|
+
},
|
|
64405
|
+
{
|
|
64406
|
+
"description": "A note's name in the list.",
|
|
64407
|
+
"name": "note-name",
|
|
64408
|
+
"inheritedFrom": {
|
|
64409
|
+
"name": "HelixHeadlessGraph",
|
|
64410
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64411
|
+
}
|
|
64412
|
+
},
|
|
64413
|
+
{
|
|
64414
|
+
"description": "How a note stands to the selected one, such as \"Linked from Alpha\".",
|
|
64415
|
+
"name": "note-relation",
|
|
64416
|
+
"inheritedFrom": {
|
|
64417
|
+
"name": "HelixHeadlessGraph",
|
|
64418
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64419
|
+
}
|
|
64420
|
+
},
|
|
64421
|
+
{
|
|
64422
|
+
"description": "The selected note, first in the list.",
|
|
64423
|
+
"name": "note-selected",
|
|
64424
|
+
"inheritedFrom": {
|
|
64425
|
+
"name": "HelixHeadlessGraph",
|
|
64426
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64427
|
+
}
|
|
64428
|
+
},
|
|
64429
|
+
{
|
|
64430
|
+
"description": "The button that moves the graph down.",
|
|
64431
|
+
"name": "pan-down",
|
|
64432
|
+
"inheritedFrom": {
|
|
64433
|
+
"name": "HelixHeadlessGraph",
|
|
64434
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64435
|
+
}
|
|
64436
|
+
},
|
|
64437
|
+
{
|
|
64438
|
+
"description": "The button that moves the graph toward the end of a line of text: right in English.",
|
|
64439
|
+
"name": "pan-end",
|
|
64440
|
+
"inheritedFrom": {
|
|
64441
|
+
"name": "HelixHeadlessGraph",
|
|
64442
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64443
|
+
}
|
|
64444
|
+
},
|
|
64445
|
+
{
|
|
64446
|
+
"description": "The button that moves the graph toward the start of a line of text: left in English.",
|
|
64447
|
+
"name": "pan-start",
|
|
64448
|
+
"inheritedFrom": {
|
|
64449
|
+
"name": "HelixHeadlessGraph",
|
|
64450
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64451
|
+
}
|
|
64452
|
+
},
|
|
64453
|
+
{
|
|
64454
|
+
"description": "The button that moves the graph up.",
|
|
64455
|
+
"name": "pan-up",
|
|
64456
|
+
"inheritedFrom": {
|
|
64457
|
+
"name": "HelixHeadlessGraph",
|
|
64458
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64459
|
+
}
|
|
64460
|
+
},
|
|
64461
|
+
{
|
|
64462
|
+
"description": "The search field and the list, beside the drawing or below it.",
|
|
64463
|
+
"name": "panel",
|
|
64464
|
+
"inheritedFrom": {
|
|
64465
|
+
"name": "HelixHeadlessGraph",
|
|
64466
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64467
|
+
}
|
|
64468
|
+
},
|
|
64469
|
+
{
|
|
64470
|
+
"description": "The frame: the drawing, its controls and the list.",
|
|
64471
|
+
"name": "region",
|
|
64472
|
+
"inheritedFrom": {
|
|
64473
|
+
"name": "HelixHeadlessGraph",
|
|
64474
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64475
|
+
}
|
|
64476
|
+
},
|
|
64477
|
+
{
|
|
64478
|
+
"description": "The bar holding the icon, the search field and the count.",
|
|
64479
|
+
"name": "search",
|
|
64480
|
+
"inheritedFrom": {
|
|
64481
|
+
"name": "HelixHeadlessGraph",
|
|
64482
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64483
|
+
}
|
|
64484
|
+
},
|
|
64485
|
+
{
|
|
64486
|
+
"description": "The field that finds a note by its name.",
|
|
64487
|
+
"name": "search-field",
|
|
64488
|
+
"inheritedFrom": {
|
|
64489
|
+
"name": "HelixHeadlessGraph",
|
|
64490
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64491
|
+
}
|
|
64492
|
+
},
|
|
64493
|
+
{
|
|
64494
|
+
"description": "The drawing and its controls.",
|
|
64495
|
+
"name": "stage",
|
|
64496
|
+
"inheritedFrom": {
|
|
64497
|
+
"name": "HelixHeadlessGraph",
|
|
64498
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64499
|
+
}
|
|
64500
|
+
},
|
|
64501
|
+
{
|
|
64502
|
+
"description": "The box the renderer draws in.",
|
|
64503
|
+
"name": "viewport",
|
|
64504
|
+
"inheritedFrom": {
|
|
64505
|
+
"name": "HelixHeadlessGraph",
|
|
64506
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64507
|
+
}
|
|
64508
|
+
},
|
|
64509
|
+
{
|
|
64510
|
+
"description": "The zoom in button.",
|
|
64511
|
+
"name": "zoom-in",
|
|
64512
|
+
"inheritedFrom": {
|
|
64513
|
+
"name": "HelixHeadlessGraph",
|
|
64514
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64515
|
+
}
|
|
64516
|
+
},
|
|
64517
|
+
{
|
|
64518
|
+
"description": "The zoom out button.",
|
|
64519
|
+
"name": "zoom-out",
|
|
64520
|
+
"inheritedFrom": {
|
|
64521
|
+
"name": "HelixHeadlessGraph",
|
|
64522
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64523
|
+
}
|
|
64524
|
+
}
|
|
64525
|
+
],
|
|
64526
|
+
"cssStates": [
|
|
64527
|
+
{
|
|
64528
|
+
"description": "The graph fills the screen.",
|
|
64529
|
+
"name": "fullscreen",
|
|
64530
|
+
"inheritedFrom": {
|
|
64531
|
+
"name": "HelixHeadlessGraph",
|
|
64532
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64533
|
+
}
|
|
64534
|
+
},
|
|
64535
|
+
{
|
|
64536
|
+
"description": "The user has been still long enough for the header and footer to fade.",
|
|
64537
|
+
"name": "idle",
|
|
64538
|
+
"inheritedFrom": {
|
|
64539
|
+
"name": "HelixHeadlessGraph",
|
|
64540
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64541
|
+
}
|
|
64542
|
+
},
|
|
64543
|
+
{
|
|
64544
|
+
"description": "The graph has been drawn whole, after `helix-graph-ready`.",
|
|
64545
|
+
"name": "ready",
|
|
64546
|
+
"inheritedFrom": {
|
|
64547
|
+
"name": "HelixHeadlessGraph",
|
|
64548
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64549
|
+
}
|
|
64550
|
+
},
|
|
64551
|
+
{
|
|
64552
|
+
"description": "The page keeps the plain wheel and one finger, with `gestures=\"cooperative\"` or while a graph with `gestures=\"activate\"` waits to be pressed.",
|
|
64553
|
+
"name": "sharing",
|
|
64554
|
+
"inheritedFrom": {
|
|
64555
|
+
"name": "HelixHeadlessGraph",
|
|
64556
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64557
|
+
}
|
|
64558
|
+
},
|
|
64559
|
+
{
|
|
64560
|
+
"description": "A graph with `gestures=\"activate\"` has been pressed and has the gestures.",
|
|
64561
|
+
"name": "using",
|
|
64562
|
+
"inheritedFrom": {
|
|
64563
|
+
"name": "HelixHeadlessGraph",
|
|
64564
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64565
|
+
}
|
|
64566
|
+
},
|
|
64567
|
+
{
|
|
64568
|
+
"description": "Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.",
|
|
64569
|
+
"name": "settled",
|
|
64570
|
+
"inheritedFrom": {
|
|
64571
|
+
"name": "HelixElement",
|
|
64572
|
+
"module": "src/helix-element/helix-element.ts"
|
|
64573
|
+
}
|
|
64574
|
+
}
|
|
64575
|
+
],
|
|
64576
|
+
"modulePath": "src/graph/root/graph-root.ts",
|
|
64577
|
+
"definitionPath": "src/graph/root/graph-root.ts"
|
|
64578
|
+
}
|
|
64579
|
+
],
|
|
64580
|
+
"exports": [
|
|
64581
|
+
{
|
|
64582
|
+
"kind": "js",
|
|
64583
|
+
"name": "HelixGraph",
|
|
64584
|
+
"declaration": {
|
|
64585
|
+
"name": "HelixGraph",
|
|
64586
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64587
|
+
}
|
|
64588
|
+
},
|
|
64589
|
+
{
|
|
64590
|
+
"kind": "custom-element-definition",
|
|
64591
|
+
"name": "helix-graph",
|
|
64592
|
+
"declaration": {
|
|
64593
|
+
"name": "HelixGraph",
|
|
64594
|
+
"module": "src/graph/root/graph-root.ts"
|
|
64595
|
+
}
|
|
64596
|
+
}
|
|
64597
|
+
]
|
|
64598
|
+
},
|
|
64599
|
+
{
|
|
64600
|
+
"kind": "javascript-module",
|
|
64601
|
+
"path": "src/grid/index.ts",
|
|
64602
|
+
"declarations": [],
|
|
64603
|
+
"exports": [
|
|
64604
|
+
{
|
|
64605
|
+
"kind": "js",
|
|
64606
|
+
"name": "*",
|
|
64607
|
+
"declaration": {
|
|
64608
|
+
"name": "*",
|
|
64609
|
+
"module": "src/grid/root/grid-root.js"
|
|
64610
|
+
}
|
|
64611
|
+
}
|
|
64612
|
+
]
|
|
64613
|
+
},
|
|
64614
|
+
{
|
|
64615
|
+
"kind": "javascript-module",
|
|
64616
|
+
"path": "src/grid/root/grid-root.css.ts",
|
|
64617
|
+
"declarations": [
|
|
64618
|
+
{
|
|
64619
|
+
"kind": "variable",
|
|
64620
|
+
"name": "styles"
|
|
64621
|
+
}
|
|
64622
|
+
],
|
|
64623
|
+
"exports": [
|
|
64624
|
+
{
|
|
64625
|
+
"kind": "js",
|
|
64626
|
+
"name": "styles",
|
|
64627
|
+
"declaration": {
|
|
64628
|
+
"name": "styles",
|
|
64629
|
+
"module": "src/grid/root/grid-root.css.ts"
|
|
64630
|
+
}
|
|
64631
|
+
}
|
|
64632
|
+
]
|
|
64633
|
+
},
|
|
64634
|
+
{
|
|
64635
|
+
"kind": "javascript-module",
|
|
64636
|
+
"path": "src/grid/root/grid-root.ts",
|
|
64637
|
+
"declarations": [
|
|
64638
|
+
{
|
|
64639
|
+
"kind": "class",
|
|
64640
|
+
"description": "Set columns in one of two ways:\n\n- `columns` sets a fixed count.\n- `min` fits as many equal columns as there is room for at that width, so the\n layout responds with no breakpoints to maintain.\n\nIf you set both, `min` wins. The grid is presentation only, so there is no\nheadless tier.",
|
|
64641
|
+
"name": "HelixGrid",
|
|
64642
|
+
"cssProperties": [
|
|
64643
|
+
{
|
|
64644
|
+
"description": "An explicit track list. It overrides `min` and `columns`. Use it for tracks of unequal widths, which neither attribute can set.",
|
|
64645
|
+
"name": "--grid-columns"
|
|
64646
|
+
}
|
|
64647
|
+
],
|
|
64648
|
+
"slots": [
|
|
64649
|
+
{
|
|
64650
|
+
"description": "The items to lay out.",
|
|
64651
|
+
"name": ""
|
|
64652
|
+
}
|
|
64653
|
+
],
|
|
64654
|
+
"members": [
|
|
64655
|
+
{
|
|
64656
|
+
"kind": "field",
|
|
64657
|
+
"name": "alignItems",
|
|
64658
|
+
"type": {
|
|
64659
|
+
"text": "'start' | 'center' | 'end' | 'stretch' | undefined"
|
|
64660
|
+
},
|
|
64661
|
+
"description": "How each cell aligns within its row. Sets `align-items`.\n\n**Named for the CSS property it sets**, the way `Flex` is, and the same\nproperty on a grid: it places every cell in its row's track rather than\nplacing the tracks. No `baseline`, which `Flex` offers, because cells in a\nrow of a grid are boxes of unrelated content and lining their first lines\nup is a thing a reader asks for between siblings in a row, not between\ncells in a table of them.\n\nThere is no `justifyContent` here for the same reason: the tracks are\n`1fr`, so they already fill the row and there is nothing left over to\ndistribute. `columns`, `min` and `--grid-columns` are how a grid says how\nwide its tracks are.",
|
|
64662
|
+
"attribute": "align-items",
|
|
64663
|
+
"reflects": true
|
|
64664
|
+
},
|
|
64665
|
+
{
|
|
64666
|
+
"kind": "field",
|
|
64667
|
+
"name": "columns",
|
|
64668
|
+
"type": {
|
|
64669
|
+
"text": "number | undefined"
|
|
64670
|
+
},
|
|
64671
|
+
"description": "A fixed number of equal columns.",
|
|
64672
|
+
"attribute": "columns",
|
|
64673
|
+
"reflects": true
|
|
64674
|
+
},
|
|
64675
|
+
{
|
|
64676
|
+
"kind": "field",
|
|
64677
|
+
"name": "gap",
|
|
64678
|
+
"type": {
|
|
64679
|
+
"text": "'none' | '2xs' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl' | '3xl' | undefined"
|
|
64680
|
+
},
|
|
64681
|
+
"description": "The space between cells, as a step on the space scale.",
|
|
64682
|
+
"attribute": "gap",
|
|
64683
|
+
"reflects": true
|
|
64684
|
+
},
|
|
64685
|
+
{
|
|
64686
|
+
"kind": "field",
|
|
64687
|
+
"name": "min",
|
|
64688
|
+
"type": {
|
|
64689
|
+
"text": "string"
|
|
64690
|
+
},
|
|
64691
|
+
"default": "''",
|
|
64692
|
+
"description": "The minimum column width. The grid fits as many columns as the width allows.\n\nTakes precedence over `columns`: a grid that both fixes a count and reflows\nis two intentions in one element.",
|
|
64693
|
+
"attribute": "min"
|
|
64694
|
+
},
|
|
64695
|
+
{
|
|
64696
|
+
"kind": "method",
|
|
64697
|
+
"name": "applyTemplate",
|
|
64698
|
+
"privacy": "private",
|
|
64699
|
+
"return": {
|
|
64700
|
+
"type": {
|
|
64701
|
+
"text": "void"
|
|
64702
|
+
}
|
|
64703
|
+
},
|
|
64704
|
+
"description": "Writes the track list into the shadow root's own stylesheet.\n\nInto a `<style>` rather than onto `this.style`, and the difference is\nhydration. An inline style on the host is an attribute the element gives\nitself once it upgrades, so a React consumer's server markup does not have\nit and hydration reports a mismatch it will not patch up. The shadow root\nis not part of the tree React hydrates, so a rule written there is free.\n\nThe element is filled imperatively because Lit refuses expressions inside\n`<style>`: it is an invalid binding location and throws while rendering\nrather than at build time. Hence a static, empty element in the template\nand its `textContent` set here.\n\nIt sets a custom property rather than the track list itself. A shadow\nroot's adopted stylesheets cascade *after* its own `<style>` elements, and\n`static styles` is adopted, so a `grid-template-columns` here lost to the\none in the stylesheet and every `min` grid came out a single column. The\nstylesheet only ever reads `--_grid-template`, so there is nothing to\nlose against.\n\nThe consequence is that a server-rendered grid falls back to the\nstylesheet's single column until it upgrades. That is why `columns` is also\nexpressed as plain CSS below: the fixed-count case, which can be enumerated,\nneeds no JavaScript at all, and only `min` depends on this."
|
|
64705
|
+
},
|
|
64706
|
+
{
|
|
64707
|
+
"kind": "field",
|
|
64708
|
+
"name": "tier",
|
|
64709
|
+
"type": {
|
|
64710
|
+
"text": "string"
|
|
64711
|
+
},
|
|
64712
|
+
"static": true,
|
|
64713
|
+
"default": "'helix-headless-'",
|
|
64714
|
+
"description": "The prefix this tier registers its elements under.\n\n**A component that renders another renders its own tier's version of it**,\nso `helix-headless-pagination-size` composes `helix-headless-select` and\n`helix-pagination-size` composes `helix-select`. One template says\n`${this.tag('select')}` and each tier answers with its own name.\n\n**The public tag may not be the composed one, in either tier.** Using it\ncosts three things: the name means two different things depending on what a\nconsumer imported, the headless tier composes an element it does not ship,\nand the composition cannot be tested there at all, because there is no\n`helix-select` on that tier to test it against.\n\n**A prefix rather than an override per composition**, which was the first\nplan and does not compile. An override re-renders the fragment from the\nsubclass, and the fragment reads members the base keeps private:\n`PaginationSize` alone would have had to widen `options`, `current` and\n`handleChange` to `protected` so a subclass could say the same thing again.\nSixteen families of that is a lot of encapsulation spent on saying one\nword differently.",
|
|
64715
|
+
"inheritedFrom": {
|
|
64716
|
+
"name": "HelixElement",
|
|
64717
|
+
"module": "src/helix-element/helix-element.ts"
|
|
64718
|
+
}
|
|
64719
|
+
},
|
|
64720
|
+
{
|
|
64721
|
+
"kind": "method",
|
|
64722
|
+
"name": "tag",
|
|
64723
|
+
"privacy": "protected",
|
|
64724
|
+
"return": {
|
|
64725
|
+
"type": {
|
|
64726
|
+
"text": "StaticValue"
|
|
64727
|
+
}
|
|
64728
|
+
},
|
|
64729
|
+
"parameters": [
|
|
64730
|
+
{
|
|
64731
|
+
"name": "name",
|
|
64732
|
+
"type": {
|
|
64733
|
+
"text": "string"
|
|
64734
|
+
}
|
|
64735
|
+
}
|
|
64736
|
+
],
|
|
64737
|
+
"description": "One composed tag, as a static value a template can interpolate.\n\n`unsafeStatic` is safe by construction: the name is a literal in our own\nsource and the prefix is one of two strings this class defines. Called per\nrender and not cached, which costs nothing, because `static-html` keys its\ntemplate cache on the joined string rather than on the object.",
|
|
64738
|
+
"inheritedFrom": {
|
|
64739
|
+
"name": "HelixElement",
|
|
64740
|
+
"module": "src/helix-element/helix-element.ts"
|
|
64741
|
+
}
|
|
64742
|
+
},
|
|
64743
|
+
{
|
|
64744
|
+
"kind": "method",
|
|
64745
|
+
"name": "partNamed",
|
|
64746
|
+
"privacy": "protected",
|
|
64747
|
+
"return": {
|
|
64748
|
+
"type": {
|
|
64749
|
+
"text": "T | null"
|
|
64750
|
+
}
|
|
64751
|
+
},
|
|
64752
|
+
"parameters": [
|
|
64753
|
+
{
|
|
64754
|
+
"name": "name",
|
|
64755
|
+
"type": {
|
|
64756
|
+
"text": "string"
|
|
64757
|
+
}
|
|
64758
|
+
}
|
|
64759
|
+
],
|
|
64760
|
+
"description": "One of this element's own parts, by name, or null where it is not rendered.\n\nNot `part`, which every element already has: `Element.part` is the\n`DOMTokenList` of the names the element itself carries, and a method under\nthat name is a type error on every subclass.\n\n**One guard for every lookup.** Lit's server shim has no `querySelector`\non the render root, so a lookup reached during a server render, from a\ngetter a template reads or from `willUpdate`, throws there and nowhere\nelse. Four spellings of the same guard had grown across the library, and\na fifth site with none. Null on the server, which is what the rest of the\ncode already treats a part that has not rendered as.\n\n**`~=` and not `=`.** A part drawn in a state carries a second name while\nthe state holds, `part=\"page page-current\"`, and an exact match stops\nfinding it for exactly as long as it is the one that matters.\n\n`helix component`'s `selectors` reads these calls the way it reads a\n`querySelector('[part=\"x\"]')`, so a name nothing renders is a finding\nrather than a null an optional chain swallows.",
|
|
64761
|
+
"inheritedFrom": {
|
|
64762
|
+
"name": "HelixElement",
|
|
64763
|
+
"module": "src/helix-element/helix-element.ts"
|
|
64764
|
+
}
|
|
64765
|
+
},
|
|
64766
|
+
{
|
|
64767
|
+
"kind": "field",
|
|
64768
|
+
"name": "internals",
|
|
64769
|
+
"type": {
|
|
64770
|
+
"text": "ElementInternals"
|
|
64771
|
+
},
|
|
64772
|
+
"privacy": "protected",
|
|
64773
|
+
"readonly": true,
|
|
64774
|
+
"description": "The element's semantics, set without touching the DOM.\n\n`ElementInternals` sets the implicit role, which an author's own `role`\nattribute still overrides, and it writes no attribute. Setting `role` on the\nhost directly would: that is an attribute the element gives itself after it\nupgrades, which a React consumer's server markup never had, and hydration\nreports it as a mismatch.\n\nAvailable during server rendering. Lit's shim implements `attachInternals`,\nso nothing here needs a guard.",
|
|
64775
|
+
"inheritedFrom": {
|
|
64776
|
+
"name": "HelixElement",
|
|
64777
|
+
"module": "src/helix-element/helix-element.ts"
|
|
64778
|
+
}
|
|
64779
|
+
},
|
|
64780
|
+
{
|
|
64781
|
+
"kind": "method",
|
|
64782
|
+
"name": "toggleState",
|
|
64783
|
+
"privacy": "protected",
|
|
64784
|
+
"return": {
|
|
64785
|
+
"type": {
|
|
64786
|
+
"text": "void"
|
|
64787
|
+
}
|
|
64788
|
+
},
|
|
64789
|
+
"parameters": [
|
|
64790
|
+
{
|
|
64791
|
+
"name": "name",
|
|
64792
|
+
"type": {
|
|
64793
|
+
"text": "string"
|
|
64794
|
+
}
|
|
64795
|
+
},
|
|
64796
|
+
{
|
|
64797
|
+
"name": "on",
|
|
64798
|
+
"type": {
|
|
64799
|
+
"text": "boolean"
|
|
64800
|
+
}
|
|
64801
|
+
}
|
|
64802
|
+
],
|
|
64803
|
+
"description": "Records a boolean fact about this element as a custom state.\n\n**The host belongs to whoever rendered it, and a component's own\nbookkeeping may not be kept there.** An attribute written on the first\nupdate is markup a consumer's server never sent, so a React consumer\nhydrates a DOM that has gained attributes since and reports a mismatch it\nwill not patch up. A custom state is not in the DOM at all: it carries the\nfact to a stylesheet through `:state()` and leaves the markup alone, so the\nserver's output and the client's agree by construction.\n\n`SETTLED` carries the long version of that argument; `checked`, `open`,\n`invalid` and `has-label` are recorded the same way, each of them a state a\n`default-*` attribute resolves before React reaches the node.\n\n**Deferring the definitions is not a fix and could not be.** Importing them\nfrom an effect so the upgrades fall the other side of hydration works only\nwhile hydration is one pass: anything that splits it, a streamed segment or\na suspended boundary, puts an upgrade back inside the window. Timing cannot\nbe the guarantee when the fact is kept somewhere React reconciles.\n\nFeature-tested rather than assumed, the way `hostAria` tests element\nreferences. An engine without `CustomStateSet` records nothing and keeps\nwhatever the resting rule draws, which is the safe direction to fail.\n\n**The engines the test is for are browsers**: Safari below 17.4 and Firefox\nbelow 126, where the write is a `TypeError`, so a component bypassing this\nfails to render rather than rendering without whatever the state draws.\nLit's server shim sets `states`, so the guard passes there and records a\nstate nothing reads, which is harmless.",
|
|
64804
|
+
"inheritedFrom": {
|
|
64805
|
+
"name": "HelixElement",
|
|
64806
|
+
"module": "src/helix-element/helix-element.ts"
|
|
64807
|
+
}
|
|
64808
|
+
},
|
|
64809
|
+
{
|
|
64810
|
+
"kind": "field",
|
|
64811
|
+
"name": "whenSettled",
|
|
64812
|
+
"type": {
|
|
64813
|
+
"text": "Promise<void>"
|
|
64814
|
+
},
|
|
64815
|
+
"readonly": true,
|
|
64816
|
+
"description": "Resolves a frame after the first update, when transitions are switched on.\n\n**Named `whenSettled` because `settled` is taken four times over**, by\nImage, Splitter and both color controls, none of them about transitions. A\nbase class takes the name every subclass then cannot use.\n\n**The state it reports cannot be watched, which is why this exists.** A\ncustom state is deliberately not in the DOM, so there is no\n`MutationObserver` equivalent for `ElementInternals.states`. Await this\ninstead.\n\nSeparate from `updateComplete`, which resolves in the microtask checkpoint\nthe suppression is still active in. That is the distinction `readyToMove`\nin `@fusion.dev/helix-testing` is written around.\n\nIt never resolves where `requestAnimationFrame` never fires, which is a\nserver, a hidden tab, and happy-dom. Callers that must not hang there race\nit against a timeout, as the happy-dom harness's `readyToMove` does. The\nbrowser harness's awaits it alone: a browser always runs the frame, and a\ntimer beside it was a bet on how long one takes, which a busy run lost.",
|
|
64817
|
+
"default": "new Promise<void>((resolve) => { this.resolveSettled = resolve })",
|
|
64818
|
+
"inheritedFrom": {
|
|
64819
|
+
"name": "HelixElement",
|
|
64820
|
+
"module": "src/helix-element/helix-element.ts"
|
|
64821
|
+
}
|
|
64822
|
+
},
|
|
64823
|
+
{
|
|
64824
|
+
"kind": "field",
|
|
64825
|
+
"name": "resolveSettled",
|
|
64826
|
+
"type": {
|
|
64827
|
+
"text": "() => void"
|
|
64828
|
+
},
|
|
64829
|
+
"privacy": "private",
|
|
64830
|
+
"description": "Resolves `whenSettled`, once, from the frame that records the state.",
|
|
64831
|
+
"inheritedFrom": {
|
|
64832
|
+
"name": "HelixElement",
|
|
64833
|
+
"module": "src/helix-element/helix-element.ts"
|
|
64834
|
+
}
|
|
64835
|
+
},
|
|
64836
|
+
{
|
|
64837
|
+
"kind": "field",
|
|
64838
|
+
"name": "fromServer",
|
|
64839
|
+
"type": {
|
|
64840
|
+
"text": "boolean"
|
|
64841
|
+
},
|
|
64842
|
+
"privacy": "private",
|
|
64843
|
+
"default": "false",
|
|
64844
|
+
"description": "Whether the shadow root was a server's, parsed from declarative shadow DOM.",
|
|
64845
|
+
"inheritedFrom": {
|
|
64846
|
+
"name": "HelixElement",
|
|
64847
|
+
"module": "src/helix-element/helix-element.ts"
|
|
64848
|
+
}
|
|
64849
|
+
},
|
|
64850
|
+
{
|
|
64851
|
+
"kind": "field",
|
|
64852
|
+
"name": "hydrating",
|
|
64853
|
+
"type": {
|
|
64854
|
+
"text": "boolean"
|
|
64855
|
+
},
|
|
64856
|
+
"privacy": "protected",
|
|
64857
|
+
"description": "Whether this update is hydrating a server's markup, and so has to render\nexactly what the server rendered.\n\n**Lit hydrates by assuming the markup already shows the first render.** A\nvalue that differs is recorded and never written, so the page keeps the\nserver's, and a template that differs throws. The server has no children,\nso anything a component reads from its children waits for the update after\nhydration, which `finishHydration` asks for. Without a server's markup the\nfirst render reads them and there is one render.",
|
|
64858
|
+
"readonly": true,
|
|
64859
|
+
"inheritedFrom": {
|
|
64860
|
+
"name": "HelixElement",
|
|
64861
|
+
"module": "src/helix-element/helix-element.ts"
|
|
64862
|
+
}
|
|
64863
|
+
},
|
|
64864
|
+
{
|
|
64865
|
+
"kind": "field",
|
|
64866
|
+
"name": "serverRendered",
|
|
64867
|
+
"type": {
|
|
64868
|
+
"text": "boolean"
|
|
64869
|
+
},
|
|
64870
|
+
"privacy": "protected",
|
|
64871
|
+
"description": "Whether this element hydrated a server's markup rather than rendering its own.\n\nFor what happened before hydration and cannot be heard after it: an image\nthe parser fetched fires `load` or `error` before any listener exists, so a\ncomponent asks the image instead, once, when this is true.",
|
|
64872
|
+
"readonly": true,
|
|
64873
|
+
"inheritedFrom": {
|
|
64874
|
+
"name": "HelixElement",
|
|
64875
|
+
"module": "src/helix-element/helix-element.ts"
|
|
64876
|
+
}
|
|
64877
|
+
},
|
|
64878
|
+
{
|
|
64879
|
+
"kind": "method",
|
|
64880
|
+
"name": "finishHydration",
|
|
64881
|
+
"privacy": "protected",
|
|
64882
|
+
"return": {
|
|
64883
|
+
"type": {
|
|
64884
|
+
"text": "void"
|
|
64885
|
+
}
|
|
64886
|
+
},
|
|
64887
|
+
"description": "Asks for the update a hydration put off, so the reads it skipped happen.\n\nCalled from `firstUpdated`, the end of the hydrating update. The render it\nschedules can only follow that one, which is the exception Lit's\nchange-in-update warning names, and it happens only on a page a server\nrendered.",
|
|
64888
|
+
"inheritedFrom": {
|
|
64889
|
+
"name": "HelixElement",
|
|
64890
|
+
"module": "src/helix-element/helix-element.ts"
|
|
64891
|
+
}
|
|
64892
|
+
},
|
|
64893
|
+
{
|
|
64894
|
+
"kind": "field",
|
|
64895
|
+
"name": "childrenKnown",
|
|
64896
|
+
"type": {
|
|
64897
|
+
"text": "boolean"
|
|
64898
|
+
},
|
|
64899
|
+
"privacy": "protected",
|
|
64900
|
+
"description": "Whether this render can know the children.\n\nA server cannot: its element shim carries attributes and no tree, so\n`children` is undefined there. A render hydrating what a server sent must\nnot, because it has to be the server's render. Anywhere else it can. A\ncomponent whose render depends on its children reads them through\n`knownChildren`, and treats \"not known\" as its own answer rather than as\n\"none\": a list that renders its empty state because nobody has looked yet is\nthe one thing an empty state must never do.",
|
|
64901
|
+
"readonly": true,
|
|
64902
|
+
"inheritedFrom": {
|
|
64903
|
+
"name": "HelixElement",
|
|
64904
|
+
"module": "src/helix-element/helix-element.ts"
|
|
64905
|
+
}
|
|
64906
|
+
},
|
|
64907
|
+
{
|
|
64908
|
+
"kind": "field",
|
|
64909
|
+
"name": "knownChildren",
|
|
64910
|
+
"type": {
|
|
64911
|
+
"text": "Element[]"
|
|
64912
|
+
},
|
|
64913
|
+
"privacy": "protected",
|
|
64914
|
+
"description": "The children a render may read: all of them where they are known, and none otherwise.",
|
|
64915
|
+
"readonly": true,
|
|
64916
|
+
"inheritedFrom": {
|
|
64917
|
+
"name": "HelixElement",
|
|
64918
|
+
"module": "src/helix-element/helix-element.ts"
|
|
64919
|
+
}
|
|
64920
|
+
},
|
|
64921
|
+
{
|
|
64922
|
+
"kind": "field",
|
|
64923
|
+
"name": "assignsByName",
|
|
64924
|
+
"type": {
|
|
64925
|
+
"text": "boolean"
|
|
64926
|
+
},
|
|
64927
|
+
"privacy": "protected",
|
|
64928
|
+
"description": "Whether this element's slots route by name although it asked to assign them\nby hand.\n\n**A declarative shadow root is always the by-name kind.** HTML has no way to\nask for manual assignment, so a component that assigns by hand and hydrates\na server's root gets one where `slot.assign()` does nothing, and its\nchildren land wherever their `slot` attribute sends them. The way through is\nto write that attribute, which is what `route` does. Only there: on a root\nthis element made, assignment stays manual and the consumer's markup is\nnever touched, which is what a React consumer's hydration requires.",
|
|
64929
|
+
"readonly": true,
|
|
64930
|
+
"inheritedFrom": {
|
|
64931
|
+
"name": "HelixElement",
|
|
64932
|
+
"module": "src/helix-element/helix-element.ts"
|
|
64933
|
+
}
|
|
64934
|
+
},
|
|
64935
|
+
{
|
|
64936
|
+
"kind": "method",
|
|
64937
|
+
"name": "route",
|
|
64938
|
+
"privacy": "protected",
|
|
64939
|
+
"return": {
|
|
64940
|
+
"type": {
|
|
64941
|
+
"text": "void"
|
|
64942
|
+
}
|
|
64943
|
+
},
|
|
64944
|
+
"parameters": [
|
|
64945
|
+
{
|
|
64946
|
+
"name": "child",
|
|
64947
|
+
"type": {
|
|
64948
|
+
"text": "Element"
|
|
64949
|
+
}
|
|
64950
|
+
},
|
|
61876
64951
|
{
|
|
61877
64952
|
"name": "name",
|
|
61878
64953
|
"type": {
|
|
@@ -66520,6 +69595,14 @@
|
|
|
66520
69595
|
"module": "src/format-date/index.js"
|
|
66521
69596
|
}
|
|
66522
69597
|
},
|
|
69598
|
+
{
|
|
69599
|
+
"kind": "js",
|
|
69600
|
+
"name": "*",
|
|
69601
|
+
"declaration": {
|
|
69602
|
+
"name": "*",
|
|
69603
|
+
"module": "src/graph/index.js"
|
|
69604
|
+
}
|
|
69605
|
+
},
|
|
66523
69606
|
{
|
|
66524
69607
|
"kind": "js",
|
|
66525
69608
|
"name": "*",
|
|
@@ -83284,6 +86367,19 @@
|
|
|
83284
86367
|
"attribute": "material",
|
|
83285
86368
|
"reflects": true
|
|
83286
86369
|
},
|
|
86370
|
+
{
|
|
86371
|
+
"kind": "field",
|
|
86372
|
+
"name": "activateHintLabel",
|
|
86373
|
+
"type": {
|
|
86374
|
+
"text": "string | undefined"
|
|
86375
|
+
},
|
|
86376
|
+
"description": "The hint shown when a surface waiting to be pressed is scrolled or\nswiped over, with `gestures=\"activate\"`. Absent is the family's own.",
|
|
86377
|
+
"attribute": "activate-hint-label",
|
|
86378
|
+
"inheritedFrom": {
|
|
86379
|
+
"name": "MixinViewport",
|
|
86380
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86381
|
+
}
|
|
86382
|
+
},
|
|
83287
86383
|
{
|
|
83288
86384
|
"kind": "field",
|
|
83289
86385
|
"name": "controls",
|
|
@@ -83339,6 +86435,19 @@
|
|
|
83339
86435
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
83340
86436
|
}
|
|
83341
86437
|
},
|
|
86438
|
+
{
|
|
86439
|
+
"kind": "field",
|
|
86440
|
+
"name": "gestures",
|
|
86441
|
+
"type": {
|
|
86442
|
+
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
86443
|
+
},
|
|
86444
|
+
"description": "Which gestures the surface takes from the page.\n\n- `always`: the surface takes the wheel and one finger, for a surface\n that is the page, such as a full-screen view. A map rests here.\n- Unset is the family's own: `always` for a map, and for a board, a\n drag and a pinch, with the plain wheel left to the page until the\n board fills the screen.\n- `cooperative`: the wheel and one finger scroll the page, and the\n surface takes Ctrl or ⌘ with the wheel, and two fingers. The frame\n says so when a gesture passes to the page. Best for a surface embedded\n in a page.\n- `activate`: the surface takes nothing until it is pressed, and gives it\n back on Escape, when the pointer leaves it, or on a press elsewhere.\n\nThe keyboard and the frame's buttons work in every mode.\n\n**Unreflected and without a default**, because a default that reflected\nwould write an attribute onto every host that no server sent, and the\nhydration that followed would disagree with it.",
|
|
86445
|
+
"attribute": "gestures",
|
|
86446
|
+
"inheritedFrom": {
|
|
86447
|
+
"name": "MixinViewport",
|
|
86448
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86449
|
+
}
|
|
86450
|
+
},
|
|
83342
86451
|
{
|
|
83343
86452
|
"kind": "field",
|
|
83344
86453
|
"name": "idleDelay",
|
|
@@ -83423,6 +86532,45 @@
|
|
|
83423
86532
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
83424
86533
|
}
|
|
83425
86534
|
},
|
|
86535
|
+
{
|
|
86536
|
+
"kind": "field",
|
|
86537
|
+
"name": "twoFingerHintLabel",
|
|
86538
|
+
"type": {
|
|
86539
|
+
"text": "string | undefined"
|
|
86540
|
+
},
|
|
86541
|
+
"description": "The hint shown when one finger swipes over a surface with\n`gestures=\"cooperative\"`. Absent is the family's own.",
|
|
86542
|
+
"attribute": "two-finger-hint-label",
|
|
86543
|
+
"inheritedFrom": {
|
|
86544
|
+
"name": "MixinViewport",
|
|
86545
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86546
|
+
}
|
|
86547
|
+
},
|
|
86548
|
+
{
|
|
86549
|
+
"kind": "field",
|
|
86550
|
+
"name": "usingLabel",
|
|
86551
|
+
"type": {
|
|
86552
|
+
"text": "string | undefined"
|
|
86553
|
+
},
|
|
86554
|
+
"description": "The line shown while a surface with `gestures=\"activate\"` has the\ngestures. Absent is the family's own.",
|
|
86555
|
+
"attribute": "using-label",
|
|
86556
|
+
"inheritedFrom": {
|
|
86557
|
+
"name": "MixinViewport",
|
|
86558
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86559
|
+
}
|
|
86560
|
+
},
|
|
86561
|
+
{
|
|
86562
|
+
"kind": "field",
|
|
86563
|
+
"name": "wheelHintLabel",
|
|
86564
|
+
"type": {
|
|
86565
|
+
"text": "string | undefined"
|
|
86566
|
+
},
|
|
86567
|
+
"description": "The hint shown when the wheel scrolls past a surface with\n`gestures=\"cooperative\"`, with `{key}`, which is ⌘ on a Mac and Ctrl\nelsewhere. Absent is the family's own.",
|
|
86568
|
+
"attribute": "wheel-hint-label",
|
|
86569
|
+
"inheritedFrom": {
|
|
86570
|
+
"name": "MixinViewport",
|
|
86571
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86572
|
+
}
|
|
86573
|
+
},
|
|
83426
86574
|
{
|
|
83427
86575
|
"kind": "field",
|
|
83428
86576
|
"name": "zoomInLabel",
|
|
@@ -83465,6 +86613,73 @@
|
|
|
83465
86613
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
83466
86614
|
}
|
|
83467
86615
|
},
|
|
86616
|
+
{
|
|
86617
|
+
"kind": "field",
|
|
86618
|
+
"name": "gesturesTaken",
|
|
86619
|
+
"type": {
|
|
86620
|
+
"text": "boolean"
|
|
86621
|
+
},
|
|
86622
|
+
"privacy": "protected",
|
|
86623
|
+
"default": "false",
|
|
86624
|
+
"description": "Whether an `activate` surface has been pressed, and has the gestures.",
|
|
86625
|
+
"inheritedFrom": {
|
|
86626
|
+
"name": "MixinViewport",
|
|
86627
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86628
|
+
}
|
|
86629
|
+
},
|
|
86630
|
+
{
|
|
86631
|
+
"kind": "field",
|
|
86632
|
+
"name": "hint",
|
|
86633
|
+
"type": {
|
|
86634
|
+
"text": "string"
|
|
86635
|
+
},
|
|
86636
|
+
"privacy": "private",
|
|
86637
|
+
"default": "''",
|
|
86638
|
+
"description": "The hint over the surface while one shows, put there by a gesture it let pass.",
|
|
86639
|
+
"inheritedFrom": {
|
|
86640
|
+
"name": "MixinViewport",
|
|
86641
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86642
|
+
}
|
|
86643
|
+
},
|
|
86644
|
+
{
|
|
86645
|
+
"kind": "field",
|
|
86646
|
+
"name": "hinting",
|
|
86647
|
+
"type": {
|
|
86648
|
+
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
86649
|
+
},
|
|
86650
|
+
"privacy": "private",
|
|
86651
|
+
"description": "When the hint goes.",
|
|
86652
|
+
"inheritedFrom": {
|
|
86653
|
+
"name": "MixinViewport",
|
|
86654
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86655
|
+
}
|
|
86656
|
+
},
|
|
86657
|
+
{
|
|
86658
|
+
"kind": "field",
|
|
86659
|
+
"name": "hintAt",
|
|
86660
|
+
"type": {
|
|
86661
|
+
"text": "{ x: number; y: number } | undefined"
|
|
86662
|
+
},
|
|
86663
|
+
"privacy": "private",
|
|
86664
|
+
"description": "Where the gesture was, in the viewport's box, which the hint is shown\nat: where the reader is looking, and on the surface wherever a page laid\nits own content over the rest of it.",
|
|
86665
|
+
"inheritedFrom": {
|
|
86666
|
+
"name": "MixinViewport",
|
|
86667
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86668
|
+
}
|
|
86669
|
+
},
|
|
86670
|
+
{
|
|
86671
|
+
"kind": "field",
|
|
86672
|
+
"name": "takenBy",
|
|
86673
|
+
"type": {
|
|
86674
|
+
"text": "Event | undefined"
|
|
86675
|
+
},
|
|
86676
|
+
"privacy": "private",
|
|
86677
|
+
"description": "The press that took the gestures, which is not also the first gesture.",
|
|
86678
|
+
"inheritedFrom": {
|
|
86679
|
+
"name": "MixinViewport",
|
|
86680
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86681
|
+
}
|
|
86682
|
+
},
|
|
83468
86683
|
{
|
|
83469
86684
|
"kind": "field",
|
|
83470
86685
|
"name": "fullscreen",
|
|
@@ -83515,6 +86730,180 @@
|
|
|
83515
86730
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
83516
86731
|
}
|
|
83517
86732
|
},
|
|
86733
|
+
{
|
|
86734
|
+
"kind": "field",
|
|
86735
|
+
"name": "restingGestureLabels",
|
|
86736
|
+
"type": {
|
|
86737
|
+
"text": "ViewportGestureLabels"
|
|
86738
|
+
},
|
|
86739
|
+
"privacy": "protected",
|
|
86740
|
+
"description": "What the surface says about its gestures where the page does not say\nit, which a family overrides to name what it is: \"Press the map to use\nit\" reads better than a word that fits every surface.",
|
|
86741
|
+
"readonly": true,
|
|
86742
|
+
"inheritedFrom": {
|
|
86743
|
+
"name": "MixinViewport",
|
|
86744
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86745
|
+
}
|
|
86746
|
+
},
|
|
86747
|
+
{
|
|
86748
|
+
"kind": "method",
|
|
86749
|
+
"name": "gestureAllowed",
|
|
86750
|
+
"privacy": "protected",
|
|
86751
|
+
"return": {
|
|
86752
|
+
"type": {
|
|
86753
|
+
"text": "boolean"
|
|
86754
|
+
}
|
|
86755
|
+
},
|
|
86756
|
+
"parameters": [
|
|
86757
|
+
{
|
|
86758
|
+
"name": "event",
|
|
86759
|
+
"type": {
|
|
86760
|
+
"text": "Event"
|
|
86761
|
+
}
|
|
86762
|
+
}
|
|
86763
|
+
],
|
|
86764
|
+
"description": "Whether a gesture that started with this event is the surface's to\nanswer, for a family that answers gestures itself. Never while an\n`activate` surface waits, and never on the press that ended the wait:\nthat press hands over the gestures and moves nothing.",
|
|
86765
|
+
"inheritedFrom": {
|
|
86766
|
+
"name": "MixinViewport",
|
|
86767
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86768
|
+
}
|
|
86769
|
+
},
|
|
86770
|
+
{
|
|
86771
|
+
"kind": "method",
|
|
86772
|
+
"name": "gesturesChanged",
|
|
86773
|
+
"privacy": "protected",
|
|
86774
|
+
"return": {
|
|
86775
|
+
"type": {
|
|
86776
|
+
"text": "void"
|
|
86777
|
+
}
|
|
86778
|
+
},
|
|
86779
|
+
"description": "Says that `gestureMode` changed. Nothing here; a family whose renderer\nis told through a connector says it with its own event.",
|
|
86780
|
+
"inheritedFrom": {
|
|
86781
|
+
"name": "MixinViewport",
|
|
86782
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86783
|
+
}
|
|
86784
|
+
},
|
|
86785
|
+
{
|
|
86786
|
+
"kind": "method",
|
|
86787
|
+
"name": "showHint",
|
|
86788
|
+
"privacy": "private",
|
|
86789
|
+
"return": {
|
|
86790
|
+
"type": {
|
|
86791
|
+
"text": "void"
|
|
86792
|
+
}
|
|
86793
|
+
},
|
|
86794
|
+
"parameters": [
|
|
86795
|
+
{
|
|
86796
|
+
"name": "words",
|
|
86797
|
+
"type": {
|
|
86798
|
+
"text": "string"
|
|
86799
|
+
}
|
|
86800
|
+
},
|
|
86801
|
+
{
|
|
86802
|
+
"name": "at",
|
|
86803
|
+
"optional": true,
|
|
86804
|
+
"type": {
|
|
86805
|
+
"text": "{ clientX: number; clientY: number }"
|
|
86806
|
+
}
|
|
86807
|
+
}
|
|
86808
|
+
],
|
|
86809
|
+
"description": "Shows a hint over the surface for a moment, where the gesture was.",
|
|
86810
|
+
"inheritedFrom": {
|
|
86811
|
+
"name": "MixinViewport",
|
|
86812
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86813
|
+
}
|
|
86814
|
+
},
|
|
86815
|
+
{
|
|
86816
|
+
"kind": "field",
|
|
86817
|
+
"name": "handleGestureWheel",
|
|
86818
|
+
"privacy": "private",
|
|
86819
|
+
"readonly": true,
|
|
86820
|
+
"description": "A wheel the surface let pass to the page, which is said: a reader\nscrolling the page past a surface that did not zoom is told why, and how\nto zoom it. **Ctrl or ⌘ with the wheel is the surface's**, and is what a\ntrackpad's pinch arrives as.",
|
|
86821
|
+
"inheritedFrom": {
|
|
86822
|
+
"name": "MixinViewport",
|
|
86823
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86824
|
+
}
|
|
86825
|
+
},
|
|
86826
|
+
{
|
|
86827
|
+
"kind": "field",
|
|
86828
|
+
"name": "handleGestureTouch",
|
|
86829
|
+
"privacy": "private",
|
|
86830
|
+
"readonly": true,
|
|
86831
|
+
"description": "One finger moving over the surface, which scrolls the page, and is said.",
|
|
86832
|
+
"inheritedFrom": {
|
|
86833
|
+
"name": "MixinViewport",
|
|
86834
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86835
|
+
}
|
|
86836
|
+
},
|
|
86837
|
+
{
|
|
86838
|
+
"kind": "field",
|
|
86839
|
+
"name": "handleTake",
|
|
86840
|
+
"privacy": "private",
|
|
86841
|
+
"readonly": true,
|
|
86842
|
+
"description": "A press on the surface itself, which hands a waiting surface the gestures.",
|
|
86843
|
+
"inheritedFrom": {
|
|
86844
|
+
"name": "MixinViewport",
|
|
86845
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86846
|
+
}
|
|
86847
|
+
},
|
|
86848
|
+
{
|
|
86849
|
+
"kind": "field",
|
|
86850
|
+
"name": "handleGiveBackKey",
|
|
86851
|
+
"privacy": "private",
|
|
86852
|
+
"readonly": true,
|
|
86853
|
+
"description": "Escape, which gives the page its scroll back.",
|
|
86854
|
+
"inheritedFrom": {
|
|
86855
|
+
"name": "MixinViewport",
|
|
86856
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86857
|
+
}
|
|
86858
|
+
},
|
|
86859
|
+
{
|
|
86860
|
+
"kind": "field",
|
|
86861
|
+
"name": "handleGiveBackOutside",
|
|
86862
|
+
"privacy": "private",
|
|
86863
|
+
"readonly": true,
|
|
86864
|
+
"description": "A press anywhere else on the page, which gives it its scroll back.",
|
|
86865
|
+
"inheritedFrom": {
|
|
86866
|
+
"name": "MixinViewport",
|
|
86867
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86868
|
+
}
|
|
86869
|
+
},
|
|
86870
|
+
{
|
|
86871
|
+
"kind": "field",
|
|
86872
|
+
"name": "handleGiveBackBlur",
|
|
86873
|
+
"privacy": "private",
|
|
86874
|
+
"readonly": true,
|
|
86875
|
+
"description": "The window losing focus, as a reader switching away does.",
|
|
86876
|
+
"inheritedFrom": {
|
|
86877
|
+
"name": "MixinViewport",
|
|
86878
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86879
|
+
}
|
|
86880
|
+
},
|
|
86881
|
+
{
|
|
86882
|
+
"kind": "field",
|
|
86883
|
+
"name": "handlePointerLeave",
|
|
86884
|
+
"privacy": "protected",
|
|
86885
|
+
"readonly": true,
|
|
86886
|
+
"description": "The pointer leaving the frame, which the family binds on its region.\n**Heard on the frame and not the drawing**, which a pointer resting on\nsomething raised over it has left. **A mouse or a pen and never a\nfinger**, whose `pointerleave` is the finger lifting: a tap took the\nsurface and gave it back in one.",
|
|
86887
|
+
"inheritedFrom": {
|
|
86888
|
+
"name": "MixinViewport",
|
|
86889
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86890
|
+
}
|
|
86891
|
+
},
|
|
86892
|
+
{
|
|
86893
|
+
"kind": "method",
|
|
86894
|
+
"name": "renderGestures",
|
|
86895
|
+
"privacy": "protected",
|
|
86896
|
+
"return": {
|
|
86897
|
+
"type": {
|
|
86898
|
+
"text": "TemplateResult"
|
|
86899
|
+
}
|
|
86900
|
+
},
|
|
86901
|
+
"description": "The hint over the surface and the line while it is in use, which the\nfamily draws inside its viewport, over what was slotted. The parts are\nwritten out, as the controls' are, so the manifest sees them.",
|
|
86902
|
+
"inheritedFrom": {
|
|
86903
|
+
"name": "MixinViewport",
|
|
86904
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
86905
|
+
}
|
|
86906
|
+
},
|
|
83518
86907
|
{
|
|
83519
86908
|
"kind": "method",
|
|
83520
86909
|
"name": "panEvent",
|
|
@@ -83826,20 +87215,6 @@
|
|
|
83826
87215
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
83827
87216
|
}
|
|
83828
87217
|
},
|
|
83829
|
-
{
|
|
83830
|
-
"kind": "field",
|
|
83831
|
-
"name": "activateHintLabel",
|
|
83832
|
-
"type": {
|
|
83833
|
-
"text": "string"
|
|
83834
|
-
},
|
|
83835
|
-
"default": "'Press the map to use it'",
|
|
83836
|
-
"description": "The hint shown when a map waiting to be pressed is scrolled or swiped\nover, with `gestures=\"activate\"`.",
|
|
83837
|
-
"attribute": "activate-hint-label",
|
|
83838
|
-
"inheritedFrom": {
|
|
83839
|
-
"name": "HelixHeadlessMap",
|
|
83840
|
-
"module": "src/map/root/map-root.ts"
|
|
83841
|
-
}
|
|
83842
|
-
},
|
|
83843
87218
|
{
|
|
83844
87219
|
"kind": "field",
|
|
83845
87220
|
"name": "bearing",
|
|
@@ -83896,19 +87271,6 @@
|
|
|
83896
87271
|
"module": "src/map/root/map-root.ts"
|
|
83897
87272
|
}
|
|
83898
87273
|
},
|
|
83899
|
-
{
|
|
83900
|
-
"kind": "field",
|
|
83901
|
-
"name": "gestures",
|
|
83902
|
-
"type": {
|
|
83903
|
-
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
83904
|
-
},
|
|
83905
|
-
"description": "Which gestures the map takes from the page.\n\n- `always`, which unset is: the wheel zooms the map and one finger pans\n it, for a map that is the page, such as a full-screen view.\n- `cooperative`: the wheel and one finger scroll the page, and the map\n takes Ctrl or ⌘ with the wheel, and two fingers. The frame says so\n when a gesture passes to the page. Best for a map embedded in a page.\n- `activate`: the map takes nothing until it is pressed, and gives it\n back on Escape, when the pointer leaves it, or on a press elsewhere.\n\nThe keyboard and the frame's buttons work in every mode. The renderer is\ntold through the connector, so MapLibre and Leaflet behave alike.",
|
|
83906
|
-
"attribute": "gestures",
|
|
83907
|
-
"inheritedFrom": {
|
|
83908
|
-
"name": "HelixHeadlessMap",
|
|
83909
|
-
"module": "src/map/root/map-root.ts"
|
|
83910
|
-
}
|
|
83911
|
-
},
|
|
83912
87274
|
{
|
|
83913
87275
|
"kind": "field",
|
|
83914
87276
|
"name": "hybridLabel",
|
|
@@ -84161,48 +87523,6 @@
|
|
|
84161
87523
|
"module": "src/map/root/map-root.ts"
|
|
84162
87524
|
}
|
|
84163
87525
|
},
|
|
84164
|
-
{
|
|
84165
|
-
"kind": "field",
|
|
84166
|
-
"name": "twoFingerHintLabel",
|
|
84167
|
-
"type": {
|
|
84168
|
-
"text": "string"
|
|
84169
|
-
},
|
|
84170
|
-
"default": "'Use two fingers to move the map'",
|
|
84171
|
-
"description": "The hint shown when one finger swipes over a map with `gestures=\"cooperative\"`.",
|
|
84172
|
-
"attribute": "two-finger-hint-label",
|
|
84173
|
-
"inheritedFrom": {
|
|
84174
|
-
"name": "HelixHeadlessMap",
|
|
84175
|
-
"module": "src/map/root/map-root.ts"
|
|
84176
|
-
}
|
|
84177
|
-
},
|
|
84178
|
-
{
|
|
84179
|
-
"kind": "field",
|
|
84180
|
-
"name": "usingLabel",
|
|
84181
|
-
"type": {
|
|
84182
|
-
"text": "string"
|
|
84183
|
-
},
|
|
84184
|
-
"default": "'Using the map. Press Escape to scroll the page again.'",
|
|
84185
|
-
"description": "The line shown while a map with `gestures=\"activate\"` has the gestures.",
|
|
84186
|
-
"attribute": "using-label",
|
|
84187
|
-
"inheritedFrom": {
|
|
84188
|
-
"name": "HelixHeadlessMap",
|
|
84189
|
-
"module": "src/map/root/map-root.ts"
|
|
84190
|
-
}
|
|
84191
|
-
},
|
|
84192
|
-
{
|
|
84193
|
-
"kind": "field",
|
|
84194
|
-
"name": "wheelHintLabel",
|
|
84195
|
-
"type": {
|
|
84196
|
-
"text": "string"
|
|
84197
|
-
},
|
|
84198
|
-
"default": "'Use {key} and scroll to zoom the map'",
|
|
84199
|
-
"description": "The hint shown when the wheel scrolls past a map with\n`gestures=\"cooperative\"`, with `{key}`, which is ⌘ on a Mac and Ctrl\nelsewhere, as the renderer reads it.",
|
|
84200
|
-
"attribute": "wheel-hint-label",
|
|
84201
|
-
"inheritedFrom": {
|
|
84202
|
-
"name": "HelixHeadlessMap",
|
|
84203
|
-
"module": "src/map/root/map-root.ts"
|
|
84204
|
-
}
|
|
84205
|
-
},
|
|
84206
87526
|
{
|
|
84207
87527
|
"kind": "field",
|
|
84208
87528
|
"name": "zoomedLabel",
|
|
@@ -84686,167 +88006,6 @@
|
|
|
84686
88006
|
"module": "src/map/root/map-root.ts"
|
|
84687
88007
|
}
|
|
84688
88008
|
},
|
|
84689
|
-
{
|
|
84690
|
-
"kind": "field",
|
|
84691
|
-
"name": "hint",
|
|
84692
|
-
"type": {
|
|
84693
|
-
"text": "string"
|
|
84694
|
-
},
|
|
84695
|
-
"privacy": "private",
|
|
84696
|
-
"default": "''",
|
|
84697
|
-
"description": "The hint on the map while one shows, put there by a gesture the map let pass.",
|
|
84698
|
-
"inheritedFrom": {
|
|
84699
|
-
"name": "HelixHeadlessMap",
|
|
84700
|
-
"module": "src/map/root/map-root.ts"
|
|
84701
|
-
}
|
|
84702
|
-
},
|
|
84703
|
-
{
|
|
84704
|
-
"kind": "field",
|
|
84705
|
-
"name": "hinting",
|
|
84706
|
-
"type": {
|
|
84707
|
-
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
84708
|
-
},
|
|
84709
|
-
"privacy": "private",
|
|
84710
|
-
"description": "When the hint goes.",
|
|
84711
|
-
"inheritedFrom": {
|
|
84712
|
-
"name": "HelixHeadlessMap",
|
|
84713
|
-
"module": "src/map/root/map-root.ts"
|
|
84714
|
-
}
|
|
84715
|
-
},
|
|
84716
|
-
{
|
|
84717
|
-
"kind": "field",
|
|
84718
|
-
"name": "hintAt",
|
|
84719
|
-
"type": {
|
|
84720
|
-
"text": "{ x: number; y: number } | undefined"
|
|
84721
|
-
},
|
|
84722
|
-
"privacy": "private",
|
|
84723
|
-
"description": "Where the gesture was, in the map's box, which the hint is shown at:\nwhere the reader is looking, and on the map wherever a page laid its own\ncontent over the rest of it.",
|
|
84724
|
-
"inheritedFrom": {
|
|
84725
|
-
"name": "HelixHeadlessMap",
|
|
84726
|
-
"module": "src/map/root/map-root.ts"
|
|
84727
|
-
}
|
|
84728
|
-
},
|
|
84729
|
-
{
|
|
84730
|
-
"kind": "field",
|
|
84731
|
-
"name": "taken",
|
|
84732
|
-
"type": {
|
|
84733
|
-
"text": "boolean"
|
|
84734
|
-
},
|
|
84735
|
-
"privacy": "private",
|
|
84736
|
-
"default": "false",
|
|
84737
|
-
"description": "Whether a map with `gestures=\"activate\"` has been pressed, and has the gestures.",
|
|
84738
|
-
"inheritedFrom": {
|
|
84739
|
-
"name": "HelixHeadlessMap",
|
|
84740
|
-
"module": "src/map/root/map-root.ts"
|
|
84741
|
-
}
|
|
84742
|
-
},
|
|
84743
|
-
{
|
|
84744
|
-
"kind": "method",
|
|
84745
|
-
"name": "showHint",
|
|
84746
|
-
"privacy": "private",
|
|
84747
|
-
"return": {
|
|
84748
|
-
"type": {
|
|
84749
|
-
"text": "void"
|
|
84750
|
-
}
|
|
84751
|
-
},
|
|
84752
|
-
"parameters": [
|
|
84753
|
-
{
|
|
84754
|
-
"name": "words",
|
|
84755
|
-
"type": {
|
|
84756
|
-
"text": "string"
|
|
84757
|
-
}
|
|
84758
|
-
},
|
|
84759
|
-
{
|
|
84760
|
-
"name": "at",
|
|
84761
|
-
"optional": true,
|
|
84762
|
-
"type": {
|
|
84763
|
-
"text": "{ clientX: number; clientY: number }"
|
|
84764
|
-
}
|
|
84765
|
-
}
|
|
84766
|
-
],
|
|
84767
|
-
"description": "Shows a hint over the map for a moment, where the gesture was.",
|
|
84768
|
-
"inheritedFrom": {
|
|
84769
|
-
"name": "HelixHeadlessMap",
|
|
84770
|
-
"module": "src/map/root/map-root.ts"
|
|
84771
|
-
}
|
|
84772
|
-
},
|
|
84773
|
-
{
|
|
84774
|
-
"kind": "field",
|
|
84775
|
-
"name": "handleWheel",
|
|
84776
|
-
"privacy": "private",
|
|
84777
|
-
"readonly": true,
|
|
84778
|
-
"description": "A wheel the map let pass to the page, which is said: a reader scrolling\nthe page past a map that did not zoom is told why, and how to zoom it.\n**Ctrl or ⌘ with the wheel is the map's**, and is what a trackpad's pinch\narrives as.",
|
|
84779
|
-
"inheritedFrom": {
|
|
84780
|
-
"name": "HelixHeadlessMap",
|
|
84781
|
-
"module": "src/map/root/map-root.ts"
|
|
84782
|
-
}
|
|
84783
|
-
},
|
|
84784
|
-
{
|
|
84785
|
-
"kind": "field",
|
|
84786
|
-
"name": "handleTouchMove",
|
|
84787
|
-
"privacy": "private",
|
|
84788
|
-
"readonly": true,
|
|
84789
|
-
"description": "One finger moving over the map, which scrolls the page, and is said.",
|
|
84790
|
-
"inheritedFrom": {
|
|
84791
|
-
"name": "HelixHeadlessMap",
|
|
84792
|
-
"module": "src/map/root/map-root.ts"
|
|
84793
|
-
}
|
|
84794
|
-
},
|
|
84795
|
-
{
|
|
84796
|
-
"kind": "field",
|
|
84797
|
-
"name": "handleTake",
|
|
84798
|
-
"privacy": "private",
|
|
84799
|
-
"readonly": true,
|
|
84800
|
-
"description": "A press on the map itself, which hands a waiting map the gestures.",
|
|
84801
|
-
"inheritedFrom": {
|
|
84802
|
-
"name": "HelixHeadlessMap",
|
|
84803
|
-
"module": "src/map/root/map-root.ts"
|
|
84804
|
-
}
|
|
84805
|
-
},
|
|
84806
|
-
{
|
|
84807
|
-
"kind": "field",
|
|
84808
|
-
"name": "handleGiveBackKey",
|
|
84809
|
-
"privacy": "private",
|
|
84810
|
-
"readonly": true,
|
|
84811
|
-
"description": "Escape, which gives the page its scroll back.",
|
|
84812
|
-
"inheritedFrom": {
|
|
84813
|
-
"name": "HelixHeadlessMap",
|
|
84814
|
-
"module": "src/map/root/map-root.ts"
|
|
84815
|
-
}
|
|
84816
|
-
},
|
|
84817
|
-
{
|
|
84818
|
-
"kind": "field",
|
|
84819
|
-
"name": "handleGiveBackOutside",
|
|
84820
|
-
"privacy": "private",
|
|
84821
|
-
"readonly": true,
|
|
84822
|
-
"description": "A press anywhere else on the page, which gives it its scroll back.",
|
|
84823
|
-
"inheritedFrom": {
|
|
84824
|
-
"name": "HelixHeadlessMap",
|
|
84825
|
-
"module": "src/map/root/map-root.ts"
|
|
84826
|
-
}
|
|
84827
|
-
},
|
|
84828
|
-
{
|
|
84829
|
-
"kind": "field",
|
|
84830
|
-
"name": "handleGiveBackBlur",
|
|
84831
|
-
"privacy": "private",
|
|
84832
|
-
"readonly": true,
|
|
84833
|
-
"description": "The window losing focus, as a reader switching away does.",
|
|
84834
|
-
"inheritedFrom": {
|
|
84835
|
-
"name": "HelixHeadlessMap",
|
|
84836
|
-
"module": "src/map/root/map-root.ts"
|
|
84837
|
-
}
|
|
84838
|
-
},
|
|
84839
|
-
{
|
|
84840
|
-
"kind": "field",
|
|
84841
|
-
"name": "handleLeave",
|
|
84842
|
-
"privacy": "private",
|
|
84843
|
-
"readonly": true,
|
|
84844
|
-
"description": "The pointer leaving the frame. **Heard on the frame and not the map's\ncanvas**, which a pointer resting on a marker has left, since markers\nstand outside it. **A mouse or a pen and never a finger**, whose\n`pointerleave` is the finger lifting: a tap took the map and gave it back\nin one.",
|
|
84845
|
-
"inheritedFrom": {
|
|
84846
|
-
"name": "HelixHeadlessMap",
|
|
84847
|
-
"module": "src/map/root/map-root.ts"
|
|
84848
|
-
}
|
|
84849
|
-
},
|
|
84850
88009
|
{
|
|
84851
88010
|
"kind": "field",
|
|
84852
88011
|
"name": "handleSlotChange",
|
|
@@ -85403,6 +88562,18 @@
|
|
|
85403
88562
|
"description": "The background of the pan and zoom buttons. Leave unset for solid. `glass`\nshows the map through a blur, `frosted` blurs more, and `transparent` has\nno background. Your theme sets how see-through each one is.",
|
|
85404
88563
|
"fieldName": "material"
|
|
85405
88564
|
},
|
|
88565
|
+
{
|
|
88566
|
+
"name": "activate-hint-label",
|
|
88567
|
+
"type": {
|
|
88568
|
+
"text": "string | undefined"
|
|
88569
|
+
},
|
|
88570
|
+
"description": "The hint shown when a surface waiting to be pressed is scrolled or\nswiped over, with `gestures=\"activate\"`. Absent is the family's own.",
|
|
88571
|
+
"fieldName": "activateHintLabel",
|
|
88572
|
+
"inheritedFrom": {
|
|
88573
|
+
"name": "MixinViewport",
|
|
88574
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
88575
|
+
}
|
|
88576
|
+
},
|
|
85406
88577
|
{
|
|
85407
88578
|
"name": "controls",
|
|
85408
88579
|
"type": {
|
|
@@ -85452,6 +88623,18 @@
|
|
|
85452
88623
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
85453
88624
|
}
|
|
85454
88625
|
},
|
|
88626
|
+
{
|
|
88627
|
+
"name": "gestures",
|
|
88628
|
+
"type": {
|
|
88629
|
+
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
88630
|
+
},
|
|
88631
|
+
"description": "Which gestures the surface takes from the page.\n\n- `always`: the surface takes the wheel and one finger, for a surface\n that is the page, such as a full-screen view. A map rests here.\n- Unset is the family's own: `always` for a map, and for a board, a\n drag and a pinch, with the plain wheel left to the page until the\n board fills the screen.\n- `cooperative`: the wheel and one finger scroll the page, and the\n surface takes Ctrl or ⌘ with the wheel, and two fingers. The frame\n says so when a gesture passes to the page. Best for a surface embedded\n in a page.\n- `activate`: the surface takes nothing until it is pressed, and gives it\n back on Escape, when the pointer leaves it, or on a press elsewhere.\n\nThe keyboard and the frame's buttons work in every mode.\n\n**Unreflected and without a default**, because a default that reflected\nwould write an attribute onto every host that no server sent, and the\nhydration that followed would disagree with it.",
|
|
88632
|
+
"fieldName": "gestures",
|
|
88633
|
+
"inheritedFrom": {
|
|
88634
|
+
"name": "MixinViewport",
|
|
88635
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
88636
|
+
}
|
|
88637
|
+
},
|
|
85455
88638
|
{
|
|
85456
88639
|
"name": "idle-delay",
|
|
85457
88640
|
"type": {
|
|
@@ -85530,6 +88713,42 @@
|
|
|
85530
88713
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
85531
88714
|
}
|
|
85532
88715
|
},
|
|
88716
|
+
{
|
|
88717
|
+
"name": "two-finger-hint-label",
|
|
88718
|
+
"type": {
|
|
88719
|
+
"text": "string | undefined"
|
|
88720
|
+
},
|
|
88721
|
+
"description": "The hint shown when one finger swipes over a surface with\n`gestures=\"cooperative\"`. Absent is the family's own.",
|
|
88722
|
+
"fieldName": "twoFingerHintLabel",
|
|
88723
|
+
"inheritedFrom": {
|
|
88724
|
+
"name": "MixinViewport",
|
|
88725
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
88726
|
+
}
|
|
88727
|
+
},
|
|
88728
|
+
{
|
|
88729
|
+
"name": "using-label",
|
|
88730
|
+
"type": {
|
|
88731
|
+
"text": "string | undefined"
|
|
88732
|
+
},
|
|
88733
|
+
"description": "The line shown while a surface with `gestures=\"activate\"` has the\ngestures. Absent is the family's own.",
|
|
88734
|
+
"fieldName": "usingLabel",
|
|
88735
|
+
"inheritedFrom": {
|
|
88736
|
+
"name": "MixinViewport",
|
|
88737
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
88738
|
+
}
|
|
88739
|
+
},
|
|
88740
|
+
{
|
|
88741
|
+
"name": "wheel-hint-label",
|
|
88742
|
+
"type": {
|
|
88743
|
+
"text": "string | undefined"
|
|
88744
|
+
},
|
|
88745
|
+
"description": "The hint shown when the wheel scrolls past a surface with\n`gestures=\"cooperative\"`, with `{key}`, which is ⌘ on a Mac and Ctrl\nelsewhere. Absent is the family's own.",
|
|
88746
|
+
"fieldName": "wheelHintLabel",
|
|
88747
|
+
"inheritedFrom": {
|
|
88748
|
+
"name": "MixinViewport",
|
|
88749
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
88750
|
+
}
|
|
88751
|
+
},
|
|
85533
88752
|
{
|
|
85534
88753
|
"name": "zoom-in-label",
|
|
85535
88754
|
"type": {
|
|
@@ -85556,19 +88775,6 @@
|
|
|
85556
88775
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
85557
88776
|
}
|
|
85558
88777
|
},
|
|
85559
|
-
{
|
|
85560
|
-
"name": "activate-hint-label",
|
|
85561
|
-
"type": {
|
|
85562
|
-
"text": "string"
|
|
85563
|
-
},
|
|
85564
|
-
"default": "'Press the map to use it'",
|
|
85565
|
-
"description": "The hint shown when a map waiting to be pressed is scrolled or swiped\nover, with `gestures=\"activate\"`.",
|
|
85566
|
-
"fieldName": "activateHintLabel",
|
|
85567
|
-
"inheritedFrom": {
|
|
85568
|
-
"name": "HelixHeadlessMap",
|
|
85569
|
-
"module": "src/map/root/map-root.ts"
|
|
85570
|
-
}
|
|
85571
|
-
},
|
|
85572
88778
|
{
|
|
85573
88779
|
"name": "bearing",
|
|
85574
88780
|
"type": {
|
|
@@ -85621,18 +88827,6 @@
|
|
|
85621
88827
|
"module": "src/map/root/map-root.ts"
|
|
85622
88828
|
}
|
|
85623
88829
|
},
|
|
85624
|
-
{
|
|
85625
|
-
"name": "gestures",
|
|
85626
|
-
"type": {
|
|
85627
|
-
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
85628
|
-
},
|
|
85629
|
-
"description": "Which gestures the map takes from the page.\n\n- `always`, which unset is: the wheel zooms the map and one finger pans\n it, for a map that is the page, such as a full-screen view.\n- `cooperative`: the wheel and one finger scroll the page, and the map\n takes Ctrl or ⌘ with the wheel, and two fingers. The frame says so\n when a gesture passes to the page. Best for a map embedded in a page.\n- `activate`: the map takes nothing until it is pressed, and gives it\n back on Escape, when the pointer leaves it, or on a press elsewhere.\n\nThe keyboard and the frame's buttons work in every mode. The renderer is\ntold through the connector, so MapLibre and Leaflet behave alike.",
|
|
85630
|
-
"fieldName": "gestures",
|
|
85631
|
-
"inheritedFrom": {
|
|
85632
|
-
"name": "HelixHeadlessMap",
|
|
85633
|
-
"module": "src/map/root/map-root.ts"
|
|
85634
|
-
}
|
|
85635
|
-
},
|
|
85636
88830
|
{
|
|
85637
88831
|
"name": "hybrid-label",
|
|
85638
88832
|
"type": {
|
|
@@ -85866,45 +89060,6 @@
|
|
|
85866
89060
|
"module": "src/map/root/map-root.ts"
|
|
85867
89061
|
}
|
|
85868
89062
|
},
|
|
85869
|
-
{
|
|
85870
|
-
"name": "two-finger-hint-label",
|
|
85871
|
-
"type": {
|
|
85872
|
-
"text": "string"
|
|
85873
|
-
},
|
|
85874
|
-
"default": "'Use two fingers to move the map'",
|
|
85875
|
-
"description": "The hint shown when one finger swipes over a map with `gestures=\"cooperative\"`.",
|
|
85876
|
-
"fieldName": "twoFingerHintLabel",
|
|
85877
|
-
"inheritedFrom": {
|
|
85878
|
-
"name": "HelixHeadlessMap",
|
|
85879
|
-
"module": "src/map/root/map-root.ts"
|
|
85880
|
-
}
|
|
85881
|
-
},
|
|
85882
|
-
{
|
|
85883
|
-
"name": "using-label",
|
|
85884
|
-
"type": {
|
|
85885
|
-
"text": "string"
|
|
85886
|
-
},
|
|
85887
|
-
"default": "'Using the map. Press Escape to scroll the page again.'",
|
|
85888
|
-
"description": "The line shown while a map with `gestures=\"activate\"` has the gestures.",
|
|
85889
|
-
"fieldName": "usingLabel",
|
|
85890
|
-
"inheritedFrom": {
|
|
85891
|
-
"name": "HelixHeadlessMap",
|
|
85892
|
-
"module": "src/map/root/map-root.ts"
|
|
85893
|
-
}
|
|
85894
|
-
},
|
|
85895
|
-
{
|
|
85896
|
-
"name": "wheel-hint-label",
|
|
85897
|
-
"type": {
|
|
85898
|
-
"text": "string"
|
|
85899
|
-
},
|
|
85900
|
-
"default": "'Use {key} and scroll to zoom the map'",
|
|
85901
|
-
"description": "The hint shown when the wheel scrolls past a map with\n`gestures=\"cooperative\"`, with `{key}`, which is ⌘ on a Mac and Ctrl\nelsewhere, as the renderer reads it.",
|
|
85902
|
-
"fieldName": "wheelHintLabel",
|
|
85903
|
-
"inheritedFrom": {
|
|
85904
|
-
"name": "HelixHeadlessMap",
|
|
85905
|
-
"module": "src/map/root/map-root.ts"
|
|
85906
|
-
}
|
|
85907
|
-
},
|
|
85908
89063
|
{
|
|
85909
89064
|
"name": "zoomed-label",
|
|
85910
89065
|
"type": {
|
|
@@ -86446,6 +89601,14 @@
|
|
|
86446
89601
|
"module": "src/map/root/map-root.ts"
|
|
86447
89602
|
}
|
|
86448
89603
|
},
|
|
89604
|
+
{
|
|
89605
|
+
"description": "The page keeps the plain wheel and one finger, with `gestures=\"cooperative\"` or while a map with `gestures=\"activate\"` waits to be pressed.",
|
|
89606
|
+
"name": "sharing",
|
|
89607
|
+
"inheritedFrom": {
|
|
89608
|
+
"name": "HelixHeadlessMap",
|
|
89609
|
+
"module": "src/map/root/map-root.ts"
|
|
89610
|
+
}
|
|
89611
|
+
},
|
|
86449
89612
|
{
|
|
86450
89613
|
"description": "A map with `gestures=\"activate\"` has been pressed and has the gestures.",
|
|
86451
89614
|
"name": "using",
|