Getting Started
Installation
Add Akaza UI to your Vue or Nuxt project in minutes.
Install the package
npm install akaza-ui
pnpm add akaza-ui
yarn add akaza-ui
Setup
Nuxt
Add the Nuxt module to your nuxt.config.ts. It automatically registers all components as auto-imports and injects the CSS — no further setup required.
nuxt.config.ts
export default defineNuxtConfig({
modules: ['akaza-ui/nuxt'],
})
Vue (with Tailwind CSS)
Import component styles in your CSS entry point. Declare the akaza-reset layer before Tailwind so that utility classes can override component base styles:
main.css
@layer akaza-reset;
@import "tailwindcss";
Then import components where you use them:
<script setup lang="ts">
import { Dialog, Tooltip } from 'akaza-ui'
</script>
Vue (without Tailwind)
Import the CSS in your app entry point:
main.ts
import 'akaza-ui/dist/akaza-ui.css'
TypeScript support
Akaza UI is fully typed. Types are exported alongside components:
import type { AccordionItem, DialogProps } from 'akaza-ui'
Framework compatibility
| Framework | Support |
|---|---|
| Vue 3 | ✅ Full support |
| Nuxt 3 / 4 | ✅ Full support |
| Vite | ✅ Full support |
| Webpack | ✅ Full support |
| Vue 2 | ❌ Not supported |