SidebarRail() — ui Function Reference

Architecture documentation for the SidebarRail() function in sidebar.tsx from the ui codebase.

Function tsx DocumentationAtlas SearchAPI calls 1

Entity Profile

DocumentationAtlas→ SearchAPI→ SidebarRail() — ui Function Reference

Dependency Diagram

graph TD
  b4914d34_4bf4_0707_b89a_9653eff9727f["SidebarRail()"]
  cc4e35e8_a38d_157c_ff53_3fbfa32c26c4["sidebar.tsx"]
  b4914d34_4bf4_0707_b89a_9653eff9727f -->|defined in| cc4e35e8_a38d_157c_ff53_3fbfa32c26c4
  8c33e434_24fc_7386_9971_8b2330bfde84["useSidebar()"]
  b4914d34_4bf4_0707_b89a_9653eff9727f -->|calls| 8c33e434_24fc_7386_9971_8b2330bfde84
  style b4914d34_4bf4_0707_b89a_9653eff9727f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/v4/examples/base/ui-rtl/sidebar.tsx lines 279–302

function SidebarRail({ className, ...props }: React.ComponentProps<"button">) {
  const { toggleSidebar } = useSidebar()

  return (
    <button
      data-sidebar="rail"
      data-slot="sidebar-rail"
      aria-label="Toggle Sidebar"
      tabIndex={-1}
      onClick={toggleSidebar}
      title="Toggle Sidebar"
      className={cn(
        "hover:after:bg-sidebar-border absolute inset-y-0 z-20 hidden w-4 transition-all ease-linear group-data-[side=left]:-right-4 group-data-[side=right]:left-0 after:absolute after:inset-y-0 after:start-1/2 after:w-[2px] sm:flex ltr:-translate-x-1/2 rtl:-translate-x-1/2",
        "in-data-[side=left]:cursor-w-resize in-data-[side=right]:cursor-e-resize rtl:in-data-[side=left]:cursor-e-resize rtl:in-data-[side=right]:cursor-w-resize",
        "[[data-side=left][data-state=collapsed]_&]:cursor-e-resize rtl:[[data-side=left][data-state=collapsed]_&]:cursor-w-resize [[data-side=right][data-state=collapsed]_&]:cursor-w-resize rtl:[[data-side=right][data-state=collapsed]_&]:cursor-e-resize",
        "hover:group-data-[collapsible=offcanvas]:bg-sidebar group-data-[collapsible=offcanvas]:translate-x-0 group-data-[collapsible=offcanvas]:after:start-full rtl:group-data-[collapsible=offcanvas]:-translate-x-0",
        "[[data-side=left][data-collapsible=offcanvas]_&]:-end-2",
        "[[data-side=right][data-collapsible=offcanvas]_&]:-start-2",
        className
      )}
      {...props}
    />
  )
}