@inkbar/svelte 0.4.0 → 0.6.0

package/dist/components/popover-focus.js

@@ -1,4 +1,5 @@
 import { createFocusReturn, shouldKeepOpenOnAnnotation, } from '@inkbar/core/dom';
+import { flushSync } from 'svelte';
 import { peekActivated } from '../context.js';
 /** Bits UI's `onInteractOutside` handler: a press that will activate an annotation keeps the popover open. */
 export function keepOpenOnAnnotation(event) {
@@ -16,8 +17,10 @@ export function keepOpenOnAnnotation(event) {
  * close reaches the planner one microtask late, and only when no open was reported after it.
  *
  * This relies on Bits UI reporting a remount as a close and then an open within one synchronous
- * call (observed in bits-ui 2.19.5, `FocusScope.mount`). If that changes, the browser case 'a
- * card opened by selection alone takes focus without passing it through the annotation' fails.
+ * call (observed in bits-ui 2.19.5, `FocusScope.mount`). The unit case 'a close followed by an
+ * open in the same tick moves no focus and uses up the removal plan' pins the planner's side, and
+ * the browser case 'a popover opened without passing focus through the annotation takes focus'
+ * checks that an open moves focus straight into the popover.
  *
  * A close that is superseded this way moves no focus, but it still uses up whatever
  * `beforeRemove` planned for it, so the plan cannot leak into a later close. A close that is
@@ -35,7 +38,25 @@ export function useFocusReturn(ctx) {
     /** Open and close reports so far, so a deferred close can tell what followed it. */
     let opens = 0;
     let closes = 0;
+    /** A press closed the popover, and the planner answers that close without moving focus. */
+    let pressed = false;
     return {
+        onPressOutside(event, inside, close) {
+            const target = event.target;
+            if (event.button !== 0 || !(target instanceof Element))
+                return;
+            if (target.closest(inside) || shouldKeepOpenOnAnnotation(target))
+                return;
+            const scroll = target.closest('[data-ink-scroll]');
+            if (!scroll || !ctx.rootEl?.contains(scroll))
+                return;
+            pressed = true;
+            close();
+            flushSync();
+        },
+        onPressEnd() {
+            pressed = false;
+        },
         beforeRemove: (anchor, prefer) => planner.beforeRemove(anchor, prefer),
         onOpenAutoFocus() {
             opens += 1;
@@ -50,7 +71,7 @@ export function useFocusReturn(ctx) {
                 if (close !== closes)
                     return;
                 // An open followed: the popover is open, so only the plan is cleared.
-                discarding = opens !== opensBefore;
+                discarding = opens !== opensBefore || pressed;
                 try {
                     planner.onCloseAutoFocus(event, anchor);
                 }

package/dist/context.d.ts

@@ -1,8 +1,11 @@
-import type { Annotation, InkDocument, InkStatus, PdfAssets, SignatureLibrary } from '@inkbar/core';
-import type { Tool, ToolController, ToolId, ToolOptions, ToolStyle, Viewport, ZoomValue } from '@inkbar/core/dom';
+import type { Annotation, InkDocument, InkStatus, PdfAssets, PluginHistory, SignatureLibrary, Writable } from '@inkbar/core';
+import type { DecorateAnnotation, PluginHost, Tool, ToolController, ToolId, ToolOptions, ToolStyle, Viewport, ZoomValue } from '@inkbar/core/dom';
 export type { InkStatus };
-/** Undo and redo for the current document, whichever mode its annotations are in. */
-export interface InkHistory {
+/**
+ * Undo and redo for the current document, whichever mode its annotations are in. `track` and
+ * `react` (from `PluginHistory`) reach the same history, so plugin stores undo with the edits.
+ */
+export interface InkHistory extends PluginHistory {
     readonly canUndo: boolean;
     readonly canRedo: boolean;
     undo(): void;
@@ -27,6 +30,14 @@ export interface InkContext {
     readonly status: InkStatus;
     readonly annotations: readonly Annotation[];
     readonly selection: readonly string[];
+    /**
+     * The plugins from InkRoot's `plugins` prop, set up once the root has mounted and kept for
+     * its life; `null` before that, and on the server. InkViewport hands it to the engine;
+     * InkCommand places its commands.
+     */
+    readonly pluginHost: PluginHost | null;
+    /** InkViewport's scroll element while it is mounted: the plugins' `root`. */
+    readonly viewportEl: Writable<HTMLElement | null>;
     /** Set by InkViewport once it has built its viewport and tool controller. */
     readonly viewport: Viewport | null;
     readonly tools: ToolController | null;
@@ -35,6 +46,8 @@ export interface InkContext {
     setTool(id: ToolId): void;
     /** Host tools from InkRoot's `tools` prop; InkViewport registers them. */
     readonly hostTools: Tool[] | undefined;
+    /** InkRoot's `decorateAnnotation` prop. InkViewport re-applies decorations when it changes. */
+    readonly decorateAnnotation: DecorateAnnotation | undefined;
     /** The font families text boxes offer: InkRoot's `fonts`, else `FONT_FAMILIES`. */
     readonly fonts: readonly string[];
     /** The tools' options for InkRoot's life, so they persist across documents. */
@@ -52,6 +65,11 @@ export interface InkContext {
     reportPage(p: number): void;
     /** Last activated annotation (Enter, click with the note tool, etc.). Popovers key off this. */
     readonly activated: string | null;
+    /**
+     * Activates annotation `id`, or clears the activation with `null`. This is the context's
+     * own: unlike core's `Viewer.setActivated`, it calls InkRoot's `onActivate` for an id, and
+     * it does not check that the id is in the document.
+     */
     setActivated(id: string | null): void;
     readonly history: InkHistory;
     readonly rootEl: HTMLElement | null;

package/dist/context.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../src/lib/context.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,UAAU,EACV,WAAW,EACX,SAAS,EACT,SAAS,EACT,gBAAgB,EACjB,MAAM,cAAc,CAAA;AACrB,OAAO,KAAK,EACV,IAAI,EACJ,cAAc,EACd,MAAM,EACN,WAAW,EACX,SAAS,EACT,QAAQ,EACR,SAAS,EACV,MAAM,kBAAkB,CAAA;AAEzB,YAAY,EAAE,SAAS,EAAE,CAAA;AAEzB,qFAAqF;AACrF,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,IAAI,IAAI,IAAI,CAAA;IACZ,IAAI,IAAI,IAAI,CAAA;IACZ,KAAK,IAAI,IAAI,CAAA;IACb;;;;;OAKG;IACH,KAAK,CAAC,EAAE,EAAE,MAAM,IAAI,GAAG,IAAI,CAAA;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAA;IAC1B,QAAQ,CAAC,QAAQ,EAAE,WAAW,GAAG,IAAI,CAAA;IACrC,2FAA2F;IAC3F,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAA;IAC1B,QAAQ,CAAC,WAAW,EAAE,SAAS,UAAU,EAAE,CAAA;IAC3C,QAAQ,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAA;IACrC,6EAA6E;IAC7E,QAAQ,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;IAClC,QAAQ,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI,CAAA;IACrC,8DAA8D;IAC9D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,0EAA0E;IAC1E,QAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,GAAG,SAAS,CAAA;IACtC,mFAAmF;IACnF,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAA;IACjC,+EAA+E;IAC/E,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAA;IACjC,mFAAmF;IACnF,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAA;IACrC,8FAA8F;IAC9F,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAA;IAC1C,wEAAwE;IACxE,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAA;IACpC,yFAAyF;IACzF,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IACtC,UAAU,CAAC,CAAC,EAAE,SAAS,GAAG,IAAI,CAAA;IAC9B,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,gGAAgG;IAChG,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;IACrC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAA;IAC5B,QAAQ,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAAA;IACnC,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,EAAE,KAAK,EAAE,cAAc,GAAG,IAAI,GAAG,IAAI,CAAA;CAC3E;AAWD,wDAAwD;AACxD,wBAAgB,aAAa,CAAC,GAAG,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,MAAM,GAAG,IAAI,GAAG,IAAI,CAGvF;AAED,4FAA4F;AAC5F,wBAAgB,aAAa,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,GAAG,IAAI,CAG5D;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU,CAY1D"}
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../src/lib/context.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,UAAU,EACV,WAAW,EACX,SAAS,EACT,SAAS,EACT,aAAa,EACb,gBAAgB,EAChB,QAAQ,EACT,MAAM,cAAc,CAAA;AACrB,OAAO,KAAK,EACV,kBAAkB,EAClB,UAAU,EACV,IAAI,EACJ,cAAc,EACd,MAAM,EACN,WAAW,EACX,SAAS,EACT,QAAQ,EACR,SAAS,EACV,MAAM,kBAAkB,CAAA;AAEzB,YAAY,EAAE,SAAS,EAAE,CAAA;AAEzB;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,aAAa;IAC/C,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,IAAI,IAAI,IAAI,CAAA;IACZ,IAAI,IAAI,IAAI,CAAA;IACZ,KAAK,IAAI,IAAI,CAAA;IACb;;;;;OAKG;IACH,KAAK,CAAC,EAAE,EAAE,MAAM,IAAI,GAAG,IAAI,CAAA;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAA;IAC1B,QAAQ,CAAC,QAAQ,EAAE,WAAW,GAAG,IAAI,CAAA;IACrC,2FAA2F;IAC3F,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAA;IAC1B,QAAQ,CAAC,WAAW,EAAE,SAAS,UAAU,EAAE,CAAA;IAC3C,QAAQ,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAA;IACrC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAA;IACtC,6EAA6E;IAC7E,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC,CAAA;IACjD,6EAA6E;IAC7E,QAAQ,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;IAClC,QAAQ,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI,CAAA;IACrC,8DAA8D;IAC9D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,0EAA0E;IAC1E,QAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,GAAG,SAAS,CAAA;IACtC,+FAA+F;IAC/F,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,SAAS,CAAA;IAC3D,mFAAmF;IACnF,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAA;IACjC,+EAA+E;IAC/E,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAA;IACjC,mFAAmF;IACnF,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAA;IACrC,8FAA8F;IAC9F,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAA;IAC1C,wEAAwE;IACxE,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAA;IACpC,yFAAyF;IACzF,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IACtC,UAAU,CAAC,CAAC,EAAE,SAAS,GAAG,IAAI,CAAA;IAC9B,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,gGAAgG;IAChG,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;;;OAIG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;IACrC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAA;IAC5B,QAAQ,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAAA;IACnC,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,EAAE,KAAK,EAAE,cAAc,GAAG,IAAI,GAAG,IAAI,CAAA;CAC3E;AAWD,wDAAwD;AACxD,wBAAgB,aAAa,CAAC,GAAG,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,MAAM,GAAG,IAAI,GAAG,IAAI,CAGvF;AAED,4FAA4F;AAC5F,wBAAgB,aAAa,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,GAAG,IAAI,CAG5D;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU,CAY1D"}