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)

vuejs
Searching Database…

18.6K ·GitHub
What is this?Naive UI is a Vue 3 component library with 90+ UI components, theme customization, full TypeScript coverage and a focus on speed.
Is it a framework I build my app on, or a library I add to an existing Vue project?A library you add to an existing Vue 3 app: import whichever components you need. All 90+ are treeshakable, so unused ones don't bloat your bundle.
How do I add it to a project?Install it via npm and import the components in your Vue 3 app; the full documentation lives at www.naiveui.com.
Does it work with Vue 2, or only Vue 3 — and does my project have to use TypeScript?It targets Vue 3 apps. The library is written in TypeScript and works seamlessly with TS projects, but plain JavaScript apps can use it too; working on the repo itself requires Node 20+ and pnpm.
Do I need to import any CSS or set up build tooling for the styles to work?No. There is no CSS to import when using the components, and theming needs no less/sass, no CSS variables and no webpack loaders.
Is it free to use in commercial projects?Yes, it is MIT licensed. One nuance: the graphics resources of the result component come from Twemoji and are licensed under CC-BY 4.0.
Which icon library should I pair it with?The README recommends xicons as the icon library. There are also official Naive UI design resources available as a Sketch file.
Does it support server-side rendering?Yes — the package ships with @css-render/vue3-ssr among its dependencies, which provides SSR styling support for Vue 3.
Creator
tusen-ai
Size
28 MB
Stars
18.6K
Updated
CommitOct 05
Age
5y
Commits · 90 Days