naive-ui README

The project's README from github.com/tusen-ai/naive-ui. As one markdown file: README.md.

Naive UI

A Vue 3 Component Library

Fairly Complete, Theme Customizable, Uses TypeScript, Fast

Kinda Interesting

npm pkg.pr.new

English | 中文

Documentation

www.naiveui.com

Community

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.

npm i naive-ui

Fonts

npm i 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 resources of result component is licensed under the CC-BY 4.0. The graphics resources come from Twemoji.

naive-ui (tusen-ai/naive-ui)

Searching Database…

18.6K ·GitHub
这是什么?Naive UI 是一个 Vue 3 组件库,包含 90 多个 UI 组件,支持主题定制,全面采用 TypeScript,并且注重速度。
它是我搭建应用的框架,还是添加到现有 Vue 项目里的库?它是一个库,添加到现有的 Vue 3 应用中:按需导入你需要的组件即可。全部 90 多个组件都支持 tree shaking,没用到的组件不会让打包体积变大。
怎么把它加到项目里?用 npm 安装,然后在你的 Vue 3 应用中导入组件;完整文档在 www.naiveui.com。
它支持 Vue 2 吗,还是只支持 Vue 3?我的项目必须用 TypeScript 吗?它面向 Vue 3 应用。这个库本身是用 TypeScript 写的,和 TypeScript 项目配合得很好,但纯 JavaScript 的应用也能用;不过要参与这个仓库本身的开发,需要 Node 20+ 和 pnpm。
我需要额外导入 CSS 或者配置构建工具,样式才能生效吗?不需要。使用组件时没有任何 CSS 要导入,主题定制也不需要 less/sass、CSS 变量或 webpack loader。
在商业项目里使用是免费的吗?是的,它采用 MIT 许可证。有一点要注意:result 组件里的图形资源来自 Twemoji,采用 CC-BY 4.0 许可证。
我应该搭配哪个图标库?README 推荐使用 xicons 作为图标库。另外还有官方的 Naive UI 设计资源,以 Sketch 文件的形式提供。
它支持服务端渲染吗?支持——这个包的依赖里自带 @css-render/vue3-ssr,为 Vue 3 提供 SSR 样式支持。
Creator
tusen-ai
Size
28 MB
Stars
18.6K
Updated
CommitOct 05
Age
5y
Commits · 90 Days