SidebarMenuButton() — ui Function Reference

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

Function tsx DocumentationAtlas SearchAPI calls 1

Entity Profile

DocumentationAtlas→ SearchAPI→ SidebarMenuButton() — ui Function Reference

Dependency Diagram

graph TD
  df86aa05_efcc_0307_8007_bf6d28de89cd["SidebarMenuButton()"]
  403a7802_5284_b88e_6793_ca6286c4d07c["sidebar.tsx"]
  df86aa05_efcc_0307_8007_bf6d28de89cd -->|defined in| 403a7802_5284_b88e_6793_ca6286c4d07c
  1f9f6fed_bfb5_58df_017b_cc77688dfff3["useSidebar()"]
  df86aa05_efcc_0307_8007_bf6d28de89cd -->|calls| 1f9f6fed_bfb5_58df_017b_cc77688dfff3
  style df86aa05_efcc_0307_8007_bf6d28de89cd fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/v4/examples/radix/ui-rtl/sidebar.tsx lines 489–537

function SidebarMenuButton({
  asChild = false,
  isActive = false,
  variant = "default",
  size = "default",
  tooltip,
  className,
  ...props
}: React.ComponentProps<"button"> & {
  asChild?: boolean
  isActive?: boolean
  tooltip?: string | React.ComponentProps<typeof TooltipContent>
} & VariantProps<typeof sidebarMenuButtonVariants>) {
  const Comp = asChild ? Slot.Root : "button"
  const { isMobile, state } = useSidebar()

  const button = (
    <Comp
      data-slot="sidebar-menu-button"
      data-sidebar="menu-button"
      data-size={size}
      data-active={isActive}
      className={cn(sidebarMenuButtonVariants({ variant, size }), className)}
      {...props}
    />
  )

  if (!tooltip) {
    return button
  }

  if (typeof tooltip === "string") {
    tooltip = {
      children: tooltip,
    }
  }

  return (
    <Tooltip>
      <TooltipTrigger asChild>{button}</TooltipTrigger>
      <TooltipContent
        side="right"
        align="center"
        hidden={state !== "collapsed" || isMobile}
        {...tooltip}
      />
    </Tooltip>
  )
}