react-cheminfo 0.10.0 → 0.12.0

package/lib/format/core/units.js

@@ -1,8 +1,14 @@
 import { MISSING_VALUE } from "./missing.js";
 const BYTE_UNITS = ['B', 'kB', 'MB', 'GB', 'TB', 'PB'];
 const BYTES_PER_UNIT = 1024;
+const MILLISECONDS_PER_SECOND = 1000;
+const TENTHS_PER_MINUTE = 600;
 const SECONDS_PER_MINUTE = 60;
 const MINUTES_PER_HOUR = 60;
+const UNIT_NAMES = {
+    compact: { millisecond: 'ms', second: 's', minute: 'm', hour: 'h' },
+    spaced: { millisecond: ' ms', second: ' s', minute: ' min', hour: ' h' },
+};
 /**
  * A byte count in the largest unit that keeps it under a thousand: `512 B`,
  * `1.5 kB`, `240 MB`.
@@ -26,27 +32,40 @@ export function formatBytes(bytes) {
     return `${value.toFixed(digits)} ${BYTE_UNITS[unitIndex] ?? 'B'}`;
 }
 /**
- * A duration written with its two largest units: `45s`, `3m 20s`, `2h 05m`.
+ * A duration written with its two largest units: `45s`, `3m 20s`, `2h 05m`,
+ * or `45 s`, `3 min 20 s`, `2 h 05 min` in the spaced style.
  * @param milliseconds - The duration in milliseconds.
+ * @param options - See {@link FormatDurationOptions}.
  * @returns The duration, or the missing marker when there is no finite, non-negative duration.
  */
-export function formatDuration(milliseconds) {
+export function formatDuration(milliseconds, options = {}) {
     if (milliseconds === undefined ||
         !Number.isFinite(milliseconds) ||
         milliseconds < 0) {
         return MISSING_VALUE;
     }
-    const seconds = Math.round(milliseconds / 1000);
+    const { style = 'compact', subSecond = false } = options;
+    const names = UNIT_NAMES[style];
+    if (subSecond) {
+        const whole = Math.round(milliseconds);
+        if (whole < MILLISECONDS_PER_SECOND)
+            return `${whole}${names.millisecond}`;
+        const tenths = Math.round(milliseconds / 100);
+        if (tenths < TENTHS_PER_MINUTE) {
+            return `${(tenths / 10).toFixed(1)}${names.second}`;
+        }
+    }
+    const seconds = Math.round(milliseconds / MILLISECONDS_PER_SECOND);
     if (seconds < SECONDS_PER_MINUTE)
-        return `${seconds}s`;
+        return `${seconds}${names.second}`;
     const minutes = Math.floor(seconds / SECONDS_PER_MINUTE);
     const remainingSeconds = seconds % SECONDS_PER_MINUTE;
     if (minutes < MINUTES_PER_HOUR) {
-        return `${minutes}m ${pad(remainingSeconds)}s`;
+        return `${minutes}${names.minute} ${pad(remainingSeconds)}${names.second}`;
     }
     const hours = Math.floor(minutes / MINUTES_PER_HOUR);
     const remainingMinutes = minutes % MINUTES_PER_HOUR;
-    return `${hours}h ${pad(remainingMinutes)}m`;
+    return `${hours}${names.hour} ${pad(remainingMinutes)}${names.minute}`;
 }
 function pad(value) {
     return value.toString().padStart(2, '0');

package/lib/format/core/units.js.map

@@ -1 +1 @@
-{"version":3,"file":"units.js","sourceRoot":"","sources":["../../../src/format/core/units.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE7C,MAAM,UAAU,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAU,CAAC;AAChE,MAAM,cAAc,GAAG,IAAI,CAAC;AAC5B,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAE5B;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CAAC,KAAyB;IACnD,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QAChE,OAAO,aAAa,CAAC;IACvB,CAAC;IACD,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,OAAO,KAAK,IAAI,cAAc,IAAI,SAAS,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpE,KAAK,IAAI,cAAc,CAAC;QACxB,SAAS,IAAI,CAAC,CAAC;IACjB,CAAC;IACD,MAAM,MAAM,GAAG,SAAS,KAAK,CAAC,IAAI,KAAK,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,SAAS,CAAC,IAAI,GAAG,EAAE,CAAC;AACpE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,YAAgC;IAC7D,IACE,YAAY,KAAK,SAAS;QAC1B,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC;QAC9B,YAAY,GAAG,CAAC,EAChB,CAAC;QACD,OAAO,aAAa,CAAC;IACvB,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;IAChD,IAAI,OAAO,GAAG,kBAAkB;QAAE,OAAO,GAAG,OAAO,GAAG,CAAC;IAEvD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,kBAAkB,CAAC,CAAC;IACzD,MAAM,gBAAgB,GAAG,OAAO,GAAG,kBAAkB,CAAC;IACtD,IAAI,OAAO,GAAG,gBAAgB,EAAE,CAAC;QAC/B,OAAO,GAAG,OAAO,KAAK,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC;IACjD,CAAC;IAED,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,gBAAgB,CAAC,CAAC;IACrD,MAAM,gBAAgB,GAAG,OAAO,GAAG,gBAAgB,CAAC;IACpD,OAAO,GAAG,KAAK,KAAK,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC;AAC/C,CAAC;AAED,SAAS,GAAG,CAAC,KAAa;IACxB,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AAC3C,CAAC"}
+{"version":3,"file":"units.js","sourceRoot":"","sources":["../../../src/format/core/units.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE7C,MAAM,UAAU,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAU,CAAC;AAChE,MAAM,cAAc,GAAG,IAAI,CAAC;AAC5B,MAAM,uBAAuB,GAAG,IAAI,CAAC;AACrC,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAC9B,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAK5B,MAAM,UAAU,GAGZ;IACF,OAAO,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE;IACnE,MAAM,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;CACzE,CAAC;AAmBF;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CAAC,KAAyB;IACnD,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QAChE,OAAO,aAAa,CAAC;IACvB,CAAC;IACD,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,OAAO,KAAK,IAAI,cAAc,IAAI,SAAS,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpE,KAAK,IAAI,cAAc,CAAC;QACxB,SAAS,IAAI,CAAC,CAAC;IACjB,CAAC;IACD,MAAM,MAAM,GAAG,SAAS,KAAK,CAAC,IAAI,KAAK,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,SAAS,CAAC,IAAI,GAAG,EAAE,CAAC;AACpE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAC5B,YAAgC,EAChC,UAAiC,EAAE;IAEnC,IACE,YAAY,KAAK,SAAS;QAC1B,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC;QAC9B,YAAY,GAAG,CAAC,EAChB,CAAC;QACD,OAAO,aAAa,CAAC;IACvB,CAAC;IACD,MAAM,EAAE,KAAK,GAAG,SAAS,EAAE,SAAS,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;IACzD,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IAEhC,IAAI,SAAS,EAAE,CAAC;QACd,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QACvC,IAAI,KAAK,GAAG,uBAAuB;YAAE,OAAO,GAAG,KAAK,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAC3E,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,GAAG,CAAC,CAAC;QAC9C,IAAI,MAAM,GAAG,iBAAiB,EAAE,CAAC;YAC/B,OAAO,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QACtD,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,uBAAuB,CAAC,CAAC;IACnE,IAAI,OAAO,GAAG,kBAAkB;QAAE,OAAO,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;IAErE,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,kBAAkB,CAAC,CAAC;IACzD,MAAM,gBAAgB,GAAG,OAAO,GAAG,kBAAkB,CAAC;IACtD,IAAI,OAAO,GAAG,gBAAgB,EAAE,CAAC;QAC/B,OAAO,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,IAAI,GAAG,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;IAC7E,CAAC;IAED,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,gBAAgB,CAAC,CAAC;IACrD,MAAM,gBAAgB,GAAG,OAAO,GAAG,gBAAgB,CAAC;IACpD,OAAO,GAAG,KAAK,GAAG,KAAK,CAAC,IAAI,IAAI,GAAG,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;AACzE,CAAC;AAED,SAAS,GAAG,CAAC,KAAa;IACxB,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AAC3C,CAAC"}

package/lib/help/ui/HelpBody.d.ts

@@ -17,16 +17,22 @@ export interface HelpExample {
 }
 /** Everything a piece of help says, wherever it is shown. */
 export interface HelpContent {
-    /** First line, in bold: what the thing is, not what its label already says. */
-    title: string;
-    /** The explanation, one or two sentences. */
-    body: ReactNode;
     /**
-     * A concrete case, because a definition without one is what makes a reader
-     * give up.
+     * First line, in bold: what the thing is, not what its label already says.
+     * @default undefined — the body stands on its own, as a plain tooltip does
+     */
+    title?: string;
+    /**
+     * The explanation: one or two sentences, or any content of the site's own.
+     * @default undefined
+     */
+    body?: ReactNode;
+    /**
+     * A concrete case, or several read in order, because a definition without
+     * one is what makes a reader give up.
      * @default undefined
      */
-    example?: HelpExample;
+    example?: HelpExample | readonly HelpExample[];
     /**
      * Where the full documentation lives, offered as a "Learn more" link.
      * @default undefined
@@ -43,6 +49,11 @@ export interface HelpBodyProps {
      * @default 280
      */
     width?: number;
+    /**
+     * Class names added to the root element, after the component's own.
+     * @default undefined
+     */
+    className?: string;
 }
 /**
  * The one rendering of a piece of help.

package/lib/help/ui/HelpBody.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HelpBody.d.ts","sourceRoot":"","sources":["../../../src/help/ui/HelpBody.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAiB,YAAY,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEpE,+EAA+E;AAC/E,MAAM,WAAW,WAAW;IAC1B,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,6DAA6D;AAC7D,MAAM,WAAW,WAAW;IAC1B,+EAA+E;IAC/E,KAAK,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,IAAI,EAAE,SAAS,CAAC;IAChB;;;;OAIG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,mCAAmC;AACnC,MAAM,WAAW,aAAa;IAC5B,0BAA0B;IAC1B,OAAO,EAAE,WAAW,CAAC;IACrB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,aAAa,GAAG,YAAY,CAiC3D"}
+{"version":3,"file":"HelpBody.d.ts","sourceRoot":"","sources":["../../../src/help/ui/HelpBody.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAiB,YAAY,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAIpE,+EAA+E;AAC/E,MAAM,WAAW,WAAW;IAC1B,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,6DAA6D;AAC7D,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;;;OAIG;IACH,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,WAAW,EAAE,CAAC;IAC/C;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,mCAAmC;AACnC,MAAM,WAAW,aAAa;IAC5B,0BAA0B;IAC1B,OAAO,EAAE,WAAW,CAAC;IACrB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,aAAa,GAAG,YAAY,CAoC3D"}

package/lib/help/ui/HelpBody.js

@@ -1,4 +1,5 @@
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { joinClassNames } from "../../shared/ui/joinClassNames.js";
 /**
  * The one rendering of a piece of help.
  *
@@ -9,9 +10,30 @@ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
  * @returns The help body.
  */
 export function HelpBody(props) {
-    const { content, width = DEFAULT_WIDTH } = props;
+    const { className, content, width = DEFAULT_WIDTH } = props;
     const { title, body, example, link } = content;
-    return (_jsxs("div", { className: "help-body", style: { ...BODY_STYLE, maxWidth: width }, children: [_jsx("div", { style: TITLE_STYLE, children: title }), _jsx("div", { style: TEXT_STYLE, children: body }), example === undefined ? null : (_jsxs("div", { style: EXAMPLE_STYLE, children: [_jsx("code", { style: CODE_STYLE, children: example.code }), example.input === undefined ? null : (_jsxs("div", { style: INPUT_STYLE, children: ["on ", _jsx("code", { style: CODE_STYLE, children: example.input })] })), example.note === undefined ? null : (_jsx("div", { style: NOTE_STYLE, children: example.note }))] })), link === undefined ? null : (_jsx("a", { href: link, target: "_blank", rel: "noopener noreferrer", style: LINK_STYLE, children: "Learn more" }))] }));
+    return (_jsxs("div", { className: joinClassNames('help-body', className), style: { ...BODY_STYLE, maxWidth: width }, children: [title === undefined ? null : _jsx("div", { style: TITLE_STYLE, children: title }), body === undefined ? null : _jsx("div", { style: TEXT_STYLE, children: body }), examplesOf(example).map((item) => (_jsxs("div", { style: EXAMPLE_STYLE, children: [_jsx("code", { style: CODE_STYLE, children: item.code }), item.input === undefined ? null : (_jsxs("div", { style: INPUT_STYLE, children: ["on ", _jsx("code", { style: CODE_STYLE, children: item.input })] })), item.note === undefined ? null : (_jsx("div", { style: NOTE_STYLE, children: item.note }))] }, exampleKey(item)))), link === undefined ? null : (_jsx("a", { href: link, target: "_blank", rel: "noopener noreferrer", style: LINK_STYLE, children: "Learn more" }))] }));
+}
+// Two examples are only the same when all three of their parts are, and a help
+// that repeats one example has nothing to gain from drawing it twice.
+function exampleKey(example) {
+    return `${example.code}\n${example.input ?? ''}\n${example.note ?? ''}`;
+}
+function examplesOf(example) {
+    if (example === undefined)
+        return [];
+    if ('code' in example)
+        return [example];
+    const seen = new Set();
+    const unique = [];
+    for (const item of example) {
+        const key = exampleKey(item);
+        if (seen.has(key))
+            continue;
+        seen.add(key);
+        unique.push(item);
+    }
+    return unique;
 }
 /** How wide a piece of help is drawn when the caller does not say. */
 const DEFAULT_WIDTH = 280;

package/lib/help/ui/HelpBody.js.map

@@ -1 +1 @@
-{"version":3,"file":"HelpBody.js","sourceRoot":"","sources":["../../../src/help/ui/HelpBody.tsx"],"names":[],"mappings":";AAkDA;;;;;;;;GAQG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAoB;IAC3C,MAAM,EAAE,OAAO,EAAE,KAAK,GAAG,aAAa,EAAE,GAAG,KAAK,CAAC;IACjD,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAE/C,OAAO,CACL,eAAK,SAAS,EAAC,WAAW,EAAC,KAAK,EAAE,EAAE,GAAG,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE,aAClE,cAAK,KAAK,EAAE,WAAW,YAAG,KAAK,GAAO,EACtC,cAAK,KAAK,EAAE,UAAU,YAAG,IAAI,GAAO,EACnC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAC9B,eAAK,KAAK,EAAE,aAAa,aACvB,eAAM,KAAK,EAAE,UAAU,YAAG,OAAO,CAAC,IAAI,GAAQ,EAC7C,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CACpC,eAAK,KAAK,EAAE,WAAW,oBAClB,eAAM,KAAK,EAAE,UAAU,YAAG,OAAO,CAAC,KAAK,GAAQ,IAC9C,CACP,EACA,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CACnC,cAAK,KAAK,EAAE,UAAU,YAAG,OAAO,CAAC,IAAI,GAAO,CAC7C,IACG,CACP,EACA,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAC3B,YACE,IAAI,EAAE,IAAI,EACV,MAAM,EAAC,QAAQ,EACf,GAAG,EAAC,qBAAqB,EACzB,KAAK,EAAE,UAAU,2BAGf,CACL,IACG,CACP,CAAC;AACJ,CAAC;AAED,sEAAsE;AACtE,MAAM,aAAa,GAAG,GAAG,CAAC;AAE1B,MAAM,UAAU,GAAG;IACjB,OAAO,EAAE,MAAM;IACf,aAAa,EAAE,QAAQ;IACvB,GAAG,EAAE,CAAC;CAC0B,CAAC;AAEnC,MAAM,WAAW,GAAG,EAAE,UAAU,EAAE,GAAG,EAAmC,CAAC;AAEzE,MAAM,UAAU,GAAG;IACjB,UAAU,EAAE,GAAG;IACf,UAAU,EAAE,IAAI;CACgB,CAAC;AAEnC,MAAM,aAAa,GAAG;IACpB,OAAO,EAAE,MAAM;IACf,aAAa,EAAE,QAAQ;IACvB,GAAG,EAAE,CAAC;IACN,UAAU,EAAE,GAAG;CACiB,CAAC;AAEnC,MAAM,UAAU,GAAG;IACjB,UAAU,EAAE,gDAAgD;IAC5D,QAAQ,EAAE,EAAE;CACoB,CAAC;AAEnC,MAAM,WAAW,GAAG,EAAE,QAAQ,EAAE,EAAE,EAAmC,CAAC;AAEtE,MAAM,UAAU,GAAG;IACjB,QAAQ,EAAE,EAAE;IACZ,SAAS,EAAE,QAAQ;CACa,CAAC;AAEnC,MAAM,UAAU,GAAG,EAAE,UAAU,EAAE,GAAG,EAAmC,CAAC"}
+{"version":3,"file":"HelpBody.js","sourceRoot":"","sources":["../../../src/help/ui/HelpBody.tsx"],"names":[],"mappings":";AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AA6DnE;;;;;;;;GAQG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAoB;IAC3C,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,GAAG,aAAa,EAAE,GAAG,KAAK,CAAC;IAC5D,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAE/C,OAAO,CACL,eACE,SAAS,EAAE,cAAc,CAAC,WAAW,EAAE,SAAS,CAAC,EACjD,KAAK,EAAE,EAAE,GAAG,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE,aAExC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,cAAK,KAAK,EAAE,WAAW,YAAG,KAAK,GAAO,EACnE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,cAAK,KAAK,EAAE,UAAU,YAAG,IAAI,GAAO,EAChE,UAAU,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CACjC,eAA4B,KAAK,EAAE,aAAa,aAC9C,eAAM,KAAK,EAAE,UAAU,YAAG,IAAI,CAAC,IAAI,GAAQ,EAC1C,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CACjC,eAAK,KAAK,EAAE,WAAW,oBAClB,eAAM,KAAK,EAAE,UAAU,YAAG,IAAI,CAAC,KAAK,GAAQ,IAC3C,CACP,EACA,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAChC,cAAK,KAAK,EAAE,UAAU,YAAG,IAAI,CAAC,IAAI,GAAO,CAC1C,KATO,UAAU,CAAC,IAAI,CAAC,CAUpB,CACP,CAAC,EACD,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAC3B,YACE,IAAI,EAAE,IAAI,EACV,MAAM,EAAC,QAAQ,EACf,GAAG,EAAC,qBAAqB,EACzB,KAAK,EAAE,UAAU,2BAGf,CACL,IACG,CACP,CAAC;AACJ,CAAC;AAED,+EAA+E;AAC/E,sEAAsE;AACtE,SAAS,UAAU,CAAC,OAAoB;IACtC,OAAO,GAAG,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,KAAK,IAAI,EAAE,KAAK,OAAO,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC;AAC1E,CAAC;AAED,SAAS,UAAU,CAAC,OAA+B;IACjD,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IACrC,IAAI,MAAM,IAAI,OAAO;QAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACxC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,MAAM,MAAM,GAAkB,EAAE,CAAC;IACjC,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,SAAS;QAC5B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACd,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,sEAAsE;AACtE,MAAM,aAAa,GAAG,GAAG,CAAC;AAE1B,MAAM,UAAU,GAAG;IACjB,OAAO,EAAE,MAAM;IACf,aAAa,EAAE,QAAQ;IACvB,GAAG,EAAE,CAAC;CAC0B,CAAC;AAEnC,MAAM,WAAW,GAAG,EAAE,UAAU,EAAE,GAAG,EAAmC,CAAC;AAEzE,MAAM,UAAU,GAAG;IACjB,UAAU,EAAE,GAAG;IACf,UAAU,EAAE,IAAI;CACgB,CAAC;AAEnC,MAAM,aAAa,GAAG;IACpB,OAAO,EAAE,MAAM;IACf,aAAa,EAAE,QAAQ;IACvB,GAAG,EAAE,CAAC;IACN,UAAU,EAAE,GAAG;CACiB,CAAC;AAEnC,MAAM,UAAU,GAAG;IACjB,UAAU,EAAE,gDAAgD;IAC5D,QAAQ,EAAE,EAAE;CACoB,CAAC;AAEnC,MAAM,WAAW,GAAG,EAAE,QAAQ,EAAE,EAAE,EAAmC,CAAC;AAEtE,MAAM,UAAU,GAAG;IACjB,QAAQ,EAAE,EAAE;IACZ,SAAS,EAAE,QAAQ;CACa,CAAC;AAEnC,MAAM,UAAU,GAAG,EAAE,UAAU,EAAE,GAAG,EAAmC,CAAC"}

package/lib/help/ui/HelpIcon.d.ts

@@ -1,9 +1,23 @@
+import type { IconName } from '@blueprintjs/core';
 import type { ReactElement } from 'react';
 import type { HelpContent } from './HelpBody.tsx';
-/** What {@link HelpIcon} explains, and how big the glyph is. */
+/** What {@link HelpIcon} explains, and how the glyph looks. */
 export interface HelpIconProps {
-    /** The help the glyph reveals. */
+    /**
+     * The help the glyph reveals. A site with free-form help passes only a
+     * `body`.
+     */
     content: HelpContent;
+    /**
+     * What a screen reader calls the glyph.
+     * @default the help's title, or `'Help'` when it has none
+     */
+    label?: string;
+    /**
+     * Glyph drawn, for a site that marks help with another sign.
+     * @default 'help'
+     */
+    icon?: IconName;
     /**
      * Size of the glyph in pixels, so it sits on the line of the label it
      * follows.

package/lib/help/ui/HelpIcon.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HelpIcon.d.ts","sourceRoot":"","sources":["../../../src/help/ui/HelpIcon.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAE1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAGlD,gEAAgE;AAChE,MAAM,WAAW,aAAa;IAC5B,kCAAkC;IAClC,OAAO,EAAE,WAAW,CAAC;IACrB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;IAChD;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,aAAa,GAAG,YAAY,CAgB3D"}
+{"version":3,"file":"HelpIcon.d.ts","sourceRoot":"","sources":["../../../src/help/ui/HelpIcon.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAI1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAIlD,+DAA+D;AAC/D,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,OAAO,EAAE,WAAW,CAAC;IACrB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;IAChD;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,aAAa,GAAG,YAAY,CAqB3D"}

package/lib/help/ui/HelpIcon.js

@@ -1,6 +1,8 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { Icon } from '@blueprintjs/core';
+import { joinClassNames } from "../../shared/ui/joinClassNames.js";
 import { HelpTooltip } from "./HelpTooltip.js";
+import { helpName } from "./helpName.js";
 /**
  * The small question mark that sits beside a field label.
  *
@@ -10,7 +12,7 @@ import { HelpTooltip } from "./HelpTooltip.js";
  * @returns The glyph and its help.
  */
 export function HelpIcon(props) {
-    const { content, size = 13, placement = 'right', className } = props;
-    return (_jsx(HelpTooltip, { content: content, placement: placement, children: _jsx(Icon, { icon: "help", size: size, tabIndex: 0, "aria-label": content.title, className: className === undefined ? 'help-icon' : `help-icon ${className}` }) }));
+    const { content, label = helpName(content), icon = 'help', size = 13, placement = 'right', className, } = props;
+    return (_jsx(HelpTooltip, { content: content, placement: placement, children: _jsx(Icon, { icon: icon, size: size, tabIndex: 0, "aria-label": label, className: joinClassNames('help-icon', className) }) }));
 }
 //# sourceMappingURL=HelpIcon.js.map

package/lib/help/ui/HelpIcon.js.map

@@ -1 +1 @@
-{"version":3,"file":"HelpIcon.js","sourceRoot":"","sources":["../../../src/help/ui/HelpIcon.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAIzC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAmB,CAAC;AAwBhD;;;;;;;GAOG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAoB;IAC3C,MAAM,EAAE,OAAO,EAAE,IAAI,GAAG,EAAE,EAAE,SAAS,GAAG,OAAO,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC;IAErE,OAAO,CACL,KAAC,WAAW,IAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,YACjD,KAAC,IAAI,IACH,IAAI,EAAC,MAAM,EACX,IAAI,EAAE,IAAI,EACV,QAAQ,EAAE,CAAC,gBACC,OAAO,CAAC,KAAK,EACzB,SAAS,EACP,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,SAAS,EAAE,GAElE,GACU,CACf,CAAC;AACJ,CAAC"}
+{"version":3,"file":"HelpIcon.js","sourceRoot":"","sources":["../../../src/help/ui/HelpIcon.tsx"],"names":[],"mappings":";AACA,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAGzC,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AAGnE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAmB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAqCzC;;;;;;;GAOG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAoB;IAC3C,MAAM,EACJ,OAAO,EACP,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,EACzB,IAAI,GAAG,MAAM,EACb,IAAI,GAAG,EAAE,EACT,SAAS,GAAG,OAAO,EACnB,SAAS,GACV,GAAG,KAAK,CAAC;IAEV,OAAO,CACL,KAAC,WAAW,IAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,YACjD,KAAC,IAAI,IACH,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,IAAI,EACV,QAAQ,EAAE,CAAC,gBACC,KAAK,EACjB,SAAS,EAAE,cAAc,CAAC,WAAW,EAAE,SAAS,CAAC,GACjD,GACU,CACf,CAAC;AACJ,CAAC"}

package/lib/help/ui/HelpToolbarButton.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HelpToolbarButton.d.ts","sourceRoot":"","sources":["../../../src/help/ui/HelpToolbarButton.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAE1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAGlD,0EAA0E;AAC1E,MAAM,WAAW,sBAAsB;IACrC,4CAA4C;IAC5C,OAAO,EAAE,WAAW,CAAC;IACrB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,GAAG,YAAY,CAuB7E"}
+{"version":3,"file":"HelpToolbarButton.d.ts","sourceRoot":"","sources":["../../../src/help/ui/HelpToolbarButton.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAE1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAIlD,0EAA0E;AAC1E,MAAM,WAAW,sBAAsB;IACrC,4CAA4C;IAC5C,OAAO,EAAE,WAAW,CAAC;IACrB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,GAAG,YAAY,CAuB7E"}

package/lib/help/ui/HelpToolbarButton.js

@@ -1,6 +1,7 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { Button } from '@blueprintjs/core';
 import { HelpTooltip } from "./HelpTooltip.js";
+import { helpName } from "./helpName.js";
 /**
  * The help entry of a toolbar: a glyph that explains itself on hover and opens
  * the full guide when pressed.
@@ -12,6 +13,6 @@ import { HelpTooltip } from "./HelpTooltip.js";
  */
 export function HelpToolbarButton(props) {
     const { content, onClick, label, icon = 'help', small = false, className, } = props;
-    return (_jsx(HelpTooltip, { content: content, placement: "bottom", children: _jsx(Button, { variant: "minimal", size: small ? 'small' : 'medium', icon: icon, text: label, "aria-label": label ?? content.title, className: className, onClick: onClick }) }));
+    return (_jsx(HelpTooltip, { content: content, placement: "bottom", children: _jsx(Button, { variant: "minimal", size: small ? 'small' : 'medium', icon: icon, text: label, "aria-label": label ?? helpName(content), className: className, onClick: onClick }) }));
 }
 //# sourceMappingURL=HelpToolbarButton.js.map

package/lib/help/ui/HelpToolbarButton.js.map

@@ -1 +1 @@
-{"version":3,"file":"HelpToolbarButton.js","sourceRoot":"","sources":["../../../src/help/ui/HelpToolbarButton.tsx"],"names":[],"mappings":";AACA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAI3C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAmB,CAAC;AAkChD;;;;;;;;GAQG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAA6B;IAC7D,MAAM,EACJ,OAAO,EACP,OAAO,EACP,KAAK,EACL,IAAI,GAAG,MAAM,EACb,KAAK,GAAG,KAAK,EACb,SAAS,GACV,GAAG,KAAK,CAAC;IAEV,OAAO,CACL,KAAC,WAAW,IAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAC,QAAQ,YAC/C,KAAC,MAAM,IACL,OAAO,EAAC,SAAS,EACjB,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAChC,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,KAAK,gBACC,KAAK,IAAI,OAAO,CAAC,KAAK,EAClC,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,OAAO,GAChB,GACU,CACf,CAAC;AACJ,CAAC"}
+{"version":3,"file":"HelpToolbarButton.js","sourceRoot":"","sources":["../../../src/help/ui/HelpToolbarButton.tsx"],"names":[],"mappings":";AACA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAI3C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAmB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAkCzC;;;;;;;;GAQG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAA6B;IAC7D,MAAM,EACJ,OAAO,EACP,OAAO,EACP,KAAK,EACL,IAAI,GAAG,MAAM,EACb,KAAK,GAAG,KAAK,EACb,SAAS,GACV,GAAG,KAAK,CAAC;IAEV,OAAO,CACL,KAAC,WAAW,IAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAC,QAAQ,YAC/C,KAAC,MAAM,IACL,OAAO,EAAC,SAAS,EACjB,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAChC,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,KAAK,gBACC,KAAK,IAAI,QAAQ,CAAC,OAAO,CAAC,EACtC,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,OAAO,GAChB,GACU,CACf,CAAC;AACJ,CAAC"}

package/lib/help/ui/HelpTooltip.d.ts

@@ -22,6 +22,11 @@ export interface HelpTooltipProps {
      * @default undefined
      */
     popoverClassName?: string;
+    /**
+     * Class names added to the root element.
+     * @default undefined
+     */
+    className?: string;
 }
 /**
  * A piece of help attached to whatever it explains.

package/lib/help/ui/HelpTooltip.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HelpTooltip.d.ts","sourceRoot":"","sources":["../../../src/help/ui/HelpTooltip.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAErD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAGlD,iEAAiE;AACjE,MAAM,WAAW,gBAAgB;IAC/B,2DAA2D;IAC3D,OAAO,EAAE,WAAW,CAAC;IACrB,8BAA8B;IAC9B,QAAQ,EAAE,SAAS,CAAC;IACpB;;;OAGG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;IACtC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,YAAY,CA2BjE"}
+{"version":3,"file":"HelpTooltip.d.ts","sourceRoot":"","sources":["../../../src/help/ui/HelpTooltip.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAErD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAGlD,iEAAiE;AACjE,MAAM,WAAW,gBAAgB;IAC/B,2DAA2D;IAC3D,OAAO,EAAE,WAAW,CAAC;IACrB,8BAA8B;IAC9B,QAAQ,EAAE,SAAS,CAAC;IACpB;;;OAGG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;IACtC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,YAAY,CA6BjE"}

package/lib/help/ui/HelpTooltip.js

@@ -11,9 +11,9 @@ import { HelpBody } from "./HelpBody.js";
  * @returns The target, with its help.
  */
 export function HelpTooltip(props) {
-    const { content, children, placement = 'top', width, popoverClassName, } = props;
+    const { className, content, children, placement = 'top', width, popoverClassName, } = props;
     const hasLink = content.link !== undefined;
-    return (_jsx(Tooltip, { content: _jsx(HelpBody, { content: content, width: width }), placement: placement, hoverOpenDelay: HOVER_OPEN_DELAY, hoverCloseDelay: hasLink ? HOVER_CLOSE_DELAY : 0, interactionKind: hasLink ? 'hover' : 'hover-target', targetTagName: "span", popoverClassName: popoverClassName === undefined
+    return (_jsx(Tooltip, { className: className, content: _jsx(HelpBody, { content: content, width: width }), placement: placement, hoverOpenDelay: HOVER_OPEN_DELAY, hoverCloseDelay: hasLink ? HOVER_CLOSE_DELAY : 0, interactionKind: hasLink ? 'hover' : 'hover-target', targetTagName: "span", popoverClassName: popoverClassName === undefined
             ? 'help-tooltip'
             : `help-tooltip ${popoverClassName}`, children: children }));
 }

package/lib/help/ui/HelpTooltip.js.map

@@ -1 +1 @@
-{"version":3,"file":"HelpTooltip.js","sourceRoot":"","sources":["../../../src/help/ui/HelpTooltip.tsx"],"names":[],"mappings":";AACA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAI5C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAgB,CAAC;AAyB1C;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CAAC,KAAuB;IACjD,MAAM,EACJ,OAAO,EACP,QAAQ,EACR,SAAS,GAAG,KAAK,EACjB,KAAK,EACL,gBAAgB,GACjB,GAAG,KAAK,CAAC;IACV,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC;IAE3C,OAAO,CACL,KAAC,OAAO,IACN,OAAO,EAAE,KAAC,QAAQ,IAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,GAAI,EACrD,SAAS,EAAE,SAAS,EACpB,cAAc,EAAE,gBAAgB,EAChC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,EAChD,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,EACnD,aAAa,EAAC,MAAM,EACpB,gBAAgB,EACd,gBAAgB,KAAK,SAAS;YAC5B,CAAC,CAAC,cAAc;YAChB,CAAC,CAAC,gBAAgB,gBAAgB,EAAE,YAGvC,QAAQ,GACD,CACX,CAAC;AACJ,CAAC;AAED,gFAAgF;AAChF,MAAM,gBAAgB,GAAG,GAAG,CAAC;AAC7B,sEAAsE;AACtE,MAAM,iBAAiB,GAAG,GAAG,CAAC"}
+{"version":3,"file":"HelpTooltip.js","sourceRoot":"","sources":["../../../src/help/ui/HelpTooltip.tsx"],"names":[],"mappings":";AACA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAI5C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAgB,CAAC;AA8B1C;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CAAC,KAAuB;IACjD,MAAM,EACJ,SAAS,EACT,OAAO,EACP,QAAQ,EACR,SAAS,GAAG,KAAK,EACjB,KAAK,EACL,gBAAgB,GACjB,GAAG,KAAK,CAAC;IACV,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC;IAE3C,OAAO,CACL,KAAC,OAAO,IACN,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,KAAC,QAAQ,IAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,GAAI,EACrD,SAAS,EAAE,SAAS,EACpB,cAAc,EAAE,gBAAgB,EAChC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,EAChD,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,EACnD,aAAa,EAAC,MAAM,EACpB,gBAAgB,EACd,gBAAgB,KAAK,SAAS;YAC5B,CAAC,CAAC,cAAc;YAChB,CAAC,CAAC,gBAAgB,gBAAgB,EAAE,YAGvC,QAAQ,GACD,CACX,CAAC;AACJ,CAAC;AAED,gFAAgF;AAChF,MAAM,gBAAgB,GAAG,GAAG,CAAC;AAC7B,sEAAsE;AACtE,MAAM,iBAAiB,GAAG,GAAG,CAAC"}

package/lib/help/ui/helpName.d.ts

@@ -0,0 +1,9 @@
+import type { HelpContent } from './HelpBody.tsx';
+/**
+ * The name a glyph or a button carries for a screen reader: the help's own
+ * title, or a plain "Help" when the help has none.
+ * @param content - The help being named.
+ * @returns The accessible name.
+ */
+export declare function helpName(content: HelpContent): string;
+//# sourceMappingURL=helpName.d.ts.map

package/lib/help/ui/helpName.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpName.d.ts","sourceRoot":"","sources":["../../../src/help/ui/helpName.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAElD;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,WAAW,GAAG,MAAM,CAErD"}

package/lib/help/ui/helpName.js

@@ -0,0 +1,10 @@
+/**
+ * The name a glyph or a button carries for a screen reader: the help's own
+ * title, or a plain "Help" when the help has none.
+ * @param content - The help being named.
+ * @returns The accessible name.
+ */
+export function helpName(content) {
+    return content.title ?? 'Help';
+}
+//# sourceMappingURL=helpName.js.map

package/lib/help/ui/helpName.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpName.js","sourceRoot":"","sources":["../../../src/help/ui/helpName.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAC,OAAoB;IAC3C,OAAO,OAAO,CAAC,KAAK,IAAI,MAAM,CAAC;AACjC,CAAC"}

package/lib/hooks/ui/activationKey.d.ts

@@ -0,0 +1,34 @@
+/** The subset of a keyboard event {@link onActivateKey} reads. */
+export interface ActivationKeyEvent {
+    /** The key that was pressed. */
+    key: string;
+    /** What the event was aimed at. */
+    target?: EventTarget | null;
+    /** The element the handler is attached to. */
+    currentTarget?: EventTarget | null;
+    /** True while a held key auto-repeats. */
+    repeat?: boolean;
+    /** Stops the space bar from scrolling the page. */
+    preventDefault: () => void;
+}
+/**
+ * Whether a key is the keyboard equivalent of a click: `Enter` or the space
+ * bar, which is what a `<button>` answers to.
+ * @param event - The keyboard event, or anything carrying its `key`.
+ * @returns True for `Enter` and the space bar.
+ */
+export declare function isActivationKey(event: Pick<ActivationKeyEvent, 'key'>): boolean;
+/**
+ * A `keydown` handler that gives an element which is not a `<button>` — a
+ * clickable row, a card, a drop zone with `role="button"` — the activation a
+ * button gets for free.
+ *
+ * `Enter` and the space bar call `activate`, with the default suppressed so the
+ * space bar does not also scroll the page. A key typed into a field inside the
+ * element, a key aimed at a button or a link nested in it, and the repeats of a
+ * held key are all left alone, so nothing is activated twice.
+ * @param activate - What a click on the element does; it receives the event.
+ * @returns The handler, to pass as `onKeyDown`.
+ */
+export declare function onActivateKey<TEvent extends ActivationKeyEvent>(activate: (event: TEvent) => void): (event: TEvent) => void;
+//# sourceMappingURL=activationKey.d.ts.map

package/lib/hooks/ui/activationKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"activationKey.d.ts","sourceRoot":"","sources":["../../../src/hooks/ui/activationKey.ts"],"names":[],"mappings":"AAEA,kEAAkE;AAClE,MAAM,WAAW,kBAAkB;IACjC,gCAAgC;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,mCAAmC;IACnC,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAC5B,8CAA8C;IAC9C,aAAa,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IACnC,0CAA0C;IAC1C,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,mDAAmD;IACnD,cAAc,EAAE,MAAM,IAAI,CAAC;CAC5B;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,IAAI,CAAC,kBAAkB,EAAE,KAAK,CAAC,GACrC,OAAO,CAET;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,MAAM,SAAS,kBAAkB,EAC7D,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,GAChC,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAezB"}

package/lib/hooks/ui/activationKey.js

@@ -0,0 +1,39 @@
+import { isInteractiveTarget, isTextEntryTarget } from "./keyTargets.js";
+/**
+ * Whether a key is the keyboard equivalent of a click: `Enter` or the space
+ * bar, which is what a `<button>` answers to.
+ * @param event - The keyboard event, or anything carrying its `key`.
+ * @returns True for `Enter` and the space bar.
+ */
+export function isActivationKey(event) {
+    return event.key === 'Enter' || event.key === ' ';
+}
+/**
+ * A `keydown` handler that gives an element which is not a `<button>` — a
+ * clickable row, a card, a drop zone with `role="button"` — the activation a
+ * button gets for free.
+ *
+ * `Enter` and the space bar call `activate`, with the default suppressed so the
+ * space bar does not also scroll the page. A key typed into a field inside the
+ * element, a key aimed at a button or a link nested in it, and the repeats of a
+ * held key are all left alone, so nothing is activated twice.
+ * @param activate - What a click on the element does; it receives the event.
+ * @returns The handler, to pass as `onKeyDown`.
+ */
+export function onActivateKey(activate) {
+    return (event) => {
+        if (!isActivationKey(event) || event.repeat === true)
+            return;
+        const { target, currentTarget } = event;
+        if (isTextEntryTarget(target))
+            return;
+        if (target !== currentTarget &&
+            currentTarget !== undefined &&
+            isInteractiveTarget(target)) {
+            return;
+        }
+        event.preventDefault();
+        activate(event);
+    };
+}
+//# sourceMappingURL=activationKey.js.map

package/lib/hooks/ui/activationKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"activationKey.js","sourceRoot":"","sources":["../../../src/hooks/ui/activationKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAgBzE;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAC7B,KAAsC;IAEtC,OAAO,KAAK,CAAC,GAAG,KAAK,OAAO,IAAI,KAAK,CAAC,GAAG,KAAK,GAAG,CAAC;AACpD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,aAAa,CAC3B,QAAiC;IAEjC,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,IAAI;YAAE,OAAO;QAC7D,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,GAAG,KAAK,CAAC;QACxC,IAAI,iBAAiB,CAAC,MAAM,CAAC;YAAE,OAAO;QACtC,IACE,MAAM,KAAK,aAAa;YACxB,aAAa,KAAK,SAAS;YAC3B,mBAAmB,CAAC,MAAM,CAAC,EAC3B,CAAC;YACD,OAAO;QACT,CAAC;QACD,KAAK,CAAC,cAAc,EAAE,CAAC;QACvB,QAAQ,CAAC,KAAK,CAAC,CAAC;IAClB,CAAC,CAAC;AACJ,CAAC"}

package/lib/hooks/ui/activeHeading.d.ts

@@ -0,0 +1,21 @@
+/** Anything whose position in the viewport can be measured, as a heading's. */
+interface MeasurableHeading {
+    /** Where the heading sits, relative to the viewport. */
+    getBoundingClientRect: () => {
+        top: number;
+    };
+}
+/**
+ * Which heading the reader is under.
+ *
+ * The headings are in document order, so the one being read is the last whose
+ * top has passed the reading line. Before any has, the first counts, so a
+ * table of contents always marks something.
+ * @param headings - The headings, in document order.
+ * @param readingLine - Distance from the top of the viewport, in CSS pixels,
+ * a heading must pass to count as the one being read.
+ * @returns Its index, or `-1` when there is no heading at all.
+ */
+export declare function activeHeadingIndex(headings: ArrayLike<MeasurableHeading>, readingLine: number): number;
+export {};
+//# sourceMappingURL=activeHeading.d.ts.map

package/lib/hooks/ui/activeHeading.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"activeHeading.d.ts","sourceRoot":"","sources":["../../../src/hooks/ui/activeHeading.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,UAAU,iBAAiB;IACzB,wDAAwD;IACxD,qBAAqB,EAAE,MAAM;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9C;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,SAAS,CAAC,iBAAiB,CAAC,EACtC,WAAW,EAAE,MAAM,GAClB,MAAM,CASR"}

package/lib/hooks/ui/activeHeading.js

@@ -0,0 +1,24 @@
+/**
+ * Which heading the reader is under.
+ *
+ * The headings are in document order, so the one being read is the last whose
+ * top has passed the reading line. Before any has, the first counts, so a
+ * table of contents always marks something.
+ * @param headings - The headings, in document order.
+ * @param readingLine - Distance from the top of the viewport, in CSS pixels,
+ * a heading must pass to count as the one being read.
+ * @returns Its index, or `-1` when there is no heading at all.
+ */
+export function activeHeadingIndex(headings, readingLine) {
+    if (headings.length === 0)
+        return -1;
+    let active = 0;
+    for (let index = 0; index < headings.length; index++) {
+        const heading = headings[index];
+        if (heading.getBoundingClientRect().top > readingLine)
+            break;
+        active = index;
+    }
+    return active;
+}
+//# sourceMappingURL=activeHeading.js.map

package/lib/hooks/ui/activeHeading.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"activeHeading.js","sourceRoot":"","sources":["../../../src/hooks/ui/activeHeading.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;GAUG;AACH,MAAM,UAAU,kBAAkB,CAChC,QAAsC,EACtC,WAAmB;IAEnB,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,CAAC,CAAC,CAAC;IACrC,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;QACrD,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAsB,CAAC;QACrD,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC,GAAG,GAAG,WAAW;YAAE,MAAM;QAC7D,MAAM,GAAG,KAAK,CAAC;IACjB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/lib/hooks/ui/asyncState.d.ts

@@ -0,0 +1,31 @@
+/** Where an async task stands: still running, answered, or failed. */
+export type AsyncState<TData> = {
+    status: 'loading';
+    data: undefined;
+    error: undefined;
+} | {
+    status: 'success';
+    data: TData;
+    error: undefined;
+} | {
+    status: 'error';
+    data: undefined;
+    error: Error;
+};
+/** The state a task starts in. */
+export declare const ASYNC_LOADING: AsyncState<never>;
+/**
+ * The state after a task answered.
+ * @param data - What it resolved to.
+ * @returns The success state.
+ */
+export declare function asyncSucceeded<TData>(data: TData): AsyncState<TData>;
+/**
+ * The state after a task failed. Data already on screen is kept rather than
+ * replaced by the failure of a refresh.
+ * @param previous - The state before the task ran.
+ * @param thrown - What it rejected with.
+ * @returns The state to show.
+ */
+export declare function asyncFailed<TData>(previous: AsyncState<TData>, thrown: unknown): AsyncState<TData>;
+//# sourceMappingURL=asyncState.d.ts.map

package/lib/hooks/ui/asyncState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"asyncState.d.ts","sourceRoot":"","sources":["../../../src/hooks/ui/asyncState.ts"],"names":[],"mappings":"AAEA,sEAAsE;AACtE,MAAM,MAAM,UAAU,CAAC,KAAK,IACxB;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,SAAS,CAAA;CAAE,GACxD;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,SAAS,CAAA;CAAE,GACpD;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC;AAEvD,kCAAkC;AAClC,eAAO,MAAM,aAAa,EAAE,UAAU,CAAC,KAAK,CAI3C,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,CAEpE;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAC/B,QAAQ,EAAE,UAAU,CAAC,KAAK,CAAC,EAC3B,MAAM,EAAE,OAAO,GACd,UAAU,CAAC,KAAK,CAAC,CAGnB"}

package/lib/hooks/ui/asyncState.js

@@ -0,0 +1,28 @@
+import { toError } from "../../error/core/toError.js";
+/** The state a task starts in. */
+export const ASYNC_LOADING = {
+    status: 'loading',
+    data: undefined,
+    error: undefined,
+};
+/**
+ * The state after a task answered.
+ * @param data - What it resolved to.
+ * @returns The success state.
+ */
+export function asyncSucceeded(data) {
+    return { status: 'success', data, error: undefined };
+}
+/**
+ * The state after a task failed. Data already on screen is kept rather than
+ * replaced by the failure of a refresh.
+ * @param previous - The state before the task ran.
+ * @param thrown - What it rejected with.
+ * @returns The state to show.
+ */
+export function asyncFailed(previous, thrown) {
+    if (previous.status === 'success')
+        return previous;
+    return { status: 'error', data: undefined, error: toError(thrown) };
+}
+//# sourceMappingURL=asyncState.js.map

package/lib/hooks/ui/asyncState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asyncState.js","sourceRoot":"","sources":["../../../src/hooks/ui/asyncState.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AAQtD,kCAAkC;AAClC,MAAM,CAAC,MAAM,aAAa,GAAsB;IAC9C,MAAM,EAAE,SAAS;IACjB,IAAI,EAAE,SAAS;IACf,KAAK,EAAE,SAAS;CACjB,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAQ,IAAW;IAC/C,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;AACvD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CACzB,QAA2B,EAC3B,MAAe;IAEf,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS;QAAE,OAAO,QAAQ,CAAC;IACnD,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;AACtE,CAAC"}

package/lib/hooks/ui/documentListNavigation.d.ts

@@ -0,0 +1,54 @@
+import type { ListNavigationHandlerOptions, ListNavigationKeyEvent } from './listNavigation.ts';
+/** How a list whose keys are heard on the whole document behaves. */
+export interface DocumentListNavigationOptions extends ListNavigationHandlerOptions {
+    /**
+     * Called with the selected index when `Enter` is pressed, unless the key is
+     * aimed at a button, a link or a field that answers it itself.
+     * @default undefined — `Enter` is left to the page
+     */
+    onActivate?: (index: number) => void;
+    /**
+     * Whether `PageUp`, `PageDown`, `Home` and `End` move the selection too. Off
+     * by default: heard on the document, they would stop scrolling the page.
+     * @default false
+     */
+    pageKeys?: boolean;
+    /**
+     * Whether the list listens at all, e.g. `false` while a dialog is open over
+     * it or while another list on the page is the one being read.
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Leaves a key to whatever it is aimed at, on top of the text fields that
+     * are always left alone: a structure editor's canvas, a slider, a menu.
+     * @default undefined
+     */
+    ignoreKey?: (event: DocumentListKeyEvent) => boolean;
+}
+/** The subset of a document keyboard event the navigation reads. */
+export interface DocumentListKeyEvent extends ListNavigationKeyEvent {
+    /** True when an earlier handler already acted on the key. */
+    defaultPrevented?: boolean;
+    /** Whether Alt was held. */
+    altKey?: boolean;
+    /** Whether Control was held. */
+    ctrlKey?: boolean;
+    /** Whether Meta (Command) was held. */
+    metaKey?: boolean;
+    /** Whether Shift was held. */
+    shiftKey?: boolean;
+}
+/**
+ * Move a list's selection from a key heard on the whole document.
+ *
+ * A key already handled, a key pressed with a modifier, and a key aimed at a
+ * text field are left to the page. `ArrowUp` and `ArrowDown` move the
+ * selection as {@link handleListNavigationKey} does, and `Enter` activates the
+ * selected entry when the list asks for it.
+ * @param event - The native keyboard event.
+ * @param options - See {@link DocumentListNavigationOptions}.
+ * @returns Whether the selection moved; an activation does not move it.
+ */
+export declare function handleDocumentListKey(event: DocumentListKeyEvent, options: DocumentListNavigationOptions): boolean;
+//# sourceMappingURL=documentListNavigation.d.ts.map

package/lib/hooks/ui/documentListNavigation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentListNavigation.d.ts","sourceRoot":"","sources":["../../../src/hooks/ui/documentListNavigation.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,4BAA4B,EAC5B,sBAAsB,EACvB,MAAM,qBAAqB,CAAC;AAG7B,qEAAqE;AACrE,MAAM,WAAW,6BAA8B,SAAQ,4BAA4B;IACjF;;;;OAIG;IACH,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACrC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,OAAO,CAAC;CACtD;AAED,oEAAoE;AACpE,MAAM,WAAW,oBAAqB,SAAQ,sBAAsB;IAClE,6DAA6D;IAC7D,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,4BAA4B;IAC5B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gCAAgC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,uCAAuC;IACvC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,oBAAoB,EAC3B,OAAO,EAAE,6BAA6B,GACrC,OAAO,CAuBT"}