naive-ui/README.md

naive-ui

TuSimple Vue-Based Frontend Component Library

Documentation

http://REMOVED/#/start

Repository

https://REMOVED/naive-ui/tree/develop

Develop Guidelines

Git Commit Message Style

You MUST follow Angular Commit Format.

If you want see some example, see Angular Commits on Github.

Code Styles

Javascript Style

You MUST follow Standard JS.

SCSS Style

Run npm run lint-style to check styles.

Check Both

Run npm run lint You MUST fix all lint warnings and errors before you push your branch.

Unit test

If you create a component, you MUST add unit test for it.

Run npm run test to test all components. Run npm run test-cov to test all components and see detailed test coverage report.

Want to see how component works

1. Run npm run dev
2. Open http://localhost:8086/ in browser.

Want to add your own component

There is no guideline for now. If you want to know how to do it, you can explore by yourself or ask lecong.zhang@tusimple.ai.

Publish a new version

1. You MUST change your version according to semver
2. npm run release
3. You MAY publish documentation by running npm run release-doc

Installation & Usage

First install it.

npm install --save-dev naive-ui

Then add the following lines in you entry point js file.

...
import naiveUi from 'naive-ui'
import 'naive-ui/dist/lib/index.css

Vue.use(naiveUi)
...

Component Develop Status

Component	Develop status	Unit Test	Note
Alert	😍	❌
Button	😍	🆗
Checkbox	😍	🆗
DatePicker	😍	❌
TimePicker	😍	❌
GradientText	😍	🆗
Icon	😍	🆗
Input	😍	🆗
Message	😍	❌	Code clean in need
Modal	😍	❌	Code clean in need
Notification	😍	❌	Code clean in need
Pagination	😍	🆗	Unit test is not enough
Select	😍	🆗	Multiple search is not done
Switch	😍	❌
Tooltip	😍	❌
Popover	😍	❌
InputNumber	😍	❌
Radio	😍
Tab	😍
Badge	😍
Steps	😍
Tag	😍
Divider	😍
Popconfirm	😍
BackTop	😍
Progress	😍		Multiple Value
Timeline	😍
Collapse	😍
Cascader	😍
Dropdown	😍
Transfer	😍
Spin	😍
Drawer	🤔
FormItem	🤔	❌
Form	🤔	❌
Table	🤔	❌	Function is not fulfilled
LoadingBar	😍
Time	🚧
Anchor	🚧
Statistic	🚧
Breadcrumb	🚧
Card	🚧
Empty	🚧
Grid	🚧
Layout	🚧
Affix	🚧
AutoComplete	🚧
Tree	🚧
TreeSelect	🚧
Upload	🚧
Slider	🚧
Rating	🚧
Avator	🚧
Result	🚧
Menu	✋
Typography	✋
Mentions	✋
Calendar	✋		Not Planned
Carousel	✋		Not Planned

1. Z-index management on Select & Tooltip & Modal(Low Priority)
2. Full featured table component(Medium Priority)
3. Form component(Medium Priority)
4. FormItem component(High Priority)
5. Complete unit test for all existing components(High Priority)
6. Create a Markdown webpack loader to convert documentation(Low Priority)
7. Refactor documentation page(for code clairity)
8. Code refactor for some 😢 messy code(which is my bad...)
9. Refactor CSS use mixins(which means I should learn SCSS hard...)

RoadMap

v0.3 cascader v0.4 refactor popover v0.5 finish all planned components v0.6 add keyboard event on planned components v0.7 refactor form component v0.8 refactor table component v0.9 fulfill props for all components v0.10 split icons for components v0.11 refactor css v0.12 import on demand v0.13 i18n v0.14 unit test v0.15 light theme v0.16 refactor using proper html tags v0.17 document formation v0.18 refactor document page