@fusion.dev/helix-headless 0.117.0 → 0.118.0

package/types/vue.d.ts

@@ -196,7 +196,9 @@ import type {
   HelixFacetEvent,
   HelixActivateEvent,
   HelixBeforeActivateEvent,
+  HelixGraphLayoutEvent,
   HelixGraphPanEvent,
+  HelixGraphPartChangeEvent,
   HelixGraphReadyEvent,
   HelixGraphZoomEvent,
   HelixResizeEvent,
@@ -1269,6 +1271,12 @@ red is "blocked" on one board and "urgent" on the next. A reader who can
 see the board is told by the color; this is how a reader who cannot is
 told the same. A tone left out is not read. */
   toneLabels?: (HelixHeadlessCanvas["toneLabels"]) | undefined;
+  /** The hint shown when a surface waiting to be pressed is scrolled or
+swiped over, with `gestures="activate"`. Absent is the family's own. */
+  "activate-hint-label"?: (HelixHeadlessCanvas["activateHintLabel"]) | undefined;
+  /** The hint shown when a surface waiting to be pressed is scrolled or
+swiped over, with `gestures="activate"`. Absent is the family's own. */
+  activateHintLabel?: (HelixHeadlessCanvas["activateHintLabel"]) | undefined;
   /** Which controls to show, as a list such as `pan zoom fullscreen`, or
 `none`. A family can add words of its own.
 
@@ -1333,6 +1341,26 @@ would write an attribute onto every host that no server sent. */
   "fullscreen-label"?: (HelixHeadlessCanvas["fullscreenLabel"]) | undefined;
   /** The fullscreen button's label. */
   fullscreenLabel?: (HelixHeadlessCanvas["fullscreenLabel"]) | undefined;
+  /** Which gestures the surface takes from the page.
+
+- `always`: the surface takes the wheel and one finger, for a surface
+  that is the page, such as a full-screen view. A map rests here.
+- Unset is the family's own: `always` for a map, and for a board, a
+  drag and a pinch, with the plain wheel left to the page until the
+  board fills the screen.
+- `cooperative`: the wheel and one finger scroll the page, and the
+  surface takes Ctrl or ⌘ with the wheel, and two fingers. The frame
+  says so when a gesture passes to the page. Best for a surface embedded
+  in a page.
+- `activate`: the surface takes nothing until it is pressed, and gives it
+  back on Escape, when the pointer leaves it, or on a press elsewhere.
+
+The keyboard and the frame's buttons work in every mode.
+
+**Unreflected and without a default**, because a default that reflected
+would write an attribute onto every host that no server sent, and the
+hydration that followed would disagree with it. */
+  gestures?: (HelixHeadlessCanvas["gestures"]) | undefined;
   /** How long, in milliseconds, before the header and footer hide when the user is inactive. `0` keeps them visible.
 
 Zero keeps it up, which is the default: these controls are how a keyboard
@@ -1387,6 +1415,26 @@ at any zoom, and a consumer who wants their own units multiplies by them. */
   "pan-up-label"?: (HelixHeadlessCanvas["panUpLabel"]) | undefined;
   /** The pan up button's label. */
   panUpLabel?: (HelixHeadlessCanvas["panUpLabel"]) | undefined;
+  /** The hint shown when one finger swipes over a surface with
+`gestures="cooperative"`. Absent is the family's own. */
+  "two-finger-hint-label"?: (HelixHeadlessCanvas["twoFingerHintLabel"]) | undefined;
+  /** The hint shown when one finger swipes over a surface with
+`gestures="cooperative"`. Absent is the family's own. */
+  twoFingerHintLabel?: (HelixHeadlessCanvas["twoFingerHintLabel"]) | undefined;
+  /** The line shown while a surface with `gestures="activate"` has the
+gestures. Absent is the family's own. */
+  "using-label"?: (HelixHeadlessCanvas["usingLabel"]) | undefined;
+  /** The line shown while a surface with `gestures="activate"` has the
+gestures. Absent is the family's own. */
+  usingLabel?: (HelixHeadlessCanvas["usingLabel"]) | undefined;
+  /** The hint shown when the wheel scrolls past a surface with
+`gestures="cooperative"`, with `{key}`, which is ⌘ on a Mac and Ctrl
+elsewhere. Absent is the family's own. */
+  "wheel-hint-label"?: (HelixHeadlessCanvas["wheelHintLabel"]) | undefined;
+  /** The hint shown when the wheel scrolls past a surface with
+`gestures="cooperative"`, with `{key}`, which is ⌘ on a Mac and Ctrl
+elsewhere. Absent is the family's own. */
+  wheelHintLabel?: (HelixHeadlessCanvas["wheelHintLabel"]) | undefined;
   /** The zoom in button's label. */
   "zoom-in-label"?: (HelixHeadlessCanvas["zoomInLabel"]) | undefined;
   /** The zoom in button's label. */
@@ -4762,9 +4810,15 @@ export type HelixHeadlessGraphHelixActivateElementEvent =
 /** `helix-before-activate` event type */
 export type HelixHeadlessGraphHelixBeforeActivateElementEvent =
   HelixHeadlessGraphElementEvent<HelixBeforeActivateEvent>;
+/** `helix-graph-layout` event type */
+export type HelixHeadlessGraphHelixGraphLayoutElementEvent =
+  HelixHeadlessGraphElementEvent<HelixGraphLayoutEvent>;
 /** `helix-graph-pan` event type */
 export type HelixHeadlessGraphHelixGraphPanElementEvent =
   HelixHeadlessGraphElementEvent<HelixGraphPanEvent>;
+/** `helix-graph-part-change` event type */
+export type HelixHeadlessGraphHelixGraphPartChangeElementEvent =
+  HelixHeadlessGraphElementEvent<HelixGraphPartChangeEvent>;
 /** `helix-graph-ready` event type */
 export type HelixHeadlessGraphHelixGraphReadyElementEvent =
   HelixHeadlessGraphElementEvent<HelixGraphReadyEvent>;
@@ -4807,6 +4861,12 @@ Required. */
   "selected-label"?: (HelixHeadlessGraph["selectedLabel"]) | undefined;
   /** How the selected note is described in the list. */
   selectedLabel?: (HelixHeadlessGraph["selectedLabel"]) | undefined;
+  /** The hint shown when a surface waiting to be pressed is scrolled or
+swiped over, with `gestures="activate"`. Absent is the family's own. */
+  "activate-hint-label"?: (HelixHeadlessGraph["activateHintLabel"]) | undefined;
+  /** The hint shown when a surface waiting to be pressed is scrolled or
+swiped over, with `gestures="activate"`. Absent is the family's own. */
+  activateHintLabel?: (HelixHeadlessGraph["activateHintLabel"]) | undefined;
   /** Which controls to show, as a list such as `pan zoom fullscreen`, or
 `none`. A family can add words of its own.
 
@@ -4871,6 +4931,26 @@ would write an attribute onto every host that no server sent. */
   "fullscreen-label"?: (HelixHeadlessGraph["fullscreenLabel"]) | undefined;
   /** The fullscreen button's label. */
   fullscreenLabel?: (HelixHeadlessGraph["fullscreenLabel"]) | undefined;
+  /** Which gestures the surface takes from the page.
+
+- `always`: the surface takes the wheel and one finger, for a surface
+  that is the page, such as a full-screen view. A map rests here.
+- Unset is the family's own: `always` for a map, and for a board, a
+  drag and a pinch, with the plain wheel left to the page until the
+  board fills the screen.
+- `cooperative`: the wheel and one finger scroll the page, and the
+  surface takes Ctrl or ⌘ with the wheel, and two fingers. The frame
+  says so when a gesture passes to the page. Best for a surface embedded
+  in a page.
+- `activate`: the surface takes nothing until it is pressed, and gives it
+  back on Escape, when the pointer leaves it, or on a press elsewhere.
+
+The keyboard and the frame's buttons work in every mode.
+
+**Unreflected and without a default**, because a default that reflected
+would write an attribute onto every host that no server sent, and the
+hydration that followed would disagree with it. */
+  gestures?: (HelixHeadlessGraph["gestures"]) | undefined;
   /** How long, in milliseconds, before the header and footer hide when the user is inactive. `0` keeps them visible.
 
 Zero keeps it up, which is the default: these controls are how a keyboard
@@ -4925,6 +5005,26 @@ at any zoom, and a consumer who wants their own units multiplies by them. */
   "pan-up-label"?: (HelixHeadlessGraph["panUpLabel"]) | undefined;
   /** The pan up button's label. */
   panUpLabel?: (HelixHeadlessGraph["panUpLabel"]) | undefined;
+  /** The hint shown when one finger swipes over a surface with
+`gestures="cooperative"`. Absent is the family's own. */
+  "two-finger-hint-label"?: (HelixHeadlessGraph["twoFingerHintLabel"]) | undefined;
+  /** The hint shown when one finger swipes over a surface with
+`gestures="cooperative"`. Absent is the family's own. */
+  twoFingerHintLabel?: (HelixHeadlessGraph["twoFingerHintLabel"]) | undefined;
+  /** The line shown while a surface with `gestures="activate"` has the
+gestures. Absent is the family's own. */
+  "using-label"?: (HelixHeadlessGraph["usingLabel"]) | undefined;
+  /** The line shown while a surface with `gestures="activate"` has the
+gestures. Absent is the family's own. */
+  usingLabel?: (HelixHeadlessGraph["usingLabel"]) | undefined;
+  /** The hint shown when the wheel scrolls past a surface with
+`gestures="cooperative"`, with `{key}`, which is ⌘ on a Mac and Ctrl
+elsewhere. Absent is the family's own. */
+  "wheel-hint-label"?: (HelixHeadlessGraph["wheelHintLabel"]) | undefined;
+  /** The hint shown when the wheel scrolls past a surface with
+`gestures="cooperative"`, with `{key}`, which is ⌘ on a Mac and Ctrl
+elsewhere. Absent is the family's own. */
+  wheelHintLabel?: (HelixHeadlessGraph["wheelHintLabel"]) | undefined;
   /** The zoom in button's label. */
   "zoom-in-label"?: (HelixHeadlessGraph["zoomInLabel"]) | undefined;
   /** The zoom in button's label. */
@@ -4961,11 +5061,15 @@ export type HelixHeadlessGraphVueEvents = {
   "helix-activate": HelixHeadlessGraphHelixActivateElementEvent;
   /** A note is about to be selected. Cancelable: cancel it to keep the selection in your own state. */
   "helix-before-activate": HelixHeadlessGraphHelixBeforeActivateElementEvent;
-  /** A pan button or arrow key was pressed. Move the drawing. */
+  /** 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`. */
+  "helix-graph-layout": HelixHeadlessGraphHelixGraphLayoutElementEvent;
+  /** A pan button or arrow key was pressed. `connectGraph` moves the drawing. */
   "helix-graph-pan": HelixHeadlessGraphHelixGraphPanElementEvent;
+  /** The notes, the links, the selection, the depth or the gestures changed. Used by `connectGraph`; pages do not need to listen for it. */
+  "helix-graph-part-change": HelixHeadlessGraphHelixGraphPartChangeElementEvent;
   /** The graph has been drawn whole, laid out and settled. Sent each time `drawn()` says it is drawn after it was not. */
   "helix-graph-ready": HelixHeadlessGraphHelixGraphReadyElementEvent;
-  /** A zoom button or key was pressed. Zoom the drawing. */
+  /** A zoom button or key was pressed. `connectGraph` zooms the drawing. */
   "helix-graph-zoom": HelixHeadlessGraphHelixGraphZoomElementEvent;
 };
 
@@ -6420,12 +6524,6 @@ export type HelixHeadlessMapHelixMapZoomElementEvent =
   HelixHeadlessMapElementEvent<HelixMapZoomEvent>;
 
 export type HelixHeadlessMapVueProps = {
-  /** The hint shown when a map waiting to be pressed is scrolled or swiped
-over, with `gestures="activate"`. */
-  "activate-hint-label"?: (HelixHeadlessMap["activateHintLabel"]) | undefined;
-  /** The hint shown when a map waiting to be pressed is scrolled or swiped
-over, with `gestures="activate"`. */
-  activateHintLabel?: (HelixHeadlessMap["activateHintLabel"]) | undefined;
   /** The map's rotation, in degrees clockwise from north. `connectMap` keeps it
 current, and the Face north button's needle turns with it. */
   bearing?: (HelixHeadlessMap["bearing"]) | undefined;
@@ -6440,19 +6538,6 @@ the map zooms in, and pressing one zooms in to its places. */
   "flat-label"?: (HelixHeadlessMap["flatLabel"]) | undefined;
   /** What screen readers hear when the map is tilted back to looking straight down. */
   flatLabel?: (HelixHeadlessMap["flatLabel"]) | undefined;
-  /** Which gestures the map takes from the page.
-
-- `always`, which unset is: the wheel zooms the map and one finger pans
-  it, for a map that is the page, such as a full-screen view.
-- `cooperative`: the wheel and one finger scroll the page, and the map
-  takes Ctrl or ⌘ with the wheel, and two fingers. The frame says so
-  when a gesture passes to the page. Best for a map embedded in a page.
-- `activate`: the map takes nothing until it is pressed, and gives it
-  back on Escape, when the pointer leaves it, or on a press elsewhere.
-
-The keyboard and the frame's buttons work in every mode. The renderer is
-told through the connector, so MapLibre and Leaflet behave alike. */
-  gestures?: (HelixHeadlessMap["gestures"]) | undefined;
   /** The Hybrid map type's name. */
   "hybrid-label"?: (HelixHeadlessMap["hybridLabel"]) | undefined;
   /** The Hybrid map type's name. */
@@ -6534,22 +6619,6 @@ top of the map faces, clockwise from north. */
   /** What screen readers hear when the map is turned. `{degrees}` is the way the
 top of the map faces, clockwise from north. */
   turnedLabel?: (HelixHeadlessMap["turnedLabel"]) | undefined;
-  /** The hint shown when one finger swipes over a map with `gestures="cooperative"`. */
-  "two-finger-hint-label"?: (HelixHeadlessMap["twoFingerHintLabel"]) | undefined;
-  /** The hint shown when one finger swipes over a map with `gestures="cooperative"`. */
-  twoFingerHintLabel?: (HelixHeadlessMap["twoFingerHintLabel"]) | undefined;
-  /** The line shown while a map with `gestures="activate"` has the gestures. */
-  "using-label"?: (HelixHeadlessMap["usingLabel"]) | undefined;
-  /** The line shown while a map with `gestures="activate"` has the gestures. */
-  usingLabel?: (HelixHeadlessMap["usingLabel"]) | undefined;
-  /** The hint shown when the wheel scrolls past a map with
-`gestures="cooperative"`, with `{key}`, which is ⌘ on a Mac and Ctrl
-elsewhere, as the renderer reads it. */
-  "wheel-hint-label"?: (HelixHeadlessMap["wheelHintLabel"]) | undefined;
-  /** The hint shown when the wheel scrolls past a map with
-`gestures="cooperative"`, with `{key}`, which is ⌘ on a Mac and Ctrl
-elsewhere, as the renderer reads it. */
-  wheelHintLabel?: (HelixHeadlessMap["wheelHintLabel"]) | undefined;
   /** What screen readers hear after a zoom. `{level}` is the zoom level. */
   "zoomed-label"?: (HelixHeadlessMap["zoomedLabel"]) | undefined;
   /** What screen readers hear after a zoom. `{level}` is the zoom level. */
@@ -6560,6 +6629,12 @@ current, and the map says it after a zoom. */
   /** How far the map is zoomed, in its renderer's levels. `connectMap` keeps it
 current, and the map says it after a zoom. */
   zoomLevel?: (HelixHeadlessMap["zoomLevel"]) | undefined;
+  /** The hint shown when a surface waiting to be pressed is scrolled or
+swiped over, with `gestures="activate"`. Absent is the family's own. */
+  "activate-hint-label"?: (HelixHeadlessMap["activateHintLabel"]) | undefined;
+  /** The hint shown when a surface waiting to be pressed is scrolled or
+swiped over, with `gestures="activate"`. Absent is the family's own. */
+  activateHintLabel?: (HelixHeadlessMap["activateHintLabel"]) | undefined;
   /** Which controls to show, as a list such as `pan zoom fullscreen`, or
 `none`. A family can add words of its own.
 
@@ -6624,6 +6699,26 @@ would write an attribute onto every host that no server sent. */
   "fullscreen-label"?: (HelixHeadlessMap["fullscreenLabel"]) | undefined;
   /** The fullscreen button's label. */
   fullscreenLabel?: (HelixHeadlessMap["fullscreenLabel"]) | undefined;
+  /** Which gestures the surface takes from the page.
+
+- `always`: the surface takes the wheel and one finger, for a surface
+  that is the page, such as a full-screen view. A map rests here.
+- Unset is the family's own: `always` for a map, and for a board, a
+  drag and a pinch, with the plain wheel left to the page until the
+  board fills the screen.
+- `cooperative`: the wheel and one finger scroll the page, and the
+  surface takes Ctrl or ⌘ with the wheel, and two fingers. The frame
+  says so when a gesture passes to the page. Best for a surface embedded
+  in a page.
+- `activate`: the surface takes nothing until it is pressed, and gives it
+  back on Escape, when the pointer leaves it, or on a press elsewhere.
+
+The keyboard and the frame's buttons work in every mode.
+
+**Unreflected and without a default**, because a default that reflected
+would write an attribute onto every host that no server sent, and the
+hydration that followed would disagree with it. */
+  gestures?: (HelixHeadlessMap["gestures"]) | undefined;
   /** How long, in milliseconds, before the header and footer hide when the user is inactive. `0` keeps them visible.
 
 Zero keeps it up, which is the default: these controls are how a keyboard
@@ -6678,6 +6773,26 @@ at any zoom, and a consumer who wants their own units multiplies by them. */
   "pan-up-label"?: (HelixHeadlessMap["panUpLabel"]) | undefined;
   /** The pan up button's label. */
   panUpLabel?: (HelixHeadlessMap["panUpLabel"]) | undefined;
+  /** The hint shown when one finger swipes over a surface with
+`gestures="cooperative"`. Absent is the family's own. */
+  "two-finger-hint-label"?: (HelixHeadlessMap["twoFingerHintLabel"]) | undefined;
+  /** The hint shown when one finger swipes over a surface with
+`gestures="cooperative"`. Absent is the family's own. */
+  twoFingerHintLabel?: (HelixHeadlessMap["twoFingerHintLabel"]) | undefined;
+  /** The line shown while a surface with `gestures="activate"` has the
+gestures. Absent is the family's own. */
+  "using-label"?: (HelixHeadlessMap["usingLabel"]) | undefined;
+  /** The line shown while a surface with `gestures="activate"` has the
+gestures. Absent is the family's own. */
+  usingLabel?: (HelixHeadlessMap["usingLabel"]) | undefined;
+  /** The hint shown when the wheel scrolls past a surface with
+`gestures="cooperative"`, with `{key}`, which is ⌘ on a Mac and Ctrl
+elsewhere. Absent is the family's own. */
+  "wheel-hint-label"?: (HelixHeadlessMap["wheelHintLabel"]) | undefined;
+  /** The hint shown when the wheel scrolls past a surface with
+`gestures="cooperative"`, with `{key}`, which is ⌘ on a Mac and Ctrl
+elsewhere. Absent is the family's own. */
+  wheelHintLabel?: (HelixHeadlessMap["wheelHintLabel"]) | undefined;
   /** The zoom in button's label. */
   "zoom-in-label"?: (HelixHeadlessMap["zoomInLabel"]) | undefined;
   /** The zoom in button's label. */
@@ -12327,7 +12442,7 @@ export interface WcToolkitVueGlobalComponents {
     HelixHeadlessFormatDateVueProps,
     HelixHeadlessFormatDateVueEvents
   >;
-  /** Helix draws no graph. A force layout of thousands of notes is physics and WebGL, which a renderer such as Sigma.js does. Put the renderer's box in the frame, draw 'nodes' and 'links' in it, and answer the frame's pan and zoom events by moving the drawing.  What the frame adds is what a drawing of a graph cannot do: a list of every note beside it, which is the graph for a screen reader and a quick way to find a note for anyone. The selected note comes first, then the notes it links to and from, then every other note, and the search field narrows it. Selecting a note in the list or in the drawing is the same selection.  Set 'depth' to show the local graph: only the notes within that many links of the selected one.  'nodes' and 'links' are properties, never markup: a graph of ten thousand notes as ten thousand elements would cost what the renderer exists to save. The list draws only the rows in view.  The list scrolls on this tier. It carries 'data-scroller', and 'core' ships '[data-scroller] { overflow: auto }' into every shadow root. You still need to set a block size on the list, or it grows to hold every row. */
+  /** Helix draws no graph. A force layout of thousands of notes is physics and WebGL, which a renderer such as Sigma.js does. Put the renderer's box in the frame, and 'connectGraph' from '@fusion.dev/helix-graph' draws 'nodes' and 'links' in it and keeps it in step with the frame.  What the frame adds is what a drawing of a graph cannot do: a list of every note beside it, which is the graph for a screen reader and a quick way to find a note for anyone. The selected note comes first, then the notes it links to and from, then every other note, and the search field narrows it. Selecting a note in the list or in the drawing is the same selection.  Set 'depth' to show the local graph: only the notes within that many links of the selected one.  'nodes' and 'links' are properties, never markup: a graph of ten thousand notes as ten thousand elements would cost what the renderer exists to save. The list draws only the rows in view.  The list scrolls on this tier. It carries 'data-scroller', and 'core' ships '[data-scroller] { overflow: auto }' into every shadow root. You still need to set a block size on the list, or it grows to hold every row. */
   "helix-headless-graph": DefineCustomElement<
     HelixHeadlessGraph,
     HelixHeadlessGraphVueProps,