page.mdx 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  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. ## For React UI with shadcn/ui
  8. Pre-built components for fast prototyping and production use:
  9. <PackageInstall packages="@json-render/core @json-render/react @json-render/shadcn" />
  10. Requires Tailwind CSS in your project. See the [@json-render/shadcn API reference](/docs/api/shadcn) for usage.
  11. ## For React Native
  12. <PackageInstall packages="@json-render/core @json-render/react-native" />
  13. ## For Remotion Video
  14. <PackageInstall packages="@json-render/core @json-render/remotion remotion @remotion/player" />
  15. ## For External State Management (Optional)
  16. 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:
  17. <PackageInstall packages="@json-render/zustand" />
  18. <PackageInstall packages="@json-render/redux" />
  19. <PackageInstall packages="@json-render/jotai" />
  20. See the [Data Binding](/docs/data-binding#external-store-controlled-mode) guide for usage.
  21. ## Peer Dependencies
  22. json-render requires the following peer dependencies:
  23. - `react` ^19.0.0
  24. - `zod` ^4.0.0
  25. <PackageInstall packages="react zod" />
  26. ## For AI Integration
  27. To use json-render with AI models, you'll also need the Vercel AI SDK:
  28. <PackageInstall packages="ai" />