naive-ui/README.zh-CN.md

80 lines
1.9 KiB
Markdown
Raw Normal View History

2021-04-19 21:54:16 +08:00
<p align="center">
<img width="144px" src="https://naiveui.oss-cn-hongkong.aliyuncs.com/naivelogo.svg" />
</p>
<h1 align="center">Naive UI</h1>
2021-05-25 13:21:43 +08:00
<p align="center">一个 Vue 3 组件库</p>
2021-04-19 21:54:16 +08:00
<p align="center"><b>比较完整,主题可调,使用 Typescript不算太慢</b></p>
<p align="center">有点意思</p>
<p align="center"><a href="README.md">English</a> | 中文</p>
## 文档
2021-06-05 00:28:31 +08:00
[www.naiveui.com](http://www.naiveui.com)
2021-04-19 21:54:16 +08:00
## 特性
2021-04-19 21:57:06 +08:00
### 比较完整
2021-04-19 21:54:16 +08:00
有超过 70 个组件,希望能帮你少写点代码。
顺便一提,它们全都可以 treeshaking。
2021-04-19 21:57:06 +08:00
### 主题可调
2021-04-19 21:54:16 +08:00
我们提供了一个使用 Typescript 构建的先进的类型安全主题系统。你只需要提供一个样式覆盖的对象,剩下的都交给我们。
顺便一提,不用 less、sass、css 变量,也不用 webpack 的 loaders。以及你可以试试右下角的主题编辑器。
2021-04-19 21:57:06 +08:00
### 使用 Typescript
2021-04-19 21:54:16 +08:00
Naive UI 全量使用 Typescript 编写,和你的 Typescript 项目无缝衔接。
顺便一提,你不需要导入任何 CSS 就能让组件正常工作。
2021-04-19 21:57:06 +08:00
### 不算太慢
2021-04-19 21:54:16 +08:00
2021-05-17 15:52:00 +08:00
我尽力让它不要太慢。至少 select、tree、transfer、table、cascader 都可以用虚拟列表。
2021-04-19 21:54:16 +08:00
顺便一提,...,没有顺便了。祝你使用愉快。
2021-04-19 21:56:19 +08:00
## 安装
### npm
使用 npm 安装。
```bash
npm i -D naive-ui
```
### 字体
```bash
npm i -D vfonts
```
### 图标
naive-ui 建议使用 [xicons](https://www.xicons.org) 作为图标库。
### 设计资源
2021-06-06 12:41:25 +08:00
正在搞。
2021-04-19 21:56:19 +08:00
2021-06-05 09:18:38 +08:00
## 社区
- [Discord](https://discord.gg/Pqv7Mev5Dd)
- 钉钉群 33482509
2021-06-05 23:24:07 +08:00
## 贡献
请参考 [CONTRIBUTING.md](https://github.com/TuSimple/naive-ui/blob/main/CONTRIBUTING.md)。
2021-04-19 21:54:16 +08:00
## 许可
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/) 许可。