@neynar/ui 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/README.md +1 -1
  2. package/context7.json +17 -0
  3. package/llm/components/accordion.llm.md +205 -0
  4. package/llm/components/alert-dialog.llm.md +289 -0
  5. package/llm/components/alert.llm.md +310 -0
  6. package/llm/components/aspect-ratio.llm.md +110 -0
  7. package/llm/components/avatar.llm.md +282 -0
  8. package/llm/components/badge.llm.md +185 -0
  9. package/llm/components/blockquote.llm.md +86 -0
  10. package/llm/components/breadcrumb.llm.md +245 -0
  11. package/llm/components/button-group.llm.md +248 -0
  12. package/llm/components/button.llm.md +247 -0
  13. package/llm/components/calendar.llm.md +252 -0
  14. package/llm/components/card.llm.md +356 -0
  15. package/llm/components/carousel.llm.md +281 -0
  16. package/llm/components/chart.llm.md +278 -0
  17. package/llm/components/checkbox.llm.md +234 -0
  18. package/llm/components/code.llm.md +75 -0
  19. package/llm/components/collapsible.llm.md +271 -0
  20. package/llm/components/color-mode.llm.md +196 -0
  21. package/llm/components/combobox.llm.md +346 -0
  22. package/llm/components/command.llm.md +353 -0
  23. package/llm/components/context-menu.llm.md +368 -0
  24. package/llm/components/dialog.llm.md +283 -0
  25. package/llm/components/drawer.llm.md +326 -0
  26. package/llm/components/dropdown-menu.llm.md +404 -0
  27. package/llm/components/empty.llm.md +282 -0
  28. package/llm/components/field.llm.md +303 -0
  29. package/llm/components/first-light.llm.md +129 -0
  30. package/llm/components/hover-card.llm.md +278 -0
  31. package/llm/components/input-group.llm.md +334 -0
  32. package/llm/components/input-otp.llm.md +270 -0
  33. package/llm/components/input.llm.md +197 -0
  34. package/llm/components/item.llm.md +347 -0
  35. package/llm/components/kbd.llm.md +221 -0
  36. package/llm/components/label.llm.md +219 -0
  37. package/llm/components/menubar.llm.md +378 -0
  38. package/llm/components/navigation-menu.llm.md +320 -0
  39. package/llm/components/pagination.llm.md +337 -0
  40. package/llm/components/popover.llm.md +278 -0
  41. package/llm/components/progress.llm.md +259 -0
  42. package/llm/components/radio-group.llm.md +269 -0
  43. package/llm/components/resizable.llm.md +222 -0
  44. package/llm/components/scroll-area.llm.md +290 -0
  45. package/llm/components/select.llm.md +338 -0
  46. package/llm/components/separator.llm.md +129 -0
  47. package/llm/components/sheet.llm.md +275 -0
  48. package/llm/components/sidebar.llm.md +528 -0
  49. package/llm/components/skeleton.llm.md +140 -0
  50. package/llm/components/slider.llm.md +213 -0
  51. package/llm/components/sonner.llm.md +299 -0
  52. package/llm/components/spinner.llm.md +187 -0
  53. package/llm/components/switch.llm.md +258 -0
  54. package/llm/components/table.llm.md +334 -0
  55. package/llm/components/tabs.llm.md +245 -0
  56. package/llm/components/text.llm.md +108 -0
  57. package/llm/components/textarea.llm.md +236 -0
  58. package/llm/components/title.llm.md +88 -0
  59. package/llm/components/toggle-group.llm.md +228 -0
  60. package/llm/components/toggle.llm.md +235 -0
  61. package/llm/components/tooltip.llm.md +191 -0
  62. package/llm/contributing.llm.md +273 -0
  63. package/llm/hooks.llm.md +91 -0
  64. package/llm/index.llm.md +178 -0
  65. package/llm/theming.llm.md +381 -0
  66. package/llm/utilities.llm.md +97 -0
  67. package/llms-full.txt +15995 -0
  68. package/llms.txt +182 -0
  69. package/package.json +6 -2
package/llms.txt ADDED
@@ -0,0 +1,182 @@
1
+ # @neynar/ui
2
+
3
+ > React component library built on Base UI primitives + Tailwind CSS v4. 53 production-ready components with per-component imports, SSR-safe dark mode, and two visual themes. Powers Neynar Studio.
4
+
5
+ ## Prerequisites
6
+
7
+ **Tailwind CSS v4 is required.** The package exports CSS that uses `@import "tailwindcss"`.
8
+
9
+ ### Vite Setup
10
+
11
+ ```bash
12
+ npm install tailwindcss @tailwindcss/vite
13
+ ```
14
+
15
+ ```ts
16
+ // vite.config.ts
17
+ import tailwindcss from "@tailwindcss/vite";
18
+ export default defineConfig({ plugins: [react(), tailwindcss()] });
19
+ ```
20
+
21
+ ```css
22
+ /* src/index.css - MUST use CSS @import, not JS import */
23
+ @import "@neynar/ui/styles";
24
+ @import "@neynar/ui/themes/purple-dawn";
25
+ ```
26
+
27
+ ```tsx
28
+ // src/main.tsx
29
+ import "./index.css";
30
+ ```
31
+
32
+ ### Next.js Setup
33
+
34
+ ```bash
35
+ npm install tailwindcss @tailwindcss/postcss
36
+ ```
37
+
38
+ ```js
39
+ // postcss.config.js
40
+ export default { plugins: { "@tailwindcss/postcss": {} } };
41
+ ```
42
+
43
+ ```css
44
+ /* app/globals.css */
45
+ @import "@neynar/ui/styles";
46
+ @import "@neynar/ui/themes/purple-dawn";
47
+ ```
48
+
49
+ ## Quick Start
50
+
51
+ Once Tailwind is configured, use components:
52
+
53
+ ```tsx
54
+ import { Button } from "@neynar/ui/button";
55
+ import { Card, CardHeader, CardContent } from "@neynar/ui/card";
56
+
57
+ export function App() {
58
+ return (
59
+ <Card>
60
+ <CardHeader>Welcome</CardHeader>
61
+ <CardContent>
62
+ <Button>Get Started</Button>
63
+ </CardContent>
64
+ </Card>
65
+ );
66
+ }
67
+ ```
68
+
69
+ ## Key Patterns
70
+
71
+ - **Import**: `import { Component } from "@neynar/ui/component"` (lowercase, kebab-case)
72
+ - **Theme**: `import "@neynar/ui/themes/purple-dawn"` or `first-light`
73
+ - **Color mode**: `<ColorModeInitializer />` in `<head>` for SSR-safe dark mode
74
+ - **Utility**: `cn()` from `@neynar/ui/utils` for class merging
75
+ - **Polymorphism**: Use `render` prop (not `asChild`) for custom elements
76
+ - **CSS targeting**: All components have `data-slot` attributes
77
+
78
+ ## Full Documentation
79
+
80
+ - [llms-full.txt](./llms-full.txt): Complete documentation (~16k lines, all 53 components)
81
+
82
+ ## Documentation Index
83
+
84
+ - [Package Overview](llm/index.llm.md): Quick start, import patterns, component categories
85
+ - [Theming Guide](llm/theming.llm.md): Themes, color mode, CSS variables, customization
86
+ - [Hooks](llm/hooks.llm.md): useIsMobile responsive hook
87
+ - [Utilities](llm/utilities.llm.md): cn() class merging
88
+ - [Contributing](llm/contributing.llm.md): Component patterns, data-slot convention, templates
89
+
90
+ ## Core Inputs
91
+
92
+ - [Button](llm/components/button.llm.md): 9 variants, 8 sizes, icon support
93
+ - [Input](llm/components/input.llm.md): Text input with validation states
94
+ - [Textarea](llm/components/textarea.llm.md): Multi-line text input
95
+ - [Checkbox](llm/components/checkbox.llm.md): Boolean toggle with indeterminate
96
+ - [Switch](llm/components/switch.llm.md): Toggle switch control
97
+ - [Select](llm/components/select.llm.md): Dropdown selection
98
+ - [Combobox](llm/components/combobox.llm.md): Searchable select with autocomplete
99
+ - [Slider](llm/components/slider.llm.md): Range input
100
+ - [RadioGroup](llm/components/radio-group.llm.md): Single selection from options
101
+ - [Toggle](llm/components/toggle.llm.md): Pressable toggle button
102
+ - [ToggleGroup](llm/components/toggle-group.llm.md): Multiple toggle buttons
103
+
104
+ ## Form & Field
105
+
106
+ - [Field](llm/components/field.llm.md): Form field wrapper with label/description/error
107
+ - [Label](llm/components/label.llm.md): Accessible form labels
108
+ - [InputGroup](llm/components/input-group.llm.md): Input with prefix/suffix addons
109
+ - [InputOTP](llm/components/input-otp.llm.md): One-time password input
110
+ - [Calendar](llm/components/calendar.llm.md): Date picker calendar
111
+ - [ButtonGroup](llm/components/button-group.llm.md): Connected button group
112
+
113
+ ## Layout & Structure
114
+
115
+ - [Card](llm/components/card.llm.md): Content container with header/footer
116
+ - [Accordion](llm/components/accordion.llm.md): Expandable content sections
117
+ - [Collapsible](llm/components/collapsible.llm.md): Show/hide content
118
+ - [Separator](llm/components/separator.llm.md): Visual divider
119
+ - [AspectRatio](llm/components/aspect-ratio.llm.md): Maintain aspect ratio
120
+ - [ScrollArea](llm/components/scroll-area.llm.md): Custom scrollbars
121
+ - [Resizable](llm/components/resizable.llm.md): Resizable panels
122
+ - [Table](llm/components/table.llm.md): Data tables
123
+
124
+ ## Navigation & Menus
125
+
126
+ - [Tabs](llm/components/tabs.llm.md): Tab-based navigation
127
+ - [DropdownMenu](llm/components/dropdown-menu.llm.md): Trigger-based dropdown
128
+ - [ContextMenu](llm/components/context-menu.llm.md): Right-click menu
129
+ - [Menubar](llm/components/menubar.llm.md): Horizontal menu bar
130
+ - [NavigationMenu](llm/components/navigation-menu.llm.md): Site navigation
131
+ - [Breadcrumb](llm/components/breadcrumb.llm.md): Path indicator
132
+ - [Pagination](llm/components/pagination.llm.md): Page navigation
133
+ - [Sidebar](llm/components/sidebar.llm.md): Collapsible navigation
134
+
135
+ ## Overlays & Dialogs
136
+
137
+ - [Dialog](llm/components/dialog.llm.md): Modal dialog
138
+ - [AlertDialog](llm/components/alert-dialog.llm.md): Confirmation dialog
139
+ - [Sheet](llm/components/sheet.llm.md): Side panel overlay
140
+ - [Drawer](llm/components/drawer.llm.md): Bottom drawer (mobile)
141
+ - [Popover](llm/components/popover.llm.md): Floating content
142
+ - [Tooltip](llm/components/tooltip.llm.md): Hover information
143
+ - [HoverCard](llm/components/hover-card.llm.md): Rich hover preview
144
+
145
+ ## Feedback & Status
146
+
147
+ - [Alert](llm/components/alert.llm.md): Contextual messages with variants
148
+ - [Badge](llm/components/badge.llm.md): Status indicators
149
+ - [Progress](llm/components/progress.llm.md): Progress bars
150
+ - [Skeleton](llm/components/skeleton.llm.md): Loading placeholders
151
+ - [Spinner](llm/components/spinner.llm.md): Loading spinner
152
+ - [Sonner](llm/components/sonner.llm.md): Toast notifications
153
+ - [Empty](llm/components/empty.llm.md): Empty state placeholder
154
+
155
+ ## Theme Utilities
156
+
157
+ - [ColorMode](llm/components/color-mode.llm.md): SSR-safe color mode with system detection
158
+ - [FirstLight](llm/components/first-light.llm.md): SVG filters for First Light theme
159
+
160
+ ## Advanced
161
+
162
+ - [Avatar](llm/components/avatar.llm.md): User avatars with fallback
163
+ - [Carousel](llm/components/carousel.llm.md): Content slider
164
+ - [Chart](llm/components/chart.llm.md): Recharts integration
165
+ - [Command](llm/components/command.llm.md): Command palette (cmdk)
166
+ - [Kbd](llm/components/kbd.llm.md): Keyboard shortcut display
167
+ - [Item](llm/components/item.llm.md): List items with icons
168
+
169
+ ## Typography
170
+
171
+ - [Title](llm/components/title.llm.md): Heading component (h1-h6)
172
+ - [Text](llm/components/text.llm.md): Paragraph text with variants
173
+ - [Code](llm/components/code.llm.md): Inline code styling
174
+ - [Blockquote](llm/components/blockquote.llm.md): Quote blocks
175
+
176
+ ## Optional
177
+
178
+ These contain secondary/supplementary information:
179
+
180
+ - [CHANGELOG](./CHANGELOG.md): Release history
181
+ - [README](./README.md): Full package documentation
182
+ - [Human Docs](./docs/): Integration guides and troubleshooting
package/package.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
2
  "name": "@neynar/ui",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "license": "MIT",
5
5
  "author": "Neynar Inc.",
6
- "description": "React UI component library built on Base UI and Tailwind CSS",
6
+ "description": "AI-first React component library for coding agents. LLM-optimized docs, sensible defaults, zero config. Built on shadcn patterns, Base UI, and Tailwind CSS v4.",
7
7
  "keywords": [
8
8
  "react",
9
9
  "ui",
@@ -254,6 +254,10 @@
254
254
  "files": [
255
255
  "dist/**",
256
256
  "src/**",
257
+ "llm/**",
258
+ "llms.txt",
259
+ "llms-full.txt",
260
+ "context7.json",
257
261
  "LICENSE",
258
262
  "README.md"
259
263
  ],