Skip to content

Installation

Add Akaza UI to your Vue or Nuxt project in minutes.

Install the package

Setup

Headless means no visual theme, not no CSS. Akaza's stylesheet supplies required positioning, hidden-input visibility, interaction, and transition mechanics. Load it once before using components; dimensions and visual styles remain yours to define.

Nuxt

Add the Nuxt module to nuxt.config.ts. The module registers component auto-imports and injects package CSS.

nuxt.config.ts
export default defineNuxtConfig({
  modules: ['akaza-ui/nuxt'],
})

Vue (with Tailwind CSS)

Import Akaza's structural stylesheet in your Tailwind CSS entry, after the Tailwind import. Declare the akaza-reset layer first so that utility classes take precedence, even though Akaza's CSS is imported last:

main.css
@layer akaza-reset;
@import "tailwindcss";
@import "akaza-ui/dist/akaza-ui.css";

Load that CSS entry once from your app entry point. No separate Akaza CSS import in main.ts is needed:

main.ts
import './main.css'

Then import components where you use them:

vue
<Button class="rounded-md bg-black px-3 py-2 text-white">
  Save
</Button>

Vue (without Tailwind)

Import the same structural stylesheet in your app entry point, then add your own visual CSS:

main.ts
<script setup lang="ts">
import { ref } from 'vue'
import { Dialog } from 'akaza-ui'

const dialog = ref()

function showConfirmation() {
  dialog.value?.open()
}
</script>

<template>
  <Dialog ref="dialog">
    <template #body>Are you sure?</template>
    <template #footer="{ close }">
      <button @click="close">Dismiss</button>
    </template>
  </Dialog>

  <button @click="showConfirmation">Show confirmation</button>
</template>

TypeScript support

Akaza UI exports component types:

ts
<script setup lang="ts">
import { ref } from 'vue'
import { Tabs } from 'akaza-ui'

const active = ref('account')
const items = [
  { value: 'account', label: 'Account' },
  { value: 'security', label: 'Security' },
]
</script>

<template>
  <Tabs v-model="active" :items="items" aria-label="Settings">
    <template #panel-account>Account settings…</template>
    <template #panel-security>Security settings…</template>
  </Tabs>
</template>

Framework compatibility

FrameworkSupport
Vue 3✅ Full support
Nuxt 3 / 4✅ Full support
Vite✅ Full support
Webpack✅ Full support
Vue 2❌ Not supported
Edit this page on GitHub ↗