@neynar/ui 0.3.0 → 0.4.0

package/.llm/blockquote.llm.md

@@ -0,0 +1,55 @@
+# Blockquote
+
+**Type**: component
+
+Blockquote - Quoted text component Semantic blockquote element for extended quotations and excerpts. Features italic styling and left border for visual distinction. Defaults to blockquote element.
+
+## JSX Usage
+
+```jsx
+import { Blockquote } from '@neynar/ui';
+
+<Blockquote
+  as={value}
+  className="value"
+>
+  {/* Your content here */}
+</Blockquote>
+```
+
+## Component Props
+
+### as
+- **Type**: `React.ElementType`
+- **Required**: No
+- **Description**: HTML element to render
+
+### className
+- **Type**: `string`
+- **Required**: No
+- **Description**: Additional Tailwind classes
+
+### children
+- **Type**: `React.ReactNode`
+- **Required**: No
+- **Description**: Content to render
+
+## Examples
+
+```tsx
+// Simple quote
+<Blockquote>
+  "The best way to predict the future is to invent it."
+</Blockquote>
+// With attribution
+<div>
+  <Blockquote>
+    "Building great products requires deep understanding of user needs."
+  </Blockquote>
+  <Caption className="mt-2">— Product Team</Caption>
+</div>
+// Custom styling
+<Blockquote className="bg-muted/50 p-4 rounded-lg">
+  Customer testimonial or feedback.
+</Blockquote>
+```

package/.llm/body-text-large.llm.md

@@ -0,0 +1,49 @@
+# BodyTextLarge
+
+**Type**: component
+
+BodyTextLarge - Emphasized body text component Larger body text for lead paragraphs and emphasized content. Uses text-lg (18px) with relaxed line height. Defaults to p element.
+
+## JSX Usage
+
+```jsx
+import { BodyTextLarge } from '@neynar/ui';
+
+<BodyTextLarge
+  as={value}
+  className="value"
+>
+  {/* Your content here */}
+</BodyTextLarge>
+```
+
+## Component Props
+
+### as
+- **Type**: `React.ElementType`
+- **Required**: No
+- **Description**: HTML element to render
+
+### className
+- **Type**: `string`
+- **Required**: No
+- **Description**: Additional Tailwind classes
+
+### children
+- **Type**: `React.ReactNode`
+- **Required**: No
+- **Description**: Content to render
+
+## Examples
+
+```tsx
+// Lead paragraph
+<BodyTextLarge>
+  This is a lead paragraph that introduces the main content.
+</BodyTextLarge>
+// Emphasized content
+<BodyTextLarge className="font-medium text-accent">
+  Important announcement text.
+</BodyTextLarge>
+```
+/

package/.llm/body-text-small.llm.md

@@ -0,0 +1,49 @@
+# BodyTextSmall
+
+**Type**: component
+
+BodyTextSmall - De-emphasized body text component Smaller body text for less prominent content. Uses text-sm (14px) with normal line height. Defaults to p element.
+
+## JSX Usage
+
+```jsx
+import { BodyTextSmall } from '@neynar/ui';
+
+<BodyTextSmall
+  as={value}
+  className="value"
+>
+  {/* Your content here */}
+</BodyTextSmall>
+```
+
+## Component Props
+
+### as
+- **Type**: `React.ElementType`
+- **Required**: No
+- **Description**: HTML element to render
+
+### className
+- **Type**: `string`
+- **Required**: No
+- **Description**: Additional Tailwind classes
+
+### children
+- **Type**: `React.ReactNode`
+- **Required**: No
+- **Description**: Content to render
+
+## Examples
+
+```tsx
+// Small body text
+<BodyTextSmall>
+  This is smaller, less prominent body text.
+</BodyTextSmall>
+// Helper text
+<BodyTextSmall className="text-muted-foreground">
+  Additional context or helper information.
+</BodyTextSmall>
+```
+/

package/.llm/body-text.llm.md

@@ -0,0 +1,52 @@
+# BodyText
+
+**Type**: component
+
+BodyText - Primary paragraph text component Standard paragraph element for readable body text. Uses text-base (16px) with relaxed line height for optimal readability. Defaults to p element.
+
+## JSX Usage
+
+```jsx
+import { BodyText } from '@neynar/ui';
+
+<BodyText
+  as={value}
+  className="value"
+>
+  {/* Your content here */}
+</BodyText>
+```
+
+## Component Props
+
+### as
+- **Type**: `React.ElementType`
+- **Required**: No
+- **Description**: HTML element to render
+
+### className
+- **Type**: `string`
+- **Required**: No
+- **Description**: Additional Tailwind classes
+
+### children
+- **Type**: `React.ReactNode`
+- **Required**: No
+- **Description**: Content to render
+
+## Examples
+
+```tsx
+// Default usage
+<BodyText>
+  This is standard body text that provides information to the user.
+</BodyText>
+// With custom styling
+<BodyText className="text-muted-foreground">
+  Secondary information with reduced visual prominence.
+</BodyText>
+// As different element
+<BodyText as="div">
+  Body text in a div container.
+</BodyText>
+```

package/.llm/breadcrumb-ellipsis.llm.md

@@ -0,0 +1,73 @@
+# BreadcrumbEllipsis
+
+**Type**: component
+
+Ellipsis indicator for collapsed breadcrumb items Shows a horizontal ellipsis icon (MoreHorizontal) to indicate hidden or collapsed middle items in a long breadcrumb trail. Essential for deep navigation hierarchies where space is limited or mobile responsive design. Commonly used in combination with dropdown menus, popovers, or expandable sections to reveal the collapsed breadcrumb items on user interaction. The component provides a consistent 36px (9 × 4px) clickable area for better touch interaction when used as a trigger for dropdown menus. Includes hidden screen reader text to provide context about the collapsed content.
+
+## JSX Usage
+
+```jsx
+import { BreadcrumbEllipsis } from '@neynar/ui';
+
+<BreadcrumbEllipsis
+  className="value"
+>
+  {/* Your content here */}
+</BreadcrumbEllipsis>
+```
+
+## Component Props
+
+### className
+- **Type**: `string`
+- **Required**: No
+- **Description**: Additional CSS classes to apply to the ellipsis container
+
+### children
+- **Type**: `React.ReactNode`
+- **Required**: No
+- **Description**: Custom content to display instead of the default MoreHorizontal icon (rarely needed)
+
+## Examples
+
+### Example 1
+```tsx
+// Simple static ellipsis
+<BreadcrumbEllipsis />
+```
+### Example 2
+```tsx
+// Interactive ellipsis with dropdown menu
+<BreadcrumbItem>
+  <DropdownMenu>
+    <DropdownMenuTrigger asChild>
+      <BreadcrumbEllipsis className="hover:bg-muted cursor-pointer" />
+    </DropdownMenuTrigger>
+    <DropdownMenuContent>
+      <DropdownMenuItem>
+        <BreadcrumbLink href="/level1">Level 1</BreadcrumbLink>
+      </DropdownMenuItem>
+      <DropdownMenuItem>
+        <BreadcrumbLink href="/level1/level2">Level 2</BreadcrumbLink>
+      </DropdownMenuItem>
+    </DropdownMenuContent>
+  </DropdownMenu>
+</BreadcrumbItem>
+```
+### Example 3
+```tsx
+// With popover for collapsed items
+<BreadcrumbItem>
+  <Popover>
+    <PopoverTrigger asChild>
+      <BreadcrumbEllipsis className="hover:bg-accent" />
+    </PopoverTrigger>
+    <PopoverContent>
+      <div className="space-y-2">
+        <BreadcrumbLink href="/hidden1">Hidden Item 1</BreadcrumbLink>
+        <BreadcrumbLink href="/hidden2">Hidden Item 2</BreadcrumbLink>
+      </div>
+    </PopoverContent>
+  </Popover>
+</BreadcrumbItem>
+```

package/.llm/breadcrumb-item.llm.md

@@ -0,0 +1,53 @@
+# BreadcrumbItem
+
+**Type**: component
+
+Individual breadcrumb list item container Wraps breadcrumb content (links, pages, separators) in a semantic list item. Provides consistent alignment and spacing for breadcrumb elements with inline flex layout for proper icon and text alignment.
+
+## JSX Usage
+
+```jsx
+import { BreadcrumbItem } from '@neynar/ui';
+
+<BreadcrumbItem
+  className="value"
+>
+  {/* Your content here */}
+</BreadcrumbItem>
+```
+
+## Component Props
+
+### className
+- **Type**: `string`
+- **Required**: No
+- **Description**: Additional CSS classes to apply to the list item element
+
+### children
+- **Type**: `React.ReactNode`
+- **Required**: No
+- **Description**: Content to display within the item (links, pages, separators, ellipsis)
+
+## Examples
+
+### Example 1
+```tsx
+// With link
+<BreadcrumbItem>
+  <BreadcrumbLink href="/products">Products</BreadcrumbLink>
+</BreadcrumbItem>
+```
+### Example 2
+```tsx
+// With current page
+<BreadcrumbItem>
+  <BreadcrumbPage>Current Page</BreadcrumbPage>
+</BreadcrumbItem>
+```
+### Example 3
+```tsx
+// With separator
+<BreadcrumbItem>
+  <BreadcrumbSeparator />
+</BreadcrumbItem>
+```

package/.llm/breadcrumb-link.llm.md

@@ -0,0 +1,84 @@
+# BreadcrumbLink
+
+**Type**: component
+
+Navigable link within breadcrumb trail Represents a clickable parent page in the breadcrumb hierarchy with smooth hover effects and transition animations. Supports composition via the `asChild` prop for seamless integration with routing libraries like Next.js Link, React Router, or Reach Router using the Radix UI Slot primitive for prop merging. Built on Radix UI Slot primitive which enables the asChild pattern - when asChild is true, the component merges its props with the immediate child element instead of rendering its own anchor tag. This allows for flexible composition while maintaining consistent styling and behavior.
+
+## JSX Usage
+
+```jsx
+import { BreadcrumbLink } from '@neynar/ui';
+
+<BreadcrumbLink
+  asChild={true}
+  className="value"
+  href="value"
+  onClick={handleClick}
+>
+  {/* Your content here */}
+</BreadcrumbLink>
+```
+
+## Component Props
+
+### asChild
+- **Type**: `boolean`
+- **Required**: No
+- **Description**: When true, merges props with child element instead of rendering anchor. Enables composition with routing components
+
+### className
+- **Type**: `string`
+- **Required**: No
+- **Description**: Additional CSS classes to apply to the link element
+
+### href
+- **Type**: `string`
+- **Required**: No
+- **Description**: Link destination URL (when asChild is false)
+
+### children
+- **Type**: `React.ReactNode`
+- **Required**: No
+- **Description**: Link content to display (text, icons, etc.)
+
+### onClick
+- **Type**: `(event: React.MouseEvent<HTMLAnchorElement>) => void`
+- **Required**: No
+- **Description**: Click handler for the link interaction
+
+## Examples
+
+### Example 1
+```tsx
+// Standard anchor link
+<BreadcrumbLink href="/products">Products</BreadcrumbLink>
+```
+### Example 2
+```tsx
+// With Next.js Link using asChild
+import { Link } from "next/link"
+<BreadcrumbLink asChild>
+  <Link href="/products">Products</Link>
+</BreadcrumbLink>
+```
+### Example 3
+```tsx
+// With React Router Link
+import { Link } from "react-router-dom"
+<BreadcrumbLink asChild>
+  <Link to="/products">Products</Link>
+</BreadcrumbLink>
+```
+### Example 4
+```tsx
+// With click handler
+<BreadcrumbLink
+  href="/products"
+  onClick={(e) => {
+    e.preventDefault();
+    navigate('/products');
+  }}
+>
+  Products
+</BreadcrumbLink>
+```

package/.llm/breadcrumb-list.llm.md

@@ -0,0 +1,54 @@
+# 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>
+```

package/.llm/breadcrumb-page.llm.md

@@ -0,0 +1,52 @@
+# BreadcrumbPage
+
+**Type**: component
+
+Current page indicator in breadcrumb trail Represents the current page (non-clickable) at the end of the breadcrumb trail. Styled with prominent text color and marked with comprehensive accessibility attributes including `aria-current="page"` for precise screen reader identification of the user's current location within the site hierarchy. This component uses specific ARIA attributes to indicate it represents a link-like element that is disabled, providing semantic meaning while maintaining the visual breadcrumb structure. The `aria-current="page"` attribute is the standard way to identify the current page in navigation components.
+
+## JSX Usage
+
+```jsx
+import { BreadcrumbPage } from '@neynar/ui';
+
+<BreadcrumbPage
+  className="value"
+>
+  {/* Your content here */}
+</BreadcrumbPage>
+```
+
+## Component Props
+
+### className
+- **Type**: `string`
+- **Required**: No
+- **Description**: Additional CSS classes to apply to the span element
+
+### children
+- **Type**: `React.ReactNode`
+- **Required**: No
+- **Description**: Current page name or content to display
+
+## Examples
+
+### Example 1
+```tsx
+// Simple page name
+<BreadcrumbPage>Current Page Name</BreadcrumbPage>
+```
+### Example 2
+```tsx
+// With icon and text
+<BreadcrumbPage>
+  <FileIcon className="mr-1" />
+  Document.pdf
+</BreadcrumbPage>
+```
+### Example 3
+```tsx
+// With custom styling
+<BreadcrumbPage className="font-semibold text-primary">
+  Important Page
+</BreadcrumbPage>
+```

package/.llm/breadcrumb-separator.llm.md

@@ -0,0 +1,60 @@
+# BreadcrumbSeparator
+
+**Type**: component
+
+Visual separator between breadcrumb items Displays a separator icon (default: ChevronRight) between breadcrumb items to provide visual hierarchy and direction in the breadcrumb trail. Supports complete customization with any icon or content. Properly hidden from assistive technologies with accessibility attributes for clean screen reader navigation experience. The component uses CSS sizing constraints to ensure consistent icon sizing across different separator types and maintains visual alignment within the breadcrumb flow.
+
+## JSX Usage
+
+```jsx
+import { BreadcrumbSeparator } from '@neynar/ui';
+
+<BreadcrumbSeparator
+  className="value"
+>
+  {/* Your content here */}
+</BreadcrumbSeparator>
+```
+
+## Component Props
+
+### children
+- **Type**: `React.ReactNode`
+- **Required**: No
+- **Description**: Custom separator icon or content to display instead of default ChevronRight. Typically Lucide icons like Slash, ArrowRight, etc.
+
+### className
+- **Type**: `string`
+- **Required**: No
+- **Description**: Additional CSS classes to apply to the list item container
+
+## Examples
+
+### Example 1
+```tsx
+// Default ChevronRight separator
+<BreadcrumbSeparator />
+```
+### Example 2
+```tsx
+// Custom Slash separator
+import { Slash } from "lucide-react"
+<BreadcrumbSeparator>
+  <Slash />
+</BreadcrumbSeparator>
+```
+### Example 3
+```tsx
+// Arrow right separator
+import { ArrowRight } from "lucide-react"
+<BreadcrumbSeparator>
+  <ArrowRight />
+</BreadcrumbSeparator>
+```
+### Example 4
+```tsx
+// Text separator
+<BreadcrumbSeparator>
+  <span className="text-muted-foreground">/</span>
+</BreadcrumbSeparator>
+```

package/.llm/breadcrumb.llm.md

@@ -0,0 +1,110 @@
+# Breadcrumb
+
+**Type**: component
+
+Breadcrumb navigation component that displays hierarchical page location A breadcrumb navigation component built on semantic HTML that shows the current page location within a navigational hierarchy. Provides users with contextual awareness of their position in the site structure and enables easy navigation to parent pages. Based on the shadcn/ui Breadcrumb component with accessibility features and support for composition patterns including custom separators, ellipsis for long paths, dropdown menus, and custom link components via the asChild prop.
+
+## JSX Usage
+
+```jsx
+import { Breadcrumb } from '@neynar/ui';
+
+<Breadcrumb
+  className="value"
+>
+  {/* Your content here */}
+</Breadcrumb>
+```
+
+## Component Props
+
+### className
+- **Type**: `string`
+- **Required**: No
+- **Description**: Additional CSS classes to apply to the navigation element
+
+### children
+- **Type**: `React.ReactNode`
+- **Required**: No
+- **Description**: Child breadcrumb elements (typically BreadcrumbList)
+
+## Examples
+
+### Example 1
+```tsx
+// Basic breadcrumb navigation
+<Breadcrumb>
+  <BreadcrumbList>
+    <BreadcrumbItem>
+      <BreadcrumbLink href="/">Home</BreadcrumbLink>
+    </BreadcrumbItem>
+    <BreadcrumbSeparator />
+    <BreadcrumbItem>
+      <BreadcrumbLink href="/products">Products</BreadcrumbLink>
+    </BreadcrumbItem>
+    <BreadcrumbSeparator />
+    <BreadcrumbItem>
+      <BreadcrumbPage>Laptop</BreadcrumbPage>
+    </BreadcrumbItem>
+  </BreadcrumbList>
+</Breadcrumb>
+```
+### Example 2
+```tsx
+// With ellipsis for long paths
+<Breadcrumb>
+  <BreadcrumbList>
+    <BreadcrumbItem>
+      <BreadcrumbLink href="/">Home</BreadcrumbLink>
+    </BreadcrumbItem>
+    <BreadcrumbSeparator />
+    <BreadcrumbItem>
+      <BreadcrumbEllipsis />
+    </BreadcrumbItem>
+    <BreadcrumbSeparator />
+    <BreadcrumbItem>
+      <BreadcrumbLink href="/products/laptops">Laptops</BreadcrumbLink>
+    </BreadcrumbItem>
+    <BreadcrumbSeparator />
+    <BreadcrumbItem>
+      <BreadcrumbPage>Gaming Laptop</BreadcrumbPage>
+    </BreadcrumbItem>
+  </BreadcrumbList>
+</Breadcrumb>
+```
+### Example 3
+```tsx
+// With Next.js Link integration using asChild
+import { Link } from "next/link"
+<Breadcrumb>
+  <BreadcrumbList>
+    <BreadcrumbItem>
+      <BreadcrumbLink asChild>
+        <Link href="/">Home</Link>
+      </BreadcrumbLink>
+    </BreadcrumbItem>
+    <BreadcrumbSeparator />
+    <BreadcrumbItem>
+      <BreadcrumbPage>Current Page</BreadcrumbPage>
+    </BreadcrumbItem>
+  </BreadcrumbList>
+</Breadcrumb>
+```
+### Example 4
+```tsx
+// With custom separator
+import { Slash } from "lucide-react"
+<Breadcrumb>
+  <BreadcrumbList>
+    <BreadcrumbItem>
+      <BreadcrumbLink href="/">Home</BreadcrumbLink>
+    </BreadcrumbItem>
+    <BreadcrumbSeparator>
+      <Slash />
+    </BreadcrumbSeparator>
+    <BreadcrumbItem>
+      <BreadcrumbPage>Current Page</BreadcrumbPage>
+    </BreadcrumbItem>
+  </BreadcrumbList>
+</Breadcrumb>
+```