UNPKG

@neynar/ui

Version:

React UI component library built on shadcn/ui and Tailwind CSS

54 lines (44 loc) 1.31 kB
# BreadcrumbList **Type**: component Ordered list container for breadcrumb items Provides the structured list layout for breadcrumb navigation items with responsive spacing and text overflow handling. Uses semantic `ol` element for proper accessibility and screen reader navigation. Contains flexible layout with word breaking and responsive gap adjustments. ## JSX Usage ```jsx import { BreadcrumbList } from '@neynar/ui'; <BreadcrumbList className="value" > {/* Your content here */} </BreadcrumbList> ``` ## Component Props ### className - **Type**: `string` - **Required**: No - **Description**: Additional CSS classes to apply to the ordered list element ### children - **Type**: `React.ReactNode` - **Required**: No - **Description**: Child breadcrumb items (BreadcrumbItem elements) ## Examples ### Example 1 ```tsx // Basic list with multiple items <BreadcrumbList> <BreadcrumbItem> <BreadcrumbLink href="/">Home</BreadcrumbLink> </BreadcrumbItem> <BreadcrumbSeparator /> <BreadcrumbItem> <BreadcrumbPage>Current</BreadcrumbPage> </BreadcrumbItem> </BreadcrumbList> ``` ### Example 2 ```tsx // With custom styling <BreadcrumbList className="gap-4 text-base"> <BreadcrumbItem> <BreadcrumbLink href="/">Home</BreadcrumbLink> </BreadcrumbItem> </BreadcrumbList> ```