Skip to main content

Sidebar

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

PropTypeRequiredDefaultDescription
sideenumleft-
variantenumsidebar-
collapsibleenumoffcanvas-

Usage

import { Sidebar } from '@databricks/appkit-ui';

<Sidebar /* props */ />

SidebarContent

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

This component extends standard HTML element attributes.

Usage

import { SidebarContent } from '@databricks/appkit-ui';

<SidebarContent /* props */ />

SidebarFooter

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

This component extends standard HTML element attributes.

Usage

import { SidebarFooter } from '@databricks/appkit-ui';

<SidebarFooter /* props */ />

SidebarGroup

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

This component extends standard HTML element attributes.

Usage

import { SidebarGroup } from '@databricks/appkit-ui';

<SidebarGroup /* props */ />

SidebarGroupAction

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

PropTypeRequiredDefaultDescription
asChildbooleanfalse-

Usage

import { SidebarGroupAction } from '@databricks/appkit-ui';

<SidebarGroupAction /* props */ />

SidebarGroupContent

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

This component extends standard HTML element attributes.

Usage

import { SidebarGroupContent } from '@databricks/appkit-ui';

<SidebarGroupContent /* props */ />

SidebarGroupLabel

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

PropTypeRequiredDefaultDescription
asChildbooleanfalse-

Usage

import { SidebarGroupLabel } from '@databricks/appkit-ui';

<SidebarGroupLabel /* props */ />

SidebarHeader

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

This component extends standard HTML element attributes.

Usage

import { SidebarHeader } from '@databricks/appkit-ui';

<SidebarHeader /* props */ />

SidebarInput

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

This component extends standard HTML element attributes.

Usage

import { SidebarInput } from '@databricks/appkit-ui';

<SidebarInput /* props */ />

SidebarInset

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

This component extends standard HTML element attributes.

Usage

import { SidebarInset } from '@databricks/appkit-ui';

<SidebarInset /* props */ />

SidebarMenu

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

This component extends standard HTML element attributes.

Usage

import { SidebarMenu } from '@databricks/appkit-ui';

<SidebarMenu /* props */ />

SidebarMenuAction

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

PropTypeRequiredDefaultDescription
asChildbooleanfalse-
showOnHoverbooleanfalse-

Usage

import { SidebarMenuAction } from '@databricks/appkit-ui';

<SidebarMenuAction /* props */ />

SidebarMenuBadge

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

This component extends standard HTML element attributes.

Usage

import { SidebarMenuBadge } from '@databricks/appkit-ui';

<SidebarMenuBadge /* props */ />

SidebarMenuButton

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

PropTypeRequiredDefaultDescription
asChildbooleanfalse-
isActivebooleanfalse-
tooltipstring | (TooltipContentProps & RefAttributes<HTMLDivElement>)--
variant"default" | "outline" | nulldefault-
size"default" | "sm" | "lg" | nulldefault-

Usage

import { SidebarMenuButton } from '@databricks/appkit-ui';

<SidebarMenuButton /* props */ />

SidebarMenuItem

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

This component extends standard HTML element attributes.

Usage

import { SidebarMenuItem } from '@databricks/appkit-ui';

<SidebarMenuItem /* props */ />

SidebarMenuSkeleton

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

PropTypeRequiredDefaultDescription
showIconbooleanfalse-

Usage

import { SidebarMenuSkeleton } from '@databricks/appkit-ui';

<SidebarMenuSkeleton /* props */ />

SidebarMenuSub

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

This component extends standard HTML element attributes.

Usage

import { SidebarMenuSub } from '@databricks/appkit-ui';

<SidebarMenuSub /* props */ />

SidebarMenuSubButton

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

PropTypeRequiredDefaultDescription
asChildbooleanfalse-
sizeenummd-
isActivebooleanfalse-

Usage

import { SidebarMenuSubButton } from '@databricks/appkit-ui';

<SidebarMenuSubButton /* props */ />

SidebarMenuSubItem

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

This component extends standard HTML element attributes.

Usage

import { SidebarMenuSubItem } from '@databricks/appkit-ui';

<SidebarMenuSubItem /* props */ />

SidebarProvider

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

PropTypeRequiredDefaultDescription
defaultOpenbooleantrue-
openboolean--
onOpenChange((open: boolean) => void)--

Usage

import { SidebarProvider } from '@databricks/appkit-ui';

<SidebarProvider /* props */ />

SidebarRail

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

This component extends standard HTML element attributes.

Usage

import { SidebarRail } from '@databricks/appkit-ui';

<SidebarRail /* props */ />

SidebarSeparator

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

PropTypeRequiredDefaultDescription
orientationenumverticalEither vertical or horizontal. Defaults to horizontal.
decorativeboolean-Whether or not the component is purely decorative. When true, accessibility-related attributes are updated so that that the rendered element is removed from the accessibility tree.
asChildboolean--

Usage

import { SidebarSeparator } from '@databricks/appkit-ui';

<SidebarSeparator /* props */ />

SidebarTrigger

Source: packages/appkit-ui/src/react/ui/sidebar.tsx

Props

PropTypeRequiredDefaultDescription
variant"link" | "default" | "destructive" | "secondary" | "outline" | "ghost" | null--
size"default" | "sm" | "lg" | "icon" | "icon-sm" | "icon-lg" | null--
asChildboolean--

Usage

import { SidebarTrigger } from '@databricks/appkit-ui';

<SidebarTrigger /* props */ />