kui-vue
Version:
A lightweight desktop UI component library suitable for Vue.js 2.
100 lines (73 loc) • 5.69 kB
Markdown
<p align="center">
<a href="https://k-ui.cn">
<img width="100" src="https://cdn.chuchur.com/img/logo-kui.svg">
</a>
</p>
<h1 align="center">
KUI for Vue
</h1>
<div align="center">
A high quality UI components Library with Vue.js
[](https://www.npmjs.org/package/kui-vue)
[](https://npmjs.org/package/kui-vue)
[](https://npmjs.org/package/kui-vue)



English | [简体中文](./README-zh_CN.md)
</div>
# Documentation
- [Quick Start](https://k-ui.cn/start/getting-started)
- [Components Overview](https://k-ui.cn/start/components)
- [Customizing Themes](https://k-ui.cn/docs/theme)
- [Dark Mode](https://k-ui.cn/start/dark-mode)
- [Icons](https://k-ui.cn/basic/icons)
- [Internationalization](https://k-ui.cn/start/language)
- [CHANGELOG](https://k-ui.cn/start/logs)
# Features
- Up to 50 high-quality Components.
- Internationalization Support for Dozens of Languages.
- Supports Vue.js 2.x
- Supports SSR
- Supports [Nuxt.js](https://nuxtjs.org/)
- Supports Electron
- Most components and features support IE9 and above browsers, some components and features do not support IE
# Install
```sh
#with npm:
npm install kui-vue --save
#with yarn:
yarn add kui-vue
```
Using a script tag for global use:
```html
<!-- import stylesheet -->
<link rel="stylesheet" href="//unpkg.com/kui-vue/dist/k-ui.css" />
<!-- import kui -->
<script src="//unpkg.com/kui-vue@3.x"></script>
```
# Usage
```html
<template>
<div>
<Button type="primary" @click="test">Primary</Button>
</div>
</template>
<script setup>
import { message } from "kui-vue";
const test = () => {
message.info("Hello kui !");
};
</script>
```
# 👌 Platform Support
KUI supports all major modern browsers.
| [<img alt="chrome" height="24px" src="https://cdnjs.cloudflare.com/ajax/libs/browser-logos/70.4.0/chrome/chrome.png" />](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/70.4.0/chrome/chrome.png)<br>chrome | [<img alt="firefox" height="24px" src="https://cdnjs.cloudflare.com/ajax/libs/browser-logos/70.4.0/firefox/firefox.png" />](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/70.4.0/firefox/firefox.png)<br>firefox | [<img alt="safari" height="24px" src="https://cdnjs.cloudflare.com/ajax/libs/browser-logos/70.4.0/safari/safari.png" />](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/70.4.0/safari/safari.png)<br>safari | [<img alt="IE/Edge" height="24px" src="https://cdnjs.cloudflare.com/ajax/libs/browser-logos/70.4.0/edge/edge.png" />](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/70.4.0/edge/edge.png)<br> IE/Edge | [<img alt="electron" height="24px" src="https://cdnjs.cloudflare.com/ajax/libs/browser-logos/70.4.0/electron/electron.png" />](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/70.4.0/electron/electron.png)<br>Electron |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| latest 2 versions | latest 2 versions | latest 2 versions | Edge | latest 2 versions |
# Ecosystem Links
[KUI for react](https://react.k-ui.cn)
[KUI for mobile](https://gitee.com/chuchur/kui-vue-mobile)
# License
[MIT](http://opensource.org/licenses/MIT)
Copyright (c) 2017-present, Qiu