@json-render/shadcn-svelte
Pre-built shadcn-svelte component definitions and implementations for json-render. Provides 36 components built on Svelte 5 + Tailwind CSS.
Two Entry Points
| Entry Point |
Exports |
Use For |
@json-render/shadcn-svelte/catalog |
shadcnComponentDefinitions |
Catalog schemas (no Svelte dependency, safe for server) |
@json-render/shadcn-svelte |
shadcnComponents, shadcnComponentDefinitions |
Svelte implementations + catalog schemas |
Usage Pattern
Pick the components you need from the standard definitions. Do not spread all definitions -- explicitly select what your app uses:
import { defineCatalog } from "@json-render/core";
import { schema } from "@json-render/svelte/schema";
import { shadcnComponentDefinitions } from "@json-render/shadcn-svelte/catalog";
import { defineRegistry } from "@json-render/svelte";
import { shadcnComponents } from "@json-render/shadcn-svelte";
// Catalog: pick definitions
const catalog = defineCatalog(schema, {
components: {
Card: shadcnComponentDefinitions.Card,
Stack: shadcnComponentDefinitions.Stack,
Heading: shadcnComponentDefinitions.Heading,
Button: shadcnComponentDefinitions.Button,
Input: shadcnComponentDefinitions.Input,
},
actions: {},
});
// Registry: pick matching implementations
const { registry } = defineRegistry(catalog, {
components: {
Card: shadcnComponents.Card,
Stack: shadcnComponents.Stack,
Heading: shadcnComponents.Heading,
Button: shadcnComponents.Button,
Input: shadcnComponents.Input,
},
});
Then render in your Svelte component:
<script lang="ts">
import { Renderer, JsonUIProvider } from "@json-render/svelte";
export let spec;
export let registry;
</script>
<JsonUIProvider initialState={spec?.state ?? {}}>
<Renderer {spec} {registry} />
</JsonUIProvider>
Available Components
Layout
- Card - Container with optional title, description, maxWidth, centered
- Stack - Flex container with direction, gap, align, justify
- Grid - Grid layout with columns (number) and gap
- Separator - Visual divider with orientation
Navigation
- Tabs - Tabbed navigation with tabs array, defaultValue, value
- Accordion - Collapsible sections with items array and type (single/multiple)
- Collapsible - Single collapsible section with title
- Pagination - Page navigation with totalPages and page
Overlay
- Dialog - Modal dialog with title, description, openPath
- Drawer - Bottom drawer with title, description, openPath
- Tooltip - Hover tooltip with content and text
- Popover - Click-triggered popover with trigger and content
- DropdownMenu - Dropdown with label and items array
Content
- Heading - Heading text with level (h1-h4)
- Text - Paragraph with variant (body, caption, muted, lead, code)
- Image - Image with alt, width, height
- Avatar - User avatar with src, name, size
- Badge - Status badge with text and variant (default, secondary, destructive, outline)
- Alert - Alert banner with title, message, type (success, warning, info, error)
- Carousel - Scrollable carousel with items array
- Table - Data table with columns (string[]) and rows (string[][])
Feedback
- Progress - Progress bar with value, max, label
- Skeleton - Loading placeholder with width, height, rounded
- Spinner - Loading spinner with size and label
Input
- Button - Button with label, variant (primary, secondary, danger), disabled
- Link - Anchor link with label and href
- Input - Text input with label, name, type, placeholder, value, checks
- Textarea - Multi-line input with label, name, placeholder, rows, value, checks
- Select - Dropdown select with label, name, options (string[]), value, checks
- Checkbox - Checkbox with label, name, checked, checks, validateOn
- Radio - Radio group with label, name, options (string[]), value, checks, validateOn
- Switch - Toggle switch with label, name, checked, checks, validateOn
- Slider - Range slider with label, min, max, step, value
- Toggle - Toggle button with label, pressed, variant
- ToggleGroup - Group of toggles with items, type, value
- ButtonGroup - Button group with buttons array and selected
Validation Timing (validateOn)
All form components support validateOn to control when validation runs:
"change" -- validate on every input change (default for Select, Checkbox, Radio, Switch)
"blur" -- validate when field loses focus (default for Input, Textarea)
"submit" -- validate only on form submission
Important Notes
- The
/catalog entry point has no Svelte dependency -- use it for server-side prompt generation
- Components use Tailwind CSS classes -- your app must have Tailwind configured
- Component implementations use bundled shadcn-svelte primitives (not your app's
$lib/components/ui/)
- All form inputs support
checks for validation (type + message pairs) and validateOn for timing
- Events: inputs emit
change/submit/focus/blur; buttons emit press; selects emit change/select
1---
2name: shadcn-svelte
3description: Pre-built shadcn-svelte components for json-render Svelte apps. Use when working with @json-render/shadcn-svelte, adding standard UI components to a Svelte catalog, or building Svelte web UIs with shadcn-svelte + Tailwind CSS components.
4metadata:
5 source: https://skillmd.com/skills/vercel-labs/shadcn-svelte
6---
7
8# @json-render/shadcn-svelte
9
10Pre-built shadcn-svelte component definitions and implementations for json-render. Provides 36 components built on Svelte 5 + Tailwind CSS.
11
12## Two Entry Points
13
14| Entry Point | Exports | Use For |
15|-------------|---------|---------|
16| `@json-render/shadcn-svelte/catalog` | `shadcnComponentDefinitions` | Catalog schemas (no Svelte dependency, safe for server) |
17| `@json-render/shadcn-svelte` | `shadcnComponents`, `shadcnComponentDefinitions` | Svelte implementations + catalog schemas |
18
19## Usage Pattern
20
21Pick the components you need from the standard definitions. Do not spread all definitions -- explicitly select what your app uses:
22
23```typescript
24import { defineCatalog } from "@json-render/core";
25import { schema } from "@json-render/svelte/schema";
26import { shadcnComponentDefinitions } from "@json-render/shadcn-svelte/catalog";
27import { defineRegistry } from "@json-render/svelte";
28import { shadcnComponents } from "@json-render/shadcn-svelte";
29
30// Catalog: pick definitions
31const catalog = defineCatalog(schema, {
32 components: {
33 Card: shadcnComponentDefinitions.Card,
34 Stack: shadcnComponentDefinitions.Stack,
35 Heading: shadcnComponentDefinitions.Heading,
36 Button: shadcnComponentDefinitions.Button,
37 Input: shadcnComponentDefinitions.Input,
38 },
39 actions: {},
40});
41
42// Registry: pick matching implementations
43const { registry } = defineRegistry(catalog, {
44 components: {
45 Card: shadcnComponents.Card,
46 Stack: shadcnComponents.Stack,
47 Heading: shadcnComponents.Heading,
48 Button: shadcnComponents.Button,
49 Input: shadcnComponents.Input,
50 },
51});
52```
53
54Then render in your Svelte component:
55
56```svelte
57<script lang="ts">
58 import { Renderer, JsonUIProvider } from "@json-render/svelte";
59
60 export let spec;
61 export let registry;
62</script>
63
64<JsonUIProvider initialState={spec?.state ?? {}}>
65 <Renderer {spec} {registry} />
66</JsonUIProvider>
67```
68
69## Available Components
70
71### Layout
72- **Card** - Container with optional title, description, maxWidth, centered
73- **Stack** - Flex container with direction, gap, align, justify
74- **Grid** - Grid layout with columns (number) and gap
75- **Separator** - Visual divider with orientation
76
77### Navigation
78- **Tabs** - Tabbed navigation with tabs array, defaultValue, value
79- **Accordion** - Collapsible sections with items array and type (single/multiple)
80- **Collapsible** - Single collapsible section with title
81- **Pagination** - Page navigation with totalPages and page
82
83### Overlay
84- **Dialog** - Modal dialog with title, description, openPath
85- **Drawer** - Bottom drawer with title, description, openPath
86- **Tooltip** - Hover tooltip with content and text
87- **Popover** - Click-triggered popover with trigger and content
88- **DropdownMenu** - Dropdown with label and items array
89
90### Content
91- **Heading** - Heading text with level (h1-h4)
92- **Text** - Paragraph with variant (body, caption, muted, lead, code)
93- **Image** - Image with alt, width, height
94- **Avatar** - User avatar with src, name, size
95- **Badge** - Status badge with text and variant (default, secondary, destructive, outline)
96- **Alert** - Alert banner with title, message, type (success, warning, info, error)
97- **Carousel** - Scrollable carousel with items array
98- **Table** - Data table with columns (string[]) and rows (string[][])
99
100### Feedback
101- **Progress** - Progress bar with value, max, label
102- **Skeleton** - Loading placeholder with width, height, rounded
103- **Spinner** - Loading spinner with size and label
104
105### Input
106- **Button** - Button with label, variant (primary, secondary, danger), disabled
107- **Link** - Anchor link with label and href
108- **Input** - Text input with label, name, type, placeholder, value, checks
109- **Textarea** - Multi-line input with label, name, placeholder, rows, value, checks
110- **Select** - Dropdown select with label, name, options (string[]), value, checks
111- **Checkbox** - Checkbox with label, name, checked, checks, validateOn
112- **Radio** - Radio group with label, name, options (string[]), value, checks, validateOn
113- **Switch** - Toggle switch with label, name, checked, checks, validateOn
114- **Slider** - Range slider with label, min, max, step, value
115- **Toggle** - Toggle button with label, pressed, variant
116- **ToggleGroup** - Group of toggles with items, type, value
117- **ButtonGroup** - Button group with buttons array and selected
118
119## Validation Timing (`validateOn`)
120
121All form components support `validateOn` to control when validation runs:
122- `"change"` -- validate on every input change (default for Select, Checkbox, Radio, Switch)
123- `"blur"` -- validate when field loses focus (default for Input, Textarea)
124- `"submit"` -- validate only on form submission
125
126## Important Notes
127
128- The `/catalog` entry point has no Svelte dependency -- use it for server-side prompt generation
129- Components use Tailwind CSS classes -- your app must have Tailwind configured
130- Component implementations use bundled shadcn-svelte primitives (not your app's `$lib/components/ui/`)
131- All form inputs support `checks` for validation (type + message pairs) and `validateOn` for timing
132- Events: inputs emit `change`/`submit`/`focus`/`blur`; buttons emit `press`; selects emit `change`/`select`