@wildwinter/app-shell 0.35.1 → 0.37.0

package/dist/index.d.cts

@@ -150,6 +150,11 @@ interface PaneSideConfig {
     label?: string;
     /** Shortcut hint appended to the tooltip, e.g. "Cmd+1". */
     shortcutHint?: string;
+    /** false = the pane is not offered at all: no toggle, togglePane ignored,
+     *  forced closed whatever the remembered state says. For a slot a host has
+     *  retired but keeps mounted (Storyletter's inspector) - the shell used to
+     *  offer a chevron that opened a paneful of nothing. Default true. */
+    offered?: boolean;
 }
 interface PaneShellState {
     open: Record<PaneSide, boolean>;
@@ -780,6 +785,25 @@ interface StaleBarOptions {
 }
 declare function staleBar(opts: StaleBarOptions): HTMLElement;
 
+/** What the remark is about. `info` is the plain case; `ok` says a thing you
+ *  asked for happened; `error` says it did not. */
+type ToastKind = "info" | "ok" | "error";
+interface ToastOptions {
+    /** How long it stays, in ms, before the exit plays. Defaults to 4000, or
+     *  7000 for an error. */
+    duration?: number;
+}
+/**
+ * Show a toast. Replaces any toast already showing.
+ *
+ * `message` is shown as written; a newline breaks the line ("Bundle
+ * published\n<path>"), and a long unbroken token such as a path wraps inside
+ * the card rather than spilling past it.
+ */
+declare function toast(message: string, kind?: ToastKind, opts?: ToastOptions): void;
+/** Dismiss the current toast now, if any. Plays the exit. */
+declare function dismissToast(): void;
+
 interface StepperItem {
     /**
      * One word for what kind of thing this is: "error", "comment", "resolved".
@@ -876,4 +900,4 @@ declare function historyNav(onBack: () => void, onForward: () => void): {
     set(canBack: boolean, canForward: boolean): void;
 };
 
-export { type AboutOptions, type AnchoredPanel, type AnchoredPanelOptions, type Child, type Comment, type CommentMessage, type CommentsOptions, type ConfirmOptions, type DocLine, type DupGuard, type ElProps, type GameIdEditorOptions, type IconName, type IconSvgName, type Identity, type IdentityOptions, type JobProgressOptions, type JobProgressView, type NavHistory, type NavHistoryOptions, type Notes, type NotesEditorOptions, PALETTE, PALETTE_SIZE, PROPERTY_NAME_HINT, type PaneShell, type PaneShellOptions, type PaneShellState, type PaneSide, type PaneSideConfig, type PinButton, type PinButtonOptions, type PropertyRefOptions, RESERVED_PROPERTY_NAMES, type SaveController, type SaveControllerOptions, type SaveIndicator, type SaveStatus, type SettingsDialog, type SettingsDialogOptions, type SettingsSection, type SettingsSectionHandle, type ShardVc, type StaleBarOptions, type StepperBarOptions, type StepperItem, type StepperTone, type TipRect, type TooltipOptions, type VcMap, askIdentity, bindPropertyName, bindPropertyRef, closeAnchoredPanel, closeWithExit, colourFor, colourIndex, confirmDialog, createNavHistory, createSaveController, dupGuard, el, expandableRow, firstIllegalPropertyName, focusNewRow, foldVc, gameIdify, hideTip, historyNav, icon, iconBtn, iconSvg, initTooltips, isCaseOnlyPropertyName, isValidGameId, isValidPropertyName, labelled, lockControls, lockNotice, mountJobProgress, mountPaneShell, mountSettingsDialog, moveItem, openAnchoredPanel, openComments, openGameIdEditor, openNotesEditor, paintVcBadges, pinButton, placeAnchored, propertyNameProblem, propertyNameify, propertyRefProblem, renderStepperBar, revalidatePropertyRefs, saveIndicator, showAbout, staleBar, tagChips, tipAt, tipBold, vcBadgeFor };
+export { type AboutOptions, type AnchoredPanel, type AnchoredPanelOptions, type Child, type Comment, type CommentMessage, type CommentsOptions, type ConfirmOptions, type DocLine, type DupGuard, type ElProps, type GameIdEditorOptions, type IconName, type IconSvgName, type Identity, type IdentityOptions, type JobProgressOptions, type JobProgressView, type NavHistory, type NavHistoryOptions, type Notes, type NotesEditorOptions, PALETTE, PALETTE_SIZE, PROPERTY_NAME_HINT, type PaneShell, type PaneShellOptions, type PaneShellState, type PaneSide, type PaneSideConfig, type PinButton, type PinButtonOptions, type PropertyRefOptions, RESERVED_PROPERTY_NAMES, type SaveController, type SaveControllerOptions, type SaveIndicator, type SaveStatus, type SettingsDialog, type SettingsDialogOptions, type SettingsSection, type SettingsSectionHandle, type ShardVc, type StaleBarOptions, type StepperBarOptions, type StepperItem, type StepperTone, type TipRect, type ToastKind, type ToastOptions, type TooltipOptions, type VcMap, askIdentity, bindPropertyName, bindPropertyRef, closeAnchoredPanel, closeWithExit, colourFor, colourIndex, confirmDialog, createNavHistory, createSaveController, dismissToast, dupGuard, el, expandableRow, firstIllegalPropertyName, focusNewRow, foldVc, gameIdify, hideTip, historyNav, icon, iconBtn, iconSvg, initTooltips, isCaseOnlyPropertyName, isValidGameId, isValidPropertyName, labelled, lockControls, lockNotice, mountJobProgress, mountPaneShell, mountSettingsDialog, moveItem, openAnchoredPanel, openComments, openGameIdEditor, openNotesEditor, paintVcBadges, pinButton, placeAnchored, propertyNameProblem, propertyNameify, propertyRefProblem, renderStepperBar, revalidatePropertyRefs, saveIndicator, showAbout, staleBar, tagChips, tipAt, tipBold, toast, vcBadgeFor };

package/dist/index.d.ts

@@ -150,6 +150,11 @@ interface PaneSideConfig {
     label?: string;
     /** Shortcut hint appended to the tooltip, e.g. "Cmd+1". */
     shortcutHint?: string;
+    /** false = the pane is not offered at all: no toggle, togglePane ignored,
+     *  forced closed whatever the remembered state says. For a slot a host has
+     *  retired but keeps mounted (Storyletter's inspector) - the shell used to
+     *  offer a chevron that opened a paneful of nothing. Default true. */
+    offered?: boolean;
 }
 interface PaneShellState {
     open: Record<PaneSide, boolean>;
@@ -780,6 +785,25 @@ interface StaleBarOptions {
 }
 declare function staleBar(opts: StaleBarOptions): HTMLElement;
 
+/** What the remark is about. `info` is the plain case; `ok` says a thing you
+ *  asked for happened; `error` says it did not. */
+type ToastKind = "info" | "ok" | "error";
+interface ToastOptions {
+    /** How long it stays, in ms, before the exit plays. Defaults to 4000, or
+     *  7000 for an error. */
+    duration?: number;
+}
+/**
+ * Show a toast. Replaces any toast already showing.
+ *
+ * `message` is shown as written; a newline breaks the line ("Bundle
+ * published\n<path>"), and a long unbroken token such as a path wraps inside
+ * the card rather than spilling past it.
+ */
+declare function toast(message: string, kind?: ToastKind, opts?: ToastOptions): void;
+/** Dismiss the current toast now, if any. Plays the exit. */
+declare function dismissToast(): void;
+
 interface StepperItem {
     /**
      * One word for what kind of thing this is: "error", "comment", "resolved".
@@ -876,4 +900,4 @@ declare function historyNav(onBack: () => void, onForward: () => void): {
     set(canBack: boolean, canForward: boolean): void;
 };
 
-export { type AboutOptions, type AnchoredPanel, type AnchoredPanelOptions, type Child, type Comment, type CommentMessage, type CommentsOptions, type ConfirmOptions, type DocLine, type DupGuard, type ElProps, type GameIdEditorOptions, type IconName, type IconSvgName, type Identity, type IdentityOptions, type JobProgressOptions, type JobProgressView, type NavHistory, type NavHistoryOptions, type Notes, type NotesEditorOptions, PALETTE, PALETTE_SIZE, PROPERTY_NAME_HINT, type PaneShell, type PaneShellOptions, type PaneShellState, type PaneSide, type PaneSideConfig, type PinButton, type PinButtonOptions, type PropertyRefOptions, RESERVED_PROPERTY_NAMES, type SaveController, type SaveControllerOptions, type SaveIndicator, type SaveStatus, type SettingsDialog, type SettingsDialogOptions, type SettingsSection, type SettingsSectionHandle, type ShardVc, type StaleBarOptions, type StepperBarOptions, type StepperItem, type StepperTone, type TipRect, type TooltipOptions, type VcMap, askIdentity, bindPropertyName, bindPropertyRef, closeAnchoredPanel, closeWithExit, colourFor, colourIndex, confirmDialog, createNavHistory, createSaveController, dupGuard, el, expandableRow, firstIllegalPropertyName, focusNewRow, foldVc, gameIdify, hideTip, historyNav, icon, iconBtn, iconSvg, initTooltips, isCaseOnlyPropertyName, isValidGameId, isValidPropertyName, labelled, lockControls, lockNotice, mountJobProgress, mountPaneShell, mountSettingsDialog, moveItem, openAnchoredPanel, openComments, openGameIdEditor, openNotesEditor, paintVcBadges, pinButton, placeAnchored, propertyNameProblem, propertyNameify, propertyRefProblem, renderStepperBar, revalidatePropertyRefs, saveIndicator, showAbout, staleBar, tagChips, tipAt, tipBold, vcBadgeFor };
+export { type AboutOptions, type AnchoredPanel, type AnchoredPanelOptions, type Child, type Comment, type CommentMessage, type CommentsOptions, type ConfirmOptions, type DocLine, type DupGuard, type ElProps, type GameIdEditorOptions, type IconName, type IconSvgName, type Identity, type IdentityOptions, type JobProgressOptions, type JobProgressView, type NavHistory, type NavHistoryOptions, type Notes, type NotesEditorOptions, PALETTE, PALETTE_SIZE, PROPERTY_NAME_HINT, type PaneShell, type PaneShellOptions, type PaneShellState, type PaneSide, type PaneSideConfig, type PinButton, type PinButtonOptions, type PropertyRefOptions, RESERVED_PROPERTY_NAMES, type SaveController, type SaveControllerOptions, type SaveIndicator, type SaveStatus, type SettingsDialog, type SettingsDialogOptions, type SettingsSection, type SettingsSectionHandle, type ShardVc, type StaleBarOptions, type StepperBarOptions, type StepperItem, type StepperTone, type TipRect, type ToastKind, type ToastOptions, type TooltipOptions, type VcMap, askIdentity, bindPropertyName, bindPropertyRef, closeAnchoredPanel, closeWithExit, colourFor, colourIndex, confirmDialog, createNavHistory, createSaveController, dismissToast, dupGuard, el, expandableRow, firstIllegalPropertyName, focusNewRow, foldVc, gameIdify, hideTip, historyNav, icon, iconBtn, iconSvg, initTooltips, isCaseOnlyPropertyName, isValidGameId, isValidPropertyName, labelled, lockControls, lockNotice, mountJobProgress, mountPaneShell, mountSettingsDialog, moveItem, openAnchoredPanel, openComments, openGameIdEditor, openNotesEditor, paintVcBadges, pinButton, placeAnchored, propertyNameProblem, propertyNameify, propertyRefProblem, renderStepperBar, revalidatePropertyRefs, saveIndicator, showAbout, staleBar, tagChips, tipAt, tipBold, toast, vcBadgeFor };

package/dist/index.js

@@ -152,23 +152,23 @@ function initTooltips(opts = {}) {
 
 // src/dom.ts
 function el(tag, classNameOrProps, ...children) {
-  const node = document.createElement(tag);
+  const node2 = document.createElement(tag);
   const props = typeof classNameOrProps === "string" ? { className: classNameOrProps } : classNameOrProps ?? {};
-  if (props.className) node.className = props.className;
-  if (props.text !== void 0 && props.text !== null) node.textContent = props.text;
-  if (props.title !== void 0) node.title = props.title;
+  if (props.className) node2.className = props.className;
+  if (props.text !== void 0 && props.text !== null) node2.textContent = props.text;
+  if (props.title !== void 0) node2.title = props.title;
   if (props.tip !== void 0) {
-    node.dataset["tip"] = props.tip;
-    node.setAttribute("aria-label", props.tip);
+    node2.dataset["tip"] = props.tip;
+    node2.setAttribute("aria-label", props.tip);
     ensureTooltipHost();
   }
-  if (props.onClick) node.addEventListener("click", props.onClick);
+  if (props.onClick) node2.addEventListener("click", props.onClick);
   for (const child of children) {
     if (child === null || child === void 0) continue;
-    node.append(child);
+    node2.append(child);
   }
   checkTooltipHost();
-  return node;
+  return node2;
 }
 function iconBtn(glyph, title, onClick, disabled = false, danger = false) {
   const b = el("button", `shell-icon${danger ? " danger" : ""}`);
@@ -200,7 +200,7 @@ function tagChips(holder, onChange) {
   const wrap = el("div", "shell-tags");
   const input = el("input", "shell-tag-input");
   input.type = "text";
-  input.placeholder = "add value";
+  input.placeholder = "Add value";
   input.spellcheck = false;
   const makeChip = (v) => {
     const chip = el("span", "shell-tag", v);
@@ -336,7 +336,11 @@ var openVar = { nav: "--nav-open-w", inspector: "--insp-open-w" };
 var collapseClass = { nav: "no-nav", inspector: "no-inspector" };
 function mountPaneShell(host, opts) {
   const cfg = { nav: opts.nav, inspector: opts.inspector };
-  const open = { nav: opts.initial?.open?.nav ?? true, inspector: opts.initial?.open?.inspector ?? true };
+  const offered = (side) => cfg[side].offered !== false;
+  const open = {
+    nav: offered("nav") && (opts.initial?.open?.nav ?? true),
+    inspector: offered("inspector") && (opts.initial?.open?.inspector ?? true)
+  };
   const width = { ...opts.initial?.width ?? {} };
   const el2 = (tag, cls) => {
     const n = document.createElement(tag);
@@ -366,6 +370,8 @@ function mountPaneShell(host, opts) {
   const root = el2("div", "pane-shell");
   root.append(topbar, panes);
   host.append(root);
+  if (!offered("nav")) navToggle.remove();
+  if (!offered("inspector")) inspToggle.remove();
   function applyToggleGlyph(side, button) {
     const isOpen = open[side];
     button.textContent = side === "nav" ? isOpen ? "\u2039" : "\u203A" : isOpen ? "\u203A" : "\u2039";
@@ -382,8 +388,8 @@ function mountPaneShell(host, opts) {
     panes.style.setProperty(openVar.inspector, width.inspector !== void 0 ? `${width.inspector}px` : cfg.inspector.defaultWidth);
     applyToggleGlyph("nav", navToggle);
     applyToggleGlyph("inspector", inspToggle);
-    navResizer.style.display = cfg.nav.resizable === false ? "none" : "";
-    inspResizer.style.display = cfg.inspector.resizable === false ? "none" : "";
+    navResizer.style.display = cfg.nav.resizable === false || !offered("nav") ? "none" : "";
+    inspResizer.style.display = cfg.inspector.resizable === false || !offered("inspector") ? "none" : "";
   }
   const snapshot = () => ({ open: { ...open }, width: { ...width } });
   const persist = () => opts.onChange?.(snapshot());
@@ -394,7 +400,7 @@ function mountPaneShell(host, opts) {
     persist();
   }
   function togglePane(side) {
-    setPaneOpen(side, !open[side]);
+    if (offered(side)) setPaneOpen(side, !open[side]);
   }
   function resetWidths() {
     delete width.nav;
@@ -658,14 +664,14 @@ function closeWithExit(element, done) {
     if (fired) return;
     fired = true;
     element.removeEventListener("animationend", onEnd);
-    clearTimeout(timer2);
+    clearTimeout(timer3);
     done();
   };
   const onEnd = (e) => {
     if (e.target === element) finish();
   };
   element.addEventListener("animationend", onEnd);
-  const timer2 = setTimeout(finish, seconds * 1e3 + 120);
+  const timer3 = setTimeout(finish, seconds * 1e3 + 120);
 }
 
 // src/confirm.ts
@@ -1505,7 +1511,7 @@ function createSaveController(opts) {
   let auto = true;
   let dirty = false;
   let dirtySince = 0;
-  let timer2;
+  let timer3;
   let inFlight;
   const setStatus = (next) => {
     if (next === status) return;
@@ -1513,17 +1519,17 @@ function createSaveController(opts) {
     opts.onStatus?.(status);
   };
   const clearTimer = () => {
-    if (timer2 === void 0) return;
-    clearTimeout(timer2);
-    timer2 = void 0;
+    if (timer3 === void 0) return;
+    clearTimeout(timer3);
+    timer3 = void 0;
   };
   const arm = () => {
     clearTimer();
     if (!auto) return;
     const deadline = dirtySince + maxWaitMs;
     const wait = Math.max(0, Math.min(delayMs, deadline - Date.now()));
-    timer2 = setTimeout(() => {
-      timer2 = void 0;
+    timer3 = setTimeout(() => {
+      timer3 = void 0;
       void run();
     }, wait);
   };
@@ -1597,13 +1603,13 @@ var WORDS = {
   unsaved: "Unsaved"
 };
 function saveIndicator(initial = "saved") {
-  const node = el("span");
+  const node2 = el("span");
   const set = (status) => {
-    node.className = `savestat ${status}`;
-    node.textContent = WORDS[status];
+    node2.className = `savestat ${status}`;
+    node2.textContent = WORDS[status];
   };
   set(initial);
-  return { el: node, set };
+  return { el: node2, set };
 }
 
 // src/stale.ts
@@ -1624,6 +1630,43 @@ function staleBar(opts) {
   );
 }
 
+// src/toast.ts
+var DURATION = { info: 4e3, ok: 4e3, error: 7e3 };
+var node;
+var timer2 = 0;
+var seq = 0;
+function mount() {
+  if (node && node.isConnected) return node;
+  node = el("div", { className: "shell-toast" });
+  node.setAttribute("role", "status");
+  node.setAttribute("aria-live", "polite");
+  node.hidden = true;
+  document.body.append(node);
+  return node;
+}
+function toast(message, kind = "info", opts = {}) {
+  const t = mount();
+  const id = ++seq;
+  t.textContent = message;
+  t.className = `shell-toast ${kind}`;
+  t.hidden = false;
+  window.clearTimeout(timer2);
+  timer2 = window.setTimeout(() => {
+    closeWithExit(t, () => {
+      if (seq === id) t.hidden = true;
+    });
+  }, opts.duration ?? DURATION[kind]);
+}
+function dismissToast() {
+  if (!node || node.hidden) return;
+  window.clearTimeout(timer2);
+  const id = seq;
+  const t = node;
+  closeWithExit(t, () => {
+    if (seq === id) t.hidden = true;
+  });
+}
+
 // src/stepper.ts
 function renderStepperBar(host, opts) {
   const { items } = opts;
@@ -1746,6 +1789,6 @@ function historyNav(onBack, onForward) {
   };
 }
 
-export { PALETTE, PALETTE_SIZE, PROPERTY_NAME_HINT, RESERVED_PROPERTY_NAMES, askIdentity, bindPropertyName, bindPropertyRef, closeAnchoredPanel, closeWithExit, colourFor, colourIndex, confirmDialog, createNavHistory, createSaveController, dupGuard, el, expandableRow, firstIllegalPropertyName, focusNewRow, foldVc, gameIdify, hideTip, historyNav, icon, iconBtn, iconSvg, initTooltips, isCaseOnlyPropertyName, isValidGameId, isValidPropertyName, labelled, lockControls, lockNotice, mountJobProgress, mountPaneShell, mountSettingsDialog, moveItem, openAnchoredPanel, openComments, openGameIdEditor, openNotesEditor, paintVcBadges, pinButton, placeAnchored, propertyNameProblem, propertyNameify, propertyRefProblem, renderStepperBar, revalidatePropertyRefs, saveIndicator, showAbout, staleBar, tagChips, tipAt, tipBold, vcBadgeFor };
+export { PALETTE, PALETTE_SIZE, PROPERTY_NAME_HINT, RESERVED_PROPERTY_NAMES, askIdentity, bindPropertyName, bindPropertyRef, closeAnchoredPanel, closeWithExit, colourFor, colourIndex, confirmDialog, createNavHistory, createSaveController, dismissToast, dupGuard, el, expandableRow, firstIllegalPropertyName, focusNewRow, foldVc, gameIdify, hideTip, historyNav, icon, iconBtn, iconSvg, initTooltips, isCaseOnlyPropertyName, isValidGameId, isValidPropertyName, labelled, lockControls, lockNotice, mountJobProgress, mountPaneShell, mountSettingsDialog, moveItem, openAnchoredPanel, openComments, openGameIdEditor, openNotesEditor, paintVcBadges, pinButton, placeAnchored, propertyNameProblem, propertyNameify, propertyRefProblem, renderStepperBar, revalidatePropertyRefs, saveIndicator, showAbout, staleBar, tagChips, tipAt, tipBold, toast, vcBadgeFor };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map