doc: unit test status added

This commit is contained in:
07akioni 2019-07-10 11:00:50 +08:00
parent 2004fdf4f1
commit 44d00136d3

View File

@ -2,7 +2,7 @@
TuSimple Vue-Based Frontend Component Library
# Documentation
http://***REMOVED***/#/start
# Start Develop / 开始开发
# Start Develop
- packages
- packages/commons
- packages/nimbus
@ -10,22 +10,42 @@ http://***REMOVED***/#/start
- test
- demo
- build
# Want to see how component works / 想看看组件效果?
Run `npm run build`, then open `http://localhost:8086/` at browser.
# Want to see how component works
Run `npm run build`, then open `http://localhost:8086/` in browser.
# Want to add your own component?
1. add some thing in packages
2. add some thing in demo/index.js demo/components
3. add some thing to index.js
# Publish a new version / 想发布一个新的版本
`npm run build`
# Publish a new version
`npm run release`
# Want to use this ui?
`npm install --save-dev naive-ui`
```
...
import installNaiveUiTo from 'naive-ui'
installNaiveUiTo(Vue)
import 'naive-ui/dist/lib/index.css'
import naiveUi from 'naive-ui'
import 'naive-ui/dist/lib/index.css
Vue.use(naiveUi)
...
```
# Component Develop Status
|Component|Unit Test|
|-|-|
|Alert|not done|
|Button|done|
|Checkbox|done|
|DatePicker|not done|
|GradientText|done|
|Icon|done|
|Input|done|
|Message|not done|
|Modal|not done|
|Notification|not done|
|Pagination|not done|
|Popup|not done|
|Select|done|
|Switch|not done|
|Tooltip|not done|
# Todo
Z-index management on `Select` & `Tooltip` & `Modal`! 这几个东西的顺序管理实在是有点麻烦,放在之后完善吧...