SidebarMenuButton() — ui Function Reference

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

Function tsx DocumentationAtlas ContentSourcing calls 1

Entity Profile

DocumentationAtlas→ ContentSourcing→ SidebarMenuButton() — ui Function Reference

Dependency Diagram

graph TD
  6dda20f9_caec_7e22_afaf_af3322019b0b["SidebarMenuButton()"]
  334954a9_5573_f901_08c0_da02d404f69b["sidebar.tsx"]
  6dda20f9_caec_7e22_afaf_af3322019b0b -->|defined in| 334954a9_5573_f901_08c0_da02d404f69b
  363cda72_4f98_6d25_8ff6_0da233bec045["useSidebar()"]
  6dda20f9_caec_7e22_afaf_af3322019b0b -->|calls| 363cda72_4f98_6d25_8ff6_0da233bec045
  style 6dda20f9_caec_7e22_afaf_af3322019b0b fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/v4/examples/base/ui/sidebar.tsx lines 498–550

function SidebarMenuButton({
  render,
  isActive = false,
  variant = "default",
  size = "default",
  tooltip,
  className,
  ...props
}: useRender.ComponentProps<"button"> &
  React.ComponentProps<"button"> & {
    isActive?: boolean
    tooltip?: string | React.ComponentProps<typeof TooltipContent>
  } & VariantProps<typeof sidebarMenuButtonVariants>) {
  const { isMobile, state } = useSidebar()
  const comp = useRender({
    defaultTagName: "button",
    props: mergeProps<"button">(
      {
        className: cn(sidebarMenuButtonVariants({ variant, size }), className),
      },
      props
    ),
    render: !tooltip ? render : TooltipTrigger,
    state: {
      slot: "sidebar-menu-button",
      sidebar: "menu-button",
      size,
      active: isActive,
    },
  })

  if (!tooltip) {
    return comp
  }

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

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