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

Go to file

07akioni ffad17ff1f fix(popover): some times it can't disappear normally when mouseleave mouseleave event sometimes can't fire. So I detect mouseout outside the popover and activator to make it disappear. Implementation has many tricks. Sigh, life is so hard.		2019-07-18 00:32:01 +08:00
build	refactor(doc, select): a naive loader, detach select to body	2019-07-17 18:27:13 +08:00
demo	fix(popover): some times it can't disappear normally when mouseleave	2019-07-18 00:32:01 +08:00
doc	chore: remove some console.log	2019-07-17 18:42:05 +08:00
packages	fix(popover): some times it can't disappear normally when mouseleave	2019-07-18 00:32:01 +08:00
styles	refactor(doc, select): a naive loader, detach select to body	2019-07-17 18:27:13 +08:00
test	test(select): add some test case for v-model	2019-07-11 13:41:10 +08:00
.eslintignore	chore: style lint!	2019-06-28 15:08:31 +08:00
.eslintrc.js	style: .vue style fix	2019-06-04 12:09:02 +08:00
.gitignore	fixed the input model event name , from "change" to "changes".	2019-07-08 13:47:25 +08:00
.npmignore	feat: ci & doc!	2019-06-23 15:47:39 +08:00
.stylelintrc.js	chore: style-lint	2019-06-28 15:41:29 +08:00
babel.config.js	test(select)	2019-07-02 18:08:59 +08:00
index.html	feat: checkbox & round button	2019-06-14 10:59:06 +08:00
index.js	feat(radio): add radio component(not done yet)	2019-07-15 15:05:56 +08:00
package.json	release: 0.2.21	2019-07-17 19:30:05 +08:00
README.md	doc(readme): update progress	2019-07-14 18:43:27 +08:00
think.md	chore: remove some console.log	2019-07-17 18:42:05 +08:00

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

Run npm run build
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

You MUST change your version according to semver
npm run release
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	😍	❌
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	😍	❌
FormItem	🚧	❌
Form	🚧	❌
Table	🚧	❌	Function is not fulfilled
Tooltip	😍	❌
Popover	😍	❌
InputNumber	😍	❌
Radio	🚧
Tab	🚧
Breadcrumb	🚧
Badge	🚧
Steps	🚧

Todo

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