@jallall/oidea-ui 0.1.0 → 0.1.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.
- package/README.md +17 -17
- package/dist/index.cjs +2 -119
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +3213 -40244
- package/dist/index.js.map +1 -1
- package/package.json +1 -2
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @oidea
|
|
1
|
+
# @jallall/oidea-ui
|
|
2
2
|
|
|
3
3
|
Reusable React components and design tokens used by Oidea applications. The package includes accessible UI primitives, application-level building blocks, data visualization components, and the complete Oidea visual theme.
|
|
4
4
|
|
|
@@ -13,7 +13,7 @@ The package is written in TypeScript and includes its own type declarations. It
|
|
|
13
13
|
## Installation
|
|
14
14
|
|
|
15
15
|
```bash
|
|
16
|
-
npm install @oidea
|
|
16
|
+
npm install @jallall/oidea-ui react react-dom
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
Applications using `OideaQueryProvider` or the TanStack integrations should also install:
|
|
@@ -28,13 +28,13 @@ Import the stylesheet once at the root of your application:
|
|
|
28
28
|
|
|
29
29
|
```tsx
|
|
30
30
|
// main.tsx, app.tsx, or your root layout
|
|
31
|
-
import "@oidea
|
|
31
|
+
import "@jallall/oidea-ui/styles.css"
|
|
32
32
|
```
|
|
33
33
|
|
|
34
34
|
Components can then be imported directly from the package:
|
|
35
35
|
|
|
36
36
|
```tsx
|
|
37
|
-
import { Badge, Button, Card, CardContent, CardHeader, CardTitle } from "@oidea
|
|
37
|
+
import { Badge, Button, Card, CardContent, CardHeader, CardTitle } from "@jallall/oidea-ui"
|
|
38
38
|
|
|
39
39
|
export function Example() {
|
|
40
40
|
return (
|
|
@@ -56,8 +56,8 @@ export function Example() {
|
|
|
56
56
|
Most components do not need a provider. If your application uses React Query, `OideaQueryProvider` supplies a sensible default `QueryClient`:
|
|
57
57
|
|
|
58
58
|
```tsx
|
|
59
|
-
import { OideaQueryProvider } from "@oidea
|
|
60
|
-
import "@oidea
|
|
59
|
+
import { OideaQueryProvider } from "@jallall/oidea-ui"
|
|
60
|
+
import "@jallall/oidea-ui/styles.css"
|
|
61
61
|
|
|
62
62
|
export function App() {
|
|
63
63
|
return (
|
|
@@ -72,7 +72,7 @@ Pass your own client when you need custom query behavior:
|
|
|
72
72
|
|
|
73
73
|
```tsx
|
|
74
74
|
import { QueryClient } from "@tanstack/react-query"
|
|
75
|
-
import { OideaQueryProvider } from "@oidea
|
|
75
|
+
import { OideaQueryProvider } from "@jallall/oidea-ui"
|
|
76
76
|
|
|
77
77
|
const queryClient = new QueryClient()
|
|
78
78
|
|
|
@@ -88,7 +88,7 @@ export function App() {
|
|
|
88
88
|
`Badge` supports visual variants, four sizes, arbitrary CSS colors, links through `asChild`, and normal HTML attributes.
|
|
89
89
|
|
|
90
90
|
```tsx
|
|
91
|
-
import { Badge } from "@oidea
|
|
91
|
+
import { Badge } from "@jallall/oidea-ui"
|
|
92
92
|
|
|
93
93
|
export function BadgeExamples() {
|
|
94
94
|
return (
|
|
@@ -109,7 +109,7 @@ Available sizes are `xs`, `sm`, `md`, and `lg`. Available variants are `default`
|
|
|
109
109
|
Use `StatusBadge` for semantic statuses. Its tones are `success`, `warning`, `gold`, `danger`, `neutral`, `muted`, and `info`.
|
|
110
110
|
|
|
111
111
|
```tsx
|
|
112
|
-
import { StatusBadge } from "@oidea
|
|
112
|
+
import { StatusBadge } from "@jallall/oidea-ui"
|
|
113
113
|
|
|
114
114
|
<StatusBadge tone="success" size="sm" dot>Paid</StatusBadge>
|
|
115
115
|
<StatusBadge tone="danger">Rejected</StatusBadge>
|
|
@@ -123,7 +123,7 @@ import { StatusBadge } from "@oidea/ui"
|
|
|
123
123
|
The included toaster is powered by Sonner. Render `Toaster` once near the root, then use Sonner's `toast` function anywhere in the application:
|
|
124
124
|
|
|
125
125
|
```tsx
|
|
126
|
-
import { Toaster, toast } from "@oidea
|
|
126
|
+
import { Toaster, toast } from "@jallall/oidea-ui"
|
|
127
127
|
|
|
128
128
|
export function App() {
|
|
129
129
|
return (
|
|
@@ -140,7 +140,7 @@ export function App() {
|
|
|
140
140
|
`DataTable` provides typed columns, local sorting, search, pagination, loading skeletons, selectable rows, and manual/infinite data loading.
|
|
141
141
|
|
|
142
142
|
```tsx
|
|
143
|
-
import { DataTable, type DataTableColumn } from "@oidea
|
|
143
|
+
import { DataTable, type DataTableColumn } from "@jallall/oidea-ui"
|
|
144
144
|
|
|
145
145
|
type Invoice = {
|
|
146
146
|
id: string
|
|
@@ -201,7 +201,7 @@ import {
|
|
|
201
201
|
createRootRoute,
|
|
202
202
|
createRoute,
|
|
203
203
|
createRouter,
|
|
204
|
-
} from "@oidea
|
|
204
|
+
} from "@jallall/oidea-ui"
|
|
205
205
|
|
|
206
206
|
const rootRoute = createRootRoute({ component: Outlet })
|
|
207
207
|
|
|
@@ -233,7 +233,7 @@ declare module "@tanstack/react-router" {
|
|
|
233
233
|
|
|
234
234
|
```tsx
|
|
235
235
|
import { BarChart3, FileText, LayoutDashboard } from "lucide-react"
|
|
236
|
-
import { AppSidebar, SidebarProvider } from "@oidea
|
|
236
|
+
import { AppSidebar, SidebarProvider } from "@jallall/oidea-ui"
|
|
237
237
|
|
|
238
238
|
const groups = [
|
|
239
239
|
{
|
|
@@ -259,7 +259,7 @@ const groups = [
|
|
|
259
259
|
`RouterShell` combines the responsive sidebar, sidebar provider, mobile trigger, header, and route content:
|
|
260
260
|
|
|
261
261
|
```tsx
|
|
262
|
-
import { Outlet, RouterShell } from "@oidea
|
|
262
|
+
import { Outlet, RouterShell } from "@jallall/oidea-ui"
|
|
263
263
|
|
|
264
264
|
export function AuthenticatedLayout() {
|
|
265
265
|
return (
|
|
@@ -291,7 +291,7 @@ Area Chart, Bar Chart, Donut Chart, and Sparkline. Chart components are built on
|
|
|
291
291
|
|
|
292
292
|
## Complete component reference
|
|
293
293
|
|
|
294
|
-
Every example below assumes the component is imported from `@oidea
|
|
294
|
+
Every example below assumes the component is imported from `@jallall/oidea-ui`. Import `@jallall/oidea-ui/styles.css` once in the application root.
|
|
295
295
|
|
|
296
296
|
### All 34 UI primitive modules
|
|
297
297
|
|
|
@@ -386,7 +386,7 @@ These 70 modules expose more than 150 composable exports because compound module
|
|
|
386
386
|
|
|
387
387
|
## Styling and customization
|
|
388
388
|
|
|
389
|
-
Always import `@oidea
|
|
389
|
+
Always import `@jallall/oidea-ui/styles.css`. It contains Tailwind-generated component styles, animations, and Oidea's CSS variables.
|
|
390
390
|
|
|
391
391
|
All components accept `className` where applicable, so layout and presentation can be extended without modifying package source:
|
|
392
392
|
|
|
@@ -411,7 +411,7 @@ Common variables include `--background`, `--foreground`, `--card`, `--primary`,
|
|
|
411
411
|
Types are bundled automatically. Props can be imported from the main entry point:
|
|
412
412
|
|
|
413
413
|
```tsx
|
|
414
|
-
import type { DataTableColumn, OideaQueryProviderProps, StatusBadgeProps } from "@oidea
|
|
414
|
+
import type { DataTableColumn, OideaQueryProviderProps, StatusBadgeProps } from "@jallall/oidea-ui"
|
|
415
415
|
```
|
|
416
416
|
|
|
417
417
|
## Development
|