@kitlangton/knobs 0.4.0-next.0 → 0.4.0-next.10

package/dist/types/ui/walkthrough.d.ts

@@ -1,6 +1,6 @@
 import { type StoragePort } from "../core/storage.js";
 import { type UiLook } from "./look.js";
-import { type MediaSlot } from "./walkthrough-media.js";
+import { type MediaSlot, type StepLinks } from "./walkthrough-media.js";
 import { type WalkOption, type WalkPage, type WalkthroughDoc, type WalkthroughFeedback, type WalkthroughOption, type WalkthroughState } from "./walkthrough-model.js";
 export interface TasteTestOptions extends UiLook {
     readonly options: readonly (WalkthroughOption | WalkOption)[];
@@ -9,6 +9,10 @@ export interface TasteTestOptions extends UiLook {
     readonly onPick?: (id: string | null) => void;
     /** Mount each option's media when near the view (on by default). */
     readonly lazy?: boolean;
+    /** The page's steps, for media that name one. */
+    readonly steps?: StepLinks;
+    /** Options can be picked (on by default); off, they sit side by side under their labels. */
+    readonly pickable?: boolean;
 }
 export interface TasteTest {
     readonly element: HTMLElement;
@@ -24,7 +28,7 @@ export interface TasteTest {
  * A vs B (or more): each option's letter, label and media side by side (stacking where it's
  * narrow). The picked one takes a check and a wash; the others step back.
  */
-export declare function tasteTest(container: HTMLElement, options: TasteTestOptions): TasteTest;
+export declare function tasteTest(container: HTMLElement, given: TasteTestOptions): TasteTest;
 export interface WalkthroughOptions extends UiLook {
     readonly doc: WalkthroughDoc;
     /** Where Kit's answers are kept (localStorage by default; `null` keeps none). */
@@ -33,8 +37,26 @@ export interface WalkthroughOptions extends UiLook {
     readonly onFeedback?: (feedback: WalkthroughFeedback) => void;
     /** The page's keys (on by default). */
     readonly keys?: boolean;
-    /** The contents and progress rail (on by default). */
-    readonly rail?: boolean;
+    /**
+     * Kit's review tools (off by default): progress, notes (typed, voice, ink) and their bar,
+     * Copy feedback, the key hints, and picking between options. Off, the page only shows: options
+     * sit side by side, and j / k, f and the arrows still work.
+     */
+    readonly review?: boolean;
+    /**
+     * The contents and progress rail (on by default): sticky at the page's left edge, the column
+     * centred in the room beside it; `"right"` mirrors it. Under 960 px it hides (with review
+     * on, a bar on top keeps the progress and the export).
+     */
+    readonly rail?: boolean | "left" | "right";
+    /** Each step on a card of its own (off by default: steps sit on the page, hairlines between). */
+    readonly cards?: boolean;
+    /**
+     * The note bar: a small launcher in the column's corner that opens into the bar on a click, n,
+     * a recording or ink, and folds back when it's empty (`"collapsed"`, the default); the bar
+     * always there (`"docked"`); or none (`"hidden"`; `send()` still works).
+     */
+    readonly noteBar?: "collapsed" | "docked" | "hidden";
     /** Sending a note moves on to the next step (on by default). */
     readonly advance?: boolean;
 }
@@ -60,4 +82,4 @@ export interface Walkthrough {
     reset(): void;
     dispose(): void;
 }
-export declare function walkthrough(container: HTMLElement, options: WalkthroughOptions): Walkthrough;
+export declare function walkthrough(container: HTMLElement, given: WalkthroughOptions): Walkthrough;