Home / Function/ SidebarTrigger() — ui Function Reference

SidebarTrigger() — ui Function Reference

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

Entity Profile

Dependency Diagram

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

Relationship Graph

Source Code

apps/v4/examples/base/ui-rtl/sidebar.tsx lines 253–277

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(className)}
      onClick={(event) => {
        onClick?.(event)
        toggleSidebar()
      }}
      {...props}
    >
      <PanelLeftIcon className="rtl:rotate-180" />
      <span className="sr-only">Toggle Sidebar</span>
    </Button>
  )
}

Subdomains

Calls

Frequently Asked Questions

What does SidebarTrigger() do?
SidebarTrigger() is a function in the ui codebase, defined in apps/v4/examples/base/ui-rtl/sidebar.tsx.
Where is SidebarTrigger() defined?
SidebarTrigger() is defined in apps/v4/examples/base/ui-rtl/sidebar.tsx at line 253.
What does SidebarTrigger() call?
SidebarTrigger() calls 1 function(s): useSidebar.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free