@fusion.dev/helix-headless 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 +3530 -429
- package/dist/canvas/root/canvas-root.d.ts +14 -1
- package/dist/canvas/root/canvas-root.js +29 -3
- package/dist/element-events.generated.js +9 -0
- package/dist/graph/index.d.ts +3 -0
- package/dist/graph/index.js +2 -0
- package/dist/graph/root/graph-model.d.ts +63 -0
- package/dist/graph/root/graph-model.js +75 -0
- package/dist/graph/root/graph-root.d.ts +209 -0
- package/dist/graph/root/graph-root.js +342 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/dist/map/root/map-root.d.ts +6 -76
- package/dist/map/root/map-root.js +12 -136
- package/package.json +5 -5
- package/types/jsx.d.ts +1384 -108
- package/types/svelte.d.ts +1 -0
- package/types/vue.d.ts +380 -37
package/custom-elements.json
CHANGED
|
@@ -11022,6 +11022,14 @@
|
|
|
11022
11022
|
"description": "The button that makes the board fill the screen.",
|
|
11023
11023
|
"name": "fullscreen"
|
|
11024
11024
|
},
|
|
11025
|
+
{
|
|
11026
|
+
"description": "Words over the board for a moment when it lets a gesture pass to the page, such as how to zoom it.",
|
|
11027
|
+
"name": "gesture-hint"
|
|
11028
|
+
},
|
|
11029
|
+
{
|
|
11030
|
+
"description": "The line shown while a board with `gestures=\"activate\"` has the gestures.",
|
|
11031
|
+
"name": "gesture-status"
|
|
11032
|
+
},
|
|
11025
11033
|
{
|
|
11026
11034
|
"description": "The strip above the board.",
|
|
11027
11035
|
"name": "header"
|
|
@@ -11575,6 +11583,20 @@
|
|
|
11575
11583
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
11576
11584
|
}
|
|
11577
11585
|
},
|
|
11586
|
+
{
|
|
11587
|
+
"kind": "field",
|
|
11588
|
+
"name": "restingGestureLabels",
|
|
11589
|
+
"type": {
|
|
11590
|
+
"text": "ViewportGestureLabels"
|
|
11591
|
+
},
|
|
11592
|
+
"privacy": "protected",
|
|
11593
|
+
"description": "What the board says about its gestures where the page does not say it.",
|
|
11594
|
+
"readonly": true,
|
|
11595
|
+
"inheritedFrom": {
|
|
11596
|
+
"name": "MixinViewport",
|
|
11597
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
11598
|
+
}
|
|
11599
|
+
},
|
|
11578
11600
|
{
|
|
11579
11601
|
"kind": "field",
|
|
11580
11602
|
"name": "restingControls",
|
|
@@ -12581,6 +12603,13 @@
|
|
|
12581
12603
|
"readonly": true,
|
|
12582
12604
|
"description": "A pinch, which zooms, and the wheel, which pans only once the board fills\nthe screen.\n\n**`ctrlKey` is a pinch as well as a control press**, which is the platform's\nown convention rather than this component's: a trackpad pinch arrives as a\nwheel event with `ctrlKey` set, on every browser, and a component that\nignored it would be the one thing on the page a pinch does not work on.\n\n**A plain wheel belongs to the page while the board is part of one.** Taking\nit trapped the reader: a board is most of a screen tall, so scrolling down a\npage stopped the moment the pointer crossed one and panned it instead, with\nno way on but to move the pointer off it first. Measured on the examples\npage, where the second board could not be scrolled to. A drag is how an\nembedded board moves, which is the bargain an embedded map makes too; once\nthe reader has filled the screen with it there is no page left to scroll, so\nthe wheel is the board's."
|
|
12583
12605
|
},
|
|
12606
|
+
{
|
|
12607
|
+
"kind": "field",
|
|
12608
|
+
"name": "handleTouchStart",
|
|
12609
|
+
"privacy": "private",
|
|
12610
|
+
"readonly": true,
|
|
12611
|
+
"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."
|
|
12612
|
+
},
|
|
12584
12613
|
{
|
|
12585
12614
|
"kind": "field",
|
|
12586
12615
|
"name": "handleStopKeydown",
|
|
@@ -13060,6 +13089,19 @@
|
|
|
13060
13089
|
],
|
|
13061
13090
|
"description": "The connection being made, drawn from where it starts to the pointer, or to\nthe card a keyboard reader is on."
|
|
13062
13091
|
},
|
|
13092
|
+
{
|
|
13093
|
+
"kind": "field",
|
|
13094
|
+
"name": "activateHintLabel",
|
|
13095
|
+
"type": {
|
|
13096
|
+
"text": "string | undefined"
|
|
13097
|
+
},
|
|
13098
|
+
"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.",
|
|
13099
|
+
"attribute": "activate-hint-label",
|
|
13100
|
+
"inheritedFrom": {
|
|
13101
|
+
"name": "MixinViewport",
|
|
13102
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13103
|
+
}
|
|
13104
|
+
},
|
|
13063
13105
|
{
|
|
13064
13106
|
"kind": "field",
|
|
13065
13107
|
"name": "controls",
|
|
@@ -13115,6 +13157,19 @@
|
|
|
13115
13157
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13116
13158
|
}
|
|
13117
13159
|
},
|
|
13160
|
+
{
|
|
13161
|
+
"kind": "field",
|
|
13162
|
+
"name": "gestures",
|
|
13163
|
+
"type": {
|
|
13164
|
+
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
13165
|
+
},
|
|
13166
|
+
"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.",
|
|
13167
|
+
"attribute": "gestures",
|
|
13168
|
+
"inheritedFrom": {
|
|
13169
|
+
"name": "MixinViewport",
|
|
13170
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13171
|
+
}
|
|
13172
|
+
},
|
|
13118
13173
|
{
|
|
13119
13174
|
"kind": "field",
|
|
13120
13175
|
"name": "idleDelay",
|
|
@@ -13199,6 +13254,45 @@
|
|
|
13199
13254
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13200
13255
|
}
|
|
13201
13256
|
},
|
|
13257
|
+
{
|
|
13258
|
+
"kind": "field",
|
|
13259
|
+
"name": "twoFingerHintLabel",
|
|
13260
|
+
"type": {
|
|
13261
|
+
"text": "string | undefined"
|
|
13262
|
+
},
|
|
13263
|
+
"description": "The hint shown when one finger swipes over a surface with\n`gestures=\"cooperative\"`. Absent is the family's own.",
|
|
13264
|
+
"attribute": "two-finger-hint-label",
|
|
13265
|
+
"inheritedFrom": {
|
|
13266
|
+
"name": "MixinViewport",
|
|
13267
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13268
|
+
}
|
|
13269
|
+
},
|
|
13270
|
+
{
|
|
13271
|
+
"kind": "field",
|
|
13272
|
+
"name": "usingLabel",
|
|
13273
|
+
"type": {
|
|
13274
|
+
"text": "string | undefined"
|
|
13275
|
+
},
|
|
13276
|
+
"description": "The line shown while a surface with `gestures=\"activate\"` has the\ngestures. Absent is the family's own.",
|
|
13277
|
+
"attribute": "using-label",
|
|
13278
|
+
"inheritedFrom": {
|
|
13279
|
+
"name": "MixinViewport",
|
|
13280
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13281
|
+
}
|
|
13282
|
+
},
|
|
13283
|
+
{
|
|
13284
|
+
"kind": "field",
|
|
13285
|
+
"name": "wheelHintLabel",
|
|
13286
|
+
"type": {
|
|
13287
|
+
"text": "string | undefined"
|
|
13288
|
+
},
|
|
13289
|
+
"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.",
|
|
13290
|
+
"attribute": "wheel-hint-label",
|
|
13291
|
+
"inheritedFrom": {
|
|
13292
|
+
"name": "MixinViewport",
|
|
13293
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13294
|
+
}
|
|
13295
|
+
},
|
|
13202
13296
|
{
|
|
13203
13297
|
"kind": "field",
|
|
13204
13298
|
"name": "zoomInLabel",
|
|
@@ -13241,6 +13335,73 @@
|
|
|
13241
13335
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13242
13336
|
}
|
|
13243
13337
|
},
|
|
13338
|
+
{
|
|
13339
|
+
"kind": "field",
|
|
13340
|
+
"name": "gesturesTaken",
|
|
13341
|
+
"type": {
|
|
13342
|
+
"text": "boolean"
|
|
13343
|
+
},
|
|
13344
|
+
"privacy": "protected",
|
|
13345
|
+
"default": "false",
|
|
13346
|
+
"description": "Whether an `activate` surface has been pressed, and has the gestures.",
|
|
13347
|
+
"inheritedFrom": {
|
|
13348
|
+
"name": "MixinViewport",
|
|
13349
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13350
|
+
}
|
|
13351
|
+
},
|
|
13352
|
+
{
|
|
13353
|
+
"kind": "field",
|
|
13354
|
+
"name": "hint",
|
|
13355
|
+
"type": {
|
|
13356
|
+
"text": "string"
|
|
13357
|
+
},
|
|
13358
|
+
"privacy": "private",
|
|
13359
|
+
"default": "''",
|
|
13360
|
+
"description": "The hint over the surface while one shows, put there by a gesture it let pass.",
|
|
13361
|
+
"inheritedFrom": {
|
|
13362
|
+
"name": "MixinViewport",
|
|
13363
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13364
|
+
}
|
|
13365
|
+
},
|
|
13366
|
+
{
|
|
13367
|
+
"kind": "field",
|
|
13368
|
+
"name": "hinting",
|
|
13369
|
+
"type": {
|
|
13370
|
+
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
13371
|
+
},
|
|
13372
|
+
"privacy": "private",
|
|
13373
|
+
"description": "When the hint goes.",
|
|
13374
|
+
"inheritedFrom": {
|
|
13375
|
+
"name": "MixinViewport",
|
|
13376
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13377
|
+
}
|
|
13378
|
+
},
|
|
13379
|
+
{
|
|
13380
|
+
"kind": "field",
|
|
13381
|
+
"name": "hintAt",
|
|
13382
|
+
"type": {
|
|
13383
|
+
"text": "{ x: number; y: number } | undefined"
|
|
13384
|
+
},
|
|
13385
|
+
"privacy": "private",
|
|
13386
|
+
"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.",
|
|
13387
|
+
"inheritedFrom": {
|
|
13388
|
+
"name": "MixinViewport",
|
|
13389
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13390
|
+
}
|
|
13391
|
+
},
|
|
13392
|
+
{
|
|
13393
|
+
"kind": "field",
|
|
13394
|
+
"name": "takenBy",
|
|
13395
|
+
"type": {
|
|
13396
|
+
"text": "Event | undefined"
|
|
13397
|
+
},
|
|
13398
|
+
"privacy": "private",
|
|
13399
|
+
"description": "The press that took the gestures, which is not also the first gesture.",
|
|
13400
|
+
"inheritedFrom": {
|
|
13401
|
+
"name": "MixinViewport",
|
|
13402
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13403
|
+
}
|
|
13404
|
+
},
|
|
13244
13405
|
{
|
|
13245
13406
|
"kind": "field",
|
|
13246
13407
|
"name": "fullscreen",
|
|
@@ -13277,6 +13438,166 @@
|
|
|
13277
13438
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13278
13439
|
}
|
|
13279
13440
|
},
|
|
13441
|
+
{
|
|
13442
|
+
"kind": "method",
|
|
13443
|
+
"name": "gestureAllowed",
|
|
13444
|
+
"privacy": "protected",
|
|
13445
|
+
"return": {
|
|
13446
|
+
"type": {
|
|
13447
|
+
"text": "boolean"
|
|
13448
|
+
}
|
|
13449
|
+
},
|
|
13450
|
+
"parameters": [
|
|
13451
|
+
{
|
|
13452
|
+
"name": "event",
|
|
13453
|
+
"type": {
|
|
13454
|
+
"text": "Event"
|
|
13455
|
+
}
|
|
13456
|
+
}
|
|
13457
|
+
],
|
|
13458
|
+
"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.",
|
|
13459
|
+
"inheritedFrom": {
|
|
13460
|
+
"name": "MixinViewport",
|
|
13461
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13462
|
+
}
|
|
13463
|
+
},
|
|
13464
|
+
{
|
|
13465
|
+
"kind": "method",
|
|
13466
|
+
"name": "gesturesChanged",
|
|
13467
|
+
"privacy": "protected",
|
|
13468
|
+
"return": {
|
|
13469
|
+
"type": {
|
|
13470
|
+
"text": "void"
|
|
13471
|
+
}
|
|
13472
|
+
},
|
|
13473
|
+
"description": "Says that `gestureMode` changed. Nothing here; a family whose renderer\nis told through a connector says it with its own event.",
|
|
13474
|
+
"inheritedFrom": {
|
|
13475
|
+
"name": "MixinViewport",
|
|
13476
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13477
|
+
}
|
|
13478
|
+
},
|
|
13479
|
+
{
|
|
13480
|
+
"kind": "method",
|
|
13481
|
+
"name": "showHint",
|
|
13482
|
+
"privacy": "private",
|
|
13483
|
+
"return": {
|
|
13484
|
+
"type": {
|
|
13485
|
+
"text": "void"
|
|
13486
|
+
}
|
|
13487
|
+
},
|
|
13488
|
+
"parameters": [
|
|
13489
|
+
{
|
|
13490
|
+
"name": "words",
|
|
13491
|
+
"type": {
|
|
13492
|
+
"text": "string"
|
|
13493
|
+
}
|
|
13494
|
+
},
|
|
13495
|
+
{
|
|
13496
|
+
"name": "at",
|
|
13497
|
+
"optional": true,
|
|
13498
|
+
"type": {
|
|
13499
|
+
"text": "{ clientX: number; clientY: number }"
|
|
13500
|
+
}
|
|
13501
|
+
}
|
|
13502
|
+
],
|
|
13503
|
+
"description": "Shows a hint over the surface for a moment, where the gesture was.",
|
|
13504
|
+
"inheritedFrom": {
|
|
13505
|
+
"name": "MixinViewport",
|
|
13506
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13507
|
+
}
|
|
13508
|
+
},
|
|
13509
|
+
{
|
|
13510
|
+
"kind": "field",
|
|
13511
|
+
"name": "handleGestureWheel",
|
|
13512
|
+
"privacy": "private",
|
|
13513
|
+
"readonly": true,
|
|
13514
|
+
"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.",
|
|
13515
|
+
"inheritedFrom": {
|
|
13516
|
+
"name": "MixinViewport",
|
|
13517
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13518
|
+
}
|
|
13519
|
+
},
|
|
13520
|
+
{
|
|
13521
|
+
"kind": "field",
|
|
13522
|
+
"name": "handleGestureTouch",
|
|
13523
|
+
"privacy": "private",
|
|
13524
|
+
"readonly": true,
|
|
13525
|
+
"description": "One finger moving over the surface, which scrolls the page, and is said.",
|
|
13526
|
+
"inheritedFrom": {
|
|
13527
|
+
"name": "MixinViewport",
|
|
13528
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13529
|
+
}
|
|
13530
|
+
},
|
|
13531
|
+
{
|
|
13532
|
+
"kind": "field",
|
|
13533
|
+
"name": "handleTake",
|
|
13534
|
+
"privacy": "private",
|
|
13535
|
+
"readonly": true,
|
|
13536
|
+
"description": "A press on the surface itself, which hands a waiting surface the gestures.",
|
|
13537
|
+
"inheritedFrom": {
|
|
13538
|
+
"name": "MixinViewport",
|
|
13539
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13540
|
+
}
|
|
13541
|
+
},
|
|
13542
|
+
{
|
|
13543
|
+
"kind": "field",
|
|
13544
|
+
"name": "handleGiveBackKey",
|
|
13545
|
+
"privacy": "private",
|
|
13546
|
+
"readonly": true,
|
|
13547
|
+
"description": "Escape, which gives the page its scroll back.",
|
|
13548
|
+
"inheritedFrom": {
|
|
13549
|
+
"name": "MixinViewport",
|
|
13550
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13551
|
+
}
|
|
13552
|
+
},
|
|
13553
|
+
{
|
|
13554
|
+
"kind": "field",
|
|
13555
|
+
"name": "handleGiveBackOutside",
|
|
13556
|
+
"privacy": "private",
|
|
13557
|
+
"readonly": true,
|
|
13558
|
+
"description": "A press anywhere else on the page, which gives it its scroll back.",
|
|
13559
|
+
"inheritedFrom": {
|
|
13560
|
+
"name": "MixinViewport",
|
|
13561
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13562
|
+
}
|
|
13563
|
+
},
|
|
13564
|
+
{
|
|
13565
|
+
"kind": "field",
|
|
13566
|
+
"name": "handleGiveBackBlur",
|
|
13567
|
+
"privacy": "private",
|
|
13568
|
+
"readonly": true,
|
|
13569
|
+
"description": "The window losing focus, as a reader switching away does.",
|
|
13570
|
+
"inheritedFrom": {
|
|
13571
|
+
"name": "MixinViewport",
|
|
13572
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13573
|
+
}
|
|
13574
|
+
},
|
|
13575
|
+
{
|
|
13576
|
+
"kind": "field",
|
|
13577
|
+
"name": "handlePointerLeave",
|
|
13578
|
+
"privacy": "protected",
|
|
13579
|
+
"readonly": true,
|
|
13580
|
+
"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.",
|
|
13581
|
+
"inheritedFrom": {
|
|
13582
|
+
"name": "MixinViewport",
|
|
13583
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13584
|
+
}
|
|
13585
|
+
},
|
|
13586
|
+
{
|
|
13587
|
+
"kind": "method",
|
|
13588
|
+
"name": "renderGestures",
|
|
13589
|
+
"privacy": "protected",
|
|
13590
|
+
"return": {
|
|
13591
|
+
"type": {
|
|
13592
|
+
"text": "TemplateResult"
|
|
13593
|
+
}
|
|
13594
|
+
},
|
|
13595
|
+
"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.",
|
|
13596
|
+
"inheritedFrom": {
|
|
13597
|
+
"name": "MixinViewport",
|
|
13598
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
13599
|
+
}
|
|
13600
|
+
},
|
|
13280
13601
|
{
|
|
13281
13602
|
"kind": "method",
|
|
13282
13603
|
"name": "toggleFullscreen",
|
|
@@ -14034,6 +14355,18 @@
|
|
|
14034
14355
|
"description": "What each tone means on this board, in words read out with the cards and\nconnections in it, such as `{\"danger\": \"Blocked\", \"success\": \"Done\"}`.\n\n**Named by the page, since the tone names a color and the page gives it\nits meaning.** JSON Canvas leaves its six colors to the application, so\nred is \"blocked\" on one board and \"urgent\" on the next. A reader who can\nsee the board is told by the color; this is how a reader who cannot is\ntold the same. A tone left out is not read.",
|
|
14035
14356
|
"fieldName": "toneLabels"
|
|
14036
14357
|
},
|
|
14358
|
+
{
|
|
14359
|
+
"name": "activate-hint-label",
|
|
14360
|
+
"type": {
|
|
14361
|
+
"text": "string | undefined"
|
|
14362
|
+
},
|
|
14363
|
+
"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.",
|
|
14364
|
+
"fieldName": "activateHintLabel",
|
|
14365
|
+
"inheritedFrom": {
|
|
14366
|
+
"name": "MixinViewport",
|
|
14367
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14368
|
+
}
|
|
14369
|
+
},
|
|
14037
14370
|
{
|
|
14038
14371
|
"name": "controls",
|
|
14039
14372
|
"type": {
|
|
@@ -14083,6 +14416,18 @@
|
|
|
14083
14416
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14084
14417
|
}
|
|
14085
14418
|
},
|
|
14419
|
+
{
|
|
14420
|
+
"name": "gestures",
|
|
14421
|
+
"type": {
|
|
14422
|
+
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
14423
|
+
},
|
|
14424
|
+
"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.",
|
|
14425
|
+
"fieldName": "gestures",
|
|
14426
|
+
"inheritedFrom": {
|
|
14427
|
+
"name": "MixinViewport",
|
|
14428
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14429
|
+
}
|
|
14430
|
+
},
|
|
14086
14431
|
{
|
|
14087
14432
|
"name": "idle-delay",
|
|
14088
14433
|
"type": {
|
|
@@ -14161,6 +14506,42 @@
|
|
|
14161
14506
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14162
14507
|
}
|
|
14163
14508
|
},
|
|
14509
|
+
{
|
|
14510
|
+
"name": "two-finger-hint-label",
|
|
14511
|
+
"type": {
|
|
14512
|
+
"text": "string | undefined"
|
|
14513
|
+
},
|
|
14514
|
+
"description": "The hint shown when one finger swipes over a surface with\n`gestures=\"cooperative\"`. Absent is the family's own.",
|
|
14515
|
+
"fieldName": "twoFingerHintLabel",
|
|
14516
|
+
"inheritedFrom": {
|
|
14517
|
+
"name": "MixinViewport",
|
|
14518
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14519
|
+
}
|
|
14520
|
+
},
|
|
14521
|
+
{
|
|
14522
|
+
"name": "using-label",
|
|
14523
|
+
"type": {
|
|
14524
|
+
"text": "string | undefined"
|
|
14525
|
+
},
|
|
14526
|
+
"description": "The line shown while a surface with `gestures=\"activate\"` has the\ngestures. Absent is the family's own.",
|
|
14527
|
+
"fieldName": "usingLabel",
|
|
14528
|
+
"inheritedFrom": {
|
|
14529
|
+
"name": "MixinViewport",
|
|
14530
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14531
|
+
}
|
|
14532
|
+
},
|
|
14533
|
+
{
|
|
14534
|
+
"name": "wheel-hint-label",
|
|
14535
|
+
"type": {
|
|
14536
|
+
"text": "string | undefined"
|
|
14537
|
+
},
|
|
14538
|
+
"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.",
|
|
14539
|
+
"fieldName": "wheelHintLabel",
|
|
14540
|
+
"inheritedFrom": {
|
|
14541
|
+
"name": "MixinViewport",
|
|
14542
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
14543
|
+
}
|
|
14544
|
+
},
|
|
14164
14545
|
{
|
|
14165
14546
|
"name": "zoom-in-label",
|
|
14166
14547
|
"type": {
|
|
@@ -14217,6 +14598,14 @@
|
|
|
14217
14598
|
"description": "While a press on the board, its cards or its connections is under way.",
|
|
14218
14599
|
"name": "pressing"
|
|
14219
14600
|
},
|
|
14601
|
+
{
|
|
14602
|
+
"description": "The page keeps the plain wheel and one finger, with `gestures=\"cooperative\"` or while a board with `gestures=\"activate\"` waits to be pressed.",
|
|
14603
|
+
"name": "sharing"
|
|
14604
|
+
},
|
|
14605
|
+
{
|
|
14606
|
+
"description": "A board with `gestures=\"activate\"` has been pressed and has the gestures.",
|
|
14607
|
+
"name": "using"
|
|
14608
|
+
},
|
|
14220
14609
|
{
|
|
14221
14610
|
"description": "Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.",
|
|
14222
14611
|
"name": "settled",
|
|
@@ -49568,538 +49957,3078 @@
|
|
|
49568
49957
|
},
|
|
49569
49958
|
{
|
|
49570
49959
|
"kind": "javascript-module",
|
|
49571
|
-
"path": "src/
|
|
49960
|
+
"path": "src/graph/index.ts",
|
|
49572
49961
|
"declarations": [],
|
|
49573
49962
|
"exports": [
|
|
49574
49963
|
{
|
|
49575
49964
|
"kind": "js",
|
|
49576
|
-
"name": "
|
|
49965
|
+
"name": "Adjacency",
|
|
49577
49966
|
"declaration": {
|
|
49578
|
-
"name": "
|
|
49579
|
-
"module": "./root/
|
|
49967
|
+
"name": "Adjacency",
|
|
49968
|
+
"module": "./root/graph-model.js"
|
|
49580
49969
|
}
|
|
49581
49970
|
},
|
|
49582
49971
|
{
|
|
49583
49972
|
"kind": "js",
|
|
49584
|
-
"name": "
|
|
49973
|
+
"name": "Entry",
|
|
49585
49974
|
"declaration": {
|
|
49586
|
-
"name": "
|
|
49587
|
-
"module": "./root/
|
|
49975
|
+
"name": "Entry",
|
|
49976
|
+
"module": "./root/graph-model.js"
|
|
49588
49977
|
}
|
|
49589
49978
|
},
|
|
49590
49979
|
{
|
|
49591
49980
|
"kind": "js",
|
|
49592
|
-
"name": "
|
|
49981
|
+
"name": "GraphLink",
|
|
49593
49982
|
"declaration": {
|
|
49594
|
-
"name": "
|
|
49595
|
-
"module": "./root/
|
|
49983
|
+
"name": "GraphLink",
|
|
49984
|
+
"module": "./root/graph-model.js"
|
|
49596
49985
|
}
|
|
49597
49986
|
},
|
|
49598
49987
|
{
|
|
49599
49988
|
"kind": "js",
|
|
49600
|
-
"name": "
|
|
49989
|
+
"name": "GraphNode",
|
|
49601
49990
|
"declaration": {
|
|
49602
|
-
"name": "
|
|
49603
|
-
"module": "./root/
|
|
49991
|
+
"name": "GraphNode",
|
|
49992
|
+
"module": "./root/graph-model.js"
|
|
49993
|
+
}
|
|
49994
|
+
},
|
|
49995
|
+
{
|
|
49996
|
+
"kind": "js",
|
|
49997
|
+
"name": "Relation",
|
|
49998
|
+
"declaration": {
|
|
49999
|
+
"name": "Relation",
|
|
50000
|
+
"module": "./root/graph-model.js"
|
|
50001
|
+
}
|
|
50002
|
+
},
|
|
50003
|
+
{
|
|
50004
|
+
"kind": "js",
|
|
50005
|
+
"name": "adjacencyOf",
|
|
50006
|
+
"declaration": {
|
|
50007
|
+
"name": "adjacencyOf",
|
|
50008
|
+
"module": "./root/graph-model.js"
|
|
50009
|
+
}
|
|
50010
|
+
},
|
|
50011
|
+
{
|
|
50012
|
+
"kind": "js",
|
|
50013
|
+
"name": "entriesOf",
|
|
50014
|
+
"declaration": {
|
|
50015
|
+
"name": "entriesOf",
|
|
50016
|
+
"module": "./root/graph-model.js"
|
|
50017
|
+
}
|
|
50018
|
+
},
|
|
50019
|
+
{
|
|
50020
|
+
"kind": "js",
|
|
50021
|
+
"name": "nameOf",
|
|
50022
|
+
"declaration": {
|
|
50023
|
+
"name": "nameOf",
|
|
50024
|
+
"module": "./root/graph-model.js"
|
|
50025
|
+
}
|
|
50026
|
+
},
|
|
50027
|
+
{
|
|
50028
|
+
"kind": "js",
|
|
50029
|
+
"name": "sortedOf",
|
|
50030
|
+
"declaration": {
|
|
50031
|
+
"name": "sortedOf",
|
|
50032
|
+
"module": "./root/graph-model.js"
|
|
50033
|
+
}
|
|
50034
|
+
},
|
|
50035
|
+
{
|
|
50036
|
+
"kind": "js",
|
|
50037
|
+
"name": "within",
|
|
50038
|
+
"declaration": {
|
|
50039
|
+
"name": "within",
|
|
50040
|
+
"module": "./root/graph-model.js"
|
|
50041
|
+
}
|
|
50042
|
+
},
|
|
50043
|
+
{
|
|
50044
|
+
"kind": "js",
|
|
50045
|
+
"name": "HelixHeadlessGraph",
|
|
50046
|
+
"declaration": {
|
|
50047
|
+
"name": "HelixHeadlessGraph",
|
|
50048
|
+
"module": "./root/graph-root.js"
|
|
49604
50049
|
}
|
|
49605
50050
|
}
|
|
49606
50051
|
]
|
|
49607
50052
|
},
|
|
49608
50053
|
{
|
|
49609
50054
|
"kind": "javascript-module",
|
|
49610
|
-
"path": "src/
|
|
50055
|
+
"path": "src/graph/root/graph-model.ts",
|
|
49611
50056
|
"declarations": [
|
|
49612
50057
|
{
|
|
49613
50058
|
"kind": "function",
|
|
49614
|
-
"name": "
|
|
50059
|
+
"name": "nameOf",
|
|
49615
50060
|
"return": {
|
|
49616
50061
|
"type": {
|
|
49617
|
-
"text": "string
|
|
50062
|
+
"text": "string"
|
|
49618
50063
|
}
|
|
49619
50064
|
},
|
|
49620
50065
|
"parameters": [
|
|
49621
50066
|
{
|
|
49622
|
-
"name": "
|
|
50067
|
+
"name": "node",
|
|
49623
50068
|
"type": {
|
|
49624
|
-
"text": "
|
|
50069
|
+
"text": "GraphNode"
|
|
50070
|
+
}
|
|
50071
|
+
}
|
|
50072
|
+
],
|
|
50073
|
+
"description": "A note's name, its `id` where it has no label."
|
|
50074
|
+
},
|
|
50075
|
+
{
|
|
50076
|
+
"kind": "function",
|
|
50077
|
+
"name": "adjacencyOf",
|
|
50078
|
+
"return": {
|
|
50079
|
+
"type": {
|
|
50080
|
+
"text": "Adjacency"
|
|
50081
|
+
}
|
|
50082
|
+
},
|
|
50083
|
+
"parameters": [
|
|
50084
|
+
{
|
|
50085
|
+
"name": "links",
|
|
50086
|
+
"type": {
|
|
50087
|
+
"text": "readonly GraphLink[]"
|
|
50088
|
+
}
|
|
50089
|
+
}
|
|
50090
|
+
],
|
|
50091
|
+
"description": "Which notes each note links to and is linked from, in one pass over the\nlinks. A link naming a note that is not in the graph is kept: the list\nshows notes and not links, so it does no harm, and a page adding the note a\nmoment later finds its links already counted."
|
|
50092
|
+
},
|
|
50093
|
+
{
|
|
50094
|
+
"kind": "function",
|
|
50095
|
+
"name": "within",
|
|
50096
|
+
"return": {
|
|
50097
|
+
"type": {
|
|
50098
|
+
"text": "Set<string>"
|
|
50099
|
+
}
|
|
50100
|
+
},
|
|
50101
|
+
"parameters": [
|
|
50102
|
+
{
|
|
50103
|
+
"name": "adjacency",
|
|
50104
|
+
"type": {
|
|
50105
|
+
"text": "Adjacency"
|
|
49625
50106
|
}
|
|
49626
50107
|
},
|
|
49627
50108
|
{
|
|
49628
|
-
"name": "
|
|
50109
|
+
"name": "from",
|
|
49629
50110
|
"type": {
|
|
49630
|
-
"text": "
|
|
50111
|
+
"text": "string"
|
|
49631
50112
|
}
|
|
49632
50113
|
},
|
|
49633
50114
|
{
|
|
49634
|
-
"name": "
|
|
50115
|
+
"name": "depth",
|
|
49635
50116
|
"type": {
|
|
49636
|
-
"text": "
|
|
50117
|
+
"text": "number"
|
|
49637
50118
|
}
|
|
49638
50119
|
}
|
|
49639
50120
|
],
|
|
49640
|
-
"description": "The
|
|
50121
|
+
"description": "The notes within `depth` links of `from`, whichever way each link runs, the\nnote itself included: the local graph.\n\n**Both ways, as a reader thinks of a note's neighborhood**: a note that\ncites this one is as near to it as one this one cites."
|
|
49641
50122
|
},
|
|
49642
50123
|
{
|
|
49643
50124
|
"kind": "function",
|
|
49644
|
-
"name": "
|
|
50125
|
+
"name": "entriesOf",
|
|
49645
50126
|
"return": {
|
|
49646
50127
|
"type": {
|
|
49647
|
-
"text": "
|
|
50128
|
+
"text": "Entry[]"
|
|
49648
50129
|
}
|
|
49649
50130
|
},
|
|
49650
50131
|
"parameters": [
|
|
49651
50132
|
{
|
|
49652
|
-
"name": "
|
|
50133
|
+
"name": "sorted",
|
|
49653
50134
|
"type": {
|
|
49654
|
-
"text": "
|
|
50135
|
+
"text": "readonly GraphNode[]"
|
|
49655
50136
|
}
|
|
49656
50137
|
},
|
|
49657
50138
|
{
|
|
49658
|
-
"name": "
|
|
50139
|
+
"name": "adjacency",
|
|
49659
50140
|
"type": {
|
|
49660
|
-
"text": "
|
|
50141
|
+
"text": "Adjacency"
|
|
49661
50142
|
}
|
|
49662
50143
|
},
|
|
49663
50144
|
{
|
|
49664
|
-
"name": "
|
|
50145
|
+
"name": "active",
|
|
49665
50146
|
"type": {
|
|
49666
|
-
"text": "
|
|
50147
|
+
"text": "string"
|
|
49667
50148
|
}
|
|
49668
50149
|
},
|
|
49669
50150
|
{
|
|
49670
|
-
"name": "
|
|
50151
|
+
"name": "query",
|
|
49671
50152
|
"type": {
|
|
49672
|
-
"text": "
|
|
50153
|
+
"text": "string"
|
|
49673
50154
|
}
|
|
49674
50155
|
},
|
|
49675
50156
|
{
|
|
49676
|
-
"name": "
|
|
49677
|
-
"
|
|
50157
|
+
"name": "shown",
|
|
50158
|
+
"optional": true,
|
|
50159
|
+
"type": {
|
|
50160
|
+
"text": "ReadonlySet<string>"
|
|
50161
|
+
}
|
|
49678
50162
|
}
|
|
49679
50163
|
],
|
|
49680
|
-
"description": "
|
|
50164
|
+
"description": "The list's rows, in the order a reader wants them: the selected note, then\nthe notes it links to and from, then every other note, each part in the\norder of its names, and only the notes `shown` holds and `query` matches.\n\n**The neighborhood first**, because it is what a reader came to the graph\nfor and what a picture of it shows by its lines, which a list has to say in\nits order instead."
|
|
50165
|
+
},
|
|
50166
|
+
{
|
|
50167
|
+
"kind": "function",
|
|
50168
|
+
"name": "sortedOf",
|
|
50169
|
+
"return": {
|
|
50170
|
+
"type": {
|
|
50171
|
+
"text": "GraphNode[]"
|
|
50172
|
+
}
|
|
50173
|
+
},
|
|
50174
|
+
"parameters": [
|
|
50175
|
+
{
|
|
50176
|
+
"name": "nodes",
|
|
50177
|
+
"type": {
|
|
50178
|
+
"text": "readonly GraphNode[]"
|
|
50179
|
+
}
|
|
50180
|
+
},
|
|
50181
|
+
{
|
|
50182
|
+
"name": "lang",
|
|
50183
|
+
"optional": true,
|
|
50184
|
+
"type": {
|
|
50185
|
+
"text": "string"
|
|
50186
|
+
}
|
|
50187
|
+
}
|
|
50188
|
+
],
|
|
50189
|
+
"description": "The notes in the order of their names, as the page's language orders words."
|
|
49681
50190
|
}
|
|
49682
50191
|
],
|
|
49683
50192
|
"exports": [
|
|
49684
50193
|
{
|
|
49685
50194
|
"kind": "js",
|
|
49686
|
-
"name": "
|
|
50195
|
+
"name": "nameOf",
|
|
49687
50196
|
"declaration": {
|
|
49688
|
-
"name": "
|
|
49689
|
-
"module": "src/
|
|
50197
|
+
"name": "nameOf",
|
|
50198
|
+
"module": "src/graph/root/graph-model.ts"
|
|
49690
50199
|
}
|
|
49691
50200
|
},
|
|
49692
50201
|
{
|
|
49693
50202
|
"kind": "js",
|
|
49694
|
-
"name": "
|
|
50203
|
+
"name": "adjacencyOf",
|
|
49695
50204
|
"declaration": {
|
|
49696
|
-
"name": "
|
|
49697
|
-
"module": "src/
|
|
50205
|
+
"name": "adjacencyOf",
|
|
50206
|
+
"module": "src/graph/root/graph-model.ts"
|
|
50207
|
+
}
|
|
50208
|
+
},
|
|
50209
|
+
{
|
|
50210
|
+
"kind": "js",
|
|
50211
|
+
"name": "within",
|
|
50212
|
+
"declaration": {
|
|
50213
|
+
"name": "within",
|
|
50214
|
+
"module": "src/graph/root/graph-model.ts"
|
|
50215
|
+
}
|
|
50216
|
+
},
|
|
50217
|
+
{
|
|
50218
|
+
"kind": "js",
|
|
50219
|
+
"name": "entriesOf",
|
|
50220
|
+
"declaration": {
|
|
50221
|
+
"name": "entriesOf",
|
|
50222
|
+
"module": "src/graph/root/graph-model.ts"
|
|
50223
|
+
}
|
|
50224
|
+
},
|
|
50225
|
+
{
|
|
50226
|
+
"kind": "js",
|
|
50227
|
+
"name": "sortedOf",
|
|
50228
|
+
"declaration": {
|
|
50229
|
+
"name": "sortedOf",
|
|
50230
|
+
"module": "src/graph/root/graph-model.ts"
|
|
49698
50231
|
}
|
|
49699
50232
|
}
|
|
49700
50233
|
]
|
|
49701
50234
|
},
|
|
49702
50235
|
{
|
|
49703
50236
|
"kind": "javascript-module",
|
|
49704
|
-
"path": "src/
|
|
50237
|
+
"path": "src/graph/root/graph-root.ts",
|
|
49705
50238
|
"declarations": [
|
|
49706
50239
|
{
|
|
49707
50240
|
"kind": "class",
|
|
49708
|
-
"description": "A
|
|
49709
|
-
"name": "
|
|
49710
|
-
"
|
|
50241
|
+
"description": "Helix draws no graph. A force layout of thousands of notes is physics and\nWebGL, which a renderer such as Sigma.js does. Put the renderer's box in the\nframe, and `connectGraph` from `@fusion.dev/helix-graph` draws `nodes` and\n`links` in it and keeps it in step with the frame.\n\nWhat the frame adds is what a drawing of a graph cannot do: a list of every\nnote beside it, which is the graph for a screen reader and a quick way to\nfind a note for anyone. The selected note comes first, then the notes it\nlinks to and from, then every other note, and the search field narrows it.\nSelecting a note in the list or in the drawing is the same selection.\n\nSet `depth` to show the local graph: only the notes within that many links\nof the selected one.\n\n`nodes` and `links` are properties, never markup: a graph of ten thousand\nnotes as ten thousand elements would cost what the renderer exists to save.\nThe list draws only the rows in view.\n\nThe list scrolls on this tier. It carries `data-scroller`, and `core` ships\n`[data-scroller] { overflow: auto }` into every shadow root. You still need\nto set a block size on the list, or it grows to hold every row.",
|
|
50242
|
+
"name": "HelixHeadlessGraph",
|
|
50243
|
+
"cssParts": [
|
|
49711
50244
|
{
|
|
49712
|
-
"description": "
|
|
49713
|
-
"name": "
|
|
50245
|
+
"description": "The room the notes after those drawn would take, so the list scrolls its whole length.",
|
|
50246
|
+
"name": "after"
|
|
49714
50247
|
},
|
|
49715
50248
|
{
|
|
49716
|
-
"description": "The
|
|
49717
|
-
"name": "
|
|
50249
|
+
"description": "The room the notes before those drawn would take.",
|
|
50250
|
+
"name": "before"
|
|
49718
50251
|
},
|
|
49719
50252
|
{
|
|
49720
|
-
"description": "The
|
|
49721
|
-
"name": "
|
|
50253
|
+
"description": "The drawing beside the list, or above it where the frame is narrow.",
|
|
50254
|
+
"name": "body"
|
|
49722
50255
|
},
|
|
49723
50256
|
{
|
|
49724
|
-
"description": "The
|
|
49725
|
-
"name": "
|
|
50257
|
+
"description": "The group the pan and zoom buttons sit in.",
|
|
50258
|
+
"name": "controls"
|
|
49726
50259
|
},
|
|
49727
50260
|
{
|
|
49728
|
-
"description": "
|
|
49729
|
-
"name": "
|
|
50261
|
+
"description": "How many notes the list holds, which a search narrows, at the end of the search bar.",
|
|
50262
|
+
"name": "count"
|
|
49730
50263
|
},
|
|
49731
50264
|
{
|
|
49732
|
-
"description": "The
|
|
49733
|
-
"name": "
|
|
50265
|
+
"description": "The icon beside the search field.",
|
|
50266
|
+
"name": "filter-icon"
|
|
49734
50267
|
},
|
|
49735
50268
|
{
|
|
49736
|
-
"description": "The
|
|
49737
|
-
"name": "
|
|
50269
|
+
"description": "The default icon beside the search field, shown when none is slotted.",
|
|
50270
|
+
"name": "filter-mark"
|
|
49738
50271
|
},
|
|
49739
50272
|
{
|
|
49740
|
-
"description": "The
|
|
49741
|
-
"name": "
|
|
50273
|
+
"description": "The strip below the graph.",
|
|
50274
|
+
"name": "footer"
|
|
49742
50275
|
},
|
|
49743
50276
|
{
|
|
49744
|
-
"description": "The
|
|
49745
|
-
"name": "
|
|
50277
|
+
"description": "The button that makes the graph fill the screen.",
|
|
50278
|
+
"name": "fullscreen"
|
|
49746
50279
|
},
|
|
49747
50280
|
{
|
|
49748
|
-
"description": "
|
|
49749
|
-
"name": "
|
|
50281
|
+
"description": "Words over the graph for a moment when it lets a gesture pass to the page, such as how to zoom it.",
|
|
50282
|
+
"name": "gesture-hint"
|
|
49750
50283
|
},
|
|
49751
50284
|
{
|
|
49752
|
-
"description": "The
|
|
49753
|
-
"name": "
|
|
50285
|
+
"description": "The line shown while a graph with `gestures=\"activate\"` has the gestures.",
|
|
50286
|
+
"name": "gesture-status"
|
|
49754
50287
|
},
|
|
49755
50288
|
{
|
|
49756
|
-
"description": "The
|
|
49757
|
-
"name": "
|
|
50289
|
+
"description": "The strip above the graph.",
|
|
50290
|
+
"name": "header"
|
|
49758
50291
|
},
|
|
49759
50292
|
{
|
|
49760
|
-
"description": "The
|
|
49761
|
-
"name": "
|
|
50293
|
+
"description": "The list of notes, which draws only the rows in view.",
|
|
50294
|
+
"name": "list"
|
|
49762
50295
|
},
|
|
49763
50296
|
{
|
|
49764
|
-
"description": "
|
|
49765
|
-
"name": "
|
|
49766
|
-
}
|
|
49767
|
-
],
|
|
49768
|
-
"cssParts": [
|
|
49769
|
-
{
|
|
49770
|
-
"description": "One reading.",
|
|
49771
|
-
"name": "cell"
|
|
50297
|
+
"description": "What screen readers hear when a search changes how many notes there are.",
|
|
50298
|
+
"name": "live"
|
|
49772
50299
|
},
|
|
49773
50300
|
{
|
|
49774
|
-
"description": "
|
|
49775
|
-
"name": "
|
|
50301
|
+
"description": "One note in the list.",
|
|
50302
|
+
"name": "note"
|
|
49776
50303
|
},
|
|
49777
50304
|
{
|
|
49778
|
-
"description": "The
|
|
49779
|
-
"name": "
|
|
50305
|
+
"description": "The note the keyboard is on in the list.",
|
|
50306
|
+
"name": "note-cursor"
|
|
49780
50307
|
},
|
|
49781
50308
|
{
|
|
49782
|
-
"description": "
|
|
49783
|
-
"name": "
|
|
50309
|
+
"description": "A note linked to or from the selected one.",
|
|
50310
|
+
"name": "note-linked"
|
|
49784
50311
|
},
|
|
49785
50312
|
{
|
|
49786
|
-
"description": "
|
|
49787
|
-
"name": "
|
|
50313
|
+
"description": "A note's name in the list.",
|
|
50314
|
+
"name": "note-name"
|
|
49788
50315
|
},
|
|
49789
50316
|
{
|
|
49790
|
-
"description": "
|
|
49791
|
-
"name": "
|
|
50317
|
+
"description": "How a note stands to the selected one, such as \"Linked from Alpha\".",
|
|
50318
|
+
"name": "note-relation"
|
|
49792
50319
|
},
|
|
49793
50320
|
{
|
|
49794
|
-
"description": "The
|
|
49795
|
-
"name": "
|
|
50321
|
+
"description": "The selected note, first in the list.",
|
|
50322
|
+
"name": "note-selected"
|
|
49796
50323
|
},
|
|
49797
50324
|
{
|
|
49798
|
-
"description": "The
|
|
49799
|
-
"name": "
|
|
50325
|
+
"description": "The button that moves the graph down.",
|
|
50326
|
+
"name": "pan-down"
|
|
49800
50327
|
},
|
|
49801
50328
|
{
|
|
49802
|
-
"description": "The
|
|
49803
|
-
"name": "
|
|
50329
|
+
"description": "The button that moves the graph toward the end of a line of text: right in English.",
|
|
50330
|
+
"name": "pan-end"
|
|
49804
50331
|
},
|
|
49805
50332
|
{
|
|
49806
|
-
"description": "The
|
|
49807
|
-
"name": "
|
|
50333
|
+
"description": "The button that moves the graph toward the start of a line of text: left in English.",
|
|
50334
|
+
"name": "pan-start"
|
|
49808
50335
|
},
|
|
49809
50336
|
{
|
|
49810
|
-
"description": "The
|
|
49811
|
-
"name": "
|
|
50337
|
+
"description": "The button that moves the graph up.",
|
|
50338
|
+
"name": "pan-up"
|
|
49812
50339
|
},
|
|
49813
50340
|
{
|
|
49814
|
-
"description": "The
|
|
49815
|
-
"name": "
|
|
50341
|
+
"description": "The search field and the list, beside the drawing or below it.",
|
|
50342
|
+
"name": "panel"
|
|
49816
50343
|
},
|
|
49817
50344
|
{
|
|
49818
|
-
"description": "The
|
|
49819
|
-
"name": "
|
|
50345
|
+
"description": "The frame: the drawing, its controls and the list.",
|
|
50346
|
+
"name": "region"
|
|
49820
50347
|
},
|
|
49821
50348
|
{
|
|
49822
|
-
"description": "The
|
|
49823
|
-
"name": "
|
|
50349
|
+
"description": "The bar holding the icon, the search field and the count.",
|
|
50350
|
+
"name": "search"
|
|
49824
50351
|
},
|
|
49825
50352
|
{
|
|
49826
|
-
"description": "The
|
|
49827
|
-
"name": "
|
|
50353
|
+
"description": "The field that finds a note by its name.",
|
|
50354
|
+
"name": "search-field"
|
|
49828
50355
|
},
|
|
49829
50356
|
{
|
|
49830
|
-
"description": "The
|
|
49831
|
-
"name": "
|
|
50357
|
+
"description": "The drawing and its controls.",
|
|
50358
|
+
"name": "stage"
|
|
49832
50359
|
},
|
|
49833
50360
|
{
|
|
49834
|
-
"description": "
|
|
49835
|
-
"name": "
|
|
50361
|
+
"description": "The box the renderer draws in.",
|
|
50362
|
+
"name": "viewport"
|
|
49836
50363
|
},
|
|
49837
50364
|
{
|
|
49838
|
-
"description": "The
|
|
49839
|
-
"name": "
|
|
50365
|
+
"description": "The zoom in button.",
|
|
50366
|
+
"name": "zoom-in"
|
|
49840
50367
|
},
|
|
49841
50368
|
{
|
|
49842
|
-
"description": "The
|
|
49843
|
-
"name": "
|
|
49844
|
-
}
|
|
50369
|
+
"description": "The zoom out button.",
|
|
50370
|
+
"name": "zoom-out"
|
|
50371
|
+
}
|
|
50372
|
+
],
|
|
50373
|
+
"slots": [
|
|
49845
50374
|
{
|
|
49846
|
-
"description": "
|
|
49847
|
-
"name": "
|
|
50375
|
+
"description": "The renderer's box, which the drawing is made in.",
|
|
50376
|
+
"name": ""
|
|
49848
50377
|
},
|
|
49849
50378
|
{
|
|
49850
|
-
"description": "The
|
|
49851
|
-
"name": "
|
|
50379
|
+
"description": "The icon in the search field. Defaults to a magnifying glass.",
|
|
50380
|
+
"name": "filter-icon"
|
|
49852
50381
|
},
|
|
49853
50382
|
{
|
|
49854
|
-
"description": "
|
|
49855
|
-
"name": "
|
|
50383
|
+
"description": "Content below the graph.",
|
|
50384
|
+
"name": "footer"
|
|
49856
50385
|
},
|
|
49857
50386
|
{
|
|
49858
|
-
"description": "
|
|
49859
|
-
"name": "
|
|
50387
|
+
"description": "Content above the graph.",
|
|
50388
|
+
"name": "header"
|
|
49860
50389
|
}
|
|
49861
50390
|
],
|
|
49862
|
-
"
|
|
50391
|
+
"members": [
|
|
49863
50392
|
{
|
|
49864
|
-
"
|
|
49865
|
-
"name": "
|
|
50393
|
+
"kind": "field",
|
|
50394
|
+
"name": "countLabel",
|
|
50395
|
+
"type": {
|
|
50396
|
+
"text": "string"
|
|
50397
|
+
},
|
|
50398
|
+
"default": "'{count} notes'",
|
|
50399
|
+
"description": "What the list says of a note's count, with `{count}`.",
|
|
50400
|
+
"attribute": "count-label"
|
|
49866
50401
|
},
|
|
49867
50402
|
{
|
|
49868
|
-
"
|
|
49869
|
-
"name": "
|
|
50403
|
+
"kind": "field",
|
|
50404
|
+
"name": "depth",
|
|
50405
|
+
"type": {
|
|
50406
|
+
"text": "number | undefined"
|
|
50407
|
+
},
|
|
50408
|
+
"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.",
|
|
50409
|
+
"attribute": "depth"
|
|
49870
50410
|
},
|
|
49871
|
-
{
|
|
49872
|
-
"description": "Below the strip, in the middle: a summary of the range shown.",
|
|
49873
|
-
"name": "summary"
|
|
49874
|
-
}
|
|
49875
|
-
],
|
|
49876
|
-
"members": [
|
|
49877
50411
|
{
|
|
49878
50412
|
"kind": "field",
|
|
49879
|
-
"name": "
|
|
50413
|
+
"name": "label",
|
|
49880
50414
|
"type": {
|
|
49881
50415
|
"text": "string"
|
|
49882
50416
|
},
|
|
49883
|
-
"default": "'
|
|
49884
|
-
"description": "
|
|
49885
|
-
"attribute": "
|
|
50417
|
+
"default": "''",
|
|
50418
|
+
"description": "The graph's name, read by screen readers, such as \"Research notes\".\nRequired.",
|
|
50419
|
+
"attribute": "label"
|
|
49886
50420
|
},
|
|
49887
50421
|
{
|
|
49888
50422
|
"kind": "field",
|
|
49889
|
-
"name": "
|
|
50423
|
+
"name": "linkedBothLabel",
|
|
49890
50424
|
"type": {
|
|
49891
|
-
"text": "
|
|
50425
|
+
"text": "string"
|
|
49892
50426
|
},
|
|
49893
|
-
"default": "
|
|
49894
|
-
"description": "
|
|
49895
|
-
"attribute": "
|
|
50427
|
+
"default": "'Linked both ways with {note}'",
|
|
50428
|
+
"description": "How a note linked both to and from the selected one is described, with `{note}`.",
|
|
50429
|
+
"attribute": "linked-both-label"
|
|
49896
50430
|
},
|
|
49897
50431
|
{
|
|
49898
50432
|
"kind": "field",
|
|
49899
|
-
"name": "
|
|
50433
|
+
"name": "linkedFromLabel",
|
|
49900
50434
|
"type": {
|
|
49901
|
-
"text": "
|
|
50435
|
+
"text": "string"
|
|
49902
50436
|
},
|
|
49903
|
-
"default": "
|
|
49904
|
-
"description": "
|
|
49905
|
-
"attribute": "
|
|
50437
|
+
"default": "'Linked from {note}'",
|
|
50438
|
+
"description": "How a note the selected one links to is described, with `{note}`, the selected note's name.",
|
|
50439
|
+
"attribute": "linked-from-label"
|
|
49906
50440
|
},
|
|
49907
50441
|
{
|
|
49908
50442
|
"kind": "field",
|
|
49909
|
-
"name": "
|
|
50443
|
+
"name": "links",
|
|
49910
50444
|
"type": {
|
|
49911
|
-
"text": "
|
|
50445
|
+
"text": "readonly GraphLink[]"
|
|
49912
50446
|
},
|
|
49913
|
-
"default": "
|
|
49914
|
-
"description": "
|
|
49915
|
-
"attribute": "rows"
|
|
50447
|
+
"default": "[]",
|
|
50448
|
+
"description": "The links between notes, each from `source` to `target`. A property, never an attribute."
|
|
49916
50449
|
},
|
|
49917
50450
|
{
|
|
49918
50451
|
"kind": "field",
|
|
49919
|
-
"name": "
|
|
50452
|
+
"name": "linksToLabel",
|
|
49920
50453
|
"type": {
|
|
49921
50454
|
"text": "string"
|
|
49922
50455
|
},
|
|
49923
|
-
"default": "''",
|
|
49924
|
-
"description": "
|
|
49925
|
-
"attribute": "
|
|
50456
|
+
"default": "'Links to {note}'",
|
|
50457
|
+
"description": "How a note that links to the selected one is described, with `{note}`.",
|
|
50458
|
+
"attribute": "links-to-label"
|
|
49926
50459
|
},
|
|
49927
50460
|
{
|
|
49928
50461
|
"kind": "field",
|
|
49929
|
-
"name": "
|
|
50462
|
+
"name": "nodes",
|
|
50463
|
+
"type": {
|
|
50464
|
+
"text": "readonly GraphNode[]"
|
|
50465
|
+
},
|
|
50466
|
+
"default": "[]",
|
|
50467
|
+
"description": "The notes. A property, never an attribute."
|
|
50468
|
+
},
|
|
50469
|
+
{
|
|
50470
|
+
"kind": "field",
|
|
50471
|
+
"name": "notesLabel",
|
|
49930
50472
|
"type": {
|
|
49931
50473
|
"text": "string"
|
|
49932
50474
|
},
|
|
49933
|
-
"default": "''",
|
|
49934
|
-
"description": "The
|
|
49935
|
-
"attribute": "
|
|
50475
|
+
"default": "'Notes'",
|
|
50476
|
+
"description": "The list's name, read by screen readers.",
|
|
50477
|
+
"attribute": "notes-label"
|
|
49936
50478
|
},
|
|
49937
50479
|
{
|
|
49938
50480
|
"kind": "field",
|
|
49939
|
-
"name": "
|
|
50481
|
+
"name": "searchLabel",
|
|
49940
50482
|
"type": {
|
|
49941
|
-
"text": "
|
|
50483
|
+
"text": "string"
|
|
49942
50484
|
},
|
|
49943
|
-
"
|
|
49944
|
-
"
|
|
50485
|
+
"default": "'Find a note'",
|
|
50486
|
+
"description": "The search field's name.",
|
|
50487
|
+
"attribute": "search-label"
|
|
49945
50488
|
},
|
|
49946
50489
|
{
|
|
49947
50490
|
"kind": "field",
|
|
49948
|
-
"name": "
|
|
50491
|
+
"name": "selectedLabel",
|
|
49949
50492
|
"type": {
|
|
49950
|
-
"text": "
|
|
50493
|
+
"text": "string"
|
|
49951
50494
|
},
|
|
49952
|
-
"
|
|
49953
|
-
"
|
|
49954
|
-
"
|
|
50495
|
+
"default": "'Selected'",
|
|
50496
|
+
"description": "How the selected note is described in the list.",
|
|
50497
|
+
"attribute": "selected-label"
|
|
49955
50498
|
},
|
|
49956
50499
|
{
|
|
49957
50500
|
"kind": "field",
|
|
49958
|
-
"name": "
|
|
50501
|
+
"name": "query",
|
|
49959
50502
|
"type": {
|
|
49960
|
-
"text": "
|
|
50503
|
+
"text": "string"
|
|
49961
50504
|
},
|
|
49962
50505
|
"privacy": "private",
|
|
49963
|
-
"default": "
|
|
49964
|
-
"description": "
|
|
50506
|
+
"default": "''",
|
|
50507
|
+
"description": "What the search field holds."
|
|
49965
50508
|
},
|
|
49966
50509
|
{
|
|
49967
50510
|
"kind": "field",
|
|
49968
|
-
"name": "
|
|
50511
|
+
"name": "cursor",
|
|
49969
50512
|
"type": {
|
|
49970
50513
|
"text": "number"
|
|
49971
50514
|
},
|
|
49972
50515
|
"privacy": "private",
|
|
49973
|
-
"default": "
|
|
49974
|
-
"description": "
|
|
50516
|
+
"default": "0",
|
|
50517
|
+
"description": "The row the keyboard is on, as an index into the list."
|
|
49975
50518
|
},
|
|
49976
50519
|
{
|
|
49977
50520
|
"kind": "field",
|
|
49978
|
-
"name": "
|
|
50521
|
+
"name": "adjacency",
|
|
49979
50522
|
"type": {
|
|
49980
|
-
"text": "
|
|
50523
|
+
"text": "Adjacency"
|
|
49981
50524
|
},
|
|
49982
50525
|
"privacy": "private",
|
|
49983
|
-
"default": "
|
|
50526
|
+
"default": "new Map()",
|
|
50527
|
+
"description": "Which notes link to and from each, read again when `links` changes."
|
|
49984
50528
|
},
|
|
49985
50529
|
{
|
|
49986
50530
|
"kind": "field",
|
|
49987
|
-
"name": "
|
|
50531
|
+
"name": "sorted",
|
|
49988
50532
|
"type": {
|
|
49989
|
-
"text": "
|
|
50533
|
+
"text": "GraphNode[]"
|
|
49990
50534
|
},
|
|
49991
50535
|
"privacy": "private",
|
|
49992
|
-
"default": "
|
|
50536
|
+
"default": "[]",
|
|
50537
|
+
"description": "The notes in the order of their names, read again when `nodes` changes."
|
|
49993
50538
|
},
|
|
49994
50539
|
{
|
|
49995
50540
|
"kind": "field",
|
|
49996
|
-
"name": "
|
|
50541
|
+
"name": "entries",
|
|
49997
50542
|
"type": {
|
|
49998
|
-
"text": "
|
|
50543
|
+
"text": "Entry[]"
|
|
49999
50544
|
},
|
|
50000
50545
|
"privacy": "private",
|
|
50001
|
-
"
|
|
50002
|
-
"
|
|
50546
|
+
"default": "[]",
|
|
50547
|
+
"description": "The list's rows, read again when anything they come from changes."
|
|
50003
50548
|
},
|
|
50004
50549
|
{
|
|
50005
50550
|
"kind": "field",
|
|
50006
|
-
"name": "
|
|
50551
|
+
"name": "kept",
|
|
50007
50552
|
"type": {
|
|
50008
|
-
"text": "
|
|
50553
|
+
"text": "Set<string> | undefined"
|
|
50009
50554
|
},
|
|
50010
50555
|
"privacy": "private",
|
|
50011
|
-
"description": "
|
|
50012
|
-
"readonly": true
|
|
50556
|
+
"description": "The notes the local graph keeps, or every note where there is no `depth`."
|
|
50013
50557
|
},
|
|
50014
50558
|
{
|
|
50015
50559
|
"kind": "field",
|
|
50016
|
-
"name": "
|
|
50560
|
+
"name": "whole",
|
|
50017
50561
|
"type": {
|
|
50018
|
-
"text": "
|
|
50562
|
+
"text": "boolean"
|
|
50019
50563
|
},
|
|
50020
50564
|
"privacy": "private",
|
|
50021
|
-
"
|
|
50022
|
-
"
|
|
50565
|
+
"default": "false",
|
|
50566
|
+
"description": "Whether the graph has been drawn whole, which `drawn()` says."
|
|
50023
50567
|
},
|
|
50024
50568
|
{
|
|
50025
50569
|
"kind": "field",
|
|
50026
|
-
"name": "
|
|
50570
|
+
"name": "said",
|
|
50027
50571
|
"type": {
|
|
50028
|
-
"text": "
|
|
50572
|
+
"text": "string"
|
|
50029
50573
|
},
|
|
50030
50574
|
"privacy": "private",
|
|
50031
|
-
"
|
|
50032
|
-
"
|
|
50575
|
+
"default": "''",
|
|
50576
|
+
"description": "How many notes there were when the count was last said."
|
|
50033
50577
|
},
|
|
50034
50578
|
{
|
|
50035
50579
|
"kind": "field",
|
|
50036
|
-
"name": "
|
|
50037
|
-
"type": {
|
|
50038
|
-
"text": "number"
|
|
50039
|
-
},
|
|
50580
|
+
"name": "virtualize",
|
|
50040
50581
|
"privacy": "private",
|
|
50041
|
-
"
|
|
50042
|
-
"
|
|
50582
|
+
"readonly": true,
|
|
50583
|
+
"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), })), })"
|
|
50043
50584
|
},
|
|
50044
50585
|
{
|
|
50045
50586
|
"kind": "field",
|
|
50046
|
-
"name": "
|
|
50587
|
+
"name": "ready",
|
|
50047
50588
|
"type": {
|
|
50048
|
-
"text": "
|
|
50589
|
+
"text": "boolean"
|
|
50049
50590
|
},
|
|
50050
|
-
"
|
|
50051
|
-
"description": "How many cells the container has room for, as a whole number of columns.",
|
|
50591
|
+
"description": "Whether the graph has been drawn whole. For code that runs after `helix-graph-ready`.",
|
|
50052
50592
|
"readonly": true
|
|
50053
50593
|
},
|
|
50054
50594
|
{
|
|
50055
50595
|
"kind": "method",
|
|
50056
|
-
"name": "
|
|
50057
|
-
"privacy": "private",
|
|
50596
|
+
"name": "drawn",
|
|
50058
50597
|
"return": {
|
|
50059
50598
|
"type": {
|
|
50060
50599
|
"text": "void"
|
|
50061
50600
|
}
|
|
50062
50601
|
},
|
|
50063
|
-
"
|
|
50064
|
-
|
|
50065
|
-
|
|
50066
|
-
|
|
50067
|
-
|
|
50602
|
+
"parameters": [
|
|
50603
|
+
{
|
|
50604
|
+
"name": "whole",
|
|
50605
|
+
"default": "true"
|
|
50606
|
+
}
|
|
50607
|
+
],
|
|
50608
|
+
"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)`.",
|
|
50068
50609
|
"type": {
|
|
50069
|
-
"text": "
|
|
50070
|
-
}
|
|
50071
|
-
"privacy": "private",
|
|
50072
|
-
"description": "The readings actually drawn, newest kept.\n\nThe tail rather than the head: a status strip that drops the newest days to\nkeep the oldest is answering a question nobody asked.",
|
|
50073
|
-
"readonly": true
|
|
50610
|
+
"text": "drawn(whole = true) => void"
|
|
50611
|
+
}
|
|
50074
50612
|
},
|
|
50075
50613
|
{
|
|
50076
50614
|
"kind": "method",
|
|
50077
|
-
"name": "
|
|
50078
|
-
"privacy": "private",
|
|
50615
|
+
"name": "laidOut",
|
|
50079
50616
|
"return": {
|
|
50080
50617
|
"type": {
|
|
50081
50618
|
"text": "void"
|
|
50082
50619
|
}
|
|
50083
50620
|
},
|
|
50084
|
-
"
|
|
50621
|
+
"parameters": [
|
|
50622
|
+
{
|
|
50623
|
+
"name": "positions",
|
|
50624
|
+
"type": {
|
|
50625
|
+
"text": "Record<string, { x: number; y: number }>"
|
|
50626
|
+
}
|
|
50627
|
+
}
|
|
50628
|
+
],
|
|
50629
|
+
"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.",
|
|
50630
|
+
"type": {
|
|
50631
|
+
"text": "laidOut(positions: Record<string, { x: number; y: number }>) => void"
|
|
50632
|
+
}
|
|
50085
50633
|
},
|
|
50086
50634
|
{
|
|
50087
50635
|
"kind": "method",
|
|
50088
|
-
"name": "
|
|
50636
|
+
"name": "panEvent",
|
|
50089
50637
|
"privacy": "protected",
|
|
50090
50638
|
"return": {
|
|
50091
50639
|
"type": {
|
|
50092
|
-
"text": "
|
|
50640
|
+
"text": "Event"
|
|
50093
50641
|
}
|
|
50094
50642
|
},
|
|
50095
|
-
"
|
|
50096
|
-
|
|
50097
|
-
|
|
50098
|
-
|
|
50099
|
-
|
|
50100
|
-
|
|
50101
|
-
|
|
50102
|
-
|
|
50643
|
+
"parameters": [
|
|
50644
|
+
{
|
|
50645
|
+
"name": "detail",
|
|
50646
|
+
"type": {
|
|
50647
|
+
"text": "ViewportPanDetail"
|
|
50648
|
+
}
|
|
50649
|
+
}
|
|
50650
|
+
],
|
|
50651
|
+
"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.",
|
|
50652
|
+
"inheritedFrom": {
|
|
50653
|
+
"name": "MixinViewport",
|
|
50654
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
50655
|
+
}
|
|
50656
|
+
},
|
|
50657
|
+
{
|
|
50658
|
+
"kind": "method",
|
|
50659
|
+
"name": "zoomEvent",
|
|
50660
|
+
"privacy": "protected",
|
|
50661
|
+
"return": {
|
|
50662
|
+
"type": {
|
|
50663
|
+
"text": "Event"
|
|
50664
|
+
}
|
|
50665
|
+
},
|
|
50666
|
+
"parameters": [
|
|
50667
|
+
{
|
|
50668
|
+
"name": "detail",
|
|
50669
|
+
"type": {
|
|
50670
|
+
"text": "ViewportZoomDetail"
|
|
50671
|
+
}
|
|
50672
|
+
}
|
|
50673
|
+
],
|
|
50674
|
+
"description": "The zoom event, which the family names, for the same reason.",
|
|
50675
|
+
"inheritedFrom": {
|
|
50676
|
+
"name": "MixinViewport",
|
|
50677
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
50678
|
+
}
|
|
50679
|
+
},
|
|
50680
|
+
{
|
|
50681
|
+
"kind": "field",
|
|
50682
|
+
"name": "restingControls",
|
|
50683
|
+
"type": {
|
|
50684
|
+
"text": "string"
|
|
50685
|
+
},
|
|
50686
|
+
"privacy": "protected",
|
|
50687
|
+
"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.",
|
|
50688
|
+
"readonly": true,
|
|
50689
|
+
"inheritedFrom": {
|
|
50690
|
+
"name": "MixinViewport",
|
|
50691
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
50692
|
+
}
|
|
50693
|
+
},
|
|
50694
|
+
{
|
|
50695
|
+
"kind": "field",
|
|
50696
|
+
"name": "restingControlsLabel",
|
|
50697
|
+
"type": {
|
|
50698
|
+
"text": "string"
|
|
50699
|
+
},
|
|
50700
|
+
"privacy": "protected",
|
|
50701
|
+
"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.",
|
|
50702
|
+
"readonly": true,
|
|
50703
|
+
"inheritedFrom": {
|
|
50704
|
+
"name": "MixinViewport",
|
|
50705
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
50706
|
+
}
|
|
50707
|
+
},
|
|
50708
|
+
{
|
|
50709
|
+
"kind": "method",
|
|
50710
|
+
"name": "gesturesChanged",
|
|
50711
|
+
"privacy": "protected",
|
|
50712
|
+
"return": {
|
|
50713
|
+
"type": {
|
|
50714
|
+
"text": "void"
|
|
50715
|
+
}
|
|
50716
|
+
},
|
|
50717
|
+
"description": "Which gestures the renderer takes, which `connectGraph` hears from here.",
|
|
50718
|
+
"inheritedFrom": {
|
|
50719
|
+
"name": "MixinViewport",
|
|
50720
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
50721
|
+
}
|
|
50722
|
+
},
|
|
50723
|
+
{
|
|
50724
|
+
"kind": "field",
|
|
50725
|
+
"name": "restingGestureLabels",
|
|
50726
|
+
"type": {
|
|
50727
|
+
"text": "ViewportGestureLabels"
|
|
50728
|
+
},
|
|
50729
|
+
"privacy": "protected",
|
|
50730
|
+
"description": "What the graph says about its gestures where the page does not say it.",
|
|
50731
|
+
"readonly": true,
|
|
50732
|
+
"inheritedFrom": {
|
|
50733
|
+
"name": "MixinViewport",
|
|
50734
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
50735
|
+
}
|
|
50736
|
+
},
|
|
50737
|
+
{
|
|
50738
|
+
"kind": "method",
|
|
50739
|
+
"name": "countText",
|
|
50740
|
+
"privacy": "private",
|
|
50741
|
+
"return": {
|
|
50742
|
+
"type": {
|
|
50743
|
+
"text": "string"
|
|
50744
|
+
}
|
|
50745
|
+
},
|
|
50746
|
+
"description": "How many notes the list holds, in the page's numbers."
|
|
50747
|
+
},
|
|
50748
|
+
{
|
|
50749
|
+
"kind": "method",
|
|
50750
|
+
"name": "relationText",
|
|
50751
|
+
"privacy": "private",
|
|
50752
|
+
"return": {
|
|
50753
|
+
"type": {
|
|
50754
|
+
"text": "string"
|
|
50755
|
+
}
|
|
50756
|
+
},
|
|
50757
|
+
"parameters": [
|
|
50758
|
+
{
|
|
50759
|
+
"name": "entry",
|
|
50760
|
+
"type": {
|
|
50761
|
+
"text": "Entry"
|
|
50762
|
+
}
|
|
50763
|
+
}
|
|
50764
|
+
],
|
|
50765
|
+
"description": "How a row stands to the selected note, in words, or nothing where it does not."
|
|
50766
|
+
},
|
|
50767
|
+
{
|
|
50768
|
+
"kind": "method",
|
|
50769
|
+
"name": "choose",
|
|
50770
|
+
"privacy": "private",
|
|
50771
|
+
"return": {
|
|
50772
|
+
"type": {
|
|
50773
|
+
"text": "void"
|
|
50774
|
+
}
|
|
50775
|
+
},
|
|
50776
|
+
"parameters": [
|
|
50777
|
+
{
|
|
50778
|
+
"name": "index",
|
|
50779
|
+
"type": {
|
|
50780
|
+
"text": "number"
|
|
50781
|
+
}
|
|
50782
|
+
}
|
|
50783
|
+
],
|
|
50784
|
+
"description": "Selects the note a row names, through the request a page can refuse."
|
|
50785
|
+
},
|
|
50786
|
+
{
|
|
50787
|
+
"kind": "method",
|
|
50788
|
+
"name": "moveTo",
|
|
50789
|
+
"privacy": "private",
|
|
50790
|
+
"return": {
|
|
50791
|
+
"type": {
|
|
50792
|
+
"text": "void"
|
|
50793
|
+
}
|
|
50794
|
+
},
|
|
50795
|
+
"parameters": [
|
|
50796
|
+
{
|
|
50797
|
+
"name": "index",
|
|
50798
|
+
"type": {
|
|
50799
|
+
"text": "number"
|
|
50800
|
+
}
|
|
50801
|
+
}
|
|
50802
|
+
],
|
|
50803
|
+
"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."
|
|
50804
|
+
},
|
|
50805
|
+
{
|
|
50806
|
+
"kind": "field",
|
|
50807
|
+
"name": "handleListKeydown",
|
|
50808
|
+
"privacy": "private",
|
|
50809
|
+
"readonly": true,
|
|
50810
|
+
"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."
|
|
50811
|
+
},
|
|
50812
|
+
{
|
|
50813
|
+
"kind": "field",
|
|
50814
|
+
"name": "handleSearchKeydown",
|
|
50815
|
+
"privacy": "private",
|
|
50816
|
+
"readonly": true,
|
|
50817
|
+
"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."
|
|
50818
|
+
},
|
|
50819
|
+
{
|
|
50820
|
+
"kind": "field",
|
|
50821
|
+
"name": "handleSearch",
|
|
50822
|
+
"privacy": "private",
|
|
50823
|
+
"readonly": true
|
|
50824
|
+
},
|
|
50825
|
+
{
|
|
50826
|
+
"kind": "method",
|
|
50827
|
+
"name": "renderFilterIcon",
|
|
50828
|
+
"privacy": "protected",
|
|
50829
|
+
"return": {
|
|
50830
|
+
"type": {
|
|
50831
|
+
"text": "TemplateResult"
|
|
50832
|
+
}
|
|
50833
|
+
},
|
|
50834
|
+
"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."
|
|
50835
|
+
},
|
|
50836
|
+
{
|
|
50837
|
+
"kind": "method",
|
|
50838
|
+
"name": "renderRows",
|
|
50839
|
+
"privacy": "private",
|
|
50840
|
+
"return": {
|
|
50841
|
+
"type": {
|
|
50842
|
+
"text": "TemplateResult[]"
|
|
50843
|
+
}
|
|
50844
|
+
}
|
|
50845
|
+
},
|
|
50846
|
+
{
|
|
50847
|
+
"kind": "field",
|
|
50848
|
+
"name": "activateHintLabel",
|
|
50849
|
+
"type": {
|
|
50850
|
+
"text": "string | undefined"
|
|
50851
|
+
},
|
|
50852
|
+
"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.",
|
|
50853
|
+
"attribute": "activate-hint-label",
|
|
50854
|
+
"inheritedFrom": {
|
|
50855
|
+
"name": "MixinViewport",
|
|
50856
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
50857
|
+
}
|
|
50858
|
+
},
|
|
50859
|
+
{
|
|
50860
|
+
"kind": "field",
|
|
50861
|
+
"name": "controls",
|
|
50862
|
+
"type": {
|
|
50863
|
+
"text": "string | undefined"
|
|
50864
|
+
},
|
|
50865
|
+
"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.",
|
|
50866
|
+
"attribute": "controls",
|
|
50867
|
+
"reflects": true,
|
|
50868
|
+
"inheritedFrom": {
|
|
50869
|
+
"name": "MixinViewport",
|
|
50870
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
50871
|
+
}
|
|
50872
|
+
},
|
|
50873
|
+
{
|
|
50874
|
+
"kind": "field",
|
|
50875
|
+
"name": "controlsLabel",
|
|
50876
|
+
"type": {
|
|
50877
|
+
"text": "string | undefined"
|
|
50878
|
+
},
|
|
50879
|
+
"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.",
|
|
50880
|
+
"attribute": "controls-label",
|
|
50881
|
+
"inheritedFrom": {
|
|
50882
|
+
"name": "MixinViewport",
|
|
50883
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
50884
|
+
}
|
|
50885
|
+
},
|
|
50886
|
+
{
|
|
50887
|
+
"kind": "field",
|
|
50888
|
+
"name": "controlsPlacement",
|
|
50889
|
+
"type": {
|
|
50890
|
+
"text": "'top-start' | 'top-end' | 'bottom-start' | 'bottom-end' | undefined"
|
|
50891
|
+
},
|
|
50892
|
+
"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.",
|
|
50893
|
+
"attribute": "controls-placement",
|
|
50894
|
+
"reflects": true,
|
|
50895
|
+
"inheritedFrom": {
|
|
50896
|
+
"name": "MixinViewport",
|
|
50897
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
50898
|
+
}
|
|
50899
|
+
},
|
|
50900
|
+
{
|
|
50901
|
+
"kind": "field",
|
|
50902
|
+
"name": "fullscreenLabel",
|
|
50903
|
+
"type": {
|
|
50904
|
+
"text": "string"
|
|
50905
|
+
},
|
|
50906
|
+
"default": "'Fill the screen'",
|
|
50907
|
+
"description": "The fullscreen button's label.",
|
|
50908
|
+
"attribute": "fullscreen-label",
|
|
50909
|
+
"inheritedFrom": {
|
|
50910
|
+
"name": "MixinViewport",
|
|
50911
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
50912
|
+
}
|
|
50913
|
+
},
|
|
50914
|
+
{
|
|
50915
|
+
"kind": "field",
|
|
50916
|
+
"name": "gestures",
|
|
50917
|
+
"type": {
|
|
50918
|
+
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
50919
|
+
},
|
|
50920
|
+
"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.",
|
|
50921
|
+
"attribute": "gestures",
|
|
50922
|
+
"inheritedFrom": {
|
|
50923
|
+
"name": "MixinViewport",
|
|
50924
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
50925
|
+
}
|
|
50926
|
+
},
|
|
50927
|
+
{
|
|
50928
|
+
"kind": "field",
|
|
50929
|
+
"name": "idleDelay",
|
|
50930
|
+
"type": {
|
|
50931
|
+
"text": "number"
|
|
50932
|
+
},
|
|
50933
|
+
"default": "0",
|
|
50934
|
+
"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.",
|
|
50935
|
+
"attribute": "idle-delay",
|
|
50936
|
+
"inheritedFrom": {
|
|
50937
|
+
"name": "MixinViewport",
|
|
50938
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
50939
|
+
}
|
|
50940
|
+
},
|
|
50941
|
+
{
|
|
50942
|
+
"kind": "field",
|
|
50943
|
+
"name": "panDownLabel",
|
|
50944
|
+
"type": {
|
|
50945
|
+
"text": "string"
|
|
50946
|
+
},
|
|
50947
|
+
"default": "'Pan down'",
|
|
50948
|
+
"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.",
|
|
50949
|
+
"attribute": "pan-down-label",
|
|
50950
|
+
"inheritedFrom": {
|
|
50951
|
+
"name": "MixinViewport",
|
|
50952
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
50953
|
+
}
|
|
50954
|
+
},
|
|
50955
|
+
{
|
|
50956
|
+
"kind": "field",
|
|
50957
|
+
"name": "panLeftLabel",
|
|
50958
|
+
"type": {
|
|
50959
|
+
"text": "string"
|
|
50960
|
+
},
|
|
50961
|
+
"default": "'Pan left'",
|
|
50962
|
+
"description": "The pan left button's label.",
|
|
50963
|
+
"attribute": "pan-left-label",
|
|
50964
|
+
"inheritedFrom": {
|
|
50965
|
+
"name": "MixinViewport",
|
|
50966
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
50967
|
+
}
|
|
50968
|
+
},
|
|
50969
|
+
{
|
|
50970
|
+
"kind": "field",
|
|
50971
|
+
"name": "panRightLabel",
|
|
50972
|
+
"type": {
|
|
50973
|
+
"text": "string"
|
|
50974
|
+
},
|
|
50975
|
+
"default": "'Pan right'",
|
|
50976
|
+
"description": "The pan right button's label.",
|
|
50977
|
+
"attribute": "pan-right-label",
|
|
50978
|
+
"inheritedFrom": {
|
|
50979
|
+
"name": "MixinViewport",
|
|
50980
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
50981
|
+
}
|
|
50982
|
+
},
|
|
50983
|
+
{
|
|
50984
|
+
"kind": "field",
|
|
50985
|
+
"name": "panStep",
|
|
50986
|
+
"type": {
|
|
50987
|
+
"text": "number"
|
|
50988
|
+
},
|
|
50989
|
+
"default": "0.25",
|
|
50990
|
+
"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.",
|
|
50991
|
+
"attribute": "pan-step",
|
|
50992
|
+
"inheritedFrom": {
|
|
50993
|
+
"name": "MixinViewport",
|
|
50994
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
50995
|
+
}
|
|
50996
|
+
},
|
|
50997
|
+
{
|
|
50998
|
+
"kind": "field",
|
|
50999
|
+
"name": "panUpLabel",
|
|
51000
|
+
"type": {
|
|
51001
|
+
"text": "string"
|
|
51002
|
+
},
|
|
51003
|
+
"default": "'Pan up'",
|
|
51004
|
+
"description": "The pan up button's label.",
|
|
51005
|
+
"attribute": "pan-up-label",
|
|
51006
|
+
"inheritedFrom": {
|
|
51007
|
+
"name": "MixinViewport",
|
|
51008
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51009
|
+
}
|
|
51010
|
+
},
|
|
51011
|
+
{
|
|
51012
|
+
"kind": "field",
|
|
51013
|
+
"name": "twoFingerHintLabel",
|
|
51014
|
+
"type": {
|
|
51015
|
+
"text": "string | undefined"
|
|
51016
|
+
},
|
|
51017
|
+
"description": "The hint shown when one finger swipes over a surface with\n`gestures=\"cooperative\"`. Absent is the family's own.",
|
|
51018
|
+
"attribute": "two-finger-hint-label",
|
|
51019
|
+
"inheritedFrom": {
|
|
51020
|
+
"name": "MixinViewport",
|
|
51021
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51022
|
+
}
|
|
51023
|
+
},
|
|
51024
|
+
{
|
|
51025
|
+
"kind": "field",
|
|
51026
|
+
"name": "usingLabel",
|
|
51027
|
+
"type": {
|
|
51028
|
+
"text": "string | undefined"
|
|
51029
|
+
},
|
|
51030
|
+
"description": "The line shown while a surface with `gestures=\"activate\"` has the\ngestures. Absent is the family's own.",
|
|
51031
|
+
"attribute": "using-label",
|
|
51032
|
+
"inheritedFrom": {
|
|
51033
|
+
"name": "MixinViewport",
|
|
51034
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51035
|
+
}
|
|
51036
|
+
},
|
|
51037
|
+
{
|
|
51038
|
+
"kind": "field",
|
|
51039
|
+
"name": "wheelHintLabel",
|
|
51040
|
+
"type": {
|
|
51041
|
+
"text": "string | undefined"
|
|
51042
|
+
},
|
|
51043
|
+
"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.",
|
|
51044
|
+
"attribute": "wheel-hint-label",
|
|
51045
|
+
"inheritedFrom": {
|
|
51046
|
+
"name": "MixinViewport",
|
|
51047
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51048
|
+
}
|
|
51049
|
+
},
|
|
51050
|
+
{
|
|
51051
|
+
"kind": "field",
|
|
51052
|
+
"name": "zoomInLabel",
|
|
51053
|
+
"type": {
|
|
51054
|
+
"text": "string"
|
|
51055
|
+
},
|
|
51056
|
+
"default": "'Zoom in'",
|
|
51057
|
+
"description": "The zoom in button's label.",
|
|
51058
|
+
"attribute": "zoom-in-label",
|
|
51059
|
+
"inheritedFrom": {
|
|
51060
|
+
"name": "MixinViewport",
|
|
51061
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51062
|
+
}
|
|
51063
|
+
},
|
|
51064
|
+
{
|
|
51065
|
+
"kind": "field",
|
|
51066
|
+
"name": "resting",
|
|
51067
|
+
"type": {
|
|
51068
|
+
"text": "boolean"
|
|
51069
|
+
},
|
|
51070
|
+
"privacy": "protected",
|
|
51071
|
+
"default": "false",
|
|
51072
|
+
"description": "Whether the reader has been still long enough to hide the chrome.",
|
|
51073
|
+
"inheritedFrom": {
|
|
51074
|
+
"name": "MixinViewport",
|
|
51075
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51076
|
+
}
|
|
51077
|
+
},
|
|
51078
|
+
{
|
|
51079
|
+
"kind": "field",
|
|
51080
|
+
"name": "filled",
|
|
51081
|
+
"type": {
|
|
51082
|
+
"text": "boolean"
|
|
51083
|
+
},
|
|
51084
|
+
"privacy": "protected",
|
|
51085
|
+
"default": "false",
|
|
51086
|
+
"description": "Whether the surface is filling the screen.",
|
|
51087
|
+
"inheritedFrom": {
|
|
51088
|
+
"name": "MixinViewport",
|
|
51089
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51090
|
+
}
|
|
51091
|
+
},
|
|
51092
|
+
{
|
|
51093
|
+
"kind": "field",
|
|
51094
|
+
"name": "gesturesTaken",
|
|
51095
|
+
"type": {
|
|
51096
|
+
"text": "boolean"
|
|
51097
|
+
},
|
|
51098
|
+
"privacy": "protected",
|
|
51099
|
+
"default": "false",
|
|
51100
|
+
"description": "Whether an `activate` surface has been pressed, and has the gestures.",
|
|
51101
|
+
"inheritedFrom": {
|
|
51102
|
+
"name": "MixinViewport",
|
|
51103
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51104
|
+
}
|
|
51105
|
+
},
|
|
51106
|
+
{
|
|
51107
|
+
"kind": "field",
|
|
51108
|
+
"name": "hint",
|
|
51109
|
+
"type": {
|
|
51110
|
+
"text": "string"
|
|
51111
|
+
},
|
|
51112
|
+
"privacy": "private",
|
|
51113
|
+
"default": "''",
|
|
51114
|
+
"description": "The hint over the surface while one shows, put there by a gesture it let pass.",
|
|
51115
|
+
"inheritedFrom": {
|
|
51116
|
+
"name": "MixinViewport",
|
|
51117
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51118
|
+
}
|
|
51119
|
+
},
|
|
51120
|
+
{
|
|
51121
|
+
"kind": "field",
|
|
51122
|
+
"name": "hinting",
|
|
51123
|
+
"type": {
|
|
51124
|
+
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
51125
|
+
},
|
|
51126
|
+
"privacy": "private",
|
|
51127
|
+
"description": "When the hint goes.",
|
|
51128
|
+
"inheritedFrom": {
|
|
51129
|
+
"name": "MixinViewport",
|
|
51130
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51131
|
+
}
|
|
51132
|
+
},
|
|
51133
|
+
{
|
|
51134
|
+
"kind": "field",
|
|
51135
|
+
"name": "hintAt",
|
|
51136
|
+
"type": {
|
|
51137
|
+
"text": "{ x: number; y: number } | undefined"
|
|
51138
|
+
},
|
|
51139
|
+
"privacy": "private",
|
|
51140
|
+
"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.",
|
|
51141
|
+
"inheritedFrom": {
|
|
51142
|
+
"name": "MixinViewport",
|
|
51143
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51144
|
+
}
|
|
51145
|
+
},
|
|
51146
|
+
{
|
|
51147
|
+
"kind": "field",
|
|
51148
|
+
"name": "takenBy",
|
|
51149
|
+
"type": {
|
|
51150
|
+
"text": "Event | undefined"
|
|
51151
|
+
},
|
|
51152
|
+
"privacy": "private",
|
|
51153
|
+
"description": "The press that took the gestures, which is not also the first gesture.",
|
|
51154
|
+
"inheritedFrom": {
|
|
51155
|
+
"name": "MixinViewport",
|
|
51156
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51157
|
+
}
|
|
51158
|
+
},
|
|
51159
|
+
{
|
|
51160
|
+
"kind": "field",
|
|
51161
|
+
"name": "fullscreen",
|
|
51162
|
+
"privacy": "protected",
|
|
51163
|
+
"readonly": true,
|
|
51164
|
+
"default": "new FullscreenController(this, (full) => { this.filled = full })",
|
|
51165
|
+
"inheritedFrom": {
|
|
51166
|
+
"name": "MixinViewport",
|
|
51167
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51168
|
+
}
|
|
51169
|
+
},
|
|
51170
|
+
{
|
|
51171
|
+
"kind": "field",
|
|
51172
|
+
"name": "idle",
|
|
51173
|
+
"privacy": "protected",
|
|
51174
|
+
"readonly": true,
|
|
51175
|
+
"default": "new IdleController( this, () => this.idleDelay, (resting) => { this.resting = resting }, )",
|
|
51176
|
+
"inheritedFrom": {
|
|
51177
|
+
"name": "MixinViewport",
|
|
51178
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51179
|
+
}
|
|
51180
|
+
},
|
|
51181
|
+
{
|
|
51182
|
+
"kind": "field",
|
|
51183
|
+
"name": "zoomOutLabel",
|
|
51184
|
+
"type": {
|
|
51185
|
+
"text": "string"
|
|
51186
|
+
},
|
|
51187
|
+
"default": "'Zoom out'",
|
|
51188
|
+
"description": "The zoom out button's label.",
|
|
51189
|
+
"attribute": "zoom-out-label",
|
|
51190
|
+
"inheritedFrom": {
|
|
51191
|
+
"name": "MixinViewport",
|
|
51192
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51193
|
+
}
|
|
51194
|
+
},
|
|
51195
|
+
{
|
|
51196
|
+
"kind": "method",
|
|
51197
|
+
"name": "gestureAllowed",
|
|
51198
|
+
"privacy": "protected",
|
|
51199
|
+
"return": {
|
|
51200
|
+
"type": {
|
|
51201
|
+
"text": "boolean"
|
|
51202
|
+
}
|
|
51203
|
+
},
|
|
51204
|
+
"parameters": [
|
|
51205
|
+
{
|
|
51206
|
+
"name": "event",
|
|
51207
|
+
"type": {
|
|
51208
|
+
"text": "Event"
|
|
51209
|
+
}
|
|
51210
|
+
}
|
|
51211
|
+
],
|
|
51212
|
+
"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.",
|
|
51213
|
+
"inheritedFrom": {
|
|
51214
|
+
"name": "MixinViewport",
|
|
51215
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51216
|
+
}
|
|
51217
|
+
},
|
|
51218
|
+
{
|
|
51219
|
+
"kind": "method",
|
|
51220
|
+
"name": "showHint",
|
|
51221
|
+
"privacy": "private",
|
|
51222
|
+
"return": {
|
|
51223
|
+
"type": {
|
|
51224
|
+
"text": "void"
|
|
51225
|
+
}
|
|
51226
|
+
},
|
|
51227
|
+
"parameters": [
|
|
51228
|
+
{
|
|
51229
|
+
"name": "words",
|
|
51230
|
+
"type": {
|
|
51231
|
+
"text": "string"
|
|
51232
|
+
}
|
|
51233
|
+
},
|
|
51234
|
+
{
|
|
51235
|
+
"name": "at",
|
|
51236
|
+
"optional": true,
|
|
51237
|
+
"type": {
|
|
51238
|
+
"text": "{ clientX: number; clientY: number }"
|
|
51239
|
+
}
|
|
51240
|
+
}
|
|
51241
|
+
],
|
|
51242
|
+
"description": "Shows a hint over the surface for a moment, where the gesture was.",
|
|
51243
|
+
"inheritedFrom": {
|
|
51244
|
+
"name": "MixinViewport",
|
|
51245
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51246
|
+
}
|
|
51247
|
+
},
|
|
51248
|
+
{
|
|
51249
|
+
"kind": "field",
|
|
51250
|
+
"name": "handleGestureWheel",
|
|
51251
|
+
"privacy": "private",
|
|
51252
|
+
"readonly": true,
|
|
51253
|
+
"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.",
|
|
51254
|
+
"inheritedFrom": {
|
|
51255
|
+
"name": "MixinViewport",
|
|
51256
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51257
|
+
}
|
|
51258
|
+
},
|
|
51259
|
+
{
|
|
51260
|
+
"kind": "field",
|
|
51261
|
+
"name": "handleGestureTouch",
|
|
51262
|
+
"privacy": "private",
|
|
51263
|
+
"readonly": true,
|
|
51264
|
+
"description": "One finger moving over the surface, which scrolls the page, and is said.",
|
|
51265
|
+
"inheritedFrom": {
|
|
51266
|
+
"name": "MixinViewport",
|
|
51267
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51268
|
+
}
|
|
51269
|
+
},
|
|
51270
|
+
{
|
|
51271
|
+
"kind": "field",
|
|
51272
|
+
"name": "handleTake",
|
|
51273
|
+
"privacy": "private",
|
|
51274
|
+
"readonly": true,
|
|
51275
|
+
"description": "A press on the surface itself, which hands a waiting surface the gestures.",
|
|
51276
|
+
"inheritedFrom": {
|
|
51277
|
+
"name": "MixinViewport",
|
|
51278
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51279
|
+
}
|
|
51280
|
+
},
|
|
51281
|
+
{
|
|
51282
|
+
"kind": "field",
|
|
51283
|
+
"name": "handleGiveBackKey",
|
|
51284
|
+
"privacy": "private",
|
|
51285
|
+
"readonly": true,
|
|
51286
|
+
"description": "Escape, which gives the page its scroll back.",
|
|
51287
|
+
"inheritedFrom": {
|
|
51288
|
+
"name": "MixinViewport",
|
|
51289
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51290
|
+
}
|
|
51291
|
+
},
|
|
51292
|
+
{
|
|
51293
|
+
"kind": "field",
|
|
51294
|
+
"name": "handleGiveBackOutside",
|
|
51295
|
+
"privacy": "private",
|
|
51296
|
+
"readonly": true,
|
|
51297
|
+
"description": "A press anywhere else on the page, which gives it its scroll back.",
|
|
51298
|
+
"inheritedFrom": {
|
|
51299
|
+
"name": "MixinViewport",
|
|
51300
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51301
|
+
}
|
|
51302
|
+
},
|
|
51303
|
+
{
|
|
51304
|
+
"kind": "field",
|
|
51305
|
+
"name": "handleGiveBackBlur",
|
|
51306
|
+
"privacy": "private",
|
|
51307
|
+
"readonly": true,
|
|
51308
|
+
"description": "The window losing focus, as a reader switching away does.",
|
|
51309
|
+
"inheritedFrom": {
|
|
51310
|
+
"name": "MixinViewport",
|
|
51311
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51312
|
+
}
|
|
51313
|
+
},
|
|
51314
|
+
{
|
|
51315
|
+
"kind": "field",
|
|
51316
|
+
"name": "handlePointerLeave",
|
|
51317
|
+
"privacy": "protected",
|
|
51318
|
+
"readonly": true,
|
|
51319
|
+
"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.",
|
|
51320
|
+
"inheritedFrom": {
|
|
51321
|
+
"name": "MixinViewport",
|
|
51322
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51323
|
+
}
|
|
51324
|
+
},
|
|
51325
|
+
{
|
|
51326
|
+
"kind": "method",
|
|
51327
|
+
"name": "renderGestures",
|
|
51328
|
+
"privacy": "protected",
|
|
51329
|
+
"return": {
|
|
51330
|
+
"type": {
|
|
51331
|
+
"text": "TemplateResult"
|
|
51332
|
+
}
|
|
51333
|
+
},
|
|
51334
|
+
"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.",
|
|
51335
|
+
"inheritedFrom": {
|
|
51336
|
+
"name": "MixinViewport",
|
|
51337
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51338
|
+
}
|
|
51339
|
+
},
|
|
51340
|
+
{
|
|
51341
|
+
"kind": "method",
|
|
51342
|
+
"name": "pan",
|
|
51343
|
+
"return": {
|
|
51344
|
+
"type": {
|
|
51345
|
+
"text": "void"
|
|
51346
|
+
}
|
|
51347
|
+
},
|
|
51348
|
+
"parameters": [
|
|
51349
|
+
{
|
|
51350
|
+
"name": "to",
|
|
51351
|
+
"type": {
|
|
51352
|
+
"text": "ViewportWay"
|
|
51353
|
+
}
|
|
51354
|
+
}
|
|
51355
|
+
],
|
|
51356
|
+
"description": "Pans the view one step in a direction.",
|
|
51357
|
+
"inheritedFrom": {
|
|
51358
|
+
"name": "MixinViewport",
|
|
51359
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51360
|
+
},
|
|
51361
|
+
"type": {
|
|
51362
|
+
"text": "pan(to: ViewportWay) => void"
|
|
51363
|
+
}
|
|
51364
|
+
},
|
|
51365
|
+
{
|
|
51366
|
+
"kind": "method",
|
|
51367
|
+
"name": "zoom",
|
|
51368
|
+
"return": {
|
|
51369
|
+
"type": {
|
|
51370
|
+
"text": "void"
|
|
51371
|
+
}
|
|
51372
|
+
},
|
|
51373
|
+
"parameters": [
|
|
51374
|
+
{
|
|
51375
|
+
"name": "by",
|
|
51376
|
+
"type": {
|
|
51377
|
+
"text": "number"
|
|
51378
|
+
}
|
|
51379
|
+
}
|
|
51380
|
+
],
|
|
51381
|
+
"description": "Zooms the view one step: `1` zooms in and `-1` zooms out.",
|
|
51382
|
+
"inheritedFrom": {
|
|
51383
|
+
"name": "MixinViewport",
|
|
51384
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51385
|
+
},
|
|
51386
|
+
"type": {
|
|
51387
|
+
"text": "zoom(by: number) => void"
|
|
51388
|
+
}
|
|
51389
|
+
},
|
|
51390
|
+
{
|
|
51391
|
+
"kind": "method",
|
|
51392
|
+
"name": "toggleFullscreen",
|
|
51393
|
+
"return": {
|
|
51394
|
+
"type": {
|
|
51395
|
+
"text": "void"
|
|
51396
|
+
}
|
|
51397
|
+
},
|
|
51398
|
+
"description": "Turns fullscreen on or off.",
|
|
51399
|
+
"inheritedFrom": {
|
|
51400
|
+
"name": "MixinViewport",
|
|
51401
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51402
|
+
},
|
|
51403
|
+
"type": {
|
|
51404
|
+
"text": "toggleFullscreen() => void"
|
|
51405
|
+
}
|
|
51406
|
+
},
|
|
51407
|
+
{
|
|
51408
|
+
"kind": "method",
|
|
51409
|
+
"name": "drawsControls",
|
|
51410
|
+
"privacy": "protected",
|
|
51411
|
+
"return": {
|
|
51412
|
+
"type": {
|
|
51413
|
+
"text": "boolean"
|
|
51414
|
+
}
|
|
51415
|
+
},
|
|
51416
|
+
"parameters": [
|
|
51417
|
+
{
|
|
51418
|
+
"name": "group",
|
|
51419
|
+
"type": {
|
|
51420
|
+
"text": "string"
|
|
51421
|
+
}
|
|
51422
|
+
}
|
|
51423
|
+
],
|
|
51424
|
+
"description": "Whether `controls`, or the resting controls, names a group.",
|
|
51425
|
+
"inheritedFrom": {
|
|
51426
|
+
"name": "MixinViewport",
|
|
51427
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51428
|
+
}
|
|
51429
|
+
},
|
|
51430
|
+
{
|
|
51431
|
+
"kind": "method",
|
|
51432
|
+
"name": "renderMoreControls",
|
|
51433
|
+
"privacy": "protected",
|
|
51434
|
+
"return": {
|
|
51435
|
+
"type": {
|
|
51436
|
+
"text": "TemplateResult | typeof nothing"
|
|
51437
|
+
}
|
|
51438
|
+
},
|
|
51439
|
+
"description": "More buttons for the group of controls, after zoom. None here; a family adds its own.",
|
|
51440
|
+
"inheritedFrom": {
|
|
51441
|
+
"name": "MixinViewport",
|
|
51442
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51443
|
+
}
|
|
51444
|
+
},
|
|
51445
|
+
{
|
|
51446
|
+
"kind": "method",
|
|
51447
|
+
"name": "handleMoreKeys",
|
|
51448
|
+
"privacy": "protected",
|
|
51449
|
+
"return": {
|
|
51450
|
+
"type": {
|
|
51451
|
+
"text": "boolean"
|
|
51452
|
+
}
|
|
51453
|
+
},
|
|
51454
|
+
"parameters": [
|
|
51455
|
+
{
|
|
51456
|
+
"name": "_event",
|
|
51457
|
+
"type": {
|
|
51458
|
+
"text": "KeyboardEvent"
|
|
51459
|
+
}
|
|
51460
|
+
}
|
|
51461
|
+
],
|
|
51462
|
+
"description": "Answers a key the family adds, and says whether it did. None here.",
|
|
51463
|
+
"inheritedFrom": {
|
|
51464
|
+
"name": "MixinViewport",
|
|
51465
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51466
|
+
}
|
|
51467
|
+
},
|
|
51468
|
+
{
|
|
51469
|
+
"kind": "method",
|
|
51470
|
+
"name": "sideOf",
|
|
51471
|
+
"privacy": "protected",
|
|
51472
|
+
"return": {
|
|
51473
|
+
"type": {
|
|
51474
|
+
"text": "string"
|
|
51475
|
+
}
|
|
51476
|
+
},
|
|
51477
|
+
"parameters": [
|
|
51478
|
+
{
|
|
51479
|
+
"name": "way",
|
|
51480
|
+
"type": {
|
|
51481
|
+
"text": "ViewportWay"
|
|
51482
|
+
}
|
|
51483
|
+
}
|
|
51484
|
+
],
|
|
51485
|
+
"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.",
|
|
51486
|
+
"inheritedFrom": {
|
|
51487
|
+
"name": "MixinViewport",
|
|
51488
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51489
|
+
}
|
|
51490
|
+
},
|
|
51491
|
+
{
|
|
51492
|
+
"kind": "field",
|
|
51493
|
+
"name": "rightToLeft",
|
|
51494
|
+
"type": {
|
|
51495
|
+
"text": "boolean"
|
|
51496
|
+
},
|
|
51497
|
+
"privacy": "private",
|
|
51498
|
+
"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.",
|
|
51499
|
+
"readonly": true,
|
|
51500
|
+
"inheritedFrom": {
|
|
51501
|
+
"name": "MixinViewport",
|
|
51502
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51503
|
+
}
|
|
51504
|
+
},
|
|
51505
|
+
{
|
|
51506
|
+
"kind": "method",
|
|
51507
|
+
"name": "panLabel",
|
|
51508
|
+
"privacy": "protected",
|
|
51509
|
+
"return": {
|
|
51510
|
+
"type": {
|
|
51511
|
+
"text": "string"
|
|
51512
|
+
}
|
|
51513
|
+
},
|
|
51514
|
+
"parameters": [
|
|
51515
|
+
{
|
|
51516
|
+
"name": "way",
|
|
51517
|
+
"type": {
|
|
51518
|
+
"text": "ViewportWay"
|
|
51519
|
+
}
|
|
51520
|
+
}
|
|
51521
|
+
],
|
|
51522
|
+
"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.",
|
|
51523
|
+
"inheritedFrom": {
|
|
51524
|
+
"name": "MixinViewport",
|
|
51525
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51526
|
+
}
|
|
51527
|
+
},
|
|
51528
|
+
{
|
|
51529
|
+
"kind": "method",
|
|
51530
|
+
"name": "panGlyph",
|
|
51531
|
+
"privacy": "protected",
|
|
51532
|
+
"return": {
|
|
51533
|
+
"type": {
|
|
51534
|
+
"text": "string"
|
|
51535
|
+
}
|
|
51536
|
+
},
|
|
51537
|
+
"parameters": [
|
|
51538
|
+
{
|
|
51539
|
+
"name": "way",
|
|
51540
|
+
"type": {
|
|
51541
|
+
"text": "ViewportWay"
|
|
51542
|
+
}
|
|
51543
|
+
}
|
|
51544
|
+
],
|
|
51545
|
+
"description": "The arrow drawn on a pan control, pointing the way it goes on screen.",
|
|
51546
|
+
"inheritedFrom": {
|
|
51547
|
+
"name": "MixinViewport",
|
|
51548
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51549
|
+
}
|
|
51550
|
+
},
|
|
51551
|
+
{
|
|
51552
|
+
"kind": "field",
|
|
51553
|
+
"name": "handleKeydown",
|
|
51554
|
+
"privacy": "protected",
|
|
51555
|
+
"readonly": true,
|
|
51556
|
+
"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.",
|
|
51557
|
+
"inheritedFrom": {
|
|
51558
|
+
"name": "MixinViewport",
|
|
51559
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51560
|
+
}
|
|
51561
|
+
},
|
|
51562
|
+
{
|
|
51563
|
+
"kind": "field",
|
|
51564
|
+
"name": "controlsElement",
|
|
51565
|
+
"type": {
|
|
51566
|
+
"text": "Element | null"
|
|
51567
|
+
},
|
|
51568
|
+
"privacy": "protected",
|
|
51569
|
+
"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.",
|
|
51570
|
+
"readonly": true,
|
|
51571
|
+
"inheritedFrom": {
|
|
51572
|
+
"name": "MixinViewport",
|
|
51573
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51574
|
+
}
|
|
51575
|
+
},
|
|
51576
|
+
{
|
|
51577
|
+
"kind": "method",
|
|
51578
|
+
"name": "renderControls",
|
|
51579
|
+
"privacy": "protected",
|
|
51580
|
+
"return": {
|
|
51581
|
+
"type": {
|
|
51582
|
+
"text": "TemplateResult | typeof nothing"
|
|
51583
|
+
}
|
|
51584
|
+
},
|
|
51585
|
+
"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.",
|
|
51586
|
+
"inheritedFrom": {
|
|
51587
|
+
"name": "MixinViewport",
|
|
51588
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
51589
|
+
}
|
|
51590
|
+
},
|
|
51591
|
+
{
|
|
51592
|
+
"kind": "field",
|
|
51593
|
+
"name": "active",
|
|
51594
|
+
"type": {
|
|
51595
|
+
"text": "string"
|
|
51596
|
+
},
|
|
51597
|
+
"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.",
|
|
51598
|
+
"attribute": "active",
|
|
51599
|
+
"inheritedFrom": {
|
|
51600
|
+
"name": "MixinControllerActive",
|
|
51601
|
+
"module": "src/mixins/mixin-controller-active/mixin-controller-active.ts"
|
|
51602
|
+
}
|
|
51603
|
+
},
|
|
51604
|
+
{
|
|
51605
|
+
"kind": "field",
|
|
51606
|
+
"name": "defaultActive",
|
|
51607
|
+
"type": {
|
|
51608
|
+
"text": "string"
|
|
51609
|
+
},
|
|
51610
|
+
"default": "''",
|
|
51611
|
+
"description": "The `value` of the item declared current in markup.\n\nIgnored once `active` is written.",
|
|
51612
|
+
"attribute": "default-active",
|
|
51613
|
+
"inheritedFrom": {
|
|
51614
|
+
"name": "MixinControllerActive",
|
|
51615
|
+
"module": "src/mixins/mixin-controller-active/mixin-controller-active.ts"
|
|
51616
|
+
}
|
|
51617
|
+
},
|
|
51618
|
+
{
|
|
51619
|
+
"kind": "field",
|
|
51620
|
+
"name": "activeState",
|
|
51621
|
+
"type": {
|
|
51622
|
+
"text": "string | undefined"
|
|
51623
|
+
},
|
|
51624
|
+
"privacy": "private",
|
|
51625
|
+
"default": "undefined",
|
|
51626
|
+
"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.",
|
|
51627
|
+
"inheritedFrom": {
|
|
51628
|
+
"name": "MixinControllerActive",
|
|
51629
|
+
"module": "src/mixins/mixin-controller-active/mixin-controller-active.ts"
|
|
51630
|
+
}
|
|
51631
|
+
},
|
|
51632
|
+
{
|
|
51633
|
+
"kind": "method",
|
|
51634
|
+
"name": "requestActive",
|
|
51635
|
+
"return": {
|
|
51636
|
+
"type": {
|
|
51637
|
+
"text": "boolean"
|
|
51638
|
+
}
|
|
51639
|
+
},
|
|
51640
|
+
"parameters": [
|
|
51641
|
+
{
|
|
51642
|
+
"name": "next",
|
|
51643
|
+
"type": {
|
|
51644
|
+
"text": "string"
|
|
51645
|
+
}
|
|
51646
|
+
}
|
|
51647
|
+
],
|
|
51648
|
+
"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.",
|
|
51649
|
+
"inheritedFrom": {
|
|
51650
|
+
"name": "MixinControllerActive",
|
|
51651
|
+
"module": "src/mixins/mixin-controller-active/mixin-controller-active.ts"
|
|
51652
|
+
},
|
|
51653
|
+
"type": {
|
|
51654
|
+
"text": "requestActive(next: string) => boolean"
|
|
51655
|
+
}
|
|
51656
|
+
},
|
|
51657
|
+
{
|
|
51658
|
+
"kind": "method",
|
|
51659
|
+
"name": "announceActivated",
|
|
51660
|
+
"privacy": "private",
|
|
51661
|
+
"return": {
|
|
51662
|
+
"type": {
|
|
51663
|
+
"text": "void"
|
|
51664
|
+
}
|
|
51665
|
+
},
|
|
51666
|
+
"parameters": [
|
|
51667
|
+
{
|
|
51668
|
+
"name": "value",
|
|
51669
|
+
"type": {
|
|
51670
|
+
"text": "string"
|
|
51671
|
+
}
|
|
51672
|
+
}
|
|
51673
|
+
],
|
|
51674
|
+
"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.",
|
|
51675
|
+
"inheritedFrom": {
|
|
51676
|
+
"name": "MixinControllerActive",
|
|
51677
|
+
"module": "src/mixins/mixin-controller-active/mixin-controller-active.ts"
|
|
51678
|
+
}
|
|
51679
|
+
},
|
|
51680
|
+
{
|
|
51681
|
+
"kind": "method",
|
|
51682
|
+
"name": "resolveActive",
|
|
51683
|
+
"privacy": "protected",
|
|
51684
|
+
"return": {
|
|
51685
|
+
"type": {
|
|
51686
|
+
"text": "Item | undefined"
|
|
51687
|
+
}
|
|
51688
|
+
},
|
|
51689
|
+
"parameters": [
|
|
51690
|
+
{
|
|
51691
|
+
"name": "items",
|
|
51692
|
+
"type": {
|
|
51693
|
+
"text": "Item[]"
|
|
51694
|
+
}
|
|
51695
|
+
}
|
|
51696
|
+
],
|
|
51697
|
+
"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.",
|
|
51698
|
+
"inheritedFrom": {
|
|
51699
|
+
"name": "MixinControllerActive",
|
|
51700
|
+
"module": "src/mixins/mixin-controller-active/mixin-controller-active.ts"
|
|
51701
|
+
}
|
|
51702
|
+
},
|
|
51703
|
+
{
|
|
51704
|
+
"kind": "field",
|
|
51705
|
+
"name": "tier",
|
|
51706
|
+
"type": {
|
|
51707
|
+
"text": "string"
|
|
51708
|
+
},
|
|
51709
|
+
"static": true,
|
|
51710
|
+
"default": "'helix-headless-'",
|
|
51711
|
+
"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.",
|
|
51712
|
+
"inheritedFrom": {
|
|
51713
|
+
"name": "HelixElement",
|
|
51714
|
+
"module": "src/helix-element/helix-element.ts"
|
|
51715
|
+
}
|
|
51716
|
+
},
|
|
51717
|
+
{
|
|
51718
|
+
"kind": "method",
|
|
51719
|
+
"name": "tag",
|
|
51720
|
+
"privacy": "protected",
|
|
51721
|
+
"return": {
|
|
51722
|
+
"type": {
|
|
51723
|
+
"text": "StaticValue"
|
|
51724
|
+
}
|
|
51725
|
+
},
|
|
51726
|
+
"parameters": [
|
|
51727
|
+
{
|
|
51728
|
+
"name": "name",
|
|
51729
|
+
"type": {
|
|
51730
|
+
"text": "string"
|
|
51731
|
+
}
|
|
51732
|
+
}
|
|
51733
|
+
],
|
|
51734
|
+
"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.",
|
|
51735
|
+
"inheritedFrom": {
|
|
51736
|
+
"name": "HelixElement",
|
|
51737
|
+
"module": "src/helix-element/helix-element.ts"
|
|
51738
|
+
}
|
|
51739
|
+
},
|
|
51740
|
+
{
|
|
51741
|
+
"kind": "method",
|
|
51742
|
+
"name": "partNamed",
|
|
51743
|
+
"privacy": "protected",
|
|
51744
|
+
"return": {
|
|
51745
|
+
"type": {
|
|
51746
|
+
"text": "T | null"
|
|
51747
|
+
}
|
|
51748
|
+
},
|
|
51749
|
+
"parameters": [
|
|
51750
|
+
{
|
|
51751
|
+
"name": "name",
|
|
51752
|
+
"type": {
|
|
51753
|
+
"text": "string"
|
|
51754
|
+
}
|
|
51755
|
+
}
|
|
51756
|
+
],
|
|
51757
|
+
"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.",
|
|
51758
|
+
"inheritedFrom": {
|
|
51759
|
+
"name": "HelixElement",
|
|
51760
|
+
"module": "src/helix-element/helix-element.ts"
|
|
51761
|
+
}
|
|
51762
|
+
},
|
|
51763
|
+
{
|
|
51764
|
+
"kind": "field",
|
|
51765
|
+
"name": "internals",
|
|
51766
|
+
"type": {
|
|
51767
|
+
"text": "ElementInternals"
|
|
51768
|
+
},
|
|
51769
|
+
"privacy": "protected",
|
|
51770
|
+
"readonly": true,
|
|
51771
|
+
"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.",
|
|
51772
|
+
"inheritedFrom": {
|
|
51773
|
+
"name": "HelixElement",
|
|
51774
|
+
"module": "src/helix-element/helix-element.ts"
|
|
51775
|
+
}
|
|
51776
|
+
},
|
|
51777
|
+
{
|
|
51778
|
+
"kind": "method",
|
|
51779
|
+
"name": "toggleState",
|
|
51780
|
+
"privacy": "protected",
|
|
51781
|
+
"return": {
|
|
51782
|
+
"type": {
|
|
51783
|
+
"text": "void"
|
|
51784
|
+
}
|
|
51785
|
+
},
|
|
51786
|
+
"parameters": [
|
|
51787
|
+
{
|
|
51788
|
+
"name": "name",
|
|
51789
|
+
"type": {
|
|
51790
|
+
"text": "string"
|
|
51791
|
+
}
|
|
51792
|
+
},
|
|
51793
|
+
{
|
|
51794
|
+
"name": "on",
|
|
51795
|
+
"type": {
|
|
51796
|
+
"text": "boolean"
|
|
51797
|
+
}
|
|
51798
|
+
}
|
|
51799
|
+
],
|
|
51800
|
+
"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.",
|
|
51801
|
+
"inheritedFrom": {
|
|
51802
|
+
"name": "HelixElement",
|
|
51803
|
+
"module": "src/helix-element/helix-element.ts"
|
|
51804
|
+
}
|
|
51805
|
+
},
|
|
51806
|
+
{
|
|
51807
|
+
"kind": "field",
|
|
51808
|
+
"name": "whenSettled",
|
|
51809
|
+
"type": {
|
|
51810
|
+
"text": "Promise<void>"
|
|
51811
|
+
},
|
|
51812
|
+
"readonly": true,
|
|
51813
|
+
"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.",
|
|
51814
|
+
"default": "new Promise<void>((resolve) => { this.resolveSettled = resolve })",
|
|
51815
|
+
"inheritedFrom": {
|
|
51816
|
+
"name": "HelixElement",
|
|
51817
|
+
"module": "src/helix-element/helix-element.ts"
|
|
51818
|
+
}
|
|
51819
|
+
},
|
|
51820
|
+
{
|
|
51821
|
+
"kind": "field",
|
|
51822
|
+
"name": "resolveSettled",
|
|
51823
|
+
"type": {
|
|
51824
|
+
"text": "() => void"
|
|
51825
|
+
},
|
|
51826
|
+
"privacy": "private",
|
|
51827
|
+
"description": "Resolves `whenSettled`, once, from the frame that records the state.",
|
|
51828
|
+
"inheritedFrom": {
|
|
51829
|
+
"name": "HelixElement",
|
|
51830
|
+
"module": "src/helix-element/helix-element.ts"
|
|
51831
|
+
}
|
|
51832
|
+
},
|
|
51833
|
+
{
|
|
51834
|
+
"kind": "field",
|
|
51835
|
+
"name": "fromServer",
|
|
51836
|
+
"type": {
|
|
51837
|
+
"text": "boolean"
|
|
51838
|
+
},
|
|
51839
|
+
"privacy": "private",
|
|
51840
|
+
"default": "false",
|
|
51841
|
+
"description": "Whether the shadow root was a server's, parsed from declarative shadow DOM.",
|
|
51842
|
+
"inheritedFrom": {
|
|
51843
|
+
"name": "HelixElement",
|
|
51844
|
+
"module": "src/helix-element/helix-element.ts"
|
|
51845
|
+
}
|
|
51846
|
+
},
|
|
51847
|
+
{
|
|
51848
|
+
"kind": "field",
|
|
51849
|
+
"name": "hydrating",
|
|
51850
|
+
"type": {
|
|
51851
|
+
"text": "boolean"
|
|
51852
|
+
},
|
|
51853
|
+
"privacy": "protected",
|
|
51854
|
+
"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.",
|
|
51855
|
+
"readonly": true,
|
|
51856
|
+
"inheritedFrom": {
|
|
51857
|
+
"name": "HelixElement",
|
|
51858
|
+
"module": "src/helix-element/helix-element.ts"
|
|
51859
|
+
}
|
|
51860
|
+
},
|
|
51861
|
+
{
|
|
51862
|
+
"kind": "field",
|
|
51863
|
+
"name": "serverRendered",
|
|
51864
|
+
"type": {
|
|
51865
|
+
"text": "boolean"
|
|
51866
|
+
},
|
|
51867
|
+
"privacy": "protected",
|
|
51868
|
+
"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.",
|
|
51869
|
+
"readonly": true,
|
|
51870
|
+
"inheritedFrom": {
|
|
51871
|
+
"name": "HelixElement",
|
|
51872
|
+
"module": "src/helix-element/helix-element.ts"
|
|
51873
|
+
}
|
|
51874
|
+
},
|
|
51875
|
+
{
|
|
51876
|
+
"kind": "method",
|
|
51877
|
+
"name": "finishHydration",
|
|
51878
|
+
"privacy": "protected",
|
|
51879
|
+
"return": {
|
|
51880
|
+
"type": {
|
|
51881
|
+
"text": "void"
|
|
51882
|
+
}
|
|
51883
|
+
},
|
|
51884
|
+
"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.",
|
|
51885
|
+
"inheritedFrom": {
|
|
51886
|
+
"name": "HelixElement",
|
|
51887
|
+
"module": "src/helix-element/helix-element.ts"
|
|
51888
|
+
}
|
|
51889
|
+
},
|
|
51890
|
+
{
|
|
51891
|
+
"kind": "field",
|
|
51892
|
+
"name": "childrenKnown",
|
|
51893
|
+
"type": {
|
|
51894
|
+
"text": "boolean"
|
|
51895
|
+
},
|
|
51896
|
+
"privacy": "protected",
|
|
51897
|
+
"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.",
|
|
51898
|
+
"readonly": true,
|
|
51899
|
+
"inheritedFrom": {
|
|
51900
|
+
"name": "HelixElement",
|
|
51901
|
+
"module": "src/helix-element/helix-element.ts"
|
|
51902
|
+
}
|
|
51903
|
+
},
|
|
51904
|
+
{
|
|
51905
|
+
"kind": "field",
|
|
51906
|
+
"name": "knownChildren",
|
|
51907
|
+
"type": {
|
|
51908
|
+
"text": "Element[]"
|
|
51909
|
+
},
|
|
51910
|
+
"privacy": "protected",
|
|
51911
|
+
"description": "The children a render may read: all of them where they are known, and none otherwise.",
|
|
51912
|
+
"readonly": true,
|
|
51913
|
+
"inheritedFrom": {
|
|
51914
|
+
"name": "HelixElement",
|
|
51915
|
+
"module": "src/helix-element/helix-element.ts"
|
|
51916
|
+
}
|
|
51917
|
+
},
|
|
51918
|
+
{
|
|
51919
|
+
"kind": "field",
|
|
51920
|
+
"name": "assignsByName",
|
|
51921
|
+
"type": {
|
|
51922
|
+
"text": "boolean"
|
|
51923
|
+
},
|
|
51924
|
+
"privacy": "protected",
|
|
51925
|
+
"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.",
|
|
51926
|
+
"readonly": true,
|
|
51927
|
+
"inheritedFrom": {
|
|
51928
|
+
"name": "HelixElement",
|
|
51929
|
+
"module": "src/helix-element/helix-element.ts"
|
|
51930
|
+
}
|
|
51931
|
+
},
|
|
51932
|
+
{
|
|
51933
|
+
"kind": "method",
|
|
51934
|
+
"name": "route",
|
|
51935
|
+
"privacy": "protected",
|
|
51936
|
+
"return": {
|
|
51937
|
+
"type": {
|
|
51938
|
+
"text": "void"
|
|
51939
|
+
}
|
|
51940
|
+
},
|
|
51941
|
+
"parameters": [
|
|
51942
|
+
{
|
|
51943
|
+
"name": "child",
|
|
51944
|
+
"type": {
|
|
51945
|
+
"text": "Element"
|
|
51946
|
+
}
|
|
51947
|
+
},
|
|
51948
|
+
{
|
|
51949
|
+
"name": "name",
|
|
51950
|
+
"type": {
|
|
51951
|
+
"text": "string | undefined"
|
|
51952
|
+
}
|
|
51953
|
+
}
|
|
51954
|
+
],
|
|
51955
|
+
"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.",
|
|
51956
|
+
"inheritedFrom": {
|
|
51957
|
+
"name": "HelixElement",
|
|
51958
|
+
"module": "src/helix-element/helix-element.ts"
|
|
51959
|
+
}
|
|
51960
|
+
},
|
|
51961
|
+
{
|
|
51962
|
+
"kind": "field",
|
|
51963
|
+
"name": "stopInner",
|
|
51964
|
+
"privacy": "protected",
|
|
51965
|
+
"readonly": true,
|
|
51966
|
+
"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.",
|
|
51967
|
+
"inheritedFrom": {
|
|
51968
|
+
"name": "HelixElement",
|
|
51969
|
+
"module": "src/helix-element/helix-element.ts"
|
|
51970
|
+
}
|
|
51971
|
+
},
|
|
51972
|
+
{
|
|
51973
|
+
"kind": "method",
|
|
51974
|
+
"name": "relayNativeEvent",
|
|
51975
|
+
"privacy": "protected",
|
|
51976
|
+
"return": {
|
|
51977
|
+
"type": {
|
|
51978
|
+
"text": "void"
|
|
51979
|
+
}
|
|
51980
|
+
},
|
|
51981
|
+
"parameters": [
|
|
51982
|
+
{
|
|
51983
|
+
"name": "event",
|
|
51984
|
+
"type": {
|
|
51985
|
+
"text": "Event"
|
|
51986
|
+
}
|
|
51987
|
+
},
|
|
51988
|
+
{
|
|
51989
|
+
"name": "init",
|
|
51990
|
+
"optional": true,
|
|
51991
|
+
"type": {
|
|
51992
|
+
"text": "EventInit"
|
|
51993
|
+
}
|
|
51994
|
+
}
|
|
51995
|
+
],
|
|
51996
|
+
"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.",
|
|
51997
|
+
"inheritedFrom": {
|
|
51998
|
+
"name": "HelixElement",
|
|
51999
|
+
"module": "src/helix-element/helix-element.ts"
|
|
52000
|
+
}
|
|
52001
|
+
},
|
|
52002
|
+
{
|
|
52003
|
+
"kind": "method",
|
|
52004
|
+
"name": "finalizeStyles",
|
|
52005
|
+
"privacy": "protected",
|
|
52006
|
+
"static": true,
|
|
52007
|
+
"return": {
|
|
52008
|
+
"type": {
|
|
52009
|
+
"text": "CSSResultOrNative[]"
|
|
52010
|
+
}
|
|
52011
|
+
},
|
|
52012
|
+
"parameters": [
|
|
52013
|
+
{
|
|
52014
|
+
"name": "styles",
|
|
52015
|
+
"optional": true,
|
|
52016
|
+
"type": {
|
|
52017
|
+
"text": "CSSResultOrNative | CSSResultOrNative[]"
|
|
52018
|
+
}
|
|
52019
|
+
}
|
|
52020
|
+
],
|
|
52021
|
+
"description": "Prepends the shadow-root reset to every subclass's styles, so no component\nhas to remember to include it.",
|
|
52022
|
+
"inheritedFrom": {
|
|
52023
|
+
"name": "HelixElement",
|
|
52024
|
+
"module": "src/helix-element/helix-element.ts"
|
|
52025
|
+
}
|
|
52026
|
+
}
|
|
52027
|
+
],
|
|
52028
|
+
"events": [
|
|
52029
|
+
{
|
|
52030
|
+
"type": {
|
|
52031
|
+
"text": "HelixActivateEvent"
|
|
52032
|
+
},
|
|
52033
|
+
"description": "A note was selected, in the list or in the drawing. The detail's `value` is its `id`.",
|
|
52034
|
+
"name": "helix-activate",
|
|
52035
|
+
"reactProp": "onhelix-activate"
|
|
52036
|
+
},
|
|
52037
|
+
{
|
|
52038
|
+
"type": {
|
|
52039
|
+
"text": "HelixBeforeActivateEvent"
|
|
52040
|
+
},
|
|
52041
|
+
"description": "A note is about to be selected. Cancelable: cancel it to keep the selection in your own state.",
|
|
52042
|
+
"name": "helix-before-activate",
|
|
52043
|
+
"reactProp": "onhelix-before-activate"
|
|
52044
|
+
},
|
|
52045
|
+
{
|
|
52046
|
+
"type": {
|
|
52047
|
+
"text": "HelixGraphLayoutEvent"
|
|
52048
|
+
},
|
|
52049
|
+
"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`.",
|
|
52050
|
+
"name": "helix-graph-layout",
|
|
52051
|
+
"reactProp": "onhelix-graph-layout"
|
|
52052
|
+
},
|
|
52053
|
+
{
|
|
52054
|
+
"type": {
|
|
52055
|
+
"text": "HelixGraphPanEvent"
|
|
52056
|
+
},
|
|
52057
|
+
"description": "A pan button or arrow key was pressed. `connectGraph` moves the drawing.",
|
|
52058
|
+
"name": "helix-graph-pan",
|
|
52059
|
+
"reactProp": "onhelix-graph-pan"
|
|
52060
|
+
},
|
|
52061
|
+
{
|
|
52062
|
+
"type": {
|
|
52063
|
+
"text": "HelixGraphPartChangeEvent"
|
|
52064
|
+
},
|
|
52065
|
+
"description": "The notes, the links, the selection, the depth or the gestures changed. Used by `connectGraph`; pages do not need to listen for it.",
|
|
52066
|
+
"name": "helix-graph-part-change",
|
|
52067
|
+
"reactProp": "onhelix-graph-part-change"
|
|
52068
|
+
},
|
|
52069
|
+
{
|
|
52070
|
+
"type": {
|
|
52071
|
+
"text": "HelixGraphReadyEvent"
|
|
52072
|
+
},
|
|
52073
|
+
"description": "The graph has been drawn whole, laid out and settled. Sent each time `drawn()` says it is drawn after it was not.",
|
|
52074
|
+
"name": "helix-graph-ready",
|
|
52075
|
+
"reactProp": "onhelix-graph-ready"
|
|
52076
|
+
},
|
|
52077
|
+
{
|
|
52078
|
+
"type": {
|
|
52079
|
+
"text": "HelixGraphZoomEvent"
|
|
52080
|
+
},
|
|
52081
|
+
"description": "A zoom button or key was pressed. `connectGraph` zooms the drawing.",
|
|
52082
|
+
"name": "helix-graph-zoom",
|
|
52083
|
+
"reactProp": "onhelix-graph-zoom"
|
|
52084
|
+
}
|
|
52085
|
+
],
|
|
52086
|
+
"attributes": [
|
|
52087
|
+
{
|
|
52088
|
+
"name": "count-label",
|
|
52089
|
+
"type": {
|
|
52090
|
+
"text": "string"
|
|
52091
|
+
},
|
|
52092
|
+
"default": "'{count} notes'",
|
|
52093
|
+
"description": "What the list says of a note's count, with `{count}`.",
|
|
52094
|
+
"fieldName": "countLabel"
|
|
52095
|
+
},
|
|
52096
|
+
{
|
|
52097
|
+
"name": "depth",
|
|
52098
|
+
"type": {
|
|
52099
|
+
"text": "number | undefined"
|
|
52100
|
+
},
|
|
52101
|
+
"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.",
|
|
52102
|
+
"fieldName": "depth"
|
|
52103
|
+
},
|
|
52104
|
+
{
|
|
52105
|
+
"name": "label",
|
|
52106
|
+
"type": {
|
|
52107
|
+
"text": "string"
|
|
52108
|
+
},
|
|
52109
|
+
"default": "''",
|
|
52110
|
+
"description": "The graph's name, read by screen readers, such as \"Research notes\".\nRequired.",
|
|
52111
|
+
"fieldName": "label"
|
|
52112
|
+
},
|
|
52113
|
+
{
|
|
52114
|
+
"name": "linked-both-label",
|
|
52115
|
+
"type": {
|
|
52116
|
+
"text": "string"
|
|
52117
|
+
},
|
|
52118
|
+
"default": "'Linked both ways with {note}'",
|
|
52119
|
+
"description": "How a note linked both to and from the selected one is described, with `{note}`.",
|
|
52120
|
+
"fieldName": "linkedBothLabel"
|
|
52121
|
+
},
|
|
52122
|
+
{
|
|
52123
|
+
"name": "linked-from-label",
|
|
52124
|
+
"type": {
|
|
52125
|
+
"text": "string"
|
|
52126
|
+
},
|
|
52127
|
+
"default": "'Linked from {note}'",
|
|
52128
|
+
"description": "How a note the selected one links to is described, with `{note}`, the selected note's name.",
|
|
52129
|
+
"fieldName": "linkedFromLabel"
|
|
52130
|
+
},
|
|
52131
|
+
{
|
|
52132
|
+
"name": "links-to-label",
|
|
52133
|
+
"type": {
|
|
52134
|
+
"text": "string"
|
|
52135
|
+
},
|
|
52136
|
+
"default": "'Links to {note}'",
|
|
52137
|
+
"description": "How a note that links to the selected one is described, with `{note}`.",
|
|
52138
|
+
"fieldName": "linksToLabel"
|
|
52139
|
+
},
|
|
52140
|
+
{
|
|
52141
|
+
"name": "notes-label",
|
|
52142
|
+
"type": {
|
|
52143
|
+
"text": "string"
|
|
52144
|
+
},
|
|
52145
|
+
"default": "'Notes'",
|
|
52146
|
+
"description": "The list's name, read by screen readers.",
|
|
52147
|
+
"fieldName": "notesLabel"
|
|
52148
|
+
},
|
|
52149
|
+
{
|
|
52150
|
+
"name": "search-label",
|
|
52151
|
+
"type": {
|
|
52152
|
+
"text": "string"
|
|
52153
|
+
},
|
|
52154
|
+
"default": "'Find a note'",
|
|
52155
|
+
"description": "The search field's name.",
|
|
52156
|
+
"fieldName": "searchLabel"
|
|
52157
|
+
},
|
|
52158
|
+
{
|
|
52159
|
+
"name": "selected-label",
|
|
52160
|
+
"type": {
|
|
52161
|
+
"text": "string"
|
|
52162
|
+
},
|
|
52163
|
+
"default": "'Selected'",
|
|
52164
|
+
"description": "How the selected note is described in the list.",
|
|
52165
|
+
"fieldName": "selectedLabel"
|
|
52166
|
+
},
|
|
52167
|
+
{
|
|
52168
|
+
"name": "activate-hint-label",
|
|
52169
|
+
"type": {
|
|
52170
|
+
"text": "string | undefined"
|
|
52171
|
+
},
|
|
52172
|
+
"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.",
|
|
52173
|
+
"fieldName": "activateHintLabel",
|
|
52174
|
+
"inheritedFrom": {
|
|
52175
|
+
"name": "MixinViewport",
|
|
52176
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
52177
|
+
}
|
|
52178
|
+
},
|
|
52179
|
+
{
|
|
52180
|
+
"name": "controls",
|
|
52181
|
+
"type": {
|
|
52182
|
+
"text": "string | undefined"
|
|
52183
|
+
},
|
|
52184
|
+
"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.",
|
|
52185
|
+
"fieldName": "controls",
|
|
52186
|
+
"inheritedFrom": {
|
|
52187
|
+
"name": "MixinViewport",
|
|
52188
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
52189
|
+
}
|
|
52190
|
+
},
|
|
52191
|
+
{
|
|
52192
|
+
"name": "controls-label",
|
|
52193
|
+
"type": {
|
|
52194
|
+
"text": "string | undefined"
|
|
52195
|
+
},
|
|
52196
|
+
"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.",
|
|
52197
|
+
"fieldName": "controlsLabel",
|
|
52198
|
+
"inheritedFrom": {
|
|
52199
|
+
"name": "MixinViewport",
|
|
52200
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
52201
|
+
}
|
|
52202
|
+
},
|
|
52203
|
+
{
|
|
52204
|
+
"name": "controls-placement",
|
|
52205
|
+
"type": {
|
|
52206
|
+
"text": "'top-start' | 'top-end' | 'bottom-start' | 'bottom-end' | undefined"
|
|
52207
|
+
},
|
|
52208
|
+
"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.",
|
|
52209
|
+
"fieldName": "controlsPlacement",
|
|
52210
|
+
"inheritedFrom": {
|
|
52211
|
+
"name": "MixinViewport",
|
|
52212
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
52213
|
+
}
|
|
52214
|
+
},
|
|
52215
|
+
{
|
|
52216
|
+
"name": "fullscreen-label",
|
|
52217
|
+
"type": {
|
|
52218
|
+
"text": "string"
|
|
52219
|
+
},
|
|
52220
|
+
"default": "'Fill the screen'",
|
|
52221
|
+
"description": "The fullscreen button's label.",
|
|
52222
|
+
"fieldName": "fullscreenLabel",
|
|
52223
|
+
"inheritedFrom": {
|
|
52224
|
+
"name": "MixinViewport",
|
|
52225
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
52226
|
+
}
|
|
52227
|
+
},
|
|
52228
|
+
{
|
|
52229
|
+
"name": "gestures",
|
|
52230
|
+
"type": {
|
|
52231
|
+
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
52232
|
+
},
|
|
52233
|
+
"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.",
|
|
52234
|
+
"fieldName": "gestures",
|
|
52235
|
+
"inheritedFrom": {
|
|
52236
|
+
"name": "MixinViewport",
|
|
52237
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
52238
|
+
}
|
|
52239
|
+
},
|
|
52240
|
+
{
|
|
52241
|
+
"name": "idle-delay",
|
|
52242
|
+
"type": {
|
|
52243
|
+
"text": "number"
|
|
52244
|
+
},
|
|
52245
|
+
"default": "0",
|
|
52246
|
+
"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.",
|
|
52247
|
+
"fieldName": "idleDelay",
|
|
52248
|
+
"inheritedFrom": {
|
|
52249
|
+
"name": "MixinViewport",
|
|
52250
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
52251
|
+
}
|
|
52252
|
+
},
|
|
52253
|
+
{
|
|
52254
|
+
"name": "pan-down-label",
|
|
52255
|
+
"type": {
|
|
52256
|
+
"text": "string"
|
|
52257
|
+
},
|
|
52258
|
+
"default": "'Pan down'",
|
|
52259
|
+
"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.",
|
|
52260
|
+
"fieldName": "panDownLabel",
|
|
52261
|
+
"inheritedFrom": {
|
|
52262
|
+
"name": "MixinViewport",
|
|
52263
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
52264
|
+
}
|
|
52265
|
+
},
|
|
52266
|
+
{
|
|
52267
|
+
"name": "pan-left-label",
|
|
52268
|
+
"type": {
|
|
52269
|
+
"text": "string"
|
|
52270
|
+
},
|
|
52271
|
+
"default": "'Pan left'",
|
|
52272
|
+
"description": "The pan left button's label.",
|
|
52273
|
+
"fieldName": "panLeftLabel",
|
|
52274
|
+
"inheritedFrom": {
|
|
52275
|
+
"name": "MixinViewport",
|
|
52276
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
52277
|
+
}
|
|
52278
|
+
},
|
|
52279
|
+
{
|
|
52280
|
+
"name": "pan-right-label",
|
|
52281
|
+
"type": {
|
|
52282
|
+
"text": "string"
|
|
52283
|
+
},
|
|
52284
|
+
"default": "'Pan right'",
|
|
52285
|
+
"description": "The pan right button's label.",
|
|
52286
|
+
"fieldName": "panRightLabel",
|
|
52287
|
+
"inheritedFrom": {
|
|
52288
|
+
"name": "MixinViewport",
|
|
52289
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
52290
|
+
}
|
|
52291
|
+
},
|
|
52292
|
+
{
|
|
52293
|
+
"name": "pan-step",
|
|
52294
|
+
"type": {
|
|
52295
|
+
"text": "number"
|
|
52296
|
+
},
|
|
52297
|
+
"default": "0.25",
|
|
52298
|
+
"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.",
|
|
52299
|
+
"fieldName": "panStep",
|
|
52300
|
+
"inheritedFrom": {
|
|
52301
|
+
"name": "MixinViewport",
|
|
52302
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
52303
|
+
}
|
|
52304
|
+
},
|
|
52305
|
+
{
|
|
52306
|
+
"name": "pan-up-label",
|
|
52307
|
+
"type": {
|
|
52308
|
+
"text": "string"
|
|
52309
|
+
},
|
|
52310
|
+
"default": "'Pan up'",
|
|
52311
|
+
"description": "The pan up button's label.",
|
|
52312
|
+
"fieldName": "panUpLabel",
|
|
52313
|
+
"inheritedFrom": {
|
|
52314
|
+
"name": "MixinViewport",
|
|
52315
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
52316
|
+
}
|
|
52317
|
+
},
|
|
52318
|
+
{
|
|
52319
|
+
"name": "two-finger-hint-label",
|
|
52320
|
+
"type": {
|
|
52321
|
+
"text": "string | undefined"
|
|
52322
|
+
},
|
|
52323
|
+
"description": "The hint shown when one finger swipes over a surface with\n`gestures=\"cooperative\"`. Absent is the family's own.",
|
|
52324
|
+
"fieldName": "twoFingerHintLabel",
|
|
52325
|
+
"inheritedFrom": {
|
|
52326
|
+
"name": "MixinViewport",
|
|
52327
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
52328
|
+
}
|
|
52329
|
+
},
|
|
52330
|
+
{
|
|
52331
|
+
"name": "using-label",
|
|
52332
|
+
"type": {
|
|
52333
|
+
"text": "string | undefined"
|
|
52334
|
+
},
|
|
52335
|
+
"description": "The line shown while a surface with `gestures=\"activate\"` has the\ngestures. Absent is the family's own.",
|
|
52336
|
+
"fieldName": "usingLabel",
|
|
52337
|
+
"inheritedFrom": {
|
|
52338
|
+
"name": "MixinViewport",
|
|
52339
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
52340
|
+
}
|
|
52341
|
+
},
|
|
52342
|
+
{
|
|
52343
|
+
"name": "wheel-hint-label",
|
|
52344
|
+
"type": {
|
|
52345
|
+
"text": "string | undefined"
|
|
52346
|
+
},
|
|
52347
|
+
"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.",
|
|
52348
|
+
"fieldName": "wheelHintLabel",
|
|
52349
|
+
"inheritedFrom": {
|
|
52350
|
+
"name": "MixinViewport",
|
|
52351
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
52352
|
+
}
|
|
52353
|
+
},
|
|
52354
|
+
{
|
|
52355
|
+
"name": "zoom-in-label",
|
|
52356
|
+
"type": {
|
|
52357
|
+
"text": "string"
|
|
52358
|
+
},
|
|
52359
|
+
"default": "'Zoom in'",
|
|
52360
|
+
"description": "The zoom in button's label.",
|
|
52361
|
+
"fieldName": "zoomInLabel",
|
|
52362
|
+
"inheritedFrom": {
|
|
52363
|
+
"name": "MixinViewport",
|
|
52364
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
52365
|
+
}
|
|
52366
|
+
},
|
|
52367
|
+
{
|
|
52368
|
+
"name": "zoom-out-label",
|
|
52369
|
+
"type": {
|
|
52370
|
+
"text": "string"
|
|
52371
|
+
},
|
|
52372
|
+
"default": "'Zoom out'",
|
|
52373
|
+
"description": "The zoom out button's label.",
|
|
52374
|
+
"fieldName": "zoomOutLabel",
|
|
52375
|
+
"inheritedFrom": {
|
|
52376
|
+
"name": "MixinViewport",
|
|
52377
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
52378
|
+
}
|
|
52379
|
+
},
|
|
52380
|
+
{
|
|
52381
|
+
"name": "active",
|
|
52382
|
+
"type": {
|
|
52383
|
+
"text": "string"
|
|
52384
|
+
},
|
|
52385
|
+
"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.",
|
|
52386
|
+
"fieldName": "active",
|
|
52387
|
+
"inheritedFrom": {
|
|
52388
|
+
"name": "MixinControllerActive",
|
|
52389
|
+
"module": "src/mixins/mixin-controller-active/mixin-controller-active.ts"
|
|
52390
|
+
}
|
|
52391
|
+
},
|
|
52392
|
+
{
|
|
52393
|
+
"name": "default-active",
|
|
52394
|
+
"type": {
|
|
52395
|
+
"text": "string"
|
|
52396
|
+
},
|
|
52397
|
+
"default": "''",
|
|
52398
|
+
"description": "The `value` of the item declared current in markup.\n\nIgnored once `active` is written.",
|
|
52399
|
+
"fieldName": "defaultActive",
|
|
52400
|
+
"inheritedFrom": {
|
|
52401
|
+
"name": "MixinControllerActive",
|
|
52402
|
+
"module": "src/mixins/mixin-controller-active/mixin-controller-active.ts"
|
|
52403
|
+
}
|
|
52404
|
+
}
|
|
52405
|
+
],
|
|
52406
|
+
"cssStates": [
|
|
52407
|
+
{
|
|
52408
|
+
"description": "The graph fills the screen.",
|
|
52409
|
+
"name": "fullscreen"
|
|
52410
|
+
},
|
|
52411
|
+
{
|
|
52412
|
+
"description": "The user has been still long enough for the header and footer to fade.",
|
|
52413
|
+
"name": "idle"
|
|
52414
|
+
},
|
|
52415
|
+
{
|
|
52416
|
+
"description": "The graph has been drawn whole, after `helix-graph-ready`.",
|
|
52417
|
+
"name": "ready"
|
|
52418
|
+
},
|
|
52419
|
+
{
|
|
52420
|
+
"description": "The page keeps the plain wheel and one finger, with `gestures=\"cooperative\"` or while a graph with `gestures=\"activate\"` waits to be pressed.",
|
|
52421
|
+
"name": "sharing"
|
|
52422
|
+
},
|
|
52423
|
+
{
|
|
52424
|
+
"description": "A graph with `gestures=\"activate\"` has been pressed and has the gestures.",
|
|
52425
|
+
"name": "using"
|
|
52426
|
+
},
|
|
52427
|
+
{
|
|
52428
|
+
"description": "Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.",
|
|
52429
|
+
"name": "settled",
|
|
52430
|
+
"inheritedFrom": {
|
|
52431
|
+
"name": "HelixElement",
|
|
52432
|
+
"module": "src/helix-element/helix-element.ts"
|
|
52433
|
+
}
|
|
52434
|
+
}
|
|
52435
|
+
],
|
|
52436
|
+
"mixins": [
|
|
52437
|
+
{
|
|
52438
|
+
"name": "MixinViewport",
|
|
52439
|
+
"package": "@fusion.dev/helix-core"
|
|
52440
|
+
},
|
|
52441
|
+
{
|
|
52442
|
+
"name": "MixinControllerActive",
|
|
52443
|
+
"package": "@fusion.dev/helix-core"
|
|
52444
|
+
}
|
|
52445
|
+
],
|
|
52446
|
+
"superclass": {
|
|
52447
|
+
"name": "HelixElement",
|
|
52448
|
+
"package": "@fusion.dev/helix-core"
|
|
52449
|
+
},
|
|
52450
|
+
"summary": "A frame around a graph of notes drawn by another library, and the list that makes it readable.",
|
|
52451
|
+
"helix": {
|
|
52452
|
+
"category": "media",
|
|
52453
|
+
"since": "0.116.0",
|
|
52454
|
+
"status": "experimental",
|
|
52455
|
+
"documentation": "https://fusion.dev/helix/components/graph",
|
|
52456
|
+
"aliases": [
|
|
52457
|
+
"Knowledge graph",
|
|
52458
|
+
"Network",
|
|
52459
|
+
"Note graph",
|
|
52460
|
+
"Second brain"
|
|
52461
|
+
],
|
|
52462
|
+
"tier": "headless",
|
|
52463
|
+
"group": "BaseGraph",
|
|
52464
|
+
"part": "Root",
|
|
52465
|
+
"examples": [
|
|
52466
|
+
{
|
|
52467
|
+
"description": "The graph frame on the headless tier, with every style written by hand.",
|
|
52468
|
+
"slug": "preview"
|
|
52469
|
+
}
|
|
52470
|
+
],
|
|
52471
|
+
"source": "helix/headless/src/graph"
|
|
52472
|
+
},
|
|
52473
|
+
"tagName": "helix-headless-graph",
|
|
52474
|
+
"customElement": true,
|
|
52475
|
+
"modulePath": "src/graph/root/graph-root.ts",
|
|
52476
|
+
"definitionPath": "src/graph/root/graph-root.ts"
|
|
52477
|
+
}
|
|
52478
|
+
],
|
|
52479
|
+
"exports": [
|
|
52480
|
+
{
|
|
52481
|
+
"kind": "js",
|
|
52482
|
+
"name": "HelixHeadlessGraph",
|
|
52483
|
+
"declaration": {
|
|
52484
|
+
"name": "HelixHeadlessGraph",
|
|
52485
|
+
"module": "src/graph/root/graph-root.ts"
|
|
52486
|
+
}
|
|
52487
|
+
},
|
|
52488
|
+
{
|
|
52489
|
+
"kind": "custom-element-definition",
|
|
52490
|
+
"name": "helix-headless-graph",
|
|
52491
|
+
"declaration": {
|
|
52492
|
+
"name": "HelixHeadlessGraph",
|
|
52493
|
+
"module": "src/graph/root/graph-root.ts"
|
|
52494
|
+
}
|
|
52495
|
+
}
|
|
52496
|
+
]
|
|
52497
|
+
},
|
|
52498
|
+
{
|
|
52499
|
+
"kind": "javascript-module",
|
|
52500
|
+
"path": "src/heatmap/index.ts",
|
|
52501
|
+
"declarations": [],
|
|
52502
|
+
"exports": [
|
|
52503
|
+
{
|
|
52504
|
+
"kind": "js",
|
|
52505
|
+
"name": "fits",
|
|
52506
|
+
"declaration": {
|
|
52507
|
+
"name": "fits",
|
|
52508
|
+
"module": "./root/buckets.js"
|
|
52509
|
+
}
|
|
52510
|
+
},
|
|
52511
|
+
{
|
|
52512
|
+
"kind": "js",
|
|
52513
|
+
"name": "Reading",
|
|
52514
|
+
"declaration": {
|
|
52515
|
+
"name": "Reading",
|
|
52516
|
+
"module": "./root/buckets.js"
|
|
52517
|
+
}
|
|
52518
|
+
},
|
|
52519
|
+
{
|
|
52520
|
+
"kind": "js",
|
|
52521
|
+
"name": "toneOf",
|
|
52522
|
+
"declaration": {
|
|
52523
|
+
"name": "toneOf",
|
|
52524
|
+
"module": "./root/buckets.js"
|
|
52525
|
+
}
|
|
52526
|
+
},
|
|
52527
|
+
{
|
|
52528
|
+
"kind": "js",
|
|
52529
|
+
"name": "HelixHeadlessHeatmap",
|
|
52530
|
+
"declaration": {
|
|
52531
|
+
"name": "HelixHeadlessHeatmap",
|
|
52532
|
+
"module": "./root/heatmap-root.js"
|
|
52533
|
+
}
|
|
52534
|
+
}
|
|
52535
|
+
]
|
|
52536
|
+
},
|
|
52537
|
+
{
|
|
52538
|
+
"kind": "javascript-module",
|
|
52539
|
+
"path": "src/heatmap/root/buckets.ts",
|
|
52540
|
+
"declarations": [
|
|
52541
|
+
{
|
|
52542
|
+
"kind": "function",
|
|
52543
|
+
"name": "toneOf",
|
|
52544
|
+
"return": {
|
|
52545
|
+
"type": {
|
|
52546
|
+
"text": "string | undefined"
|
|
52547
|
+
}
|
|
52548
|
+
},
|
|
52549
|
+
"parameters": [
|
|
52550
|
+
{
|
|
52551
|
+
"name": "reading",
|
|
52552
|
+
"type": {
|
|
52553
|
+
"text": "Reading"
|
|
52554
|
+
}
|
|
52555
|
+
},
|
|
52556
|
+
{
|
|
52557
|
+
"name": "thresholds",
|
|
52558
|
+
"type": {
|
|
52559
|
+
"text": "readonly number[]"
|
|
52560
|
+
}
|
|
52561
|
+
},
|
|
52562
|
+
{
|
|
52563
|
+
"name": "tones",
|
|
52564
|
+
"type": {
|
|
52565
|
+
"text": "readonly string[]"
|
|
52566
|
+
}
|
|
52567
|
+
}
|
|
52568
|
+
],
|
|
52569
|
+
"description": "The tone for one reading, from its own `data-tone` or from the thresholds.\n\n**The cell's own tone wins**, and that ordering is the whole reason both\nexist. A status page already knows a day was degraded; making it encode that\nas a number so a component can decode it again is work for nothing, and the\nencoding would have to agree with the thresholds or the colors would drift\nfrom the truth. A contribution graph has only counts and wants the buckets.\n\nThresholds are read as lower bounds, in the order given, and the last one that\na value reaches wins. `thresholds=\"0,1,3,6\"` with `tones=\"muted,info,accent,success\"`\nputs 0 in `muted`, 1 and 2 in `info`, 3 to 5 in `accent`, and 6 upward in\n`success`. A value below the first bound gets no tone rather than the first\none: an empty cell in a contribution graph is a day with nothing in it, and\npainting it as the lowest bucket claims a reading that does not exist."
|
|
52570
|
+
},
|
|
52571
|
+
{
|
|
52572
|
+
"kind": "function",
|
|
52573
|
+
"name": "fits",
|
|
52574
|
+
"return": {
|
|
52575
|
+
"type": {
|
|
52576
|
+
"text": "number"
|
|
52577
|
+
}
|
|
52578
|
+
},
|
|
52579
|
+
"parameters": [
|
|
52580
|
+
{
|
|
52581
|
+
"name": "total",
|
|
52582
|
+
"type": {
|
|
52583
|
+
"text": "number"
|
|
52584
|
+
}
|
|
52585
|
+
},
|
|
52586
|
+
{
|
|
52587
|
+
"name": "width",
|
|
52588
|
+
"type": {
|
|
52589
|
+
"text": "number"
|
|
52590
|
+
}
|
|
52591
|
+
},
|
|
52592
|
+
{
|
|
52593
|
+
"name": "minimum",
|
|
52594
|
+
"type": {
|
|
52595
|
+
"text": "number"
|
|
52596
|
+
}
|
|
52597
|
+
},
|
|
52598
|
+
{
|
|
52599
|
+
"name": "gap",
|
|
52600
|
+
"type": {
|
|
52601
|
+
"text": "number"
|
|
52602
|
+
}
|
|
52603
|
+
},
|
|
52604
|
+
{
|
|
52605
|
+
"name": "rows",
|
|
52606
|
+
"default": "1"
|
|
52607
|
+
}
|
|
52608
|
+
],
|
|
52609
|
+
"description": "How many readings fit across a given width, and which ones they are.\n\n**Ninety cells in 320 pixels is three and a half pixels each**, which is not a\nstrip, it is a smear. So a narrow container shows fewer cells rather than\nthinner ones, and it shows the *most recent* ones, because a status strip that\ndrops the newest days to keep the oldest is answering a question nobody asked.\n\n**The count it returns is what the summary has to be recomputed against.** A\nstrip labeled \"99.2% over 90 days\" that is drawing 45 of them is telling the\nreader something false about the picture in front of them, and nothing about\nthe picture says so. That is the one fault in this component that a screenshot\ncannot show, which is why the element reflects the number and announces it.\n\n**What crosses the width is a column, and `rows` is how many cells are in\none.** Counting cells is the same number only while `rows` is 1. Divide by\nthe wrong thing at `rows=\"7\"` and a ten week graph comes back as fifty-nine\nreadings in a 592px box: eleven days dropped to fit a strip that wanted 156\npixels, and fifty-nine is not a multiple of seven, so every column after the\ncut is offset by a day and the day-of-week rows stop meaning anything. A\ncalendar heatmap that silently rotates its own weekdays is worse than one\nthat drops a week.\n\nThe count is therefore always a whole number of columns, which is what keeps\nthe tail slice aligned."
|
|
52610
|
+
}
|
|
52611
|
+
],
|
|
52612
|
+
"exports": [
|
|
52613
|
+
{
|
|
52614
|
+
"kind": "js",
|
|
52615
|
+
"name": "toneOf",
|
|
52616
|
+
"declaration": {
|
|
52617
|
+
"name": "toneOf",
|
|
52618
|
+
"module": "src/heatmap/root/buckets.ts"
|
|
52619
|
+
}
|
|
52620
|
+
},
|
|
52621
|
+
{
|
|
52622
|
+
"kind": "js",
|
|
52623
|
+
"name": "fits",
|
|
52624
|
+
"declaration": {
|
|
52625
|
+
"name": "fits",
|
|
52626
|
+
"module": "src/heatmap/root/buckets.ts"
|
|
52627
|
+
}
|
|
52628
|
+
}
|
|
52629
|
+
]
|
|
52630
|
+
},
|
|
52631
|
+
{
|
|
52632
|
+
"kind": "javascript-module",
|
|
52633
|
+
"path": "src/heatmap/root/heatmap-root.ts",
|
|
52634
|
+
"declarations": [
|
|
52635
|
+
{
|
|
52636
|
+
"kind": "class",
|
|
52637
|
+
"description": "A grid of cells, each colored by a tone. `rows=\"1\"` makes a status strip, and\n`rows=\"7\"` makes a contribution graph. GitHub's contribution graph uses five\ndiscrete levels, which a set of tones covers.\n\nColor in a heatmap is per cell. In every other Helix chart, color is per\nseries, so ninety differently colored cells would need ninety series.\n\n**The data is a real `<table>` named by `for`**, as in every Helix chart, and\nthe table is the accessible representation. Hide it with\n`data-hidden-visually`, and screen readers still read it.\n\nA cell takes its tone from its own `data-tone`, or from `thresholds` and\n`tones` applied to its value. `data-tone` wins, so when you already know a\nday was degraded, you can set the tone directly.\n\n**The headless tier does not resolve tone names.** A tone named `success`\nwrites `--heatmap-tone: var(--heatmap-tone-success)`, and the styled tier or\nyour own stylesheet defines that property. The headless tier does not use\n`var(--helix-color-*)`.",
|
|
52638
|
+
"name": "HelixHeadlessHeatmap",
|
|
52639
|
+
"cssProperties": [
|
|
52640
|
+
{
|
|
52641
|
+
"description": "How many rows the strip lays out. The component writes it from the data, and the stylesheet that draws the strip reads it.",
|
|
52642
|
+
"name": "--heatmap-rows"
|
|
52643
|
+
},
|
|
52644
|
+
{
|
|
52645
|
+
"description": "The tone of the cell it is set on. The component writes it, and the stylesheet that paints the cell reads it.",
|
|
52646
|
+
"name": "--heatmap-tone"
|
|
52647
|
+
},
|
|
52648
|
+
{
|
|
52649
|
+
"description": "The weakest step of the magnitude ramp, used by `tones=\"1 …\"`.",
|
|
52650
|
+
"name": "--heatmap-tone-1"
|
|
52651
|
+
},
|
|
52652
|
+
{
|
|
52653
|
+
"description": "The second step of the magnitude ramp.",
|
|
52654
|
+
"name": "--heatmap-tone-2"
|
|
52655
|
+
},
|
|
52656
|
+
{
|
|
52657
|
+
"description": "The third step of the magnitude ramp.",
|
|
52658
|
+
"name": "--heatmap-tone-3"
|
|
52659
|
+
},
|
|
52660
|
+
{
|
|
52661
|
+
"description": "The fourth step of the magnitude ramp.",
|
|
52662
|
+
"name": "--heatmap-tone-4"
|
|
52663
|
+
},
|
|
52664
|
+
{
|
|
52665
|
+
"description": "The strongest step of the magnitude ramp.",
|
|
52666
|
+
"name": "--heatmap-tone-5"
|
|
52667
|
+
},
|
|
52668
|
+
{
|
|
52669
|
+
"description": "The color of the `accent` tone.",
|
|
52670
|
+
"name": "--heatmap-tone-accent"
|
|
52671
|
+
},
|
|
52672
|
+
{
|
|
52673
|
+
"description": "The color of the `danger` tone.",
|
|
52674
|
+
"name": "--heatmap-tone-danger"
|
|
52675
|
+
},
|
|
52676
|
+
{
|
|
52677
|
+
"description": "The color of the `info` tone.",
|
|
52678
|
+
"name": "--heatmap-tone-info"
|
|
52679
|
+
},
|
|
52680
|
+
{
|
|
52681
|
+
"description": "The color of the `muted` tone: a quiet background, for a bucket that means nothing happened.",
|
|
52682
|
+
"name": "--heatmap-tone-muted"
|
|
52683
|
+
},
|
|
52684
|
+
{
|
|
52685
|
+
"description": "The color of the `primary` tone.",
|
|
52686
|
+
"name": "--heatmap-tone-primary"
|
|
52687
|
+
},
|
|
52688
|
+
{
|
|
52689
|
+
"description": "The color of the `success` tone, named in `tones` or in `data-tone`.",
|
|
52690
|
+
"name": "--heatmap-tone-success"
|
|
52691
|
+
},
|
|
52692
|
+
{
|
|
52693
|
+
"description": "The color of the `warning` tone.",
|
|
52694
|
+
"name": "--heatmap-tone-warning"
|
|
52695
|
+
}
|
|
52696
|
+
],
|
|
52697
|
+
"cssParts": [
|
|
52698
|
+
{
|
|
52699
|
+
"description": "One reading.",
|
|
52700
|
+
"name": "cell"
|
|
52701
|
+
},
|
|
52702
|
+
{
|
|
52703
|
+
"description": "Shown when the table has no readings. It stays hidden until the table can be read: on the server and during hydration, there is no document to resolve `for` in.",
|
|
52704
|
+
"name": "empty"
|
|
52705
|
+
},
|
|
52706
|
+
{
|
|
52707
|
+
"description": "The trailing slot's box.",
|
|
52708
|
+
"name": "end"
|
|
52709
|
+
},
|
|
52710
|
+
{
|
|
52711
|
+
"description": "The three-slot row under the strip.",
|
|
52712
|
+
"name": "footer"
|
|
52713
|
+
},
|
|
52714
|
+
{
|
|
52715
|
+
"description": "The invisible point the tooltip is anchored to.",
|
|
52716
|
+
"name": "mark"
|
|
52717
|
+
},
|
|
52718
|
+
{
|
|
52719
|
+
"description": "The leading slot's box.",
|
|
52720
|
+
"name": "start"
|
|
52721
|
+
},
|
|
52722
|
+
{
|
|
52723
|
+
"description": "The grid of cells.",
|
|
52724
|
+
"name": "strip"
|
|
52725
|
+
},
|
|
52726
|
+
{
|
|
52727
|
+
"description": "The middle slot's box.",
|
|
52728
|
+
"name": "summary"
|
|
52729
|
+
},
|
|
52730
|
+
{
|
|
52731
|
+
"description": "The bubble, forwarded from `Tooltip`.",
|
|
52732
|
+
"name": "tooltip"
|
|
52733
|
+
},
|
|
52734
|
+
{
|
|
52735
|
+
"description": "The `Tooltip` element itself.",
|
|
52736
|
+
"name": "tooltip-anchor"
|
|
52737
|
+
},
|
|
52738
|
+
{
|
|
52739
|
+
"description": "The bubble's point, forwarded from `Tooltip`.",
|
|
52740
|
+
"name": "tooltip-arrow"
|
|
52741
|
+
},
|
|
52742
|
+
{
|
|
52743
|
+
"description": "The point while the bubble is below the reading, on its top edge. Set alongside `tooltip-arrow`.",
|
|
52744
|
+
"name": "tooltip-arrow-bottom"
|
|
52745
|
+
},
|
|
52746
|
+
{
|
|
52747
|
+
"description": "The point while the bubble is left of the reading, on its right edge. Set alongside `tooltip-arrow`.",
|
|
52748
|
+
"name": "tooltip-arrow-left"
|
|
52749
|
+
},
|
|
52750
|
+
{
|
|
52751
|
+
"description": "The point while the bubble is right of the reading, on its left edge. Set alongside `tooltip-arrow`.",
|
|
52752
|
+
"name": "tooltip-arrow-right"
|
|
52753
|
+
},
|
|
52754
|
+
{
|
|
52755
|
+
"description": "The point while the bubble is above the reading, on its bottom edge. Set alongside `tooltip-arrow`.",
|
|
52756
|
+
"name": "tooltip-arrow-top"
|
|
52757
|
+
},
|
|
52758
|
+
{
|
|
52759
|
+
"description": "The bubble while it is below the reading. Set alongside `tooltip`.",
|
|
52760
|
+
"name": "tooltip-bottom"
|
|
52761
|
+
},
|
|
52762
|
+
{
|
|
52763
|
+
"description": "One column's name and value inside the tooltip.",
|
|
52764
|
+
"name": "tooltip-cell"
|
|
52765
|
+
},
|
|
52766
|
+
{
|
|
52767
|
+
"description": "The reading's own name inside the tooltip.",
|
|
52768
|
+
"name": "tooltip-label"
|
|
52769
|
+
},
|
|
52770
|
+
{
|
|
52771
|
+
"description": "The bubble while it is left of the reading. Set alongside `tooltip`.",
|
|
52772
|
+
"name": "tooltip-left"
|
|
52773
|
+
},
|
|
52774
|
+
{
|
|
52775
|
+
"description": "A column's name inside the tooltip.",
|
|
52776
|
+
"name": "tooltip-name"
|
|
52777
|
+
},
|
|
52778
|
+
{
|
|
52779
|
+
"description": "The bubble while it is right of the reading. Set alongside `tooltip`.",
|
|
52780
|
+
"name": "tooltip-right"
|
|
52781
|
+
},
|
|
52782
|
+
{
|
|
52783
|
+
"description": "The bubble while it is above the reading. Set alongside `tooltip`.",
|
|
52784
|
+
"name": "tooltip-top"
|
|
52785
|
+
},
|
|
52786
|
+
{
|
|
52787
|
+
"description": "A column's value inside the tooltip.",
|
|
52788
|
+
"name": "tooltip-value"
|
|
52789
|
+
}
|
|
52790
|
+
],
|
|
52791
|
+
"slots": [
|
|
52792
|
+
{
|
|
52793
|
+
"description": "Below the strip, at the trailing edge: usually the newest date.",
|
|
52794
|
+
"name": "end"
|
|
52795
|
+
},
|
|
52796
|
+
{
|
|
52797
|
+
"description": "Below the strip, at the leading edge: usually the oldest date.",
|
|
52798
|
+
"name": "start"
|
|
52799
|
+
},
|
|
52800
|
+
{
|
|
52801
|
+
"description": "Below the strip, in the middle: a summary of the range shown.",
|
|
52802
|
+
"name": "summary"
|
|
52803
|
+
}
|
|
52804
|
+
],
|
|
52805
|
+
"members": [
|
|
52806
|
+
{
|
|
52807
|
+
"kind": "field",
|
|
52808
|
+
"name": "emptyText",
|
|
52809
|
+
"type": {
|
|
52810
|
+
"text": "string"
|
|
52811
|
+
},
|
|
52812
|
+
"default": "'No readings'",
|
|
52813
|
+
"description": "Shown when the table has no readings in it.\n\nNever shown while the table cannot be read at all, which is a server render\nand the hydrating one after it: see `sourceKnown`.",
|
|
52814
|
+
"attribute": "empty-text"
|
|
52815
|
+
},
|
|
52816
|
+
{
|
|
52817
|
+
"kind": "field",
|
|
52818
|
+
"name": "gap",
|
|
52819
|
+
"type": {
|
|
52820
|
+
"text": "number"
|
|
52821
|
+
},
|
|
52822
|
+
"default": "2",
|
|
52823
|
+
"description": "Space between cells, in CSS pixels. It is a number for the same reason\n`min-cell` is.",
|
|
52824
|
+
"attribute": "gap"
|
|
52825
|
+
},
|
|
52826
|
+
{
|
|
52827
|
+
"kind": "field",
|
|
52828
|
+
"name": "minCell",
|
|
52829
|
+
"type": {
|
|
52830
|
+
"text": "number"
|
|
52831
|
+
},
|
|
52832
|
+
"default": "8",
|
|
52833
|
+
"description": "The smallest a cell may get before the strip draws fewer of them, in CSS pixels.\n\n**Set this only to overrule what the strip actually draws.** The arithmetic\nneeds a width in pixels and the width is a length the stylesheet resolves,\nso a number written here that disagrees with the sheet is a promise the\nconsumer has to keep by hand, and the one number a summary is told to trust\nis the one it gets wrong.\n\nThe strip measures itself, so sizing the cells in a sheet is enough on its\nown and these two are the estimate used until the first measurement lands.\nWriting the attribute pins the value and stops the measurement being\nconsulted, which is what a container query or a transition on the cell size\nwants, where what is drawn this frame is not what the arithmetic should\nplan around.\n\nZero turns the dropping off altogether, which is right for a strip in a\ncontainer that cannot get narrow.",
|
|
52834
|
+
"attribute": "min-cell"
|
|
52835
|
+
},
|
|
52836
|
+
{
|
|
52837
|
+
"kind": "field",
|
|
52838
|
+
"name": "rows",
|
|
52839
|
+
"type": {
|
|
52840
|
+
"text": "number"
|
|
52841
|
+
},
|
|
52842
|
+
"default": "1",
|
|
52843
|
+
"description": "How many rows the strip has.\n\n`1` is a status strip and `7` is a calendar week, which are the two readings\nthis covers. Cells fill down the column and then across, which is what a\ncalendar heatmap does: a week is a column, so the strip reads along the\nline in weeks, from the right on a right-to-left page, and top to bottom in\ndays.",
|
|
52844
|
+
"attribute": "rows"
|
|
52845
|
+
},
|
|
52846
|
+
{
|
|
52847
|
+
"kind": "field",
|
|
52848
|
+
"name": "thresholds",
|
|
52849
|
+
"type": {
|
|
52850
|
+
"text": "string"
|
|
52851
|
+
},
|
|
52852
|
+
"default": "''",
|
|
52853
|
+
"description": "Lower bounds for the tone buckets, in the order the tones are given.\n\n`thresholds=\"1 3 6 9\"` with `tones=\"1 2 3 4\"` puts 1 and 2 in the ramp's\nfirst step, 3 to 5 in the second, 6 to 8 in the third, and 9 upward in the\nfourth. A value below the first bound gets no tone at all: an empty day in a\ncontribution graph is a day with nothing in it, and painting it as the\nlowest bucket claims a reading that does not exist.",
|
|
52854
|
+
"attribute": "thresholds"
|
|
52855
|
+
},
|
|
52856
|
+
{
|
|
52857
|
+
"kind": "field",
|
|
52858
|
+
"name": "tones",
|
|
52859
|
+
"type": {
|
|
52860
|
+
"text": "string"
|
|
52861
|
+
},
|
|
52862
|
+
"default": "''",
|
|
52863
|
+
"description": "The tone for each bucket, in the same order as `thresholds`.\n\nA name, resolved as `--heatmap-tone-<name>` by whichever tier answers.\n**`\"1\"` through `\"5\"` are a ramp and everything else is a category**, which\nis the distinction a heatmap lives or dies on: magnitude has to be one hue\ngetting louder, because a reader compares two cells by weight and cannot\ncompare two hues at all. `tones=\"surface info accent success primary\"` for a\ncommit count is five unrelated hues for five amounts, which is confetti with\nno order in it.",
|
|
52864
|
+
"attribute": "tones"
|
|
52865
|
+
},
|
|
52866
|
+
{
|
|
52867
|
+
"kind": "field",
|
|
52868
|
+
"name": "visible",
|
|
52869
|
+
"type": {
|
|
52870
|
+
"text": "number"
|
|
52871
|
+
},
|
|
52872
|
+
"description": "How many cells are actually drawn.\n\n**This is the number a summary has to agree with**, and the reason it is\npublished at all: a consumer's own summary is their markup and this element\ncannot rewrite it, so the only honest arrangement is to hand over the count\nand say when it changed.\n\n**A plain getter, and the attribute is written in `updated`, because\n`@property({ reflect: true })` on a getter with no setter reflects once and\nthen goes stale.** Lit reflects a property that is in `changedProperties`,\nand nothing puts a derived getter there after the first update: the\nattribute would be right on load and wrong from the first resize, which is\nthe exact failure the count exists to prevent, arriving through the\nmechanism meant to prevent it.",
|
|
52873
|
+
"readonly": true
|
|
52874
|
+
},
|
|
52875
|
+
{
|
|
52876
|
+
"kind": "field",
|
|
52877
|
+
"name": "width",
|
|
52878
|
+
"type": {
|
|
52879
|
+
"text": "number | undefined"
|
|
52880
|
+
},
|
|
52881
|
+
"privacy": "private",
|
|
52882
|
+
"default": "undefined",
|
|
52883
|
+
"description": "The width last measured, or nothing before the first measurement.\n\nUndefined rather than zero, because the two mean different things and the\ndifference is a whole strip: unmeasured has to show everything, since a\nfirst paint that shows one cell and then expands is a flicker on every load."
|
|
52884
|
+
},
|
|
52885
|
+
{
|
|
52886
|
+
"kind": "field",
|
|
52887
|
+
"name": "metrics",
|
|
52888
|
+
"type": {
|
|
52889
|
+
"text": "{ cell: number; gap: number } | undefined"
|
|
52890
|
+
},
|
|
52891
|
+
"privacy": "private",
|
|
52892
|
+
"default": "undefined",
|
|
52893
|
+
"description": "The cell and gap the strip is drawing, in pixels, once it has been read.\n\n**The arithmetic's inputs are a stylesheet's decisions, so the honest way\nto learn them is to ask the stylesheet.** A cell's size is a length that\nonly the cascade can resolve: it may be a `rem` against a root font size, a\npercentage of a container, or whatever a container query chose this frame.\nEvery one of those is invisible to a number typed into an attribute, and\nevery hook a sheet offers for the cell box or the gap is one more way for\nthe two to drift apart silently.\n\nReading it back is not styling and does not breach the tier: this asks what\nwas decided rather than deciding, which is the same direction as the facts\nthis component writes out as custom properties, run backwards."
|
|
52894
|
+
},
|
|
52895
|
+
{
|
|
52896
|
+
"kind": "field",
|
|
52897
|
+
"name": "hovered",
|
|
52898
|
+
"type": {
|
|
52899
|
+
"text": "number"
|
|
52900
|
+
},
|
|
52901
|
+
"privacy": "private",
|
|
52902
|
+
"default": "-1",
|
|
52903
|
+
"description": "Which drawn cell the pointer is on, as an index into `drawn`, or -1 for\nnone."
|
|
52904
|
+
},
|
|
52905
|
+
{
|
|
52906
|
+
"kind": "field",
|
|
52907
|
+
"name": "observer",
|
|
52908
|
+
"type": {
|
|
52909
|
+
"text": "ResizeObserver | undefined"
|
|
52910
|
+
},
|
|
52911
|
+
"privacy": "private",
|
|
52912
|
+
"default": "undefined"
|
|
52913
|
+
},
|
|
52914
|
+
{
|
|
52915
|
+
"kind": "field",
|
|
52916
|
+
"name": "announced",
|
|
52917
|
+
"type": {
|
|
52918
|
+
"text": "number | undefined"
|
|
52919
|
+
},
|
|
52920
|
+
"privacy": "private",
|
|
52921
|
+
"default": "undefined"
|
|
52922
|
+
},
|
|
52923
|
+
{
|
|
52924
|
+
"kind": "field",
|
|
52925
|
+
"name": "points",
|
|
52926
|
+
"type": {
|
|
52927
|
+
"text": "Array<{ label: string; tone?: string | undefined; value: number }>"
|
|
52928
|
+
},
|
|
52929
|
+
"privacy": "private",
|
|
52930
|
+
"description": "Every reading in the table, oldest first, as the table is written.\n\n**Not `readings`, which the mixin already has and which means a count.**\nTwo members of the same name meaning a number and an array is the kind of\ncollision that type-checks in one direction and reads wrong in both.",
|
|
52931
|
+
"readonly": true
|
|
52932
|
+
},
|
|
52933
|
+
{
|
|
52934
|
+
"kind": "field",
|
|
52935
|
+
"name": "sourceKnown",
|
|
52936
|
+
"type": {
|
|
52937
|
+
"text": "boolean"
|
|
52938
|
+
},
|
|
52939
|
+
"privacy": "private",
|
|
52940
|
+
"description": "Whether this render can tell a table with no readings from one it has not\nresolved yet.\n\n**Unknown is not empty, which is what an empty state must never say.**\n`for` names an id and resolving an id wants a document, so a server has\nnone and a hydrating render must not look either. Without this the server\ndrew \"No readings\" over a table holding ninety days of them, a crawler read\nthat sentence, and the strip flipped to a full one on hydration: the fault\n`MixinCollection` names for a slotted collection, arriving through the one\nchannel that mixin cannot see.\n\nThe same shape as `childrenKnown`, asked of a tree that can answer about\nids rather than of one that holds children. An id that resolves to nothing\nin a browser is still known, and still empty: a `for` naming no table\nshould say so rather than sit blank, which is why this asks\n`searchableById` and not `elementById`.",
|
|
52941
|
+
"readonly": true
|
|
52942
|
+
},
|
|
52943
|
+
{
|
|
52944
|
+
"kind": "field",
|
|
52945
|
+
"name": "rowCount",
|
|
52946
|
+
"type": {
|
|
52947
|
+
"text": "number"
|
|
52948
|
+
},
|
|
52949
|
+
"privacy": "private",
|
|
52950
|
+
"description": "`rows` as a usable count, which is not always what the attribute says.\n\nOne place rather than two: the fit arithmetic and the grid template both\nneed it, and a `rows=\"0\"` or a `rows=\"2.5\"` that reached one of them and not\nthe other would draw a strip whose columns and whose capacity disagreed.",
|
|
52951
|
+
"readonly": true
|
|
52952
|
+
},
|
|
52953
|
+
{
|
|
52954
|
+
"kind": "field",
|
|
52955
|
+
"name": "cellPx",
|
|
52956
|
+
"type": {
|
|
52957
|
+
"text": "number"
|
|
52958
|
+
},
|
|
52959
|
+
"privacy": "private",
|
|
52960
|
+
"description": "The cell width the arithmetic should plan around, in pixels.\n\nThe attribute wins where a consumer wrote one, because that is what writing\nit is for; otherwise what the strip draws, and the declared default only\nuntil the first measurement lands.",
|
|
52961
|
+
"readonly": true
|
|
52962
|
+
},
|
|
52963
|
+
{
|
|
52964
|
+
"kind": "field",
|
|
52965
|
+
"name": "gapPx",
|
|
52966
|
+
"type": {
|
|
52967
|
+
"text": "number"
|
|
52968
|
+
},
|
|
52969
|
+
"privacy": "private",
|
|
52970
|
+
"description": "The gap the arithmetic should plan around, on the same terms as `cellPx`.",
|
|
52971
|
+
"readonly": true
|
|
52972
|
+
},
|
|
52973
|
+
{
|
|
52974
|
+
"kind": "field",
|
|
52975
|
+
"name": "room",
|
|
52976
|
+
"type": {
|
|
52977
|
+
"text": "number"
|
|
52978
|
+
},
|
|
52979
|
+
"privacy": "private",
|
|
52980
|
+
"description": "How many cells the container has room for, as a whole number of columns.",
|
|
52981
|
+
"readonly": true
|
|
52982
|
+
},
|
|
52983
|
+
{
|
|
52984
|
+
"kind": "method",
|
|
52985
|
+
"name": "measure",
|
|
52986
|
+
"privacy": "private",
|
|
52987
|
+
"return": {
|
|
52988
|
+
"type": {
|
|
52989
|
+
"text": "void"
|
|
52990
|
+
}
|
|
52991
|
+
},
|
|
52992
|
+
"description": "Reads back the cell and the gap the strip resolved.\n\n`gridAutoColumns` and `columnGap` rather than a cell's own box, and the\ndifference matters on the frame it matters: a cell exists only once some\nhave been drawn, and how many are drawn is what this is measuring *for*.\nAsking the track instead breaks the circle, since a track is sized whether\nor not anything sits in it. Neither property forces layout, so this stays a\nstyle read on every update rather than a reflow.\n\nAnything that does not parse to a positive number leaves the estimate alone:\n`columnGap` computes to `normal` where no gap is set, and a track given a\nkeyword or a `repeat()` has no single width to report. A wrong number here\nis worse than no number, because it is the one the count is published from."
|
|
52993
|
+
},
|
|
52994
|
+
{
|
|
52995
|
+
"kind": "field",
|
|
52996
|
+
"name": "drawn",
|
|
52997
|
+
"type": {
|
|
52998
|
+
"text": "Array<{ label: string; tone?: string | undefined; value: number }>"
|
|
52999
|
+
},
|
|
53000
|
+
"privacy": "private",
|
|
53001
|
+
"description": "The readings actually drawn, newest kept.\n\nThe tail rather than the head: a status strip that drops the newest days to\nkeep the oldest is answering a question nobody asked.",
|
|
53002
|
+
"readonly": true
|
|
53003
|
+
},
|
|
53004
|
+
{
|
|
53005
|
+
"kind": "method",
|
|
53006
|
+
"name": "markEmpty",
|
|
53007
|
+
"privacy": "private",
|
|
53008
|
+
"return": {
|
|
53009
|
+
"type": {
|
|
53010
|
+
"text": "void"
|
|
53011
|
+
}
|
|
53012
|
+
},
|
|
53013
|
+
"description": "Says on the footer whether any of its three slots holds anything.\n\n**A stylesheet cannot ask.** `[part=\"footer\"]:not(:has(slot:has(*)))` is two\nfaults at once: `:has()` may not be nested inside `:has()`, so the selector\nfails to parse and the rule is discarded whole; and a slot's assigned nodes\nare not its DOM children, so `slot:has(*)` reports fallback content rather\nthan the fill, and is false either way. Both verified in a browser."
|
|
53014
|
+
},
|
|
53015
|
+
{
|
|
53016
|
+
"kind": "method",
|
|
53017
|
+
"name": "renderTooltip",
|
|
53018
|
+
"privacy": "protected",
|
|
53019
|
+
"return": {
|
|
53020
|
+
"type": {
|
|
53021
|
+
"text": "TemplateResult | typeof nothing"
|
|
53022
|
+
}
|
|
53023
|
+
},
|
|
53024
|
+
"description": "The bubble over the cell a pointer is resting on.\n\n**One tooltip that moves, which is what every other chart here does.** Bar\nChart, Line Chart and Donut Chart each render a single anchor against an\ninvisible mark and move the mark, so the count is one however many readings\nthere are, rather than one element per cell. `drawTooltip` is their shared\nmarkup and this is the fourth caller.\n\nWhat it buys over a native `title` is the row rather than the reading.\n`sourceRows` carries every column of the table including the ones nothing\nwas plotted from, so a cell reads \"11 Jun 2026 / Uptime 81.2% / Note Partial\noutage\" where `title` could only ever say the two values this component\nhappens to hold. It is also styleable, appears at once rather than after the\nplatform's second of delay, and cannot be truncated by the window edge.\n\nThe mark is placed in pixels rather than in percent, which is the one thing\nthis does differently from its siblings: they divide a plot into equal\nslots, and a strip's cells are a fixed size with a fixed gap inside a box\nthat is usually wider, so a percentage of the box lands between cells. The\npitch is `cell + gap` and both are measured."
|
|
53025
|
+
},
|
|
53026
|
+
{
|
|
53027
|
+
"kind": "field",
|
|
53028
|
+
"name": "onPointerOver",
|
|
53029
|
+
"privacy": "private",
|
|
53030
|
+
"readonly": true,
|
|
53031
|
+
"description": "Which drawn cell the pointer is over, or -1.\n\n`pointerover` on the strip rather than a listener per cell: the event\nbubbles, so one handler covers however many cells there are, and unlike\n`mouseover` it is delivered for a pen and for the touch that follows a long\npress."
|
|
50103
53032
|
},
|
|
50104
53033
|
{
|
|
50105
53034
|
"kind": "field",
|
|
@@ -53367,6 +56296,14 @@
|
|
|
53367
56296
|
"module": "src/format-date/index.js"
|
|
53368
56297
|
}
|
|
53369
56298
|
},
|
|
56299
|
+
{
|
|
56300
|
+
"kind": "js",
|
|
56301
|
+
"name": "*",
|
|
56302
|
+
"declaration": {
|
|
56303
|
+
"name": "*",
|
|
56304
|
+
"module": "src/graph/index.js"
|
|
56305
|
+
}
|
|
56306
|
+
},
|
|
53370
56307
|
{
|
|
53371
56308
|
"kind": "js",
|
|
53372
56309
|
"name": "*",
|
|
@@ -67345,16 +70282,6 @@
|
|
|
67345
70282
|
}
|
|
67346
70283
|
],
|
|
67347
70284
|
"members": [
|
|
67348
|
-
{
|
|
67349
|
-
"kind": "field",
|
|
67350
|
-
"name": "activateHintLabel",
|
|
67351
|
-
"type": {
|
|
67352
|
-
"text": "string"
|
|
67353
|
-
},
|
|
67354
|
-
"default": "'Press the map to use it'",
|
|
67355
|
-
"description": "The hint shown when a map waiting to be pressed is scrolled or swiped\nover, with `gestures=\"activate\"`.",
|
|
67356
|
-
"attribute": "activate-hint-label"
|
|
67357
|
-
},
|
|
67358
70285
|
{
|
|
67359
70286
|
"kind": "field",
|
|
67360
70287
|
"name": "bearing",
|
|
@@ -67395,15 +70322,6 @@
|
|
|
67395
70322
|
"description": "What screen readers hear when the map is tilted back to looking straight down.",
|
|
67396
70323
|
"attribute": "flat-label"
|
|
67397
70324
|
},
|
|
67398
|
-
{
|
|
67399
|
-
"kind": "field",
|
|
67400
|
-
"name": "gestures",
|
|
67401
|
-
"type": {
|
|
67402
|
-
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
67403
|
-
},
|
|
67404
|
-
"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.",
|
|
67405
|
-
"attribute": "gestures"
|
|
67406
|
-
},
|
|
67407
70325
|
{
|
|
67408
70326
|
"kind": "field",
|
|
67409
70327
|
"name": "hybridLabel",
|
|
@@ -67584,36 +70502,6 @@
|
|
|
67584
70502
|
"description": "What screen readers hear when the map is turned. `{degrees}` is the way the\ntop of the map faces, clockwise from north.",
|
|
67585
70503
|
"attribute": "turned-label"
|
|
67586
70504
|
},
|
|
67587
|
-
{
|
|
67588
|
-
"kind": "field",
|
|
67589
|
-
"name": "twoFingerHintLabel",
|
|
67590
|
-
"type": {
|
|
67591
|
-
"text": "string"
|
|
67592
|
-
},
|
|
67593
|
-
"default": "'Use two fingers to move the map'",
|
|
67594
|
-
"description": "The hint shown when one finger swipes over a map with `gestures=\"cooperative\"`.",
|
|
67595
|
-
"attribute": "two-finger-hint-label"
|
|
67596
|
-
},
|
|
67597
|
-
{
|
|
67598
|
-
"kind": "field",
|
|
67599
|
-
"name": "usingLabel",
|
|
67600
|
-
"type": {
|
|
67601
|
-
"text": "string"
|
|
67602
|
-
},
|
|
67603
|
-
"default": "'Using the map. Press Escape to scroll the page again.'",
|
|
67604
|
-
"description": "The line shown while a map with `gestures=\"activate\"` has the gestures.",
|
|
67605
|
-
"attribute": "using-label"
|
|
67606
|
-
},
|
|
67607
|
-
{
|
|
67608
|
-
"kind": "field",
|
|
67609
|
-
"name": "wheelHintLabel",
|
|
67610
|
-
"type": {
|
|
67611
|
-
"text": "string"
|
|
67612
|
-
},
|
|
67613
|
-
"default": "'Use {key} and scroll to zoom the map'",
|
|
67614
|
-
"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.",
|
|
67615
|
-
"attribute": "wheel-hint-label"
|
|
67616
|
-
},
|
|
67617
70505
|
{
|
|
67618
70506
|
"kind": "field",
|
|
67619
70507
|
"name": "zoomedLabel",
|
|
@@ -67975,116 +70863,32 @@
|
|
|
67975
70863
|
},
|
|
67976
70864
|
{
|
|
67977
70865
|
"kind": "field",
|
|
67978
|
-
"name": "
|
|
67979
|
-
"type": {
|
|
67980
|
-
"text": "string"
|
|
67981
|
-
},
|
|
67982
|
-
"privacy": "private",
|
|
67983
|
-
"default": "''",
|
|
67984
|
-
"description": "The hint on the map while one shows, put there by a gesture the map let pass."
|
|
67985
|
-
},
|
|
67986
|
-
{
|
|
67987
|
-
"kind": "field",
|
|
67988
|
-
"name": "hinting",
|
|
67989
|
-
"type": {
|
|
67990
|
-
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
67991
|
-
},
|
|
67992
|
-
"privacy": "private",
|
|
67993
|
-
"description": "When the hint goes."
|
|
67994
|
-
},
|
|
67995
|
-
{
|
|
67996
|
-
"kind": "field",
|
|
67997
|
-
"name": "hintAt",
|
|
67998
|
-
"type": {
|
|
67999
|
-
"text": "{ x: number; y: number } | undefined"
|
|
68000
|
-
},
|
|
68001
|
-
"privacy": "private",
|
|
68002
|
-
"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."
|
|
68003
|
-
},
|
|
68004
|
-
{
|
|
68005
|
-
"kind": "field",
|
|
68006
|
-
"name": "taken",
|
|
70866
|
+
"name": "restingGestureLabels",
|
|
68007
70867
|
"type": {
|
|
68008
|
-
"text": "
|
|
70868
|
+
"text": "ViewportGestureLabels"
|
|
68009
70869
|
},
|
|
68010
|
-
"privacy": "
|
|
68011
|
-
"
|
|
68012
|
-
"
|
|
70870
|
+
"privacy": "protected",
|
|
70871
|
+
"description": "What the map says about its gestures where the page does not say it.",
|
|
70872
|
+
"readonly": true,
|
|
70873
|
+
"inheritedFrom": {
|
|
70874
|
+
"name": "MixinViewport",
|
|
70875
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
70876
|
+
}
|
|
68013
70877
|
},
|
|
68014
70878
|
{
|
|
68015
70879
|
"kind": "method",
|
|
68016
|
-
"name": "
|
|
68017
|
-
"privacy": "
|
|
70880
|
+
"name": "gesturesChanged",
|
|
70881
|
+
"privacy": "protected",
|
|
68018
70882
|
"return": {
|
|
68019
70883
|
"type": {
|
|
68020
70884
|
"text": "void"
|
|
68021
70885
|
}
|
|
68022
70886
|
},
|
|
68023
|
-
"
|
|
68024
|
-
|
|
68025
|
-
|
|
68026
|
-
|
|
68027
|
-
|
|
68028
|
-
}
|
|
68029
|
-
},
|
|
68030
|
-
{
|
|
68031
|
-
"name": "at",
|
|
68032
|
-
"optional": true,
|
|
68033
|
-
"type": {
|
|
68034
|
-
"text": "{ clientX: number; clientY: number }"
|
|
68035
|
-
}
|
|
68036
|
-
}
|
|
68037
|
-
],
|
|
68038
|
-
"description": "Shows a hint over the map for a moment, where the gesture was."
|
|
68039
|
-
},
|
|
68040
|
-
{
|
|
68041
|
-
"kind": "field",
|
|
68042
|
-
"name": "handleWheel",
|
|
68043
|
-
"privacy": "private",
|
|
68044
|
-
"readonly": true,
|
|
68045
|
-
"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."
|
|
68046
|
-
},
|
|
68047
|
-
{
|
|
68048
|
-
"kind": "field",
|
|
68049
|
-
"name": "handleTouchMove",
|
|
68050
|
-
"privacy": "private",
|
|
68051
|
-
"readonly": true,
|
|
68052
|
-
"description": "One finger moving over the map, which scrolls the page, and is said."
|
|
68053
|
-
},
|
|
68054
|
-
{
|
|
68055
|
-
"kind": "field",
|
|
68056
|
-
"name": "handleTake",
|
|
68057
|
-
"privacy": "private",
|
|
68058
|
-
"readonly": true,
|
|
68059
|
-
"description": "A press on the map itself, which hands a waiting map the gestures."
|
|
68060
|
-
},
|
|
68061
|
-
{
|
|
68062
|
-
"kind": "field",
|
|
68063
|
-
"name": "handleGiveBackKey",
|
|
68064
|
-
"privacy": "private",
|
|
68065
|
-
"readonly": true,
|
|
68066
|
-
"description": "Escape, which gives the page its scroll back."
|
|
68067
|
-
},
|
|
68068
|
-
{
|
|
68069
|
-
"kind": "field",
|
|
68070
|
-
"name": "handleGiveBackOutside",
|
|
68071
|
-
"privacy": "private",
|
|
68072
|
-
"readonly": true,
|
|
68073
|
-
"description": "A press anywhere else on the page, which gives it its scroll back."
|
|
68074
|
-
},
|
|
68075
|
-
{
|
|
68076
|
-
"kind": "field",
|
|
68077
|
-
"name": "handleGiveBackBlur",
|
|
68078
|
-
"privacy": "private",
|
|
68079
|
-
"readonly": true,
|
|
68080
|
-
"description": "The window losing focus, as a reader switching away does."
|
|
68081
|
-
},
|
|
68082
|
-
{
|
|
68083
|
-
"kind": "field",
|
|
68084
|
-
"name": "handleLeave",
|
|
68085
|
-
"privacy": "private",
|
|
68086
|
-
"readonly": true,
|
|
68087
|
-
"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."
|
|
70887
|
+
"description": "Which gestures the renderer takes, which `connectMap` hears from here.",
|
|
70888
|
+
"inheritedFrom": {
|
|
70889
|
+
"name": "MixinViewport",
|
|
70890
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
70891
|
+
}
|
|
68088
70892
|
},
|
|
68089
70893
|
{
|
|
68090
70894
|
"kind": "field",
|
|
@@ -68359,6 +71163,19 @@
|
|
|
68359
71163
|
},
|
|
68360
71164
|
"description": "The routes and areas, named, for a reader who cannot see the map.\n\n**What the renderer draws is a picture to a screen reader**, so a route\nfrom the depot or a delivery zone is not on the page at all until this\nsays it is. A list rather than a live region, because the reader should\nfind it when they come to the map rather than be told about it as it\nchanges. Nothing where there are none, so a map with only markers says\nno more than it did.\n\n**Written once the frame knows its children**, which is in the browser:\nthe server renders the frame before it has any, and a route is only on\nthe page once a renderer has drawn it, which is later still."
|
|
68361
71165
|
},
|
|
71166
|
+
{
|
|
71167
|
+
"kind": "field",
|
|
71168
|
+
"name": "activateHintLabel",
|
|
71169
|
+
"type": {
|
|
71170
|
+
"text": "string | undefined"
|
|
71171
|
+
},
|
|
71172
|
+
"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.",
|
|
71173
|
+
"attribute": "activate-hint-label",
|
|
71174
|
+
"inheritedFrom": {
|
|
71175
|
+
"name": "MixinViewport",
|
|
71176
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
71177
|
+
}
|
|
71178
|
+
},
|
|
68362
71179
|
{
|
|
68363
71180
|
"kind": "field",
|
|
68364
71181
|
"name": "controls",
|
|
@@ -68414,6 +71231,19 @@
|
|
|
68414
71231
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
68415
71232
|
}
|
|
68416
71233
|
},
|
|
71234
|
+
{
|
|
71235
|
+
"kind": "field",
|
|
71236
|
+
"name": "gestures",
|
|
71237
|
+
"type": {
|
|
71238
|
+
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
71239
|
+
},
|
|
71240
|
+
"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.",
|
|
71241
|
+
"attribute": "gestures",
|
|
71242
|
+
"inheritedFrom": {
|
|
71243
|
+
"name": "MixinViewport",
|
|
71244
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
71245
|
+
}
|
|
71246
|
+
},
|
|
68417
71247
|
{
|
|
68418
71248
|
"kind": "field",
|
|
68419
71249
|
"name": "idleDelay",
|
|
@@ -68498,6 +71328,45 @@
|
|
|
68498
71328
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
68499
71329
|
}
|
|
68500
71330
|
},
|
|
71331
|
+
{
|
|
71332
|
+
"kind": "field",
|
|
71333
|
+
"name": "twoFingerHintLabel",
|
|
71334
|
+
"type": {
|
|
71335
|
+
"text": "string | undefined"
|
|
71336
|
+
},
|
|
71337
|
+
"description": "The hint shown when one finger swipes over a surface with\n`gestures=\"cooperative\"`. Absent is the family's own.",
|
|
71338
|
+
"attribute": "two-finger-hint-label",
|
|
71339
|
+
"inheritedFrom": {
|
|
71340
|
+
"name": "MixinViewport",
|
|
71341
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
71342
|
+
}
|
|
71343
|
+
},
|
|
71344
|
+
{
|
|
71345
|
+
"kind": "field",
|
|
71346
|
+
"name": "usingLabel",
|
|
71347
|
+
"type": {
|
|
71348
|
+
"text": "string | undefined"
|
|
71349
|
+
},
|
|
71350
|
+
"description": "The line shown while a surface with `gestures=\"activate\"` has the\ngestures. Absent is the family's own.",
|
|
71351
|
+
"attribute": "using-label",
|
|
71352
|
+
"inheritedFrom": {
|
|
71353
|
+
"name": "MixinViewport",
|
|
71354
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
71355
|
+
}
|
|
71356
|
+
},
|
|
71357
|
+
{
|
|
71358
|
+
"kind": "field",
|
|
71359
|
+
"name": "wheelHintLabel",
|
|
71360
|
+
"type": {
|
|
71361
|
+
"text": "string | undefined"
|
|
71362
|
+
},
|
|
71363
|
+
"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.",
|
|
71364
|
+
"attribute": "wheel-hint-label",
|
|
71365
|
+
"inheritedFrom": {
|
|
71366
|
+
"name": "MixinViewport",
|
|
71367
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
71368
|
+
}
|
|
71369
|
+
},
|
|
68501
71370
|
{
|
|
68502
71371
|
"kind": "field",
|
|
68503
71372
|
"name": "zoomInLabel",
|
|
@@ -68540,6 +71409,73 @@
|
|
|
68540
71409
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
68541
71410
|
}
|
|
68542
71411
|
},
|
|
71412
|
+
{
|
|
71413
|
+
"kind": "field",
|
|
71414
|
+
"name": "gesturesTaken",
|
|
71415
|
+
"type": {
|
|
71416
|
+
"text": "boolean"
|
|
71417
|
+
},
|
|
71418
|
+
"privacy": "protected",
|
|
71419
|
+
"default": "false",
|
|
71420
|
+
"description": "Whether an `activate` surface has been pressed, and has the gestures.",
|
|
71421
|
+
"inheritedFrom": {
|
|
71422
|
+
"name": "MixinViewport",
|
|
71423
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
71424
|
+
}
|
|
71425
|
+
},
|
|
71426
|
+
{
|
|
71427
|
+
"kind": "field",
|
|
71428
|
+
"name": "hint",
|
|
71429
|
+
"type": {
|
|
71430
|
+
"text": "string"
|
|
71431
|
+
},
|
|
71432
|
+
"privacy": "private",
|
|
71433
|
+
"default": "''",
|
|
71434
|
+
"description": "The hint over the surface while one shows, put there by a gesture it let pass.",
|
|
71435
|
+
"inheritedFrom": {
|
|
71436
|
+
"name": "MixinViewport",
|
|
71437
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
71438
|
+
}
|
|
71439
|
+
},
|
|
71440
|
+
{
|
|
71441
|
+
"kind": "field",
|
|
71442
|
+
"name": "hinting",
|
|
71443
|
+
"type": {
|
|
71444
|
+
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
71445
|
+
},
|
|
71446
|
+
"privacy": "private",
|
|
71447
|
+
"description": "When the hint goes.",
|
|
71448
|
+
"inheritedFrom": {
|
|
71449
|
+
"name": "MixinViewport",
|
|
71450
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
71451
|
+
}
|
|
71452
|
+
},
|
|
71453
|
+
{
|
|
71454
|
+
"kind": "field",
|
|
71455
|
+
"name": "hintAt",
|
|
71456
|
+
"type": {
|
|
71457
|
+
"text": "{ x: number; y: number } | undefined"
|
|
71458
|
+
},
|
|
71459
|
+
"privacy": "private",
|
|
71460
|
+
"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.",
|
|
71461
|
+
"inheritedFrom": {
|
|
71462
|
+
"name": "MixinViewport",
|
|
71463
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
71464
|
+
}
|
|
71465
|
+
},
|
|
71466
|
+
{
|
|
71467
|
+
"kind": "field",
|
|
71468
|
+
"name": "takenBy",
|
|
71469
|
+
"type": {
|
|
71470
|
+
"text": "Event | undefined"
|
|
71471
|
+
},
|
|
71472
|
+
"privacy": "private",
|
|
71473
|
+
"description": "The press that took the gestures, which is not also the first gesture.",
|
|
71474
|
+
"inheritedFrom": {
|
|
71475
|
+
"name": "MixinViewport",
|
|
71476
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
71477
|
+
}
|
|
71478
|
+
},
|
|
68543
71479
|
{
|
|
68544
71480
|
"kind": "field",
|
|
68545
71481
|
"name": "fullscreen",
|
|
@@ -68576,6 +71512,151 @@
|
|
|
68576
71512
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
68577
71513
|
}
|
|
68578
71514
|
},
|
|
71515
|
+
{
|
|
71516
|
+
"kind": "method",
|
|
71517
|
+
"name": "gestureAllowed",
|
|
71518
|
+
"privacy": "protected",
|
|
71519
|
+
"return": {
|
|
71520
|
+
"type": {
|
|
71521
|
+
"text": "boolean"
|
|
71522
|
+
}
|
|
71523
|
+
},
|
|
71524
|
+
"parameters": [
|
|
71525
|
+
{
|
|
71526
|
+
"name": "event",
|
|
71527
|
+
"type": {
|
|
71528
|
+
"text": "Event"
|
|
71529
|
+
}
|
|
71530
|
+
}
|
|
71531
|
+
],
|
|
71532
|
+
"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.",
|
|
71533
|
+
"inheritedFrom": {
|
|
71534
|
+
"name": "MixinViewport",
|
|
71535
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
71536
|
+
}
|
|
71537
|
+
},
|
|
71538
|
+
{
|
|
71539
|
+
"kind": "method",
|
|
71540
|
+
"name": "showHint",
|
|
71541
|
+
"privacy": "private",
|
|
71542
|
+
"return": {
|
|
71543
|
+
"type": {
|
|
71544
|
+
"text": "void"
|
|
71545
|
+
}
|
|
71546
|
+
},
|
|
71547
|
+
"parameters": [
|
|
71548
|
+
{
|
|
71549
|
+
"name": "words",
|
|
71550
|
+
"type": {
|
|
71551
|
+
"text": "string"
|
|
71552
|
+
}
|
|
71553
|
+
},
|
|
71554
|
+
{
|
|
71555
|
+
"name": "at",
|
|
71556
|
+
"optional": true,
|
|
71557
|
+
"type": {
|
|
71558
|
+
"text": "{ clientX: number; clientY: number }"
|
|
71559
|
+
}
|
|
71560
|
+
}
|
|
71561
|
+
],
|
|
71562
|
+
"description": "Shows a hint over the surface for a moment, where the gesture was.",
|
|
71563
|
+
"inheritedFrom": {
|
|
71564
|
+
"name": "MixinViewport",
|
|
71565
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
71566
|
+
}
|
|
71567
|
+
},
|
|
71568
|
+
{
|
|
71569
|
+
"kind": "field",
|
|
71570
|
+
"name": "handleGestureWheel",
|
|
71571
|
+
"privacy": "private",
|
|
71572
|
+
"readonly": true,
|
|
71573
|
+
"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.",
|
|
71574
|
+
"inheritedFrom": {
|
|
71575
|
+
"name": "MixinViewport",
|
|
71576
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
71577
|
+
}
|
|
71578
|
+
},
|
|
71579
|
+
{
|
|
71580
|
+
"kind": "field",
|
|
71581
|
+
"name": "handleGestureTouch",
|
|
71582
|
+
"privacy": "private",
|
|
71583
|
+
"readonly": true,
|
|
71584
|
+
"description": "One finger moving over the surface, which scrolls the page, and is said.",
|
|
71585
|
+
"inheritedFrom": {
|
|
71586
|
+
"name": "MixinViewport",
|
|
71587
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
71588
|
+
}
|
|
71589
|
+
},
|
|
71590
|
+
{
|
|
71591
|
+
"kind": "field",
|
|
71592
|
+
"name": "handleTake",
|
|
71593
|
+
"privacy": "private",
|
|
71594
|
+
"readonly": true,
|
|
71595
|
+
"description": "A press on the surface itself, which hands a waiting surface the gestures.",
|
|
71596
|
+
"inheritedFrom": {
|
|
71597
|
+
"name": "MixinViewport",
|
|
71598
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
71599
|
+
}
|
|
71600
|
+
},
|
|
71601
|
+
{
|
|
71602
|
+
"kind": "field",
|
|
71603
|
+
"name": "handleGiveBackKey",
|
|
71604
|
+
"privacy": "private",
|
|
71605
|
+
"readonly": true,
|
|
71606
|
+
"description": "Escape, which gives the page its scroll back.",
|
|
71607
|
+
"inheritedFrom": {
|
|
71608
|
+
"name": "MixinViewport",
|
|
71609
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
71610
|
+
}
|
|
71611
|
+
},
|
|
71612
|
+
{
|
|
71613
|
+
"kind": "field",
|
|
71614
|
+
"name": "handleGiveBackOutside",
|
|
71615
|
+
"privacy": "private",
|
|
71616
|
+
"readonly": true,
|
|
71617
|
+
"description": "A press anywhere else on the page, which gives it its scroll back.",
|
|
71618
|
+
"inheritedFrom": {
|
|
71619
|
+
"name": "MixinViewport",
|
|
71620
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
71621
|
+
}
|
|
71622
|
+
},
|
|
71623
|
+
{
|
|
71624
|
+
"kind": "field",
|
|
71625
|
+
"name": "handleGiveBackBlur",
|
|
71626
|
+
"privacy": "private",
|
|
71627
|
+
"readonly": true,
|
|
71628
|
+
"description": "The window losing focus, as a reader switching away does.",
|
|
71629
|
+
"inheritedFrom": {
|
|
71630
|
+
"name": "MixinViewport",
|
|
71631
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
71632
|
+
}
|
|
71633
|
+
},
|
|
71634
|
+
{
|
|
71635
|
+
"kind": "field",
|
|
71636
|
+
"name": "handlePointerLeave",
|
|
71637
|
+
"privacy": "protected",
|
|
71638
|
+
"readonly": true,
|
|
71639
|
+
"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.",
|
|
71640
|
+
"inheritedFrom": {
|
|
71641
|
+
"name": "MixinViewport",
|
|
71642
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
71643
|
+
}
|
|
71644
|
+
},
|
|
71645
|
+
{
|
|
71646
|
+
"kind": "method",
|
|
71647
|
+
"name": "renderGestures",
|
|
71648
|
+
"privacy": "protected",
|
|
71649
|
+
"return": {
|
|
71650
|
+
"type": {
|
|
71651
|
+
"text": "TemplateResult"
|
|
71652
|
+
}
|
|
71653
|
+
},
|
|
71654
|
+
"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.",
|
|
71655
|
+
"inheritedFrom": {
|
|
71656
|
+
"name": "MixinViewport",
|
|
71657
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
71658
|
+
}
|
|
71659
|
+
},
|
|
68579
71660
|
{
|
|
68580
71661
|
"kind": "method",
|
|
68581
71662
|
"name": "pan",
|
|
@@ -69181,15 +72262,6 @@
|
|
|
69181
72262
|
}
|
|
69182
72263
|
],
|
|
69183
72264
|
"attributes": [
|
|
69184
|
-
{
|
|
69185
|
-
"name": "activate-hint-label",
|
|
69186
|
-
"type": {
|
|
69187
|
-
"text": "string"
|
|
69188
|
-
},
|
|
69189
|
-
"default": "'Press the map to use it'",
|
|
69190
|
-
"description": "The hint shown when a map waiting to be pressed is scrolled or swiped\nover, with `gestures=\"activate\"`.",
|
|
69191
|
-
"fieldName": "activateHintLabel"
|
|
69192
|
-
},
|
|
69193
72265
|
{
|
|
69194
72266
|
"name": "bearing",
|
|
69195
72267
|
"type": {
|
|
@@ -69226,14 +72298,6 @@
|
|
|
69226
72298
|
"description": "What screen readers hear when the map is tilted back to looking straight down.",
|
|
69227
72299
|
"fieldName": "flatLabel"
|
|
69228
72300
|
},
|
|
69229
|
-
{
|
|
69230
|
-
"name": "gestures",
|
|
69231
|
-
"type": {
|
|
69232
|
-
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
69233
|
-
},
|
|
69234
|
-
"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.",
|
|
69235
|
-
"fieldName": "gestures"
|
|
69236
|
-
},
|
|
69237
72301
|
{
|
|
69238
72302
|
"name": "hybrid-label",
|
|
69239
72303
|
"type": {
|
|
@@ -69395,33 +72459,6 @@
|
|
|
69395
72459
|
"description": "What screen readers hear when the map is turned. `{degrees}` is the way the\ntop of the map faces, clockwise from north.",
|
|
69396
72460
|
"fieldName": "turnedLabel"
|
|
69397
72461
|
},
|
|
69398
|
-
{
|
|
69399
|
-
"name": "two-finger-hint-label",
|
|
69400
|
-
"type": {
|
|
69401
|
-
"text": "string"
|
|
69402
|
-
},
|
|
69403
|
-
"default": "'Use two fingers to move the map'",
|
|
69404
|
-
"description": "The hint shown when one finger swipes over a map with `gestures=\"cooperative\"`.",
|
|
69405
|
-
"fieldName": "twoFingerHintLabel"
|
|
69406
|
-
},
|
|
69407
|
-
{
|
|
69408
|
-
"name": "using-label",
|
|
69409
|
-
"type": {
|
|
69410
|
-
"text": "string"
|
|
69411
|
-
},
|
|
69412
|
-
"default": "'Using the map. Press Escape to scroll the page again.'",
|
|
69413
|
-
"description": "The line shown while a map with `gestures=\"activate\"` has the gestures.",
|
|
69414
|
-
"fieldName": "usingLabel"
|
|
69415
|
-
},
|
|
69416
|
-
{
|
|
69417
|
-
"name": "wheel-hint-label",
|
|
69418
|
-
"type": {
|
|
69419
|
-
"text": "string"
|
|
69420
|
-
},
|
|
69421
|
-
"default": "'Use {key} and scroll to zoom the map'",
|
|
69422
|
-
"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.",
|
|
69423
|
-
"fieldName": "wheelHintLabel"
|
|
69424
|
-
},
|
|
69425
72462
|
{
|
|
69426
72463
|
"name": "zoomed-label",
|
|
69427
72464
|
"type": {
|
|
@@ -69439,6 +72476,18 @@
|
|
|
69439
72476
|
"description": "How far the map is zoomed, in its renderer's levels. `connectMap` keeps it\ncurrent, and the map says it after a zoom.",
|
|
69440
72477
|
"fieldName": "zoomLevel"
|
|
69441
72478
|
},
|
|
72479
|
+
{
|
|
72480
|
+
"name": "activate-hint-label",
|
|
72481
|
+
"type": {
|
|
72482
|
+
"text": "string | undefined"
|
|
72483
|
+
},
|
|
72484
|
+
"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.",
|
|
72485
|
+
"fieldName": "activateHintLabel",
|
|
72486
|
+
"inheritedFrom": {
|
|
72487
|
+
"name": "MixinViewport",
|
|
72488
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
72489
|
+
}
|
|
72490
|
+
},
|
|
69442
72491
|
{
|
|
69443
72492
|
"name": "controls",
|
|
69444
72493
|
"type": {
|
|
@@ -69488,6 +72537,18 @@
|
|
|
69488
72537
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
69489
72538
|
}
|
|
69490
72539
|
},
|
|
72540
|
+
{
|
|
72541
|
+
"name": "gestures",
|
|
72542
|
+
"type": {
|
|
72543
|
+
"text": "'activate' | 'always' | 'cooperative' | undefined"
|
|
72544
|
+
},
|
|
72545
|
+
"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.",
|
|
72546
|
+
"fieldName": "gestures",
|
|
72547
|
+
"inheritedFrom": {
|
|
72548
|
+
"name": "MixinViewport",
|
|
72549
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
72550
|
+
}
|
|
72551
|
+
},
|
|
69491
72552
|
{
|
|
69492
72553
|
"name": "idle-delay",
|
|
69493
72554
|
"type": {
|
|
@@ -69566,6 +72627,42 @@
|
|
|
69566
72627
|
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
69567
72628
|
}
|
|
69568
72629
|
},
|
|
72630
|
+
{
|
|
72631
|
+
"name": "two-finger-hint-label",
|
|
72632
|
+
"type": {
|
|
72633
|
+
"text": "string | undefined"
|
|
72634
|
+
},
|
|
72635
|
+
"description": "The hint shown when one finger swipes over a surface with\n`gestures=\"cooperative\"`. Absent is the family's own.",
|
|
72636
|
+
"fieldName": "twoFingerHintLabel",
|
|
72637
|
+
"inheritedFrom": {
|
|
72638
|
+
"name": "MixinViewport",
|
|
72639
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
72640
|
+
}
|
|
72641
|
+
},
|
|
72642
|
+
{
|
|
72643
|
+
"name": "using-label",
|
|
72644
|
+
"type": {
|
|
72645
|
+
"text": "string | undefined"
|
|
72646
|
+
},
|
|
72647
|
+
"description": "The line shown while a surface with `gestures=\"activate\"` has the\ngestures. Absent is the family's own.",
|
|
72648
|
+
"fieldName": "usingLabel",
|
|
72649
|
+
"inheritedFrom": {
|
|
72650
|
+
"name": "MixinViewport",
|
|
72651
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
72652
|
+
}
|
|
72653
|
+
},
|
|
72654
|
+
{
|
|
72655
|
+
"name": "wheel-hint-label",
|
|
72656
|
+
"type": {
|
|
72657
|
+
"text": "string | undefined"
|
|
72658
|
+
},
|
|
72659
|
+
"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.",
|
|
72660
|
+
"fieldName": "wheelHintLabel",
|
|
72661
|
+
"inheritedFrom": {
|
|
72662
|
+
"name": "MixinViewport",
|
|
72663
|
+
"module": "src/mixins/mixin-viewport/mixin-viewport.ts"
|
|
72664
|
+
}
|
|
72665
|
+
},
|
|
69569
72666
|
{
|
|
69570
72667
|
"name": "zoom-in-label",
|
|
69571
72668
|
"type": {
|
|
@@ -69606,6 +72703,10 @@
|
|
|
69606
72703
|
"description": "The map has been drawn whole, after `helix-map-ready`.",
|
|
69607
72704
|
"name": "ready"
|
|
69608
72705
|
},
|
|
72706
|
+
{
|
|
72707
|
+
"description": "The page keeps the plain wheel and one finger, with `gestures=\"cooperative\"` or while a map with `gestures=\"activate\"` waits to be pressed.",
|
|
72708
|
+
"name": "sharing"
|
|
72709
|
+
},
|
|
69609
72710
|
{
|
|
69610
72711
|
"description": "A map with `gestures=\"activate\"` has been pressed and has the gestures.",
|
|
69611
72712
|
"name": "using"
|