50bff3b274
## Thinking Path > - Paperclip is the open source control plane people use to manage AI agents, work, and company context. > - The board UI sidebar is the main way operators keep orientation across companies, projects, agents, issues, and settings. > - The existing fixed expanded sidebar competes with route-specific navigation, especially company settings and plugin routes that bring their own contextual sidebar. > - A collapsible primary rail preserves global navigation while giving contextual pages more horizontal room. > - This pull request adds a persisted collapsed rail, hover/focus peek, keyboard toggle, and a secondary sidebar takeover model for settings and plugin `routeSidebar` surfaces. > - The benefit is a denser board shell that keeps the app rail available without replacing it when a route needs its own navigation. ## Linked Issues or Issue Description Paperclip issue: PAP-10638 Create collapsible sidebar branch. Related GitHub PR found during duplicate search: #3838 (`feat/collapsible-sidebar`) covers a similar sidebar area but is a different head branch and implementation. This PR intentionally packages the work from `PAP-10638-collapsable-sidebar` into one reviewable branch. Problem description: The board shell needs a first-class collapsed sidebar mode. Contextual surfaces such as company settings and plugin route sidebars should not replace the global app sidebar; they should collapse the app sidebar to a rail and render their contextual navigation beside it. ## What Changed - Added desktop collapsed/sidebar-peek state to `SidebarContext`, including persisted user pins, route collapse requests, and forced collapse for secondary-sidebar routes. - Replaced the old resizable sidebar pane with `SidebarShell`, which supports a fixed 64px rail, persisted expanded width, keyboard/pointer resizing, and hover/focus peek overlay behavior. - Updated `Sidebar`, sidebar nav items, project/agent sections, badges, and account/company menu presentation for expanded, collapsed, and peeking states. - Added `RequestCollapsedSidebar` and `SecondarySidebar` so routes and plugin `routeSidebar` slots can request contextual sidebar layouts without replacing the primary app sidebar. - Wired company settings and plugin route sidebars into the secondary-pane takeover model. - Added focused Vitest coverage for sidebar state precedence, shell sizing, nav item rail rendering, keyboard shortcuts, layout takeover behavior, and route collapse requests. - Updated plugin authoring docs/spec references for route sidebar behavior. ## Verification Targeted local verification passed: ```sh NODE_ENV=test pnpm run preflight:workspace-links && NODE_ENV=test pnpm exec vitest run ui/src/context/SidebarContext.test.tsx ui/src/components/SidebarShell.test.tsx ui/src/components/Sidebar.test.tsx ui/src/components/Layout.test.tsx ui/src/components/RequestCollapsedSidebar.test.tsx ui/src/components/SidebarNavItem.test.tsx ui/src/components/SidebarAgents.test.tsx ui/src/components/SidebarProjects.test.tsx ui/src/components/KeyboardShortcutsCheatsheet.test.tsx ui/src/hooks/useKeyboardShortcuts.test.tsx ``` Result: 10 test files passed, 88 tests passed. Additional follow-up verification passed after review fixes: ```sh NODE_ENV=test pnpm run preflight:workspace-links && NODE_ENV=test pnpm exec vitest run ui/src/components/Layout.test.tsx ui/src/context/SidebarContext.test.tsx && pnpm --filter /ui typecheck ``` Result: 2 test files passed, 28 tests passed, and UI typecheck passed. Latest PR-head remote checks: Paperclip PR workflow, Snyk, Socket, and Greptile are green; commitperclip `review` is cancelled in its security-gate step after filing a non-blocking neutral `security-review` check. Notes: - A direct run without `NODE_ENV=test` loads React's production build in this workspace, where `act` is unavailable; the command above matches the repo stable runner's test environment. - I did not run Playwright/browser e2e or full workspace build/typecheck in this PR-creation heartbeat. - QA screenshots are attached in https://github.com/paperclipai/paperclip/pull/7824#issuecomment-4661968387 for expanded, collapsed rail, hover peek, and settings secondary-sidebar states. ## Risks - Medium UI layout risk: this changes the board shell and primary sidebar composition across many routes. - Local storage migration risk is low: new collapsed state uses a new key and existing width storage remains scoped to the sidebar width. - Plugin route risk: plugin `routeSidebar` slots now render as secondary panes on desktop, so plugin authors should confirm their route sidebar content fits a 240px contextual pane. - Mobile risk appears low because mobile keeps the drawer model and gates collapsed/peek behavior to desktop. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used OpenAI Codex coding agent based on GPT-5, with local shell/git/GitHub CLI tool use. Exact service-side model identifier and context window were not exposed in this runtime. ## 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) - [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 - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] If this change affects the UI, I have included before/after screenshots - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [ ] 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: Claude Opus 4.8 <noreply@anthropic.com> Co-authored-by: Paperclip <noreply@paperclip.ing>
380 lines
13 KiB
TypeScript
380 lines
13 KiB
TypeScript
import { useEffect, type ReactNode } from "react";
|
|
import type { Meta, StoryObj } from "@storybook/react-vite";
|
|
import {
|
|
Bot,
|
|
CircleDot,
|
|
House,
|
|
Inbox,
|
|
LayoutDashboard,
|
|
SquarePen,
|
|
Users,
|
|
} from "lucide-react";
|
|
import { BreadcrumbBar } from "@/components/BreadcrumbBar";
|
|
import { CommandPalette } from "@/components/CommandPalette";
|
|
import { CompanySwitcher } from "@/components/CompanySwitcher";
|
|
import { KeyboardShortcutsCheatsheetContent } from "@/components/KeyboardShortcutsCheatsheet";
|
|
import { MobileBottomNav } from "@/components/MobileBottomNav";
|
|
import { PageTabBar } from "@/components/PageTabBar";
|
|
import { Sidebar } from "@/components/Sidebar";
|
|
import { PluginLauncherProvider } from "@/plugins/launchers";
|
|
import { SidebarAccountMenu } from "@/components/SidebarAccountMenu";
|
|
import { SidebarCompanyMenu } from "@/components/SidebarCompanyMenu";
|
|
import { StatusBadge } from "@/components/StatusBadge";
|
|
import { Badge } from "@/components/ui/badge";
|
|
import {
|
|
Command,
|
|
CommandEmpty,
|
|
CommandGroup,
|
|
CommandInput,
|
|
CommandItem,
|
|
CommandList,
|
|
CommandSeparator,
|
|
} from "@/components/ui/command";
|
|
import { Tabs } from "@/components/ui/tabs";
|
|
import { BreadcrumbProvider, useBreadcrumbs, type Breadcrumb } from "@/context/BreadcrumbContext";
|
|
import { useNavigate } from "@/lib/router";
|
|
import { cn } from "@/lib/utils";
|
|
import {
|
|
storybookAgents,
|
|
storybookIssues,
|
|
storybookProjects,
|
|
storybookSidebarBadges,
|
|
} from "../fixtures/paperclipData";
|
|
|
|
function Section({
|
|
eyebrow,
|
|
title,
|
|
children,
|
|
}: {
|
|
eyebrow: string;
|
|
title: string;
|
|
children: ReactNode;
|
|
}) {
|
|
return (
|
|
<section className="paperclip-story__frame overflow-hidden">
|
|
<div className="border-b border-border px-5 py-4">
|
|
<div className="paperclip-story__label">{eyebrow}</div>
|
|
<h2 className="mt-1 text-xl font-semibold">{title}</h2>
|
|
</div>
|
|
<div className="p-5">{children}</div>
|
|
</section>
|
|
);
|
|
}
|
|
|
|
function RouteSetter({ to }: { to: string }) {
|
|
const navigate = useNavigate();
|
|
|
|
useEffect(() => {
|
|
navigate(to, { replace: true });
|
|
}, [navigate, to]);
|
|
|
|
return null;
|
|
}
|
|
|
|
function SidebarShell({ collapsed = false }: { collapsed?: boolean }) {
|
|
return (
|
|
<div className="h-[520px] overflow-hidden border border-border bg-background">
|
|
<div className="flex h-full min-h-0">
|
|
<div className={cn("overflow-hidden transition-[width]", collapsed ? "w-0" : "w-60")}>
|
|
<Sidebar />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
function BreadcrumbScenario({ breadcrumbs }: { breadcrumbs: Breadcrumb[] }) {
|
|
const { setBreadcrumbs } = useBreadcrumbs();
|
|
|
|
useEffect(() => {
|
|
setBreadcrumbs(breadcrumbs);
|
|
}, [breadcrumbs, setBreadcrumbs]);
|
|
|
|
return (
|
|
<div className="overflow-hidden border border-border bg-background">
|
|
<BreadcrumbBar />
|
|
</div>
|
|
);
|
|
}
|
|
|
|
function BreadcrumbSnapshot({ breadcrumbs }: { breadcrumbs: Breadcrumb[] }) {
|
|
return (
|
|
<BreadcrumbProvider>
|
|
<BreadcrumbScenario breadcrumbs={breadcrumbs} />
|
|
</BreadcrumbProvider>
|
|
);
|
|
}
|
|
|
|
const tabItems = [
|
|
{ value: "overview", label: "Overview" },
|
|
{ value: "issues", label: "Issues" },
|
|
{ value: "runs", label: "Runs" },
|
|
{ value: "approvals", label: "Approvals" },
|
|
{ value: "budget", label: "Budget" },
|
|
{ value: "activity", label: "Activity" },
|
|
{ value: "settings", label: "Settings" },
|
|
{ value: "history", label: "History" },
|
|
];
|
|
|
|
const mobileNavItems = [
|
|
{ label: "Home", icon: House },
|
|
{ label: "Issues", icon: CircleDot },
|
|
{ label: "Create", icon: SquarePen },
|
|
{ label: "Agents", icon: Users },
|
|
{ label: "Inbox", icon: Inbox, badge: storybookSidebarBadges.inbox },
|
|
];
|
|
|
|
function MobileBottomNavActiveStateMatrix() {
|
|
return (
|
|
<div className="grid gap-3 sm:grid-cols-2 xl:grid-cols-5">
|
|
{mobileNavItems.map((activeItem) => (
|
|
<div key={activeItem.label} className="overflow-hidden border border-border bg-background">
|
|
<div className="grid h-16 grid-cols-5 px-1">
|
|
{mobileNavItems.map((item) => {
|
|
const Icon = item.icon;
|
|
const active = item.label === activeItem.label;
|
|
return (
|
|
<div
|
|
key={item.label}
|
|
className={cn(
|
|
"relative flex min-w-0 flex-col items-center justify-center gap-1 rounded-md text-[10px] font-medium",
|
|
active ? "text-foreground" : "text-muted-foreground",
|
|
)}
|
|
>
|
|
<span className="relative">
|
|
<Icon className={cn("h-[18px] w-[18px]", active && "stroke-[2.3]")} />
|
|
{item.badge ? (
|
|
<span className="absolute -right-2 -top-2 rounded-full bg-primary px-1.5 py-0.5 text-[10px] leading-none text-primary-foreground">
|
|
{item.badge}
|
|
</span>
|
|
) : null}
|
|
</span>
|
|
<span className="truncate">{item.label}</span>
|
|
</div>
|
|
);
|
|
})}
|
|
</div>
|
|
</div>
|
|
))}
|
|
</div>
|
|
);
|
|
}
|
|
|
|
function CommandResultsSurface() {
|
|
return (
|
|
<Command className="rounded-none border border-border">
|
|
<CommandInput value="story" readOnly placeholder="Search issues, agents, projects..." />
|
|
<CommandList className="max-h-none">
|
|
<CommandGroup heading="Actions">
|
|
<CommandItem>
|
|
<SquarePen className="mr-2 h-4 w-4" />
|
|
Create new issue
|
|
<span className="ml-auto text-xs text-muted-foreground">C</span>
|
|
</CommandItem>
|
|
</CommandGroup>
|
|
<CommandSeparator />
|
|
<CommandGroup heading="Issues">
|
|
{storybookIssues.slice(0, 2).map((issue) => (
|
|
<CommandItem key={issue.id}>
|
|
<CircleDot className="mr-2 h-4 w-4" />
|
|
<span className="mr-2 font-mono text-xs text-muted-foreground">{issue.identifier}</span>
|
|
<span className="flex-1 truncate">{issue.title}</span>
|
|
<StatusBadge status={issue.status} />
|
|
</CommandItem>
|
|
))}
|
|
</CommandGroup>
|
|
<CommandSeparator />
|
|
<CommandGroup heading="Agents">
|
|
{storybookAgents.map((agent) => (
|
|
<CommandItem key={agent.id}>
|
|
<Bot className="mr-2 h-4 w-4" />
|
|
{agent.name}
|
|
<span className="ml-2 text-xs text-muted-foreground">{agent.role}</span>
|
|
</CommandItem>
|
|
))}
|
|
</CommandGroup>
|
|
<CommandSeparator />
|
|
<CommandGroup heading="Projects">
|
|
{storybookProjects.map((project) => (
|
|
<CommandItem key={project.id}>
|
|
<LayoutDashboard className="mr-2 h-4 w-4" />
|
|
{project.name}
|
|
</CommandItem>
|
|
))}
|
|
</CommandGroup>
|
|
</CommandList>
|
|
</Command>
|
|
);
|
|
}
|
|
|
|
function CommandEmptySurface() {
|
|
return (
|
|
<Command className="rounded-none border border-border">
|
|
<CommandInput value="no matching command" readOnly placeholder="Search issues, agents, projects..." />
|
|
<CommandList>
|
|
<CommandEmpty>No results found.</CommandEmpty>
|
|
</CommandList>
|
|
</Command>
|
|
);
|
|
}
|
|
|
|
function NavigationLayoutStories() {
|
|
return (
|
|
<div className="paperclip-story">
|
|
<RouteSetter to="/PAP/projects/board-ui/issues" />
|
|
<main className="paperclip-story__inner max-w-[1320px] space-y-6">
|
|
<section className="paperclip-story__frame p-6">
|
|
<div className="flex flex-wrap items-start justify-between gap-5">
|
|
<div>
|
|
<div className="paperclip-story__label">Navigation and layout</div>
|
|
<h1 className="mt-2 text-3xl font-semibold tracking-tight">Sidebar, command, tabs, and mobile chrome</h1>
|
|
<p className="mt-3 max-w-3xl text-sm leading-6 text-muted-foreground">
|
|
Fixture-backed navigation states for the board shell: company switching, dense work navigation,
|
|
breadcrumbs, command discovery, and mobile entry points.
|
|
</p>
|
|
</div>
|
|
<div className="flex flex-wrap gap-2">
|
|
<Badge variant="outline">fixture backed</Badge>
|
|
<Badge variant="outline">company scoped</Badge>
|
|
<Badge variant="outline">responsive chrome</Badge>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
<Section eyebrow="Sidebar" title="Expanded and collapsed shell states">
|
|
<div className="grid gap-5 xl:grid-cols-[minmax(0,1fr)_220px]">
|
|
<SidebarShell />
|
|
<SidebarShell collapsed />
|
|
</div>
|
|
</Section>
|
|
|
|
<Section eyebrow="Menus" title="Account, company, and switcher menus in open state">
|
|
<div className="grid gap-5 xl:grid-cols-3">
|
|
<div className="relative h-[440px] overflow-hidden border border-border bg-background">
|
|
<div className="absolute bottom-0 left-0 w-72">
|
|
<SidebarAccountMenu
|
|
deploymentMode="authenticated"
|
|
open
|
|
onOpenChange={() => undefined}
|
|
version="0.3.1"
|
|
/>
|
|
</div>
|
|
</div>
|
|
|
|
<div className="h-[260px] overflow-hidden border border-border bg-background p-3">
|
|
<SidebarCompanyMenu open onOpenChange={() => undefined} />
|
|
</div>
|
|
|
|
<div className="h-[320px] overflow-hidden border border-border bg-background p-4">
|
|
<CompanySwitcher open onOpenChange={() => undefined} />
|
|
</div>
|
|
</div>
|
|
</Section>
|
|
|
|
<Section eyebrow="Breadcrumbs" title="Home, project issue, and agent run depth levels">
|
|
<div className="grid gap-4">
|
|
<BreadcrumbSnapshot breadcrumbs={[{ label: "Dashboard", href: "/dashboard" }]} />
|
|
<BreadcrumbSnapshot
|
|
breadcrumbs={[
|
|
{ label: "Projects", href: "/projects" },
|
|
{ label: "Board UI", href: "/projects/board-ui/issues" },
|
|
{ label: "PAP-1641" },
|
|
]}
|
|
/>
|
|
<BreadcrumbSnapshot
|
|
breadcrumbs={[
|
|
{ label: "Agents", href: "/agents" },
|
|
{ label: "CodexCoder", href: "/agents/codexcoder" },
|
|
{ label: "Run run-storybook" },
|
|
]}
|
|
/>
|
|
</div>
|
|
</Section>
|
|
|
|
<Section eyebrow="Page tabs" title="Active and overflow tab bars">
|
|
<div className="space-y-5">
|
|
<Tabs value="issues" className="overflow-x-auto">
|
|
<PageTabBar items={tabItems.slice(0, 4)} value="issues" align="start" />
|
|
</Tabs>
|
|
<Tabs value="activity" className="overflow-x-auto">
|
|
<PageTabBar items={tabItems} value="activity" align="start" />
|
|
</Tabs>
|
|
</div>
|
|
</Section>
|
|
|
|
<Section eyebrow="Mobile bottom nav" title="Actual mobile bar and all active item states">
|
|
<div className="space-y-5">
|
|
<div className="relative h-24 max-w-sm overflow-hidden border border-border bg-background [&>nav]:!absolute [&>nav]:!bottom-0 [&>nav]:!left-0 [&>nav]:!right-0 [&>nav]:!z-0 [&>nav]:!block">
|
|
<MobileBottomNav visible />
|
|
</div>
|
|
<MobileBottomNavActiveStateMatrix />
|
|
</div>
|
|
</Section>
|
|
|
|
<Section eyebrow="Command palette" title="Open command results and empty state">
|
|
<CommandPalette />
|
|
<div className="grid gap-5 xl:grid-cols-2">
|
|
<CommandResultsSurface />
|
|
<CommandEmptySurface />
|
|
</div>
|
|
</Section>
|
|
|
|
<Section eyebrow="Keyboard shortcuts" title="Rendered shortcuts cheatsheet">
|
|
<div className="max-w-md overflow-hidden border border-border bg-background">
|
|
<div className="px-5 pb-3 pt-5">
|
|
<h3 className="text-base font-semibold">Keyboard shortcuts</h3>
|
|
</div>
|
|
<KeyboardShortcutsCheatsheetContent />
|
|
</div>
|
|
</Section>
|
|
</main>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
const meta = {
|
|
title: "Product/Navigation & Layout",
|
|
component: NavigationLayoutStories,
|
|
parameters: {
|
|
docs: {
|
|
description: {
|
|
component:
|
|
"Navigation and layout stories cover the board shell components that orient operators across companies, work surfaces, command search, breadcrumbs, tabs, and mobile navigation.",
|
|
},
|
|
},
|
|
},
|
|
} satisfies Meta<typeof NavigationLayoutStories>;
|
|
|
|
export default meta;
|
|
|
|
type Story = StoryObj<typeof meta>;
|
|
|
|
export const BoardChromeMatrix: Story = {};
|
|
|
|
// PAP-10676 verification harness: renders the real Sidebar at a fixed width so a
|
|
// screenshot of the expanded state and a screenshot of the pinned-collapsed rail
|
|
// can be overlaid. The icon column must be pixel-identical between the two — the
|
|
// only difference should be the labels (sr-only in the rail). Playwright toggles
|
|
// collapse via the in-sidebar control, so this exercises the real context path.
|
|
function SidebarIconAlignmentHarness() {
|
|
return (
|
|
<PluginLauncherProvider>
|
|
<div className="paperclip-story">
|
|
<RouteSetter to="/PAP/projects/board-ui/issues" />
|
|
<div className="flex min-h-[760px] items-start justify-center bg-muted/30 p-8">
|
|
<div
|
|
data-testid="sidebar-align-frame"
|
|
className="h-[700px] w-60 overflow-hidden border border-border bg-background"
|
|
>
|
|
<Sidebar />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</PluginLauncherProvider>
|
|
);
|
|
}
|
|
|
|
export const SidebarIconAlignment: Story = {
|
|
render: () => <SidebarIconAlignmentHarness />,
|
|
};
|