mirror of https://github.com/tusen-ai/naive-ui.git synced 2024-12-21 04:50:14 +08:00

Go to file

songjianet 5264c0b30b docs(mention): 更新提及组件的说明文档 (#525 ) * docs(icon): 更新图标组件的说明文档 * docs(pageHeader): 更新页头组件的说明文档 * docs(pageHeader): 更新页头组件的文档中的错别字 * docs(typography): 更新排印组件的说明文档 * Update src/typography/demos/zhCN/index.demo-entry.md * docs(mention): 更新提及组件的说明文档 * docs(mention): 更新提及组件的一部分参数说明 Co-authored-by: 07akioni <07akioni2@gmail.com>		2021-07-16 23:23:21 +08:00
.github	feat: open bug issue add untriaged label	2021-07-10 13:24:00 +08:00
.husky	deps: husky@7.0.0	2021-07-02 00:37:21 +08:00
build	docs: add naive ui design download url (#71 )	2021-07-07 00:12:02 +08:00
demo	docs(ssr): vite example	2021-07-12 01:29:02 +08:00
design-notes	docs(maintaining): checklist	2021-07-05 12:46:29 +08:00
playground	refactor(ssr): remove ssr-provider & use new hook from @css-render/vue3-ssr	2021-06-12 18:16:23 +08:00
scripts	fix: no web-types	2021-06-30 21:01:56 +08:00
src	docs(mention): 更新提及组件的说明文档 (#525 )	2021-07-16 23:23:21 +08:00
themes/tusimple	fix(loading-bar): throws error when no provider found and export some type (#511 )	2021-07-15 00:07:02 +08:00
.eslintignore
.eslintrc.js	fix(radio-button): font-size	2021-06-07 18:22:38 +08:00
.gitignore	feat(web-types): add web-types.json (#310 )	2021-06-28 00:29:29 +08:00
.prettierignore	docs: add homepage & keywords & repository to pkg.json	2021-06-05 06:30:21 +08:00
.prettierrc	fix(menu): title extra not working	2021-02-03 16:05:54 +08:00
babel.config.js	perf(select): use v-show to trigger open fast	2021-05-17 13:42:55 +08:00
CHANGELOG.en-US.md	2.15.5	2021-07-16 01:50:51 +08:00
CHANGELOG.zh-CN.md	2.15.5	2021-07-16 01:50:51 +08:00
CONTRIBUTING.md	docs: modified some word usages (#246 )	2021-06-23 00:08:49 +08:00
index.html	site: derive document.title by path when doing init	2021-06-06 00:36:23 +08:00
jest.config.js	fix(log): warn on highlight.js when no language is set, closes #327	2021-07-01 00:03:21 +08:00
LICENSE	docs(license)	2021-06-05 00:27:00 +08:00
package.json	2.15.5	2021-07-16 01:50:51 +08:00
postcss.config.js
README.md	docs: refactor design resources link	2021-07-07 00:41:47 +08:00
README.zh-CN.md	docs: refactor design resources link	2021-07-07 00:41:47 +08:00
tsconfig.cjs.json	build: monorepo for themes	2021-02-10 20:35:50 +08:00
tsconfig.esm.json	build: monorepo for themes	2021-02-10 20:35:50 +08:00
tsconfig.json	feat(input): show count	2021-05-19 00:59:06 +08:00
vite.config.js	fix: use event name in lower case to avoid vue 3.0.6 regression	2021-02-25 16:18:18 +08:00
vue3.md	refactor: remove icons & nimbus icons	2021-05-26 16:15:10 +08:00

README.md

Naive UI

A Vue 3 Component Library

Fairly Complete, Customizable Themes, Uses TypeScript, Not too Slow

Kinda Interesting

English | 中文

Documentation

www.naiveui.com

Community

Discord
DingTalk Group 33482509

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.

npm i -D naive-ui

Fonts

npm i -D vfonts

Icons

Naive UI recommends using xicons as icon library.

Design Resources

Naive UI (Sketch).

Contributing

Please see CONTRIBUTING.md.

License

Naive UI is licensed under the MIT license.

Graphics resouces of result component is licensed under the CC-BY 4.0. The graphics resources come from Twemoji.