Skip to main content
PolyUI/docs

Installation

Install via CLI or manually. Integrates with any framework project in minutes.

Requirements

  • • Node.js 18+
  • • Tailwind CSS v4
  • • React 18+ / Vue 3.4+ / Svelte 5+ / SolidJS 1.8+

React

Built on Base UI headless components.

1. Install

bash
pnpm add @polyui/react @polyui/core @base-ui/react

2. Configure Tailwind v4

css
/* app/globals.css */
@import "tailwindcss";
@import "@polyui/tokens/tokens.css";
@import "@polyui/tailwind/preset.css";

3. Add components via CLI (recommended)

bash
pnpm dlx shadcn@latest add button -c packages/react

4. Usage

tsx
import { Button } from "@polyui/react/button"

export default function App() {
  return <Button variant="default">Hello PolyUI</Button>
}

Vue

Built on Reka UI headless components.

bash
pnpm add @polyui/vue @polyui/core reka-ui
vue
<script setup>
import { Button } from "@polyui/vue/button"
</script>

<template>
  <Button variant="default">Hello PolyUI</Button>
</template>

Svelte

Built on Bits UI headless components.

bash
pnpm add @polyui/svelte @polyui/core bits-ui
svelte
<script lang="ts">
  import { Button } from "@polyui/svelte/button"
</script>

<Button variant="default">Hello PolyUI</Button>

Solid

Built on Kobalte headless components.

bash
pnpm add @polyui/solid @polyui/core @kobalte/core
tsx
import { Button } from "@polyui/solid/button"

export default function App() {
  return <Button variant="default">Hello PolyUI</Button>
}

Next steps

Once installed, browse the component docs to learn each component's usage and props.