@neynar/ui 0.3.0 → 0.3.1

package/.llm/date-picker.llm.md

@@ -0,0 +1,90 @@
+# DatePicker
+
+**Type**: component
+
+DatePicker - A comprehensive date selection component with popover calendar interface A polished date selection component that combines an accessible trigger button with a full-featured calendar popover. Built on Radix UI Popover and Calendar primitives with shadcn/ui styling, providing intuitive date selection with proper accessibility, keyboard navigation, automatic positioning, and internationalization support. The component handles both controlled and uncontrolled usage patterns, integrates seamlessly with forms and validation systems, and provides consistent date formatting using date-fns. The popover automatically positions itself to stay within viewport bounds and includes smooth animations for a polished user experience.
+
+## JSX Usage
+
+```jsx
+import { DatePicker } from '@neynar/ui';
+
+<DatePicker
+  date={value}
+  onDateChange={handleDateChange}
+  placeholder="value"
+  disabled={true}
+  className="value"
+/>
+```
+
+## Component Props
+
+### date
+- **Type**: `Date`
+- **Required**: No
+- **Description**: No description available
+
+### onDateChange
+- **Type**: `(date: Date | undefined) => void`
+- **Required**: No
+- **Description**: No description available
+
+### placeholder
+- **Type**: `string`
+- **Required**: No
+- **Description**: No description available
+
+### disabled
+- **Type**: `boolean`
+- **Required**: No
+- **Description**: No description available
+
+### className
+- **Type**: `string`
+- **Required**: No
+- **Description**: No description available
+
+## Examples
+
+### Example 1
+```tsx
+// Basic controlled date picker
+const [date, setDate] = useState<Date>();
+<DatePicker
+  date={date}
+  onDateChange={setDate}
+  placeholder="Select date"
+/>
+```
+### Example 2
+```tsx
+// Date picker for forms with validation
+const [birthDate, setBirthDate] = useState<Date>();
+<DatePicker
+  date={birthDate}
+  onDateChange={setBirthDate}
+  placeholder="Select birth date"
+  className="w-[280px]"
+  disabled={isSubmitting}
+/>
+```
+### Example 3
+```tsx
+// Date range start/end picker
+<div className="flex gap-2 items-center">
+  <DatePicker
+    date={startDate}
+    onDateChange={setStartDate}
+    placeholder="Start date"
+    className="w-[180px]"
+  />
+  <span>to</span>
+  <DatePicker
+    date={endDate}
+    onDateChange={setEndDate}
+    placeholder="End date"
+    className="w-[180px]"
+  />
+</div>
+```

package/.llm/dialog-close.llm.md

@@ -0,0 +1,61 @@
+# DialogClose
+
+**Type**: component
+
+DialogClose - A close button that dismisses the dialog Can be placed anywhere within DialogContent to provide a close action. Typically used for custom close buttons in addition to the default X button. Automatically closes the dialog when activated and returns focus to the trigger.
+
+## JSX Usage
+
+```jsx
+import { DialogClose } from '@neynar/ui';
+
+<DialogClose
+  asChild={true}
+  className="value"
+>
+  {/* Your content here */}
+</DialogClose>
+```
+
+## Component Props
+
+### asChild
+- **Type**: `boolean`
+- **Required**: No
+- **Description**: No description available
+
+### className
+- **Type**: `string`
+- **Required**: No
+- **Description**: No description available
+
+### children
+- **Type**: `React.ReactNode`
+- **Required**: No
+- **Description**: No description available
+
+## Examples
+
+### Example 1
+```tsx
+<DialogClose asChild>
+  <Button variant="outline">Cancel</Button>
+</DialogClose>
+```
+### Example 2
+```tsx
+// Direct button without asChild
+<DialogClose className="close-button">
+  Close Dialog
+</DialogClose>
+```
+### Example 3
+```tsx
+// In footer with multiple actions
+<DialogFooter>
+  <DialogClose asChild>
+    <Button variant="outline">Cancel</Button>
+  </DialogClose>
+  <Button type="submit">Save</Button>
+</DialogFooter>
+```

package/.llm/dialog-content.llm.md

@@ -0,0 +1,128 @@
+# DialogContent
+
+**Type**: component
+
+DialogContent - The main content container for the dialog The primary container for dialog content that automatically includes the overlay and portal. Provides the visual dialog box with animations, positioning, and focus management. Includes a close button (X) by default which can be hidden using the showCloseButton prop.
+
+## JSX Usage
+
+```jsx
+import { DialogContent } from '@neynar/ui';
+
+<DialogContent
+  asChild={true}
+  forceMount={true}
+  onOpenAutoFocus={handleOpenAutoFocus}
+  onCloseAutoFocus={handleCloseAutoFocus}
+  onEscapeKeyDown={handleEscapeKeyDown}
+  onPointerDownOutside={handlePointerDownOutside}
+  onInteractOutside={handleInteractOutside}
+  showCloseButton={true}
+  className="value"
+>
+  {/* Your content here */}
+</DialogContent>
+```
+
+## Component Props
+
+### asChild
+- **Type**: `boolean`
+- **Required**: No
+- **Description**: No description available
+
+### forceMount
+- **Type**: `boolean`
+- **Required**: No
+- **Description**: No description available
+
+### onOpenAutoFocus
+- **Type**: `(event: Event) => void`
+- **Required**: No
+- **Description**: No description available
+
+### onCloseAutoFocus
+- **Type**: `(event: Event) => void`
+- **Required**: No
+- **Description**: No description available
+
+### onEscapeKeyDown
+- **Type**: `(event: KeyboardEvent) => void`
+- **Required**: No
+- **Description**: No description available
+
+### onPointerDownOutside
+- **Type**: `(event: PointerEvent) => void`
+- **Required**: No
+- **Description**: No description available
+
+### onInteractOutside
+- **Type**: `(
+    event: React.FocusEvent | MouseEvent | TouchEvent,
+  ) => void`
+- **Required**: No
+- **Description**: No description available
+
+### showCloseButton
+- **Type**: `boolean`
+- **Required**: No
+- **Description**: Whether to show the X close button in top-right corner (default: true)
+
+### className
+- **Type**: `string`
+- **Required**: No
+- **Description**: Additional CSS classes to apply to the content container
+
+### children
+- **Type**: `React.ReactNode`
+- **Required**: No
+- **Description**: Dialog content including header, body, and footer elements
+
+## Examples
+
+### Example 1
+```tsx
+// Standard content with header and footer
+<DialogContent>
+  <DialogHeader>
+    <DialogTitle>Dialog Title</DialogTitle>
+    <DialogDescription>
+      Detailed description of the dialog's purpose
+    </DialogDescription>
+  </DialogHeader>
+  <div className="py-4">
+    Main dialog content goes here
+  </div>
+  <DialogFooter>
+    <Button variant="outline">Cancel</Button>
+    <Button>Confirm</Button>
+  </DialogFooter>
+</DialogContent>
+```
+### Example 2
+```tsx
+// Custom sizing and scrollable content
+<DialogContent className="sm:max-w-[425px] max-h-[80vh] overflow-y-auto">
+  <DialogHeader>
+    <DialogTitle>Long Content</DialogTitle>
+  </DialogHeader>
+  <div className="space-y-4">
+    // Long scrollable content
+  </div>
+</DialogContent>
+```
+### Example 3
+```tsx
+// Without default close button
+<DialogContent showCloseButton={false}>
+  <DialogHeader>
+    <DialogTitle>Custom Close</DialogTitle>
+  </DialogHeader>
+  <div>Content without X button</div>
+  <DialogFooter>
+    <DialogClose asChild>
+      <Button>Close</Button>
+    </DialogClose>
+  </DialogFooter>
+</DialogContent>
+```

package/.llm/dialog-description.llm.md

@@ -0,0 +1,44 @@
+# DialogDescription
+
+**Type**: component
+
+DialogDescription - Supplementary description for the dialog Provides additional context or instructions for the dialog content. Helps users understand what action they're about to take.
+
+## JSX Usage
+
+```jsx
+import { DialogDescription } from '@neynar/ui';
+
+<DialogDescription
+  asChild={true}
+  className="value"
+>
+  {/* Your content here */}
+</DialogDescription>
+```
+
+## Component Props
+
+### asChild
+- **Type**: `boolean`
+- **Required**: No
+- **Description**: No description available
+
+### className
+- **Type**: `string`
+- **Required**: No
+- **Description**: No description available
+
+### children
+- **Type**: `React.ReactNode`
+- **Required**: No
+- **Description**: No description available
+
+## Examples
+
+```tsx
+<DialogDescription>
+  This action cannot be undone. This will permanently delete your
+  account and remove your data from our servers.
+</DialogDescription>
+```

package/.llm/dialog-footer.llm.md

@@ -0,0 +1,38 @@
+# DialogFooter
+
+**Type**: component
+
+DialogFooter - Container for dialog action buttons Typically contains action buttons like Save, Cancel, or Submit. Automatically handles responsive layout with proper button alignment.
+
+## JSX Usage
+
+```jsx
+import { DialogFooter } from '@neynar/ui';
+
+<DialogFooter
+  className="value"
+>
+  {/* Your content here */}
+</DialogFooter>
+```
+
+## Component Props
+
+### className
+- **Type**: `string`
+- **Required**: No
+- **Description**: No description available
+
+### children
+- **Type**: `React.ReactNode`
+- **Required**: No
+- **Description**: No description available
+
+## Examples
+
+```tsx
+<DialogFooter>
+  <Button variant="outline">Cancel</Button>
+  <Button type="submit">Save changes</Button>
+</DialogFooter>
+```

package/.llm/dialog-header.llm.md

@@ -0,0 +1,40 @@
+# DialogHeader
+
+**Type**: component
+
+DialogHeader - Container for dialog title and description Groups the dialog's title and description at the top of the dialog content. Provides consistent spacing and alignment for header elements.
+
+## JSX Usage
+
+```jsx
+import { DialogHeader } from '@neynar/ui';
+
+<DialogHeader
+  className="value"
+>
+  {/* Your content here */}
+</DialogHeader>
+```
+
+## Component Props
+
+### className
+- **Type**: `string`
+- **Required**: No
+- **Description**: No description available
+
+### children
+- **Type**: `React.ReactNode`
+- **Required**: No
+- **Description**: No description available
+
+## Examples
+
+```tsx
+<DialogHeader>
+  <DialogTitle>Edit profile</DialogTitle>
+  <DialogDescription>
+    Make changes to your profile here. Click save when you're done.
+  </DialogDescription>
+</DialogHeader>
+```

package/.llm/dialog-overlay.llm.md

@@ -0,0 +1,57 @@
+# DialogOverlay
+
+**Type**: component
+
+DialogOverlay - The backdrop overlay behind the dialog Provides a semi-transparent background that covers the main content. Clicking the overlay will close the dialog by default. Features smooth fade animations using Tailwind CSS and proper z-index stacking.
+
+## JSX Usage
+
+```jsx
+import { DialogOverlay } from '@neynar/ui';
+
+<DialogOverlay
+  asChild={true}
+  forceMount={true}
+  className="value"
+>
+  {/* Your content here */}
+</DialogOverlay>
+```
+
+## Component Props
+
+### asChild
+- **Type**: `boolean`
+- **Required**: No
+- **Description**: No description available
+
+### forceMount
+- **Type**: `boolean`
+- **Required**: No
+- **Description**: No description available
+
+### className
+- **Type**: `string`
+- **Required**: No
+- **Description**: No description available
+
+### children
+- **Type**: `React.ReactNode`
+- **Required**: No
+- **Description**: No description available
+
+## Examples
+
+### Example 1
+```tsx
+// Custom overlay styling
+<DialogOverlay className="bg-red-500/20 backdrop-blur-sm" />
+```
+### Example 2
+```tsx
+// Typically used automatically within DialogContent
+<DialogContent>
+  // DialogOverlay is included automatically
+  <DialogTitle>Dialog content</DialogTitle>
+</DialogContent>
+```

package/.llm/dialog-portal.llm.md

@@ -0,0 +1,47 @@
+# DialogPortal
+
+**Type**: component
+
+DialogPortal - Portal container for dialog content Renders dialog content in a React portal at the end of the document body. This ensures proper stacking context and prevents z-index issues. Rarely used directly - typically included automatically by DialogContent.
+
+## JSX Usage
+
+```jsx
+import { DialogPortal } from '@neynar/ui';
+
+<DialogPortal
+  forceMount={true}
+  container={value}
+>
+  {/* Your content here */}
+</DialogPortal>
+```
+
+## Component Props
+
+### forceMount
+- **Type**: `boolean`
+- **Required**: No
+- **Description**: No description available
+
+### container
+- **Type**: `HTMLElement`
+- **Required**: No
+- **Description**: No description available
+
+### children
+- **Type**: `React.ReactNode`
+- **Required**: No
+- **Description**: No description available
+
+## Examples
+
+```tsx
+// Custom portal container
+const [container, setContainer] = useState(null);
+<DialogPortal container={container}>
+  <DialogOverlay />
+  <DialogContent>Portal content</DialogContent>
+</DialogPortal>
+<div ref={setContainer} />
+```

package/.llm/dialog-title.llm.md

@@ -0,0 +1,41 @@
+# DialogTitle
+
+**Type**: component
+
+DialogTitle - The main heading of the dialog Provides the accessible name for the dialog. Should clearly describe the dialog's purpose or the action being performed.
+
+## JSX Usage
+
+```jsx
+import { DialogTitle } from '@neynar/ui';
+
+<DialogTitle
+  asChild={true}
+  className="value"
+>
+  {/* Your content here */}
+</DialogTitle>
+```
+
+## Component Props
+
+### asChild
+- **Type**: `boolean`
+- **Required**: No
+- **Description**: No description available
+
+### className
+- **Type**: `string`
+- **Required**: No
+- **Description**: No description available
+
+### children
+- **Type**: `React.ReactNode`
+- **Required**: No
+- **Description**: No description available
+
+## Examples
+
+```tsx
+<DialogTitle>Delete Account</DialogTitle>
+```

package/.llm/dialog-trigger.llm.md

@@ -0,0 +1,51 @@
+# DialogTrigger
+
+**Type**: component
+
+DialogTrigger - The element that opens the dialog when clicked Typically wraps a button or other interactive element. Use asChild prop to render as the child element instead of a button. The trigger automatically receives focus management and ARIA attributes.
+
+## JSX Usage
+
+```jsx
+import { DialogTrigger } from '@neynar/ui';
+
+<DialogTrigger
+  asChild={true}
+  className="value"
+>
+  {/* Your content here */}
+</DialogTrigger>
+```
+
+## Component Props
+
+### asChild
+- **Type**: `boolean`
+- **Required**: No
+- **Description**: No description available
+
+### className
+- **Type**: `string`
+- **Required**: No
+- **Description**: No description available
+
+### children
+- **Type**: `React.ReactNode`
+- **Required**: No
+- **Description**: No description available
+
+## Examples
+
+### Example 1
+```tsx
+<DialogTrigger asChild>
+  <Button>Open Dialog</Button>
+</DialogTrigger>
+```
+### Example 2
+```tsx
+// Direct button without asChild
+<DialogTrigger className="custom-trigger-style">
+  Click to open
+</DialogTrigger>
+```