SidebarTrigger() — ui Function Reference

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

Function tsx ComponentRegistry UIPrimitives calls 1

Entity Profile

ComponentRegistry→ UIPrimitives→ SidebarTrigger() — ui Function Reference

Dependency Diagram

graph TD
  09d3b1ca_0b7d_7464_fc46_f006fb943297["SidebarTrigger()"]
  91f6d996_a9f5_b129_3201_f8eee4d8cf65["sidebar.tsx"]
  09d3b1ca_0b7d_7464_fc46_f006fb943297 -->|defined in| 91f6d996_a9f5_b129_3201_f8eee4d8cf65
  8c62ffec_57d5_c92b_d4f9_ed885df7d00a["useSidebar()"]
  09d3b1ca_0b7d_7464_fc46_f006fb943297 -->|calls| 8c62ffec_57d5_c92b_d4f9_ed885df7d00a
  style 09d3b1ca_0b7d_7464_fc46_f006fb943297 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/v4/registry/bases/base/ui/sidebar.tsx lines 254–285

function SidebarTrigger({
  className,
  onClick,
  ...props
}: React.ComponentProps<typeof Button>) {
  const { toggleSidebar } = useSidebar()

  return (
    <Button
      data-sidebar="trigger"
      data-slot="sidebar-trigger"
      variant="ghost"
      size="icon-sm"
      className={cn("cn-sidebar-trigger", className)}
      onClick={(event) => {
        onClick?.(event)
        toggleSidebar()
      }}
      {...props}
    >
      <IconPlaceholder
        lucide="PanelLeftIcon"
        tabler="IconLayoutSidebar"
        hugeicons="SidebarLeftIcon"
        phosphor="SidebarIcon"
        remixicon="RiSideBarLine"
        className="cn-rtl-flip"
      />
      <span className="sr-only">Toggle Sidebar</span>
    </Button>
  )
}