Kui for Vue

Lightweight Desktop UI Component Library for Vue.js

English | 简体中文

Documentation

• Quick Start
• Components Overview
• Dark Mode
• Icons
• Internationalization
• CHANGELOG

Features

• Up to 50 high-quality Components.
• Internationalization Support for Dozens of Languages.
• Develop with TypeScript
• Supports Vue.js 3.x
• Supports SSR
• Supports Nuxt.js
• Supports Electron

Install

npm install kui-vue --save

npm add kui-vue

yarn add kui-vue

bun add kui-vue

Using a script tag for global use:

<!-- import stylesheet -->
<link rel="stylesheet" href="//unpkg.com/kui-vue/style/index.css" />
<!-- import kui -->
<script src="//unpkg.com/kui-vue"></script>

Usage

<template>
  <div>
    <k-button type="primary" @click="test">Primary</k-button>
  </div>
</template>
<script setup lang="ts">
  import { message } from "kui-vue";
  const test = () => {
    message.info("Hello kui !");
  };
</script>

Local Development

git clone git@github.com:smallerqiu/kui-vue.git
cd kui-vue
pnpm install
pnpm dev

The documentation development server runs at http://localhost:7005 by default.

Common commands:

pnpm dev          # Start the documentation development server
pnpm typecheck    # Run TypeScript checks
pnpm build:docs   # Build the documentation site
pnpm build        # Build the component library and styles

Browser Support

KUI Vue supports the latest two versions of major modern browsers, including Chrome, Edge, Firefox, and Safari. Internet Explorer is not supported.

Contributing

Issues and pull requests are welcome. Before submitting code, please ensure that the type checks and relevant builds pass.

• GitHub repository
• Gitee repository
• Issue tracker

License

MIT

Copyright © 2017-present Qiu