API Reference@helix-hq/design-system

components/sidebar

Public API of @helix-hq/design-system/components/sidebar.

The complete public surface of @helix-hq/design-system/components/sidebar, generated from the published type declarations. Anything absent here is not part of the package's contract.

import { ClassProp } from 'class-variance-authority/types';
import { ComponentProps } from 'react';
import { JSX } from 'react';
import * as React_2 from 'react';
import { Separator as Separator_2 } from 'radix-ui';
import { Tooltip } from 'radix-ui';
import { VariantProps } from 'class-variance-authority';

// @public (undocumented)
export const Sidebar: (input: React_2.ComponentProps<'div'> & {
    side?: 'left' | 'right';
    variant?: 'sidebar' | 'floating' | 'inset';
    collapsible?: 'offcanvas' | 'icon' | 'none';
}) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarContent: (input: React_2.ComponentProps<'div'>) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarFooter: (input: React_2.ComponentProps<'div'>) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarGroup: (input: React_2.ComponentProps<'div'>) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarGroupAction: (input: React_2.ComponentProps<'button'> & {
    asChild?: boolean;
}) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarGroupContent: (input: React_2.ComponentProps<'div'>) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarGroupLabel: (input: React_2.ComponentProps<'div'> & {
    asChild?: boolean;
}) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarHeader: (input: React_2.ComponentProps<'div'>) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarInput: (input: React_2.ComponentProps<typeof Input>) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarInset: (input: React_2.ComponentProps<'main'>) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarMenu: (input: React_2.ComponentProps<'ul'>) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarMenuAction: (input: React_2.ComponentProps<'button'> & {
    asChild?: boolean;
    showOnHover?: boolean;
}) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarMenuBadge: (input: React_2.ComponentProps<'div'>) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarMenuButton: (input: React_2.ComponentProps<'button'> & {
    asChild?: boolean;
    isActive?: boolean;
    tooltip?: string | React_2.ComponentProps<typeof TooltipContent>;
} & VariantProps<typeof sidebarMenuButtonVariants>) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarMenuItem: (input: React_2.ComponentProps<'li'>) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarMenuSkeleton: (input: React_2.ComponentProps<'div'> & {
    showIcon?: boolean;
}) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarMenuSub: (input: React_2.ComponentProps<'ul'>) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarMenuSubButton: (input: React_2.ComponentProps<'a'> & {
    asChild?: boolean;
    size?: 'sm' | 'md';
    isActive?: boolean;
}) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarMenuSubItem: (input: React_2.ComponentProps<'li'>) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarProvider: (input: React_2.ComponentProps<'div'> & {
    defaultOpen?: boolean;
    open?: boolean;
    onOpenChange?: (open: boolean) => void;
}) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarRail: (input: React_2.ComponentProps<'button'>) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarSeparator: (input: React_2.ComponentProps<typeof Separator>) => React_2.JSX.Element;

// @public (undocumented)
export const SidebarTrigger: (input: React_2.ComponentProps<typeof Button>) => React_2.JSX.Element;

// @public (undocumented)
export const useSidebar: () => SidebarContextProps;

// (No @packageDocumentation comment for this package)

On this page

No Headings