page.mdx 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. import { pageMetadata } from "@/lib/page-metadata"
  2. export const metadata = pageMetadata("docs/installation")
  3. # Installation
  4. Install the core package plus your renderer of choice.
  5. ## For React UI
  6. <PackageInstall packages="@json-render/core @json-render/react" />
  7. Peer dependencies: `react ^19.0.0` and `zod ^4.0.0`.
  8. <PackageInstall packages="react zod" />
  9. ## For Vue
  10. <PackageInstall packages="@json-render/core @json-render/vue" />
  11. Peer dependencies: `vue ^3.5.0` and `zod ^4.0.0`.
  12. <PackageInstall packages="vue zod" />
  13. ## For Svelte
  14. <PackageInstall packages="@json-render/core @json-render/svelte" />
  15. Peer dependencies: `svelte ^5.0.0` and `zod ^4.0.0`.
  16. <PackageInstall packages="svelte zod" />
  17. ## For React UI with shadcn/ui
  18. Pre-built components for fast prototyping and production use:
  19. <PackageInstall packages="@json-render/core @json-render/react @json-render/shadcn" />
  20. Requires Tailwind CSS in your project. See the [@json-render/shadcn API reference](/docs/api/shadcn) for usage.
  21. ## For React Native
  22. <PackageInstall packages="@json-render/core @json-render/react-native" />
  23. ## For Remotion Video
  24. <PackageInstall packages="@json-render/core @json-render/remotion remotion @remotion/player" />
  25. ## For React Email
  26. <PackageInstall packages="@json-render/core @json-render/react-email @react-email/components @react-email/render" />
  27. ## For External State Management (Optional)
  28. If you want to wire json-render to an existing state management library instead of the built-in store, install the adapter for your library:
  29. <PackageInstall packages="@json-render/zustand" />
  30. <PackageInstall packages="@json-render/redux" />
  31. <PackageInstall packages="@json-render/jotai" />
  32. <PackageInstall packages="@json-render/xstate" />
  33. See the [Data Binding](/docs/data-binding#external-store-controlled-mode) guide for usage.
  34. ## For AI Integration
  35. To use json-render with AI models, you'll also need the Vercel AI SDK:
  36. <PackageInstall packages="ai" />