@fusion.dev/helix 0.117.0 → 0.119.0

package/types/vue.d.ts

@@ -188,7 +188,9 @@ import type {
   HelixFacetEvent,
   HelixActivateEvent,
   HelixBeforeActivateEvent,
+  HelixGraphLayoutEvent,
   HelixGraphPanEvent,
+  HelixGraphPartChangeEvent,
   HelixGraphReadyEvent,
   HelixGraphZoomEvent,
   HelixResizeEvent,
@@ -1539,6 +1541,12 @@ Absent is no ruling, a resting value being an attribute's absence. */
 Framed is where it rests. Plain is for a board that fills a panel or an
 app's working area, where the container is already the frame. */
   separation?: (HelixCanvas["separation"]) | 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"?: (HelixCanvas["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?: (HelixCanvas["activateHintLabel"]) | undefined;
   /** Which controls to show, as a list such as `pan zoom fullscreen`, or
 `none`. A family can add words of its own.
 
@@ -1603,6 +1611,26 @@ would write an attribute onto every host that no server sent. */
   "fullscreen-label"?: (HelixCanvas["fullscreenLabel"]) | undefined;
   /** The fullscreen button's label. */
   fullscreenLabel?: (HelixCanvas["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?: (HelixCanvas["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
@@ -1657,6 +1685,26 @@ at any zoom, and a consumer who wants their own units multiplies by them. */
   "pan-up-label"?: (HelixCanvas["panUpLabel"]) | undefined;
   /** The pan up button's label. */
   panUpLabel?: (HelixCanvas["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"?: (HelixCanvas["twoFingerHintLabel"]) | undefined;
+  /** The hint shown when one finger swipes over a surface with
+`gestures="cooperative"`. Absent is the family's own. */
+  twoFingerHintLabel?: (HelixCanvas["twoFingerHintLabel"]) | undefined;
+  /** The line shown while a surface with `gestures="activate"` has the
+gestures. Absent is the family's own. */
+  "using-label"?: (HelixCanvas["usingLabel"]) | undefined;
+  /** The line shown while a surface with `gestures="activate"` has the
+gestures. Absent is the family's own. */
+  usingLabel?: (HelixCanvas["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"?: (HelixCanvas["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?: (HelixCanvas["wheelHintLabel"]) | undefined;
   /** The zoom in button's label. */
   "zoom-in-label"?: (HelixCanvas["zoomInLabel"]) | undefined;
   /** The zoom in button's label. */
@@ -5654,9 +5702,15 @@ export type HelixGraphHelixActivateElementEvent =
 /** `helix-before-activate` event type */
 export type HelixGraphHelixBeforeActivateElementEvent =
   HelixGraphElementEvent<HelixBeforeActivateEvent>;
+/** `helix-graph-layout` event type */
+export type HelixGraphHelixGraphLayoutElementEvent =
+  HelixGraphElementEvent<HelixGraphLayoutEvent>;
 /** `helix-graph-pan` event type */
 export type HelixGraphHelixGraphPanElementEvent =
   HelixGraphElementEvent<HelixGraphPanEvent>;
+/** `helix-graph-part-change` event type */
+export type HelixGraphHelixGraphPartChangeElementEvent =
+  HelixGraphElementEvent<HelixGraphPartChangeEvent>;
 /** `helix-graph-ready` event type */
 export type HelixGraphHelixGraphReadyElementEvent =
   HelixGraphElementEvent<HelixGraphReadyEvent>;
@@ -5665,6 +5719,12 @@ export type HelixGraphHelixGraphZoomElementEvent =
   HelixGraphElementEvent<HelixGraphZoomEvent>;
 
 export type HelixGraphVueProps = {
+  /** 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"?: (HelixGraph["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?: (HelixGraph["activateHintLabel"]) | undefined;
   /** Which controls to show, as a list such as `pan zoom fullscreen`, or
 `none`. A family can add words of its own.
 
@@ -5729,6 +5789,26 @@ would write an attribute onto every host that no server sent. */
   "fullscreen-label"?: (HelixGraph["fullscreenLabel"]) | undefined;
   /** The fullscreen button's label. */
   fullscreenLabel?: (HelixGraph["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?: (HelixGraph["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
@@ -5783,6 +5863,26 @@ at any zoom, and a consumer who wants their own units multiplies by them. */
   "pan-up-label"?: (HelixGraph["panUpLabel"]) | undefined;
   /** The pan up button's label. */
   panUpLabel?: (HelixGraph["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"?: (HelixGraph["twoFingerHintLabel"]) | undefined;
+  /** The hint shown when one finger swipes over a surface with
+`gestures="cooperative"`. Absent is the family's own. */
+  twoFingerHintLabel?: (HelixGraph["twoFingerHintLabel"]) | undefined;
+  /** The line shown while a surface with `gestures="activate"` has the
+gestures. Absent is the family's own. */
+  "using-label"?: (HelixGraph["usingLabel"]) | undefined;
+  /** The line shown while a surface with `gestures="activate"` has the
+gestures. Absent is the family's own. */
+  usingLabel?: (HelixGraph["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"?: (HelixGraph["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?: (HelixGraph["wheelHintLabel"]) | undefined;
   /** The zoom in button's label. */
   "zoom-in-label"?: (HelixGraph["zoomInLabel"]) | undefined;
   /** The zoom in button's label. */
@@ -5853,11 +5953,15 @@ export type HelixGraphVueEvents = {
   "helix-activate": HelixGraphHelixActivateElementEvent;
   /** A note is about to be selected. Cancelable: cancel it to keep the selection in your own state. */
   "helix-before-activate": HelixGraphHelixBeforeActivateElementEvent;
-  /** 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": HelixGraphHelixGraphLayoutElementEvent;
+  /** A pan button or arrow key was pressed. `connectGraph` moves the drawing. */
   "helix-graph-pan": HelixGraphHelixGraphPanElementEvent;
+  /** 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": HelixGraphHelixGraphPartChangeElementEvent;
   /** 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": HelixGraphHelixGraphReadyElementEvent;
-  /** A zoom button or key was pressed. Zoom the drawing. */
+  /** A zoom button or key was pressed. `connectGraph` zooms the drawing. */
   "helix-graph-zoom": HelixGraphHelixGraphZoomElementEvent;
 };
 
@@ -7559,6 +7663,12 @@ the container's edge is the map's. */
 shows the map through a blur, `frosted` blurs more, and `transparent` has
 no background. Your theme sets how see-through each one is. */
   material?: (HelixMap["material"]) | 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"?: (HelixMap["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?: (HelixMap["activateHintLabel"]) | undefined;
   /** Which controls to show, as a list such as `pan zoom fullscreen`, or
 `none`. A family can add words of its own.
 
@@ -7623,6 +7733,26 @@ would write an attribute onto every host that no server sent. */
   "fullscreen-label"?: (HelixMap["fullscreenLabel"]) | undefined;
   /** The fullscreen button's label. */
   fullscreenLabel?: (HelixMap["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?: (HelixMap["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
@@ -7677,6 +7807,26 @@ at any zoom, and a consumer who wants their own units multiplies by them. */
   "pan-up-label"?: (HelixMap["panUpLabel"]) | undefined;
   /** The pan up button's label. */
   panUpLabel?: (HelixMap["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"?: (HelixMap["twoFingerHintLabel"]) | undefined;
+  /** The hint shown when one finger swipes over a surface with
+`gestures="cooperative"`. Absent is the family's own. */
+  twoFingerHintLabel?: (HelixMap["twoFingerHintLabel"]) | undefined;
+  /** The line shown while a surface with `gestures="activate"` has the
+gestures. Absent is the family's own. */
+  "using-label"?: (HelixMap["usingLabel"]) | undefined;
+  /** The line shown while a surface with `gestures="activate"` has the
+gestures. Absent is the family's own. */
+  usingLabel?: (HelixMap["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"?: (HelixMap["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?: (HelixMap["wheelHintLabel"]) | undefined;
   /** The zoom in button's label. */
   "zoom-in-label"?: (HelixMap["zoomInLabel"]) | undefined;
   /** The zoom in button's label. */
@@ -7685,12 +7835,6 @@ at any zoom, and a consumer who wants their own units multiplies by them. */
   "zoom-out-label"?: (HelixMap["zoomOutLabel"]) | undefined;
   /** The zoom out button's label. */
   zoomOutLabel?: (HelixMap["zoomOutLabel"]) | undefined;
-  /** The hint shown when a map waiting to be pressed is scrolled or swiped
-over, with `gestures="activate"`. */
-  "activate-hint-label"?: (HelixMap["activateHintLabel"]) | undefined;
-  /** The hint shown when a map waiting to be pressed is scrolled or swiped
-over, with `gestures="activate"`. */
-  activateHintLabel?: (HelixMap["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?: (HelixMap["bearing"]) | undefined;
@@ -7705,19 +7849,6 @@ the map zooms in, and pressing one zooms in to its places. */
   "flat-label"?: (HelixMap["flatLabel"]) | undefined;
   /** What screen readers hear when the map is tilted back to looking straight down. */
   flatLabel?: (HelixMap["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?: (HelixMap["gestures"]) | undefined;
   /** The Hybrid map type's name. */
   "hybrid-label"?: (HelixMap["hybridLabel"]) | undefined;
   /** The Hybrid map type's name. */
@@ -7799,22 +7930,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?: (HelixMap["turnedLabel"]) | undefined;
-  /** The hint shown when one finger swipes over a map with `gestures="cooperative"`. */
-  "two-finger-hint-label"?: (HelixMap["twoFingerHintLabel"]) | undefined;
-  /** The hint shown when one finger swipes over a map with `gestures="cooperative"`. */
-  twoFingerHintLabel?: (HelixMap["twoFingerHintLabel"]) | undefined;
-  /** The line shown while a map with `gestures="activate"` has the gestures. */
-  "using-label"?: (HelixMap["usingLabel"]) | undefined;
-  /** The line shown while a map with `gestures="activate"` has the gestures. */
-  usingLabel?: (HelixMap["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"?: (HelixMap["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?: (HelixMap["wheelHintLabel"]) | undefined;
   /** What screen readers hear after a zoom. `{level}` is the zoom level. */
   "zoomed-label"?: (HelixMap["zoomedLabel"]) | undefined;
   /** What screen readers hear after a zoom. `{level}` is the zoom level. */