@wildwinter/app-shell 0.55.0 → 0.57.0

package/dist/index.d.cts

@@ -525,6 +525,20 @@ interface FollowButton {
  * the author asking for it.
  */
 declare function followButton(opts: FollowButtonOptions): FollowButton;
+interface SelectionFollowButtonOptions {
+    on: boolean;
+    /** Persist the choice. The button reflects the click itself. */
+    onToggle: (on: boolean) => void;
+    /** What the window stays on when it stops following: "line" (Patterpad), "card" (Storyletter). */
+    what?: string;
+}
+/**
+ * "Follow selection": the other direction from `followButton`. A helper window
+ * that shows whatever the editor has selected (Patterpad's fields window, after
+ * Pattershot's brief H1) moves along as the author moves; off, it stays on the
+ * node it shows. On by default in such a window: following is what it is for.
+ */
+declare function selectionFollowButton(opts: SelectionFollowButtonOptions): FollowButton;
 
 interface ConfirmOptions {
     title: string;
@@ -796,7 +810,8 @@ declare function vcBadgeFor(s: ShardVc | undefined): VcBadge | null;
 declare function paintVcBadges(root: ParentNode, shards: VcMap): void;
 /** Turn a region's editing controls off - or back on, but only the ones WE
  *  turned off, so a control disabled for its own reasons (the first card's
- *  "previous", a redraw-turns box on "always") stays disabled. */
+ *  "previous", a redraw-turns box on "always") stays disabled. `staysLive` is
+ *  the app's own reading controls; the shell's (ALWAYS_LIVE) stay live too. */
 declare function lockControls(host: HTMLElement, off: boolean, staysLive: string): void;
 /** The notice a locked document opens with: who holds it, and why nothing types. */
 declare function lockNotice(holders: string[]): HTMLElement;
@@ -1242,4 +1257,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 Crumb, type DocLine, type ElProps, type FieldHint, type FollowButton, type FollowButtonOptions, type GameIdEditorOptions, ICON_NAMES, ICON_SIZE, type IconName, type IconSvgName, type Identity, type IdentityOptions, type JobBeginOptions, type JobProgressOptions, type JobProgressView, type LabelledToggleOptions, 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 ShardVc, type StageChipsOptions, type StaleBarOptions, type StepperBarOptions, type StepperItem, type StepperTone, type TipRect, type ToastKind, type ToastOptions, type ToolWindowHeadOptions, type TooltipOptions, type VcBadge, type VcMap, askIdentity, bindPropertyName, bindPropertyRef, breadcrumb, closeAnchoredPanel, closeWithExit, colourFor, colourIndex, confirmDialog, createNavHistory, createSaveController, dismissToast, el, firstIllegalPropertyName, foldVc, followButton, gameIdify, hideTip, historyNav, icon, iconBtn, iconHtml, iconNameOfGlyph, iconNode, iconSvg, initTooltips, isCaseOnlyPropertyName, isIconName, isValidGameId, isValidPropertyName, labelled, labelledToggle, lockControls, lockNotice, metaLine, mountJobProgress, mountPaneShell, moveItem, openAnchoredPanel, openComments, openGameIdEditor, openNotesEditor, paintVcBadges, pinButton, placeAnchored, propertyNameProblem, propertyNameify, propertyRefProblem, renderStepperBar, revalidatePropertyRefs, saveIndicator, showAbout, stageChips, staleBar, tagChips, tipAt, tipBold, toast, toolWindowHead, vcBadgeFor, wireReorder };
+export { type AboutOptions, type AnchoredPanel, type AnchoredPanelOptions, type Child, type Comment, type CommentMessage, type CommentsOptions, type ConfirmOptions, type Crumb, type DocLine, type ElProps, type FieldHint, type FollowButton, type FollowButtonOptions, type GameIdEditorOptions, ICON_NAMES, ICON_SIZE, type IconName, type IconSvgName, type Identity, type IdentityOptions, type JobBeginOptions, type JobProgressOptions, type JobProgressView, type LabelledToggleOptions, 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 ShardVc, type StageChipsOptions, type StaleBarOptions, type StepperBarOptions, type StepperItem, type StepperTone, type TipRect, type ToastKind, type ToastOptions, type ToolWindowHeadOptions, type TooltipOptions, type VcBadge, type VcMap, askIdentity, bindPropertyName, bindPropertyRef, breadcrumb, closeAnchoredPanel, closeWithExit, colourFor, colourIndex, confirmDialog, createNavHistory, createSaveController, dismissToast, el, firstIllegalPropertyName, foldVc, followButton, gameIdify, hideTip, historyNav, icon, iconBtn, iconHtml, iconNameOfGlyph, iconNode, iconSvg, initTooltips, isCaseOnlyPropertyName, isIconName, isValidGameId, isValidPropertyName, labelled, labelledToggle, lockControls, lockNotice, metaLine, mountJobProgress, mountPaneShell, moveItem, openAnchoredPanel, openComments, openGameIdEditor, openNotesEditor, paintVcBadges, pinButton, placeAnchored, propertyNameProblem, propertyNameify, propertyRefProblem, renderStepperBar, revalidatePropertyRefs, saveIndicator, selectionFollowButton, showAbout, stageChips, staleBar, tagChips, tipAt, tipBold, toast, toolWindowHead, vcBadgeFor, wireReorder };

package/dist/index.d.ts

@@ -525,6 +525,20 @@ interface FollowButton {
  * the author asking for it.
  */
 declare function followButton(opts: FollowButtonOptions): FollowButton;
+interface SelectionFollowButtonOptions {
+    on: boolean;
+    /** Persist the choice. The button reflects the click itself. */
+    onToggle: (on: boolean) => void;
+    /** What the window stays on when it stops following: "line" (Patterpad), "card" (Storyletter). */
+    what?: string;
+}
+/**
+ * "Follow selection": the other direction from `followButton`. A helper window
+ * that shows whatever the editor has selected (Patterpad's fields window, after
+ * Pattershot's brief H1) moves along as the author moves; off, it stays on the
+ * node it shows. On by default in such a window: following is what it is for.
+ */
+declare function selectionFollowButton(opts: SelectionFollowButtonOptions): FollowButton;
 
 interface ConfirmOptions {
     title: string;
@@ -796,7 +810,8 @@ declare function vcBadgeFor(s: ShardVc | undefined): VcBadge | null;
 declare function paintVcBadges(root: ParentNode, shards: VcMap): void;
 /** Turn a region's editing controls off - or back on, but only the ones WE
  *  turned off, so a control disabled for its own reasons (the first card's
- *  "previous", a redraw-turns box on "always") stays disabled. */
+ *  "previous", a redraw-turns box on "always") stays disabled. `staysLive` is
+ *  the app's own reading controls; the shell's (ALWAYS_LIVE) stay live too. */
 declare function lockControls(host: HTMLElement, off: boolean, staysLive: string): void;
 /** The notice a locked document opens with: who holds it, and why nothing types. */
 declare function lockNotice(holders: string[]): HTMLElement;
@@ -1242,4 +1257,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 Crumb, type DocLine, type ElProps, type FieldHint, type FollowButton, type FollowButtonOptions, type GameIdEditorOptions, ICON_NAMES, ICON_SIZE, type IconName, type IconSvgName, type Identity, type IdentityOptions, type JobBeginOptions, type JobProgressOptions, type JobProgressView, type LabelledToggleOptions, 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 ShardVc, type StageChipsOptions, type StaleBarOptions, type StepperBarOptions, type StepperItem, type StepperTone, type TipRect, type ToastKind, type ToastOptions, type ToolWindowHeadOptions, type TooltipOptions, type VcBadge, type VcMap, askIdentity, bindPropertyName, bindPropertyRef, breadcrumb, closeAnchoredPanel, closeWithExit, colourFor, colourIndex, confirmDialog, createNavHistory, createSaveController, dismissToast, el, firstIllegalPropertyName, foldVc, followButton, gameIdify, hideTip, historyNav, icon, iconBtn, iconHtml, iconNameOfGlyph, iconNode, iconSvg, initTooltips, isCaseOnlyPropertyName, isIconName, isValidGameId, isValidPropertyName, labelled, labelledToggle, lockControls, lockNotice, metaLine, mountJobProgress, mountPaneShell, moveItem, openAnchoredPanel, openComments, openGameIdEditor, openNotesEditor, paintVcBadges, pinButton, placeAnchored, propertyNameProblem, propertyNameify, propertyRefProblem, renderStepperBar, revalidatePropertyRefs, saveIndicator, showAbout, stageChips, staleBar, tagChips, tipAt, tipBold, toast, toolWindowHead, vcBadgeFor, wireReorder };
+export { type AboutOptions, type AnchoredPanel, type AnchoredPanelOptions, type Child, type Comment, type CommentMessage, type CommentsOptions, type ConfirmOptions, type Crumb, type DocLine, type ElProps, type FieldHint, type FollowButton, type FollowButtonOptions, type GameIdEditorOptions, ICON_NAMES, ICON_SIZE, type IconName, type IconSvgName, type Identity, type IdentityOptions, type JobBeginOptions, type JobProgressOptions, type JobProgressView, type LabelledToggleOptions, 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 ShardVc, type StageChipsOptions, type StaleBarOptions, type StepperBarOptions, type StepperItem, type StepperTone, type TipRect, type ToastKind, type ToastOptions, type ToolWindowHeadOptions, type TooltipOptions, type VcBadge, type VcMap, askIdentity, bindPropertyName, bindPropertyRef, breadcrumb, closeAnchoredPanel, closeWithExit, colourFor, colourIndex, confirmDialog, createNavHistory, createSaveController, dismissToast, el, firstIllegalPropertyName, foldVc, followButton, gameIdify, hideTip, historyNav, icon, iconBtn, iconHtml, iconNameOfGlyph, iconNode, iconSvg, initTooltips, isCaseOnlyPropertyName, isIconName, isValidGameId, isValidPropertyName, labelled, labelledToggle, lockControls, lockNotice, metaLine, mountJobProgress, mountPaneShell, moveItem, openAnchoredPanel, openComments, openGameIdEditor, openNotesEditor, paintVcBadges, pinButton, placeAnchored, propertyNameProblem, propertyNameify, propertyRefProblem, renderStepperBar, revalidatePropertyRefs, saveIndicator, selectionFollowButton, showAbout, stageChips, staleBar, tagChips, tipAt, tipBold, toast, toolWindowHead, vcBadgeFor, wireReorder };

package/dist/index.js

@@ -278,6 +278,27 @@ function followButton(opts) {
     reflect();
   } };
 }
+function selectionFollowButton(opts) {
+  const what = opts.what ?? "line";
+  const b = el("button", "btn swin-follow", "Follow selection");
+  b.type = "button";
+  let on = opts.on;
+  const reflect = () => {
+    b.classList.toggle("on", on);
+    b.setAttribute("aria-pressed", String(on));
+    b.dataset["tip"] = on ? `Shows whatever is selected in the editor. Click to stay on this ${what}.` : `Stays on this ${what}. Click to follow the selection.`;
+  };
+  reflect();
+  b.addEventListener("click", () => {
+    on = !on;
+    reflect();
+    opts.onToggle(on);
+  });
+  return { el: b, set: (next) => {
+    on = next;
+    reflect();
+  } };
+}
 
 // src/confirm.ts
 function confirmDialog(opts) {
@@ -554,11 +575,12 @@ function paintVcBadges(root, shards) {
     host.append(span);
   });
 }
+var ALWAYS_LIVE = ".shell-fold-cap";
 function lockControls(host, off, staysLive) {
   host.classList.toggle("vc-readonly", off);
   if (off) {
     host.querySelectorAll("input, textarea, select, button").forEach((c) => {
-      if (c.disabled || staysLive !== "" && c.matches(staysLive)) return;
+      if (c.disabled || c.matches(ALWAYS_LIVE) || staysLive !== "" && c.matches(staysLive)) return;
       c.disabled = true;
       c.classList.add("vc-off");
     });
@@ -1260,6 +1282,6 @@ function historyNav(onBack, onForward) {
   };
 }
 
-export { PALETTE, PALETTE_SIZE, askIdentity, closeAnchoredPanel, colourFor, colourIndex, confirmDialog, createNavHistory, createSaveController, dismissToast, foldVc, followButton, gameIdify, historyNav, isValidGameId, lockControls, lockNotice, mountJobProgress, mountPaneShell, openAnchoredPanel, openComments, openGameIdEditor, openNotesEditor, paintVcBadges, pinButton, placeAnchored, renderStepperBar, saveIndicator, showAbout, staleBar, toast, toolWindowHead, vcBadgeFor };
+export { PALETTE, PALETTE_SIZE, askIdentity, closeAnchoredPanel, colourFor, colourIndex, confirmDialog, createNavHistory, createSaveController, dismissToast, foldVc, followButton, gameIdify, historyNav, isValidGameId, lockControls, lockNotice, mountJobProgress, mountPaneShell, openAnchoredPanel, openComments, openGameIdEditor, openNotesEditor, paintVcBadges, pinButton, placeAnchored, renderStepperBar, saveIndicator, selectionFollowButton, showAbout, staleBar, toast, toolWindowHead, vcBadgeFor };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map