naive-ui/README.md

<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, Customizable Themes, Uses TypeScript, Not too Slow</b></p>
<p align="center">Kinda Interesting</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 33482509
- [Awesome Naive UI](https://github.com/naive-ui/awesome-naive)

## Features

### Fairly Complete

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

What's more, they are all treeshakable.

### Customizable Themes

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.

### Not too Slow

I try to make it not rather slow. At least select, tree, transfer, table and cascader work with virtual list.

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%28Square-Corner%29.sketch).

## Contributing

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

## License

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

Graphics resouces 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).
doc(readme): add logo 2019-10-20 10:44:12 +08:00			`<p align="center">`
chore: change logo url 2019-10-28 12:38:59 +08:00			`<img width="144px" src="https://naiveui.oss-cn-hongkong.aliyuncs.com/naivelogo.svg" />`
doc(readme): add logo 2019-10-20 10:44:12 +08:00			`</p>`

doc(readme) 2019-10-20 11:02:37 +08:00			`<h1 align="center">Naive UI</h1>`
docs: ui framework => component lib 2021-05-25 13:21:43 +08:00			`<p align="center">A Vue 3 Component Library</p>`
chore: fix cases for GitHub and TypeScript (#28) 2021-06-09 00:21:50 +08:00			`<p align="center"><b>Fairly Complete, Customizable Themes, Uses TypeScript, Not too Slow</b></p>`
docs: introduction en translation 2021-06-03 12:26:41 +08:00			`<p align="center">Kinda Interesting</p>`
doc(readme): fix typo 2019-10-20 11:03:43 +08:00
docs(readme): zhCN 2021-04-19 21:54:16 +08:00			`<p align="center">English \| <a href="README.zh-CN.md">中文</a></p>`

doc(readme): fulfill it 2019-07-10 11:42:46 +08:00			`## Documentation`
docs: rewrite introduction 2021-04-19 21:47:29 +08:00
docs(readme): add site url 2021-06-05 00:28:31 +08:00			`[www.naiveui.com](http://www.naiveui.com)`
chore: some fixes 2020-03-02 22:41:52 +08:00
docs(readme): move up community Hope more people can be got involved in. 2021-06-12 16:06:28 +08:00			`## Community`

			`- [Discord](https://discord.gg/Pqv7Mev5Dd)`
			`- DingTalk Group 33482509`
docs: add Awesome in README (#558) 2021-07-20 16:32:09 +08:00			`- [Awesome Naive UI](https://github.com/naive-ui/awesome-naive)`
docs(readme): move up community Hope more people can be got involved in. 2021-06-12 16:06:28 +08:00
Update README.md 2020-03-02 23:24:44 +08:00			`## Features`
docs: rewrite introduction 2021-04-19 21:47:29 +08:00
docs: introduction en translation 2021-06-03 12:26:41 +08:00			`### Fairly Complete`
docs: rewrite introduction 2021-04-19 21:47:29 +08:00
			`There are more than 70 components. Hope they can help you write less code.`

			`What's more, they are all treeshakable.`

docs: introduction en translation 2021-06-03 12:26:41 +08:00			`### Customizable Themes`
docs: rewrite introduction 2021-04-19 21:47:29 +08:00
docs(readme): fix typos (#63) 2021-06-10 23:09:18 +08:00			`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.`
docs: rewrite introduction 2021-04-19 21:47:29 +08:00
			`What's more, no less/sass/css variables, no webpack loaders are required.`

chore: fix cases for GitHub and TypeScript (#28) 2021-06-09 00:21:50 +08:00			`### Uses TypeScript`
docs: rewrite introduction 2021-04-19 21:47:29 +08:00
docs(readme): fix typos (#63) 2021-06-10 23:09:18 +08:00			`All the stuff in Naive UI is written in TypeScript. It can work with your typescript project seamlessly.`
docs: rewrite introduction 2021-04-19 21:47:29 +08:00
			`What's more, you don't need to import any CSS to use the components.`

			`### Not too Slow`

feat(cascader): virtual-scroll prop 2021-05-17 15:52:00 +08:00			`I try to make it not rather slow. At least select, tree, transfer, table and cascader work with virtual list.`
docs: rewrite introduction 2021-04-19 21:47:29 +08:00
			`What's more, ..., no more. Just enjoy it.`
Update README.md 2020-03-02 23:24:44 +08:00
docs(readme): installation 2021-04-19 21:56:19 +08:00			`## Installation`

			`### npm`

			`Use npm to install.`

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

			`### Fonts`

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

			`### Icons`

docs(readme): community 2021-06-05 09:18:38 +08:00			`Naive UI recommends using [xicons](https://www.xicons.org) as icon library.`
docs(readme): installation 2021-04-19 21:56:19 +08:00
			`### Design Resources`

docs: refactor design resources link 2021-07-07 00:41:47 +08:00			`[Naive UI (Sketch)](https://naive-ui.oss-accelerate.aliyuncs.com/NaiveUI-Design-Library%28Square-Corner%29.sketch).`
docs(readme): installation 2021-04-19 21:56:19 +08:00
docs(readme): add contributing guide 2021-06-05 23:24:07 +08:00			`## Contributing`

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

chore: some fixes 2020-03-02 22:41:52 +08:00			`## License`
docs: rewrite introduction 2021-04-19 21:47:29 +08:00
chore: some fixes 2020-03-02 22:41:52 +08:00			`Naive UI is licensed under the [MIT license](https://opensource.org/licenses/MIT).`

docs: rewrite introduction 2021-04-19 21:47:29 +08:00			Graphics resouces 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).