Installation

KaonUI provides packages for both Lit Elements and Vue.js. Choose the installation method that matches your project setup.

Prerequisites

• Node.js 18 or higher
• A modern bundler (Vite, Webpack, etc.)

For Lit Projects

pnpm add @kaonui/lit-components

import '@kaonui/lit-components';

// Use in HTML
<kaon-button variant="primary">Click me</kaon-button>

For Vue Projects

pnpm add @kaonui/vue-components

import { createApp } from 'vue';
import KaonUI from '@kaonui/vue-components';

const app = createApp({});
app.use(KaonUI);

<template>
  <KaonButton variant="primary" @click="handleClick">
    Click me
  </KaonButton>
</template>

Development Setup

For contributing to KaonUI:

git clone https://github.com/Conventional-Convention/kaonui.git
cd kaonui
pnpm install
pnpm dev