@orion-ds/react 2.0.0 โ 2.0.1
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.
- package/README.md +97 -15
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# @orion/react
|
|
1
|
+
# @orion-ds/react
|
|
2
2
|
|
|
3
|
-
> **Orion Design System** - React Component Library
|
|
3
|
+
> **Orion Design System** - AI-First React Component Library
|
|
4
4
|
|
|
5
|
-
TypeScript-first React component library built on the Orion Design System
|
|
5
|
+
TypeScript-first React component library built on the Orion Design System. Features 40+ components, 30+ sections, and 9 page templates with full type safety, theme switching, and multi-brand support.
|
|
6
6
|
|
|
7
7
|
[](https://www.typescriptlang.org/)
|
|
8
8
|
[](#)
|
|
@@ -10,15 +10,15 @@ TypeScript-first React component library built on the Orion Design System tokens
|
|
|
10
10
|
|
|
11
11
|
## Features
|
|
12
12
|
|
|
13
|
-
-
|
|
13
|
+
- ๐ค **AI-First Design** - Optimized for AI/LLM code generation (see AI_GUIDE.md)
|
|
14
|
+
- โ
**40+ Components** - Fully typed with IntelliSense support
|
|
15
|
+
- ๐ **30+ Sections** - Pre-built page sections (Hero, Features, Pricing, etc.)
|
|
16
|
+
- ๐ **9 Templates** - Complete page templates (Landing, Dashboard, Profile, etc.)
|
|
14
17
|
- ๐จ **Theme Switching** - Light/Dark modes with CSS variables
|
|
15
|
-
- ๐ข **Multi-Brand** -
|
|
16
|
-
- ๐ฏ **Lucide Icons** - 5000+ icons built-in
|
|
17
|
-
- โฟ **Accessible** - WCAG AA compliant
|
|
18
|
-
- ๐ฆ **Tree-Shakeable** -
|
|
19
|
-
- ๐ญ **CSS Modules** - Scoped styling, no conflicts
|
|
20
|
-
- ๐งช **Tested** - 19+ unit tests with Vitest
|
|
21
|
-
- ๐ **Documented** - 50+ Storybook stories
|
|
18
|
+
- ๐ข **Multi-Brand** - orion, red, deepblue, orange, lemon brands
|
|
19
|
+
- ๐ฏ **Lucide Icons** - 5000+ icons built-in
|
|
20
|
+
- โฟ **Accessible** - WCAG AA compliant
|
|
21
|
+
- ๐ฆ **Tree-Shakeable** - ESM + CJS
|
|
22
22
|
|
|
23
23
|
## Installation
|
|
24
24
|
|
|
@@ -88,6 +88,18 @@ function MyApp() {
|
|
|
88
88
|
}
|
|
89
89
|
\`\`\`
|
|
90
90
|
|
|
91
|
+
## AI / LLM Integration
|
|
92
|
+
|
|
93
|
+
This library is optimized for AI code generation. When using with Claude, Cursor, Copilot, or other AI tools:
|
|
94
|
+
|
|
95
|
+
| Document | Purpose |
|
|
96
|
+
|----------|---------|
|
|
97
|
+
| `AI_GUIDE.md` | Complete integration guide, decision trees, anti-patterns |
|
|
98
|
+
| `AI_QUICKREF.md` | Quick reference for common patterns |
|
|
99
|
+
| `AI_COMPONENTS.md` | All components with examples |
|
|
100
|
+
|
|
101
|
+
These files are included in the npm package.
|
|
102
|
+
|
|
91
103
|
## Google Fonts (Automatic)
|
|
92
104
|
|
|
93
105
|
**Fonts are loaded automatically by `ThemeProvider`** (since v1.1.4). No manual setup required!
|
|
@@ -180,12 +192,58 @@ if (missing.length > 0) {
|
|
|
180
192
|
- **ThemeController** - Theme & brand selector
|
|
181
193
|
- **useTheme** - Theme management hook
|
|
182
194
|
|
|
195
|
+
## Sections
|
|
196
|
+
|
|
197
|
+
Pre-built page sections for rapid development:
|
|
198
|
+
|
|
199
|
+
| Category | Sections |
|
|
200
|
+
|----------|----------|
|
|
201
|
+
| **Marketing** | Hero, Features, Pricing, CTA, Testimonials, FAQ, Footer |
|
|
202
|
+
| **App** | Sidebar, Header, DetailPanel, StatCards |
|
|
203
|
+
| **Content** | ArticleContent, MediaGallery, Timeline |
|
|
204
|
+
|
|
205
|
+
\`\`\`tsx
|
|
206
|
+
import { Hero, Features, Pricing } from '@orion-ds/react';
|
|
207
|
+
|
|
208
|
+
<Hero title="Welcome" description="Build faster" />
|
|
209
|
+
<Features items={[...]} columns={3} />
|
|
210
|
+
<Pricing plans={[...]} />
|
|
211
|
+
\`\`\`
|
|
212
|
+
|
|
213
|
+
[View all 30+ sections in AI_COMPONENTS.md](./AI_COMPONENTS.md)
|
|
214
|
+
|
|
215
|
+
## Templates
|
|
216
|
+
|
|
217
|
+
Complete page templates ready to use:
|
|
218
|
+
|
|
219
|
+
| Template | Use Case |
|
|
220
|
+
|----------|----------|
|
|
221
|
+
| `LandingPageTemplate` | Marketing landing pages |
|
|
222
|
+
| `DashboardTemplate` | Admin dashboards |
|
|
223
|
+
| `ProfilePageTemplate` | User profile pages |
|
|
224
|
+
| `SettingsTemplate` | Settings pages |
|
|
225
|
+
| `LoginTemplate` | Authentication pages |
|
|
226
|
+
| `OnboardingTemplate` | User onboarding flows |
|
|
227
|
+
| `NotFoundTemplate` | 404 error pages |
|
|
228
|
+
| `MaintenanceTemplate` | Maintenance pages |
|
|
229
|
+
| `ComingSoonTemplate` | Pre-launch pages |
|
|
230
|
+
|
|
231
|
+
\`\`\`tsx
|
|
232
|
+
import { LandingPageTemplate } from '@orion-ds/react';
|
|
233
|
+
|
|
234
|
+
<LandingPageTemplate
|
|
235
|
+
hero={{ title: 'Welcome', description: '...' }}
|
|
236
|
+
features={{ items: [...] }}
|
|
237
|
+
pricing={{ plans: [...] }}
|
|
238
|
+
/>
|
|
239
|
+
\`\`\`
|
|
240
|
+
|
|
183
241
|
## Lucide Icons
|
|
184
242
|
|
|
185
243
|
All components support **Lucide icons** - 5000+ beautiful, consistent icons.
|
|
186
244
|
|
|
187
245
|
\`\`\`tsx
|
|
188
|
-
import { Button, Field, Alert } from '@orion/react';
|
|
246
|
+
import { Button, Field, Alert } from '@orion-ds/react';
|
|
189
247
|
import { Search, Download, AlertCircle } from 'lucide-react';
|
|
190
248
|
|
|
191
249
|
// Icon in button (left side)
|
|
@@ -217,7 +275,7 @@ See [LUCIDE_ICONS.md](./LUCIDE_ICONS.md) for complete icon documentation.
|
|
|
217
275
|
### Using the Hook
|
|
218
276
|
|
|
219
277
|
\`\`\`tsx
|
|
220
|
-
import { useTheme } from '@orion/react';
|
|
278
|
+
import { useTheme } from '@orion-ds/react';
|
|
221
279
|
|
|
222
280
|
function ThemeSwitcher() {
|
|
223
281
|
const { theme, brand, setTheme, setBrand, toggleTheme } = useTheme();
|
|
@@ -227,14 +285,38 @@ function ThemeSwitcher() {
|
|
|
227
285
|
<button onClick={toggleTheme}>
|
|
228
286
|
Current: {theme}
|
|
229
287
|
</button>
|
|
230
|
-
<button onClick={() => setBrand('
|
|
231
|
-
Switch to
|
|
288
|
+
<button onClick={() => setBrand('deepblue')}>
|
|
289
|
+
Switch to Deepblue Brand
|
|
232
290
|
</button>
|
|
233
291
|
</>
|
|
234
292
|
);
|
|
235
293
|
}
|
|
236
294
|
\`\`\`
|
|
237
295
|
|
|
296
|
+
## v2.0.0 Migration Guide
|
|
297
|
+
|
|
298
|
+
### Breaking Changes
|
|
299
|
+
|
|
300
|
+
#### Hero & CTA: `headline` โ `title`
|
|
301
|
+
\`\`\`diff
|
|
302
|
+
- <Hero headline="Welcome" description="..." />
|
|
303
|
+
+ <Hero title="Welcome" description="..." />
|
|
304
|
+
\`\`\`
|
|
305
|
+
|
|
306
|
+
#### DetailPanel: `subtitle` โ `description`
|
|
307
|
+
\`\`\`diff
|
|
308
|
+
- <DetailPanel title="Edit" subtitle="User profile" />
|
|
309
|
+
+ <DetailPanel title="Edit" description="User profile" />
|
|
310
|
+
\`\`\`
|
|
311
|
+
|
|
312
|
+
#### ThemeProvider: Flat Props (Optional)
|
|
313
|
+
\`\`\`diff
|
|
314
|
+
- <ThemeProvider options={{ defaultBrand: 'red' }}>
|
|
315
|
+
+ <ThemeProvider defaultBrand="red">
|
|
316
|
+
\`\`\`
|
|
317
|
+
|
|
318
|
+
> **Backward Compatibility**: The old props still work but show deprecation warnings in development.
|
|
319
|
+
|
|
238
320
|
## License
|
|
239
321
|
|
|
240
322
|
MIT ยฉ Orion Team
|
package/package.json
CHANGED