mirror of
https://github.com/tusen-ai/naive-ui.git
synced 2024-12-21 04:50:14 +08:00
80 lines
1.9 KiB
Markdown
80 lines
1.9 KiB
Markdown
<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">一个 Vue 3 组件库</p>
|
||
<p align="center"><b>比较完整，主题可调，使用 TypeScript，不算太慢</b></p>
|
||
<p align="center">有点意思</p>
|
||
|
||
<p align="center"><a href="README.md">English</a> | 中文</p>
|
||
|
||
## 文档
|
||
|
||
[www.naiveui.com](http://www.naiveui.com)
|
||
|
||
## 社区
|
||
|
||
- [Discord](https://discord.gg/Pqv7Mev5Dd)
|
||
- 钉钉群 33482509
|
||
|
||
## 特性
|
||
|
||
### 比较完整
|
||
|
||
有超过 70 个组件，希望能帮你少写点代码。
|
||
|
||
顺便一提，它们全都可以 treeshaking。
|
||
|
||
### 主题可调
|
||
|
||
我们提供了一个使用 TypeScript 构建的先进的类型安全主题系统。你只需要提供一个样式覆盖的对象，剩下的都交给我们。
|
||
|
||
顺便一提，不用 less、sass、css 变量，也不用 webpack 的 loaders。以及你可以试试右下角的主题编辑器。
|
||
|
||
### 使用 TypeScript
|
||
|
||
Naive UI 全量使用 TypeScript 编写，和你的 TypeScript 项目无缝衔接。
|
||
|
||
顺便一提，你不需要导入任何 CSS 就能让组件正常工作。
|
||
|
||
### 不算太慢
|
||
|
||
我尽力让它不要太慢。至少 select、tree、transfer、table、cascader 都可以用虚拟列表。
|
||
|
||
顺便一提，...，没有顺便了。祝你使用愉快。
|
||
|
||
## 安装
|
||
|
||
### npm
|
||
|
||
使用 npm 安装。
|
||
|
||
```bash
|
||
npm i -D naive-ui
|
||
```
|
||
|
||
### 字体
|
||
|
||
```bash
|
||
npm i -D vfonts
|
||
```
|
||
|
||
### 图标
|
||
|
||
naive-ui 建议使用 [xicons](https://www.xicons.org) 作为图标库。
|
||
|
||
### 设计资源
|
||
|
||
正在搞。
|
||
|
||
## 贡献
|
||
|
||
请参考 [CONTRIBUTING.md](https://github.com/TuSimple/naive-ui/blob/main/CONTRIBUTING.md)。
|
||
|
||
## 许可
|
||
|
||
Naive UI 使用 [MIT license](https://opensource.org/licenses/MIT) 许可证书。
|
||
|
||
`result` 组件的图像资源来自于 [Twemoji](https://github.com/twitter/twemoji)，遵守 [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/) 许可。
|