@plannotator/ui 0.35.1 → 0.36.0

package/HANDOFF.md

@@ -196,6 +196,7 @@ We deliberately did **not** restructure the exports map in this PR (move-don't-r
 | `components/CommentPopover` | Anchor capture + comment entry. Ask-AI UI renders only if you pass `onAskAI`. |
 | `components/AnnotationPanel` | Renders from your annotation state; no fetches of its own. |
 | `components/AnnotationToolstrip` | The annotation mode toolstrip (Select / Pinpoint / Markup / Comment / Redline / Label). **Pass `showHelpLink={false}` in a host** — the default help modal embeds Plannotator's own YouTube walkthroughs. `hideQuickLabel` omits only the Label button (`StickyHeaderLane` forwards it, so the pinned scroll header matches); it hides the control, it does **not** clamp the mode — keep host mode state out of `'quickLabel'` (including preferences restored through `utils/editorMode`, which accepts it from storage) or text selection silently opens the quick-label picker with no visible cause. `hideInputMethodSwitch` likewise omits the pinpoint/drag switch. *(Blessed in 0.35.0.)* |
+| `components/StickyHeaderLane` | The measured compact toolstrip + badge lane aligned beside `Viewer`'s `[data-sticky-actions]` cluster. Defaults remain hidden/inert at rest and visible only while stuck, including the incumbent hidden chrome during its fade. `visibility="always"` exposes the zero-height, absolutely positioned lane at rest without sticky chrome or document padding; the host must reserve a clear header-height region so its controls do not cover or intercept document content. `sticky={false}` uses normal-flow positioning, creates no intersection observer, and scrolls away; pass the same value to `Viewer.stickyActions` and pair it with `visibility="always"` because the default stuck-only visibility would otherwise stay hidden. The measured Viewer-actions width is intentionally retained because both clusters still share the lane at rest. Wide active-label, tight icon-only, and narrow stacked fallbacks remain measurement-driven, and `hideQuickLabel` still forwards to the compact toolstrip. |
 | `components/ThemeProvider` | Color-mode context. |
 | `theme-modes` (`THEME_MODES`, `Mode`) | The supported Light/Dark/System catalog and mode type. `Mode` also remains exported from `components/ThemeProvider` for compatibility with existing consumers. |
 | `components/ImageThumbnail` / `getImageSrc` | Routes through `imageSrcResolver`. |
@@ -675,8 +676,8 @@ Additive only, but required: `@plannotator/ui` 0.32.0 imports the new `@plannota
 
 ## Publishing & versioning
 
-- The current pair is `@plannotator/ui` `0.35.1` on `@plannotator/core` `0.25.0`. **No lockstep again**: nothing under `packages/core` changed, so core is not republished. UI 0.35.1 is the packaging correction for 0.35.0: the source and packed UI manifests now pin core 0.25.0 exactly, so external pnpm consumers do not receive the unpublished `workspace:*` protocol. It otherwise carries the same `hideQuickLabel` toolstrip seam as 0.35.0.
-- Recent pairs, for the consumer's install matrix: ui 0.31.0 on core 0.24.0 (lockstep), ui 0.32.0 on core 0.25.0 (lockstep, `html-anchor`), and ui 0.33.0 through ui 0.35.1 on core 0.25.0 (ui only, core unchanged). Do not consume ui 0.35.0 externally; its published manifest contains `workspace:*`.
+- The current pair is `@plannotator/ui` `0.35.2` on `@plannotator/core` `0.25.1`. Core 0.25.1 publishes the `annotation-threads` subpath already used by `AnnotationPanel` and `utils/parser`; UI 0.35.2 pins that corrected core exactly. The UI behavior remains the `hideQuickLabel` seam introduced in 0.35.0.
+- Recent pairs, for the consumer's install matrix: ui 0.31.0 on core 0.24.0 (lockstep), ui 0.32.0 on core 0.25.0 (lockstep, `html-anchor`), ui 0.33.0 and ui 0.34.0 on core 0.25.0 (ui only), and ui 0.35.2 on core 0.25.1. Do not consume ui 0.35.0 externally because its published manifest contains `workspace:*`; do not consume ui 0.35.1 because its exact core 0.25.0 dependency lacks the `annotation-threads` export.
 - When both packages change, **publish `core` first**: ui 0.32.0 imports the `@plannotator/core/html-anchor` subpath, which no earlier published core (0.24.0 and before) has, just as ui 0.29.0 needed core 0.23.0 for `@plannotator/core/annotatable`. Bump core, update UI's exact core dependency to the same new version, and run `bun install` so `bun.lock` records the new workspace versions before packing either package.
 - The HTML annotation seams also changed the guides.show viewer **stylesheet** (five utility rules from `HtmlSurfaceControls`; the viewer JS is unchanged), so `packages/core/guide-viewer-manifest.ts` now pins a CSS hash that exists on guides.show only after the deploy workflow has published this build's `/v1/` assets. A guide exported from this build before that deploy would pin a stylesheet the host does not serve yet: **deploy guides.show before any release that ships this manifest.**
 - UI declares the already published core version exactly in its source manifest. Do not replace it with `workspace:*`: direct publication can preserve that protocol and make the package impossible to install outside this repository. Bun links the local core workspace whenever its version matches the exact dependency. Before publishing, run `bun run --cwd packages/ui smoke:package`; it checks the source and packed manifests, required tarball subpaths, local Bun linking, and a real pnpm install in an external temporary consumer. When both packages change, publish **`core` first, then `ui`**.

package/README.md

@@ -137,6 +137,29 @@ The srcdoc then carries one classic `<script src>` in the exact place the inline
 - **`showHelpLink={false}`** for hosts: the default help modal embeds Plannotator's own video walkthroughs.
 - **`hideInputMethodSwitch`** omits the pinpoint/drag input-method switch.
 
+#### Sticky header lane host props
+
+`components/StickyHeaderLane` is the measured compact companion to `Viewer`'s
+`[data-sticky-actions]` cluster. Its defaults preserve Plannotator's ghost-header
+behavior: hidden and inert at rest, then visible with card chrome once stuck.
+
+- **`visibility="always"`** keeps the existing measured left lane visible and
+  interactive at rest as well as while stuck. Resting lanes have no background,
+  border, backdrop, shadow, or new document padding; stuck lanes retain the
+  incumbent chrome. The lane remains zero-height and absolutely positioned, so
+  the host must reserve a clear header-height region; otherwise its visible
+  controls can cover and intercept interaction with document content below.
+- **`sticky={false}`** uses non-sticky positioning, creates no intersection
+  observer, and scrolls away normally. Pass the same value to
+  `Viewer.stickyActions` so the left lane and right action cluster follow one
+  policy. By itself it leaves the default stuck-only lane permanently hidden;
+  combine it with `visibility="always"` for a visible non-sticky header. The
+  measured Viewer-actions width is still reserved because both clusters share
+  the lane at rest before they scroll away together.
+- Wide, tight icon-only, and narrow stacked layouts continue to derive from the
+  wrapper width and the measured action-cluster width. `hideQuickLabel` is still
+  forwarded to the compact toolstrip.
+
 ### WebMCP provider (`@plannotator/ui/webmcp`; 0.32.0)
 
 The engine that lets a browser-integrated agent (Chrome/Edge WebMCP, `document.modelContext`) call in-page tools on a document surface. Feature-detected once; a browser without the API sees no registration, no DOM, no network, no timers. Seam: `configurePlannotatorUI({ webmcp: { enabled, namePrefix } })`, default enabled with the `plannotator.` prefix; pass `enabled: false` to keep a host page tool-free, or your own prefix to namespace the tools beside your own. There is deliberately no confirmation seam: the catalog is read-and-comment only (no approve / submit / close tools), and the agent may only edit or remove comments stamped `source: "browser-agent"`.
@@ -172,7 +195,7 @@ npm install @plannotator/ui @plannotator/core
 - `@plannotator/core` — pure utils + types, zero deps, browser-safe (CI enforces no `node:` imports). Published.
 - `@plannotator/ui` — React components/hooks + theme + `configure()`. Depends on an exact published `@plannotator/core` version. Published.
 - `@plannotator/shared`, `@plannotator/ai` — stay private to the monorepo; `shared` re-exports `core`'s modules via shims so Plannotator's internals are untouched.
-- Currently `@plannotator/ui` 0.35.1 depends exactly on `@plannotator/core` 0.25.0. `core` is bumped only when something under `packages/core` changes, so `ui` can advance alone. Keep the published core version exact in `packages/ui/package.json`; do not use a `workspace:` protocol there, because a directly published manifest must remain installable outside this monorepo. Bun still links the matching local workspace during development. When both packages change, publish `core` first, then build and publish the UI tarball. See HANDOFF.md "Publishing & versioning" for the verification command.
+- Currently `@plannotator/ui` 0.35.2 depends exactly on `@plannotator/core` 0.25.1. `core` is bumped only when something under `packages/core` changes, so `ui` can advance alone. Keep the published core version exact in `packages/ui/package.json`; do not use a `workspace:` protocol there, because a directly published manifest must remain installable outside this monorepo. Bun still links the matching local workspace during development. When both packages change, publish `core` first, then build and publish the UI tarball. See HANDOFF.md "Publishing & versioning" for the verification command.
 
 ## The one rule
 

package/components/StickyHeaderLane.tsx

@@ -1,11 +1,12 @@
 /**
- * StickyHeaderLane — compact "ghost" header that pins as the user scrolls
+ * StickyHeaderLane — compact "ghost" header that can pin as the user scrolls
  * past the AnnotationToolstrip.
  *
- * At rest (top of doc): invisible, non-interactive. The original toolstrip
- * and badge cluster on the card remain the visible source of truth.
+ * By default, the lane is invisible and non-interactive at rest, leaving the
+ * original toolstrip and badge cluster as the visible source of truth. Hosts
+ * can keep this measured lane visible at rest or let it scroll normally.
  *
- * Layout is driven by two ResizeObserver measurements — the sticky
+ * Layout is driven by two ResizeObserver measurements — the lane
  * wrapper's actual width AND the Viewer action button cluster's actual
  * width — so the bar fits exactly into the space between its left edge
  * and the buttons, with no fixed pixel reserves.
@@ -58,7 +59,11 @@ const GAP = 16;
 const WIDE_BAR_WIDTH = 460;
 const MIN_BAR_WIDTH = 300;
 
-interface StickyHeaderLaneProps {
+/** Controls when the compact header lane is visible and interactive. */
+export type StickyHeaderLaneVisibility = 'stuck' | 'always';
+
+/** Props for the measured compact annotation and document header lane. */
+export interface StickyHeaderLaneProps {
   // Toolstrip state
   inputMethod: InputMethod;
   onInputMethodChange: (method: InputMethod) => void;
@@ -68,6 +73,21 @@ interface StickyHeaderLaneProps {
   /** Omit the Quick Label tool in the compact toolstrip (mirrors AnnotationToolstripProps.hideQuickLabel). */
   hideQuickLabel?: boolean;
 
+  /**
+   * Show the lane only after it sticks, or keep it visible at rest too.
+   * Defaults to `'stuck'`, preserving the incumbent ghost-header behavior.
+   * Hosts using `'always'` must reserve a clear header-height region because
+   * the lane remains zero-height and absolutely positioned over its sibling.
+   */
+  visibility?: StickyHeaderLaneVisibility;
+  /**
+   * Keep the lane pinned while its scroll viewport moves. Pass the same value
+   * to `Viewer.stickyActions` so both measured header lanes share one policy.
+   * Defaults to true. Pair false with `visibility="always"`; the default
+   * stuck-only visibility cannot become visible when stickiness is disabled.
+   */
+  sticky?: boolean;
+
   // Badge state
   repoInfo?: { display: string; branch?: string } | null;
   planDiffStats?: PlanDiffStats | null;
@@ -91,6 +111,7 @@ interface StickyHeaderLaneProps {
   remountToken?: string;
 }
 
+/** Render the shared, measured header lane beside the Viewer's action cluster. */
 export const StickyHeaderLane: React.FC<StickyHeaderLaneProps> = ({
   inputMethod,
   onInputMethodChange,
@@ -98,6 +119,8 @@ export const StickyHeaderLane: React.FC<StickyHeaderLaneProps> = ({
   onModeChange,
   taterMode,
   hideQuickLabel,
+  visibility = 'stuck',
+  sticky = true,
   repoInfo,
   planDiffStats,
   isPlanDiffActive,
@@ -115,6 +138,12 @@ export const StickyHeaderLane: React.FC<StickyHeaderLaneProps> = ({
   const [wrapperWidth, setWrapperWidth] = useState(0);
   const [actionsWidth, setActionsWidth] = useState(0);
   const scrollViewport = useScrollViewport();
+  const laneIsStuck = sticky && isStuck;
+  const isVisible = visibility === 'always' || laneIsStuck;
+  // Preserve the incumbent ghost lane exactly: its chrome remains mounted
+  // while the whole hidden bar fades out. Only the new always-visible mode
+  // removes chrome at rest for the supported chrome-free presentation.
+  const showChrome = visibility === 'always' ? laneIsStuck : true;
 
   // Space available for the bar in the shared lane = wrapper width, minus
   // the bar's left offset, minus the action buttons' measured width, minus
@@ -175,6 +204,10 @@ export const StickyHeaderLane: React.FC<StickyHeaderLaneProps> = ({
   // doubles up with the still-visible toolstrip. Root is the OverlayScrollArea
   // viewport from context, NOT <main> (which doesn't actually scroll).
   useEffect(() => {
+    if (!sticky) {
+      setIsStuck(false);
+      return;
+    }
     if (!sentinelRef.current || !scrollViewport) return;
     const observer = new IntersectionObserver(
       ([entry]) => setIsStuck(!entry.isIntersecting),
@@ -186,17 +219,18 @@ export const StickyHeaderLane: React.FC<StickyHeaderLaneProps> = ({
     );
     observer.observe(sentinelRef.current);
     return () => observer.disconnect();
-  }, [scrollViewport]);
+  }, [scrollViewport, sticky]);
 
   return (
     <>
-      {/* Sentinel — zero-size, rendered in normal flow at the top of the
-          column. When it scrolls out of the OverlayScrollArea viewport,
-          the sticky bar fades in. */}
-      <div ref={sentinelRef} aria-hidden="true" className="h-0 w-0" />
+      {/* Sentinel — present only for sticky positioning. It sits at the top of
+          the column and activates the stuck state after scrolling out of the
+          OverlayScrollArea viewport. */}
+      {sticky && <div ref={sentinelRef} aria-hidden="true" className="h-0 w-0" />}
 
-      {/* Sticky wrapper — zero-height so it never pushes content down. The
-          visible bar is positioned absolutely relative to this wrapper.
+      {/* Zero-height wrapper — sticky by default, relative when sticky is
+          disabled so the absolutely positioned lane scrolls in normal flow.
+          It never pushes document content down.
           The Viewer's outer wrapper uses z-50, so the sticky lane must
           sit above that to paint over the card.
 
@@ -209,8 +243,8 @@ export const StickyHeaderLane: React.FC<StickyHeaderLaneProps> = ({
       <div
         ref={wrapperRef}
         data-sticky-header-lane="true"
-        className={`sticky z-[60] w-full self-center pointer-events-none ${
-          isNarrow ? 'top-[52px] md:top-[60px]' : 'top-3'
+        className={`${sticky ? 'sticky' : 'relative'} z-[60] w-full self-center pointer-events-none ${
+          sticky ? (isNarrow ? 'top-[52px] md:top-[60px]' : 'top-3') : ''
         }`}
         style={maxWidth == null ? { height: 0 } : { maxWidth, height: 0 }}
       >
@@ -227,11 +261,13 @@ export const StickyHeaderLane: React.FC<StickyHeaderLaneProps> = ({
             is the final safety net so any overflow clips inside the chrome
             rather than leaking out.
 
-            `inert` removes the bar from the tab order when not stuck. */}
+            `inert` removes the bar from the tab order whenever it is hidden. */}
         <div
-          inert={!isStuck || undefined}
-          className={`absolute left-3 md:left-5 top-0 inline-flex flex-wrap items-center gap-x-3 gap-y-1 min-w-0 overflow-hidden rounded-lg py-1 md:py-1.5 bg-card/95 backdrop-blur-sm shadow-sm border border-border/30 motion-reduce:transform-none ${
-            isStuck
+          inert={!isVisible || undefined}
+          className={`absolute left-3 md:left-5 top-0 inline-flex flex-wrap items-center gap-x-3 gap-y-1 min-w-0 overflow-hidden rounded-lg py-1 md:py-1.5 ${
+            showChrome ? 'bg-card/95 backdrop-blur-sm shadow-sm border border-border/30' : ''
+          } motion-reduce:transform-none ${
+            isVisible
               ? 'opacity-100 translate-y-0 pointer-events-auto'
               : 'opacity-0 -translate-y-1 pointer-events-none'
           }`}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plannotator/ui",
-  "version": "0.35.1",
+  "version": "0.36.0",
   "type": "module",
   "exports": {
     "./components/*": "./components/*.tsx",
@@ -74,7 +74,7 @@
     "@lezer/highlight": "^1.2.3",
     "@pierre/diffs": "1.3.2",
     "@plannotator/atomic-editor": "^0.8.0",
-    "@plannotator/core": "0.25.0",
+    "@plannotator/core": "0.25.1",
     "@plannotator/markdown-editor": "^0.4.0",
     "@plannotator/web-highlighter": "^0.8.1",
     "@tanstack/react-table": "^8.21.3",