<p align="center">
  <img width="144px" src="https://naiveui.oss-cn-hongkong.aliyuncs.com/naivelogo.svg" />
</p>

<h1 align="center">Naive UI</h1>
<p align="center">A Vue 3 Component Library</p>
<p align="center"><b>Fairly Complete, Theme Customizable, Uses TypeScript, Fast</b></p>
<p align="center">Kinda Interesting</p>

<p align="center">
  <a href="https://npmjs.com/package/naive-ui">
    <img src="https://img.shields.io/npm/v/naive-ui.svg" alt="npm">
  </a>
  <a href="https://pkg.pr.new/~/tusen-ai/naive-ui">
    <img src="https://pkg.pr.new/badge/tusen-ai/naive-ui" alt="pkg.pr.new">
  </a>
</p>

<p align="center">English | <a href="README.zh-CN.md">中文</a></p>

## Documentation

[www.naiveui.com](http://www.naiveui.com)

## Community

- [Discord](https://discord.gg/Pqv7Mev5Dd)
- DingTalk Group 1 (Member limit reached) 33482509
- DingTalk Group 2 (Member limit reached) 35886835
- DingTalk Group 3 (Member limit reached) 32377370
- DingTalk Group 4 (Member limit reached) 8165002788
- DingTalk Group 5 (Member limit reached) 31205022250
- DingTalk Group 6 62720001971

- [Awesome Naive UI](https://github.com/naive-ui/awesome-naive)

## Features

### Fairly Complete

There are more than 90 components. Hope they can help you write less code.

What's more, they are all treeshakable.

### Theme Customizable

We provide an advanced type safe theme system built using TypeScript. All you need is to provide a theme overrides object in JS. Then all the stuff will be done by us.

What's more, no less/sass/css variables, no webpack loaders are required.

### Uses TypeScript

All the stuff in Naive UI is written in TypeScript. It can work with your typescript project seamlessly.

What's more, you don't need to import any CSS to use the components.

### Fast

I try to make it not rather slow. All data components works with virtual list by default.

What's more, ..., no more. Just enjoy it.

## Installation

### npm

Use npm to install.

```bash
npm i -D naive-ui
```

### Fonts

```bash
npm i -D vfonts
```

### Icons

Naive UI recommends using [xicons](https://www.xicons.org) as icon library.

### Design Resources

[Naive UI (Sketch)](https://naive-ui.oss-accelerate.aliyuncs.com/NaiveUI-Design-Library-en-US.sketch).

## Contributing

Please see [CONTRIBUTING.md](https://github.com/tusen-ai/naive-ui/blob/main/CONTRIBUTING.md).

## License

Naive UI is licensed under the [MIT license](https://opensource.org/licenses/MIT).

Graphics resources of `result` component is licensed under the [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/). The graphics resources come from [Twemoji](https://github.com/twitter/twemoji).
