mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-27 02:44:50 +01:00
## 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>
185 lines
6.8 KiB
TypeScript
185 lines
6.8 KiB
TypeScript
import { createContext, useContext, type ReactNode } from "react";
|
|
import { NavLink } from "@/lib/router";
|
|
import { SIDEBAR_SCROLL_RESET_STATE } from "../lib/navigation-scroll";
|
|
import { cn, SIDEBAR_RAIL_HIDDEN_LABEL } from "../lib/utils";
|
|
import { useSidebar } from "../context/SidebarContext";
|
|
import { Tooltip, TooltipContent, TooltipTrigger } from "@/components/ui/tooltip";
|
|
import type { LucideIcon } from "lucide-react";
|
|
|
|
/**
|
|
* Forces the full-label (non-rail) presentation for any `SidebarNavItem`
|
|
* rendered beneath it, regardless of the global `useSidebar().collapsed` state.
|
|
*
|
|
* Takeover routes (PAP-10695) collapse the app `<Sidebar/>` to its 64px rail
|
|
* and render the contextual nav in a fixed 240px `SecondarySidebar`. That pane
|
|
* is always wide enough for labels, but its `SidebarNavItem` children still
|
|
* read the *global* `collapsed=true` and would otherwise render icon-only —
|
|
* leaving the settings nav unreadable (PAP-10700). Wrapping the pane in this
|
|
* provider decouples its items from the global rail collapse.
|
|
*/
|
|
const SidebarNavExpandedContext = createContext(false);
|
|
|
|
export function SidebarNavExpandedProvider({ children }: { children: ReactNode }) {
|
|
return (
|
|
<SidebarNavExpandedContext.Provider value={true}>
|
|
{children}
|
|
</SidebarNavExpandedContext.Provider>
|
|
);
|
|
}
|
|
|
|
export function useSidebarNavExpanded() {
|
|
return useContext(SidebarNavExpandedContext);
|
|
}
|
|
|
|
interface SidebarNavItemProps {
|
|
to: string;
|
|
label: string;
|
|
icon: LucideIcon;
|
|
end?: boolean;
|
|
className?: string;
|
|
badge?: number;
|
|
badgeTone?: "default" | "danger";
|
|
/**
|
|
* Accessible noun for the numeric badge when collapsed to the rail, where the
|
|
* count is rendered as a dot (e.g. `badgeLabel="unread"` → "Inbox, 28 unread").
|
|
*/
|
|
badgeLabel?: string;
|
|
textBadge?: string;
|
|
textBadgeTone?: "default" | "amber";
|
|
alert?: boolean;
|
|
liveCount?: number;
|
|
}
|
|
|
|
export function SidebarNavItem({
|
|
to,
|
|
label,
|
|
icon: Icon,
|
|
end,
|
|
className,
|
|
badge,
|
|
badgeTone = "default",
|
|
badgeLabel,
|
|
textBadge,
|
|
textBadgeTone = "default",
|
|
alert = false,
|
|
liveCount,
|
|
}: SidebarNavItemProps) {
|
|
const { isMobile, setSidebarOpen, collapsed, peeking } = useSidebar();
|
|
// A fixed-width contextual pane (SecondarySidebar) forces full labels even
|
|
// when the global app sidebar is collapsed to its rail (PAP-10700).
|
|
const forceExpanded = useSidebarNavExpanded();
|
|
// The icon-only rail presentation only applies when pinned collapsed and not
|
|
// peeking; a peek/expanded panel — or an expanded contextual pane — restores
|
|
// the full label + badge.
|
|
const rail = collapsed && !peeking && !forceExpanded;
|
|
|
|
const hasBadge = badge != null && badge > 0;
|
|
const hasLive = liveCount != null && liveCount > 0;
|
|
|
|
// Accessible text equivalent for the collapsed dot indicator. The visible
|
|
// label is `sr-only` in the rail, so the count must be surfaced here.
|
|
const railAriaLabel = !rail
|
|
? undefined
|
|
: hasLive
|
|
? `${label}, ${liveCount} live`
|
|
: hasBadge
|
|
? `${label}, ${badge}${badgeLabel ? ` ${badgeLabel}` : ""}`
|
|
: alert
|
|
? `${label}, attention needed`
|
|
: undefined;
|
|
|
|
const link = (
|
|
<NavLink
|
|
to={to}
|
|
state={SIDEBAR_SCROLL_RESET_STATE}
|
|
end={end}
|
|
aria-label={railAriaLabel}
|
|
onClick={() => { if (isMobile) setSidebarOpen(false); }}
|
|
className={({ isActive }) =>
|
|
cn(
|
|
"flex items-center gap-2.5 px-3 py-2 pointer-coarse:py-1.5 text-[13px] font-medium transition-colors",
|
|
isActive
|
|
? "bg-accent text-foreground"
|
|
: "text-foreground/80 hover:bg-accent/50 hover:text-foreground",
|
|
className,
|
|
)
|
|
}
|
|
>
|
|
<span className="relative shrink-0">
|
|
<Icon className="h-4 w-4" />
|
|
{alert && (
|
|
<span className="absolute -right-0.5 -top-0.5 h-2 w-2 rounded-full bg-red-500 shadow-[0_0_0_2px_hsl(var(--background))]" aria-hidden="true" />
|
|
)}
|
|
{/* Collapsed rail: numeric badge / live count collapse to a dot on the
|
|
icon. The icon markup is untouched so it stays pixel-aligned. */}
|
|
{rail && !alert && hasLive && (
|
|
<span className="absolute -right-0.5 -top-0.5 flex h-2 w-2" aria-hidden="true">
|
|
<span className="animate-pulse absolute inline-flex h-full w-full rounded-full bg-blue-400 opacity-75" />
|
|
<span className="relative inline-flex h-2 w-2 rounded-full bg-blue-500 shadow-[0_0_0_2px_hsl(var(--background))]" />
|
|
</span>
|
|
)}
|
|
{rail && !alert && !hasLive && hasBadge && (
|
|
<span
|
|
className={cn(
|
|
"absolute -right-0.5 -top-0.5 h-2 w-2 rounded-full shadow-[0_0_0_2px_hsl(var(--background))]",
|
|
badgeTone === "danger" ? "bg-red-600" : "bg-primary",
|
|
)}
|
|
aria-hidden="true"
|
|
/>
|
|
)}
|
|
</span>
|
|
<span className={rail ? SIDEBAR_RAIL_HIDDEN_LABEL : "flex-1 truncate"}>{label}</span>
|
|
{!rail && textBadge && (
|
|
<span
|
|
className={cn(
|
|
"ml-auto rounded-full px-1.5 py-0.5 text-[10px] font-medium leading-none",
|
|
textBadgeTone === "amber"
|
|
? "bg-amber-100 text-amber-800 dark:bg-amber-900/30 dark:text-amber-400"
|
|
: "bg-muted text-muted-foreground",
|
|
)}
|
|
>
|
|
{textBadge}
|
|
</span>
|
|
)}
|
|
{!rail && hasLive && (
|
|
<span className="ml-auto flex items-center gap-1.5">
|
|
<span className="relative flex h-2 w-2">
|
|
<span className="animate-pulse absolute inline-flex h-full w-full rounded-full bg-blue-400 opacity-75" />
|
|
<span className="relative inline-flex rounded-full h-2 w-2 bg-blue-500" />
|
|
</span>
|
|
<span className="text-[11px] font-medium text-blue-600 dark:text-blue-400">{liveCount} live</span>
|
|
</span>
|
|
)}
|
|
{!rail && hasBadge && (
|
|
<span
|
|
className={cn(
|
|
"ml-auto rounded-full px-1.5 py-0.5 text-xs leading-none",
|
|
badgeTone === "danger"
|
|
? "bg-red-600/90 text-red-50"
|
|
: "bg-primary text-primary-foreground",
|
|
)}
|
|
>
|
|
{badge}
|
|
</span>
|
|
)}
|
|
</NavLink>
|
|
);
|
|
|
|
if (!rail) return link;
|
|
|
|
// The tooltip wraps a plain block element rather than the NavLink directly:
|
|
// Radix `asChild` (Slot) drops React Router's *function* className, which would
|
|
// strip `flex` off the <a> and render it as a block — the in-flow label would
|
|
// then stack under the icon and the row would grow. Anchoring the tooltip to a
|
|
// wrapper keeps the <a> rendering normally (flex), so the row stays 1:1 with
|
|
// the expanded state and the icon never moves (PAP-10676).
|
|
return (
|
|
<Tooltip>
|
|
<TooltipTrigger asChild>
|
|
<div>{link}</div>
|
|
</TooltipTrigger>
|
|
<TooltipContent side="right">{label}</TooltipContent>
|
|
</Tooltip>
|
|
);
|
|
}
|