Files
PaperClipAI/ui/src/components/SidebarShell.tsx
T
7b9334cd10 Draft: Build agent-ready design proposal system (#16875)
## Thinking Path

> - Paperclip helps people manage AI agents and their work.
> - People need consistent UI patterns to review and control that work.
> - The current board uses related layouts and controls with different
spacing, type, and behavior.
> - That drift makes it hard for a designer or an agent to build a new
page from a reliable reference.
> - Storybook can show the shared patterns and the states they need to
support.
> - This pull request adds design proposals, a local sandbox, and
reusable UI controls so people can compare the patterns in context.
> - The benefit is a clearer design system that agents can use to build
consistent UI.

## Linked Issues or Issue Description

**Subsystem affected**

`ui/` — React board UI and Storybook.

**Problem or motivation**

Board pages repeat visual and interaction decisions. Storybook did not
provide a complete reference for task views, conversation states,
typography, toolbars, tabs, and light/dark colors. People could not
compare a proposed pattern with the running board in one place.

**Proposed solution**

Add a staged Design Proposals catalog with foundations, components,
layouts, and page specimens. Add an opt-in sandbox. Reuse production
components where possible. Include synthetic conversation states and
shared controls so reviewers can compare and refine them.

**Alternatives considered**

Separate static mockups would not show keyboard behavior, responsive
layout, or real component states. Rebuilding each page only in Storybook
would allow the reference to drift from the board.

**Roadmap alignment**

This improves existing board UI and Skills Manager surfaces. It does not
add a new control-plane capability.

## What Changed

- Added dark and light color references, typography and conversation
specimens, and component stories for buttons, tabs, toolbars, sidebar,
popovers, activity, and task lists.
- Added a local design sandbox with synthetic task conversation playback
and representative states.
- Shared collection toolbars and navigation patterns across task, agent,
project, routine, skill, connector, and artifact pages.
- Added the streamlined Skills tabs and a My Skills collection that uses
the shared skill cards.
- Restored saved-thread access during synthetic playback, kept connector
searchbox semantics, and updated reproduction checks after moving trial
stories.
- Documented the proposed patterns and added focused UI, catalog, and
browser checks.

## Verification

- `pnpm check:token-gates`, `node scripts/check-maps.mjs`, and `node
scripts/storybook-catalog.mjs --check` passed.
- Full workspace `pnpm -r typecheck` and `pnpm build` passed after
merging master. After the review fixes, focused UI typecheck, `pnpm
build-storybook`, 23 Skills Sources tests, and all 15 Storybook
typography browser tests passed.
- Focused task-thread and system-notice suites passed: 251 tests.
Connector Browse passed 84 tests; the connector, attachment, recovery,
and Storybook flyout browser journeys passed locally.
- A local full Vitest run hit one intermittent chat-channels integration
failure; that test passed in isolation. GitHub CI
[39347996059](https://github.com/paperclipai/paperclip/actions/runs/39347996059)
passed on the exact latest commit: 55 successful checks and two skipped
draft-only Storybook jobs.
- Greptile reviewed the exact latest commit at 5/5 with no new comments
or open review threads. GitHub reports the branch as cleanly mergeable.

## Risks

- This PR changes 206 files and exceeds the repository's 100-file review
target. Review by commit and consider a scoped split before merge.
- Design Proposals are staged references. Fixture interactions do not
prove API behavior, permissions, or provider execution.
- UI changes to shared controls may affect pages outside the proposal
sandbox. Focused browser checks and the full CI matrix passed.

## Model Used

- OpenAI Codex, GPT-6 family. The exact runtime model ID and context
window are not exposed in this session. The model used reasoning, code
execution, browser inspection, and local tests. Earlier branch commits
were also AI-assisted in this Codex conversation.

## Checklist

- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details available in this session)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have searched GitHub for duplicate or related PRs and linked
them above where applicable
- [x] I have either linked existing issues or described the issue in-PR
following the relevant issue template
- [x] I have not referenced internal or instance-local Paperclip issues
or links
- [x] My branch name describes the change and contains no internal
ticket id
- [x] I have run focused tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented risks above
- [x] All Paperclip CI gates are green
- [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge

---------

Co-authored-by: Scott Tong <scott@scotts-mbp-m5-max.local>
Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-10-19 17:45:26 -07:00

266 lines
9.4 KiB
TypeScript

import {
useCallback,
useEffect,
useMemo,
useRef,
useState,
type FocusEventHandler,
type KeyboardEvent,
type MouseEventHandler,
type PointerEvent,
type ReactNode,
} from "react";
import { cn } from "@/lib/utils";
import { usePaneWidthReset } from "@/hooks/usePaneWidthReset";
const DEFAULT_SIDEBAR_WIDTH = 240;
const MIN_SIDEBAR_WIDTH = 208;
const MAX_SIDEBAR_WIDTH = 420;
const SIDEBAR_WIDTH_STEP = 16;
// Collapsed icon rail. Width is chosen so the icon is *centered* in the rail,
// which keeps the active/hover highlight symmetric around it (PAP-10676):
// the icon's left edge sits at nav px-3 (12) + item px-3 (12) = 24px, so a
// matching 24px trailing margin (12 item px-3 + 12 nav px-3) yields
// 24 + 16 (icon) + 24 = 64. The icon's left edge is unchanged from the expanded
// layout, so icons stay pixel-identical across states.
export const SIDEBAR_RAIL_WIDTH = 64;
function clampSidebarWidth(width: number) {
return Math.min(MAX_SIDEBAR_WIDTH, Math.max(MIN_SIDEBAR_WIDTH, width));
}
function readStoredSidebarWidth(storageKey: string) {
if (typeof window === "undefined") return DEFAULT_SIDEBAR_WIDTH;
try {
const stored = window.localStorage.getItem(storageKey);
if (!stored) return DEFAULT_SIDEBAR_WIDTH;
const parsed = Number.parseInt(stored, 10);
if (!Number.isFinite(parsed)) return DEFAULT_SIDEBAR_WIDTH;
return clampSidebarWidth(parsed);
} catch {
return DEFAULT_SIDEBAR_WIDTH;
}
}
function writeStoredSidebarWidth(storageKey: string, width: number) {
if (typeof window === "undefined") return;
try {
window.localStorage.setItem(storageKey, String(clampSidebarWidth(width)));
} catch {
// Storage can be unavailable in private contexts; resizing should still work.
}
}
type SidebarShellProps = {
children: ReactNode;
/** Whether the sidebar occupies space at all (mobile back-compat / hidden). */
open: boolean;
/** Pinned collapsed (rail) mode. Desktop-only; the caller gates this. */
collapsed?: boolean;
/** Ephemeral hover/focus peek. Only meaningful while collapsed. */
peeking?: boolean;
resizable?: boolean;
storageKey?: string;
className?: string;
/** Forwarded to the overlay panel so Layout can wire peek triggers. */
onPanelMouseEnter?: MouseEventHandler<HTMLDivElement>;
onPanelMouseLeave?: MouseEventHandler<HTMLDivElement>;
onPanelFocusCapture?: FocusEventHandler<HTMLDivElement>;
onPanelBlurCapture?: FocusEventHandler<HTMLDivElement>;
};
/**
* Layout shell for the desktop sidebar. Owns the persisted expanded width and
* renders two layers:
* - an in-flow spacer that reserves `reservedWidth` (rail when collapsed,
* expanded width otherwise) so content to the right only reflows on pin, and
* - an absolutely-positioned panel of `panelWidth` (rail at rest, expanded
* while peeking) that overlays content — with shadow/raised z-index — when it
* is wider than the reserved spacer.
*
* The icon-alignment guarantee comes for free: collapsing is a pure width
* change with `overflow-hidden` clipping the labels; item padding/icon markup
* are never touched, so the left-aligned icon stays pixel-identical.
*
* Opening/closing is intentionally instant (no width transition): the pin toggle
* and peek snap between rail and expanded widths so the content never appears to
* slide. Resizing the drag handle is likewise direct; only double-click reset animates.
*/
export function SidebarShell({
children,
open,
collapsed = false,
peeking = false,
resizable = false,
storageKey = "paperclip.sidebar.width",
className,
onPanelMouseEnter,
onPanelMouseLeave,
onPanelFocusCapture,
onPanelBlurCapture,
}: SidebarShellProps) {
const [width, setWidth] = useState(() => readStoredSidebarWidth(storageKey));
const [isResizing, setIsResizing] = useState(false);
const shellRef = useRef<HTMLDivElement>(null);
const { resetting, startReset, cancelReset, onResetTransitionEnd } = usePaneWidthReset();
const widthRef = useRef(width);
const dragState = useRef<{ startX: number; startWidth: number } | null>(null);
useEffect(() => {
cancelReset();
const storedWidth = readStoredSidebarWidth(storageKey);
widthRef.current = storedWidth;
setWidth(storedWidth);
}, [storageKey, cancelReset]);
useEffect(() => { cancelReset(); }, [open, collapsed, peeking, cancelReset]);
// Unified width function (plan §5): one code path for every pinned state.
const expandedWidth = open ? width : 0;
const reservedWidth = !open ? 0 : collapsed ? SIDEBAR_RAIL_WIDTH : expandedWidth;
const panelWidth = !open ? 0 : collapsed && !peeking ? SIDEBAR_RAIL_WIDTH : expandedWidth;
const isOverlay = panelWidth > reservedWidth;
// The drag handle can only resize the expanded width, so it is disabled while
// collapsed (the rail width is a fixed constant, not user-resizable).
const canResize = resizable && open && !collapsed;
const reservedStyle = useMemo(
() => ({ width: `${reservedWidth}px` }),
[reservedWidth],
);
const panelStyle = useMemo(
() => ({ width: `${panelWidth}px` }),
[panelWidth],
);
const commitWidth = useCallback(
(nextWidth: number, animate = false) => {
if (animate) startReset();
else cancelReset();
const clamped = clampSidebarWidth(nextWidth);
widthRef.current = clamped;
setWidth(clamped);
writeStoredSidebarWidth(storageKey, clamped);
},
[storageKey, startReset, cancelReset],
);
const handlePointerDown = useCallback(
(event: PointerEvent<HTMLDivElement>) => {
if (!canResize) return;
event.preventDefault();
const startWidth = resetting ? shellRef.current!.getBoundingClientRect().width : widthRef.current;
cancelReset();
widthRef.current = startWidth;
setWidth(startWidth);
event.currentTarget.setPointerCapture(event.pointerId);
dragState.current = { startX: event.clientX, startWidth };
setIsResizing(true);
},
[canResize, resetting, cancelReset],
);
const handlePointerMove = useCallback(
(event: PointerEvent<HTMLDivElement>) => {
if (!dragState.current) return;
const nextWidth = dragState.current.startWidth + event.clientX - dragState.current.startX;
const clamped = clampSidebarWidth(nextWidth);
widthRef.current = clamped;
setWidth(clamped);
},
[],
);
const endResize = useCallback(() => {
if (!dragState.current) return;
dragState.current = null;
setIsResizing(false);
writeStoredSidebarWidth(storageKey, widthRef.current);
}, [storageKey]);
const handleKeyDown = useCallback(
(event: KeyboardEvent<HTMLDivElement>) => {
if (!canResize) return;
const currentWidth = resetting ? shellRef.current!.getBoundingClientRect().width : width;
if (event.key === "ArrowLeft") {
event.preventDefault();
commitWidth(currentWidth - SIDEBAR_WIDTH_STEP);
} else if (event.key === "ArrowRight") {
event.preventDefault();
commitWidth(currentWidth + SIDEBAR_WIDTH_STEP);
} else if (event.key === "Home") {
event.preventDefault();
commitWidth(MIN_SIDEBAR_WIDTH);
} else if (event.key === "End") {
event.preventDefault();
commitWidth(MAX_SIDEBAR_WIDTH);
}
},
[canResize, commitWidth, width, resetting],
);
return (
<div ref={shellRef} className={cn("sidebar-shell relative h-full shrink-0", className)} style={reservedStyle}
data-width-resetting={resetting && canResize && !isResizing || undefined} onTransitionEnd={onResetTransitionEnd}>
<div
className={cn(
"sidebar-shell-panel absolute inset-y-0 left-0 flex flex-col overflow-hidden",
// Open/close is instant (PAP-10676): no width transition so the rail and
// expanded states snap without any sliding motion.
// Overlay styling only while the panel is wider than its reserved
// spacer (i.e. peeking) so it floats above content without reflow.
isOverlay
? "z-30 border-r border-border bg-background shadow-lg"
: "z-0",
)}
style={panelStyle}
data-sidebar-overlay={isOverlay ? "" : undefined}
onMouseEnter={onPanelMouseEnter}
onMouseLeave={onPanelMouseLeave}
onFocusCapture={onPanelFocusCapture}
onBlurCapture={onPanelBlurCapture}
>
{children}
</div>
{canResize ? (
<div
role="separator"
aria-label="Resize sidebar"
aria-orientation="vertical"
aria-valuemin={MIN_SIDEBAR_WIDTH}
aria-valuemax={MAX_SIDEBAR_WIDTH}
aria-valuenow={width}
tabIndex={0}
data-dragging={isResizing ? "" : undefined}
className="pane-resize-handle group absolute inset-y-0 z-20 cursor-col-resize touch-none outline-none"
style={{ right: -4, width: 8 }}
onPointerDown={handlePointerDown}
onPointerMove={handlePointerMove}
onPointerUp={endResize}
onPointerCancel={endResize}
onLostPointerCapture={endResize}
onDoubleClick={() => commitWidth(DEFAULT_SIDEBAR_WIDTH, true)}
onKeyDown={handleKeyDown}
>
<div
className={cn(
"mx-auto h-full w-0.5 transition-colors",
isResizing
? "bg-ring"
: "bg-transparent group-hover:bg-ring group-focus-visible:bg-ring",
)}
/>
</div>
) : null}
</div>
);
}