@fusion.dev/helix-headless 0.103.2 → 0.103.3

package/types/vue.d.ts

@@ -4808,56 +4808,61 @@ export type HelixHeadlessMapHelixMapZoomElementEvent =
   HelixHeadlessMapElementEvent<HelixMapZoomEvent>;
 
 export type HelixHeadlessMapVueProps = {
-  /** Which of the controls this frame draws, as a list of what to keep.
-
-**A list rather than a switch, because the overlap is not symmetric.**
-Every map library draws zoom controls and none of them draws pan buttons:
-MapLibre's navigation control is zoom and a compass, Leaflet's is zoom,
-Google's is zoom. So a consumer slotting one of those has our zoom twice
-over and our pan pad not at all, and a single switch would make them choose
-between a duplicate and nothing.
-
-`none` draws none of them, which is the right answer where the slotted map
-already has controls a reader can find: what this family argues for is that
-*a* findable control exists, never that it is ours. The methods stay public
-either way, so a consumer drawing their own chrome can still drive the
-frame.
-
-Absent is all three, which is this library's rule that a resting value is an
-attribute's absence, and it is what the stylesheet asks about: the layout
-rules are written against `[controls]:not([controls~="zoom"])` rather than
-the bare negation, or a frame that named no list at all would be laid out as
-though it had dropped everything. */
+  /** Accessible name for the map, which is the one thing a consumer must write.
+
+There is no sensible default. "Map" names the widget rather than the place,
+and a reader meeting three of them on a page learns nothing from hearing the
+same word three times.
+
+**The region is a tab stop**, so the keys are reachable however the controls
+are configured: the listener is on the region, and without a stop of its own
+a frame at `controls="none"` around a map with nothing focusable in it had
+arrow keys no reader could ever press. `aria-keyshortcuts` says which keys
+rather than spelling them into the name, which would otherwise be read out
+at every encounter. */
+  label?: (HelixHeadlessMap["label"]) | undefined;
+  /** Which of the controls this surface draws, as a list of what to keep.
+
+**A list rather than a switch, because the overlap is not symmetric.** A
+surface a consumer brings often has zoom controls of its own and almost
+never has pan buttons, so a single switch would make them choose between
+a duplicate and nothing.
+
+`none` draws none of them, which is the right answer where what was
+slotted already has controls a reader can find: what this argues for is
+that *a* findable control exists, never that it is ours. The methods stay
+public either way, so a consumer drawing their own chrome can still drive
+the surface.
+
+Absent is all three, which is this library's rule that a resting value is
+an attribute's absence, and it is what the stylesheet asks about: the
+layout rules are written against `[controls]:not([controls~="zoom"])`
+rather than the bare negation, or a surface that named no list at all
+would be laid out as though it had dropped everything. */
   controls?: (HelixHeadlessMap["controls"]) | undefined;
   /** Which corner the controls sit in.
 
-**Configurable because there is no safe default**, and this is a collision
-rather than a taste: MapLibre puts its own controls at the top end, Leaflet
-and OpenLayers at the top start, Google's zoom at the bottom end. Whichever
-corner this took would land on somebody's, which is why every one of those
-libraries made it a setting too.
+**Configurable because there is no safe default**, which is a collision
+rather than a taste: whatever a consumer slots may put its own controls
+in any corner, and every library that draws some made this a setting for
+the same reason.
 
 Logical corners rather than left and right, so a right-to-left page moves
-them without a consumer writing a second rule.
-
-Absent is the top end, which is this library's rule that a resting value is
-an attribute's absence: a default that reflected would write an attribute
-onto every host that no server sent and nobody asked for. */
+them without a consumer writing a second rule. Absent is the top end, a
+resting value being an attribute's absence: a default that reflected
+would write an attribute onto every host that no server sent. */
   "controls-placement"?: (HelixHeadlessMap["controlsPlacement"]) | undefined;
   /** Which corner the controls sit in.
 
-**Configurable because there is no safe default**, and this is a collision
-rather than a taste: MapLibre puts its own controls at the top end, Leaflet
-and OpenLayers at the top start, Google's zoom at the bottom end. Whichever
-corner this took would land on somebody's, which is why every one of those
-libraries made it a setting too.
+**Configurable because there is no safe default**, which is a collision
+rather than a taste: whatever a consumer slots may put its own controls
+in any corner, and every library that draws some made this a setting for
+the same reason.
 
 Logical corners rather than left and right, so a right-to-left page moves
-them without a consumer writing a second rule.
-
-Absent is the top end, which is this library's rule that a resting value is
-an attribute's absence: a default that reflected would write an attribute
-onto every host that no server sent and nobody asked for. */
+them without a consumer writing a second rule. Absent is the top end, a
+resting value being an attribute's absence: a default that reflected
+would write an attribute onto every host that no server sent. */
   controlsPlacement?: (HelixHeadlessMap["controlsPlacement"]) | undefined;
   /** What the control that fills the screen is called. */
   "fullscreen-label"?: (HelixHeadlessMap["fullscreenLabel"]) | undefined;
@@ -4865,54 +4870,41 @@ onto every host that no server sent and nobody asked for. */
   fullscreenLabel?: (HelixHeadlessMap["fullscreenLabel"]) | undefined;
   /** How long the reader may be still before the chrome hides, in milliseconds.
 
-Zero keeps it up, which is the default: a map's controls are how a keyboard
-reader operates it, and chrome that hides itself by default would be this
-component undoing its own argument. Set it for a display map nobody drives. */
+Zero keeps it up, which is the default: these controls are how a keyboard
+reader operates the surface, and chrome that hid itself by default would
+be the component undoing its own argument. Set it for a display nobody
+drives. */
   "idle-delay"?: (HelixHeadlessMap["idleDelay"] | `${number}`) | undefined;
   /** How long the reader may be still before the chrome hides, in milliseconds.
 
-Zero keeps it up, which is the default: a map's controls are how a keyboard
-reader operates it, and chrome that hides itself by default would be this
-component undoing its own argument. Set it for a display map nobody drives. */
+Zero keeps it up, which is the default: these controls are how a keyboard
+reader operates the surface, and chrome that hid itself by default would
+be the component undoing its own argument. Set it for a display nobody
+drives. */
   idleDelay?: (HelixHeadlessMap["idleDelay"]) | undefined;
-  /** Accessible name for the map, which is the one thing a consumer must write.
-
-There is no sensible default. "Map" names the widget rather than the place,
-and a reader meeting three of them on a page learns nothing from hearing the
-same word three times.
-
-**The region is a tab stop**, so the keys are reachable however the controls
-are configured: the listener is on the region, and without a stop of its own
-a frame at `controls="none"` around a map with nothing focusable in it had
-arrow keys no reader could ever press. `aria-keyshortcuts` says which keys
-rather than spelling them into the name, which would otherwise be read out
-at every encounter. */
-  label?: (HelixHeadlessMap["label"]) | undefined;
-  /** What the controls are called, for a page not in English. */
+  /** What one pan control is called, with `{way}` filled in. */
   "pan-label"?: (HelixHeadlessMap["panLabel"]) | undefined;
-  /** What the controls are called, for a page not in English. */
+  /** What one pan control is called, with `{way}` filled in. */
   panLabel?: (HelixHeadlessMap["panLabel"]) | undefined;
-  /** How far one press moves the map, as a fraction of what is on screen.
+  /** How far one press moves the view, as a fraction of what is on screen.
 
-A fraction rather than a distance, because this frame does not know the
-scale of what is inside it: a quarter of the viewport is the same gesture at
-street level and at country level, and a consumer who wants metres can
-multiply by their own. */
+A fraction rather than a distance, because this surface does not know the
+scale of what is inside it: a quarter of the viewport is the same gesture
+at any zoom, and a consumer who wants their own units multiplies by them. */
   "pan-step"?: (HelixHeadlessMap["panStep"] | `${number}`) | undefined;
-  /** How far one press moves the map, as a fraction of what is on screen.
+  /** How far one press moves the view, as a fraction of what is on screen.
 
-A fraction rather than a distance, because this frame does not know the
-scale of what is inside it: a quarter of the viewport is the same gesture at
-street level and at country level, and a consumer who wants metres can
-multiply by their own. */
+A fraction rather than a distance, because this surface does not know the
+scale of what is inside it: a quarter of the viewport is the same gesture
+at any zoom, and a consumer who wants their own units multiplies by them. */
   panStep?: (HelixHeadlessMap["panStep"]) | undefined;
-  /** What the zoom controls are called. */
+  /** What the control that zooms in is called. */
   "zoom-in-label"?: (HelixHeadlessMap["zoomInLabel"]) | undefined;
-  /** What the zoom controls are called. */
+  /** What the control that zooms in is called. */
   zoomInLabel?: (HelixHeadlessMap["zoomInLabel"]) | undefined;
-  /** What the zoom control that goes the other way is called. */
+  /** What the control that zooms out is called. */
   "zoom-out-label"?: (HelixHeadlessMap["zoomOutLabel"]) | undefined;
-  /** What the zoom control that goes the other way is called. */
+  /** What the control that zooms out is called. */
   zoomOutLabel?: (HelixHeadlessMap["zoomOutLabel"]) | undefined;
 };