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+ компонентов поддерживают treeshaking, поэтому неиспользуемые не раздувают ваш бандл.
Как добавить её в проект?Установите её через npm и импортируйте компоненты в своём приложении на Vue 3; полная документация находится на сайте www.naiveui.com.
Она работает с Vue 2 или только с Vue 3 — и обязан ли мой проект использовать TypeScript?Она рассчитана на приложения на Vue 3. Библиотека написана на TypeScript и без проблем работает в TS-проектах, но обычные приложения на JavaScript тоже могут её использовать; для работы над самим репозиторием нужны Node 20+ и pnpm.
Нужно ли импортировать какие-то CSS-файлы или настраивать сборку, чтобы работали стили?Нет. При использовании компонентов не нужно импортировать никакой CSS, а для темизации не требуются ни less/sass, ни CSS-переменные, ни загрузчики webpack.
Можно ли бесплатно использовать её в коммерческих проектах?Да, она распространяется по лицензии MIT. Один нюанс: графические ресурсы компонента result взяты из Twemoji и лицензированы под CC-BY 4.0.
Какую библиотеку иконок лучше использовать вместе с ней?В README в качестве библиотеки иконок рекомендуется xicons. Также доступны официальные дизайн-ресурсы Naive UI в виде файла Sketch.
Она поддерживает серверный рендеринг?Да — в зависимостях пакета есть @css-render/vue3-ssr, который обеспечивает поддержку SSR-стилей для Vue 3.
Creator
tusen-ai
Size
28 MB
Stars
18.6K
Updated
CommitOct 05
Age
5y
Commits · 90 Days