doc(readme): complete develop status

This commit is contained in:
07akioni 2019-07-10 15:04:08 +08:00
parent 4f34b89568
commit 795cd615f4
2 changed files with 79 additions and 20 deletions

View File

@ -48,24 +48,27 @@ Vue.use(naiveUi)
```
## Component Develop Status
|Component|Unit Test|
|--|:--:|
|Alert|❌|
|Button|🆗|
|Checkbox|🆗|
|DatePicker|❌|
|GradientText|🆗|
|Icon|🆗|
|Input|🆗|
|Message|❌|
|Modal|❌|
|Notification|❌|
|Pagination|❌|
|Popup|❌|
|Select|🆗|
|Switch|❌|
|Tooltip|❌|
|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|
|Popup|😍|❌||
|Select|😍|🆗|Multiple search is not done|
|Switch|😍|❌||
|FormItem|🚧|❌||
|Form|🚧|❌||
|Table|🚧|❌|Function is not fulfilled|
|Tooltip|😍|❌|Remove the dependency of Popper.js|
|Popup|😍|❌|May be need to merge with Tooltip|
## Todo
1. Z-index management on `Select` & `Tooltip` & `Modal`(Low Priority)
2. Full featured table component(Medium Priority)

View File

@ -26,7 +26,7 @@ Run <code>npm run test-cov</code> to test all components and see detailed test c
<li>Open <code>http://localhost:8086/</code> in browser.</li>
</ol>
<h2 id="wanttoaddyourowncomponent">Want to add your own component</h2>
<p>Explore by your self or ask <code>lecong.zhang@tusimple.ai</code></p>
<p>There is no guideline for now. If you want to know how to do it, you can explore by yourself or ask <code>lecong.zhang@tusimple.ai</code>.</p>
<h2 id="publishanewversion">Publish a new version</h2>
<ol>
<li>You <strong>MUST</strong> change your version according to <a href="https://semver.org/">semver</a></li>
@ -50,69 +50,125 @@ Vue.use(naiveUi)
<thead>
<tr>
<th>Component</th>
<th style="text-align:center;">Develop status</th>
<th style="text-align:center;">Unit Test</th>
<th>Note</th>
</tr>
</thead>
<tbody>
<tr>
<td>Alert</td>
<td style="text-align:center;">😍</td>
<td style="text-align:center;"></td>
<td></td>
</tr>
<tr>
<td>Button</td>
<td style="text-align:center;">😍</td>
<td style="text-align:center;">🆗</td>
<td></td>
</tr>
<tr>
<td>Checkbox</td>
<td style="text-align:center;">😍</td>
<td style="text-align:center;">🆗</td>
<td></td>
</tr>
<tr>
<td>DatePicker</td>
<td style="text-align:center;">😍</td>
<td style="text-align:center;"></td>
<td></td>
</tr>
<tr>
<td>GradientText</td>
<td style="text-align:center;">😍</td>
<td style="text-align:center;">🆗</td>
<td></td>
</tr>
<tr>
<td>Icon</td>
<td style="text-align:center;">😍</td>
<td style="text-align:center;">🆗</td>
<td></td>
</tr>
<tr>
<td>Input</td>
<td style="text-align:center;">😍</td>
<td style="text-align:center;">🆗</td>
<td></td>
</tr>
<tr>
<td>Message</td>
<td style="text-align:center;">😍</td>
<td style="text-align:center;"></td>
<td>Code clean in need</td>
</tr>
<tr>
<td>Modal</td>
<td style="text-align:center;">😍</td>
<td style="text-align:center;"></td>
<td>Code clean in need</td>
</tr>
<tr>
<td>Notification</td>
<td style="text-align:center;">😍</td>
<td style="text-align:center;"></td>
<td>Code clean in need</td>
</tr>
<tr>
<td>Pagination</td>
<td style="text-align:center;"></td>
<td style="text-align:center;">😍</td>
<td style="text-align:center;">🆗</td>
<td>Unit test is not enough</td>
</tr>
<tr>
<td>Popup</td>
<td style="text-align:center;">😍</td>
<td style="text-align:center;"></td>
<td></td>
</tr>
<tr>
<td>Select</td>
<td style="text-align:center;">😍</td>
<td style="text-align:center;">🆗</td>
<td>Multiple search is not done</td>
</tr>
<tr>
<td>Switch</td>
<td style="text-align:center;">😍</td>
<td style="text-align:center;"></td>
<td></td>
</tr>
<tr>
<td>FormItem</td>
<td style="text-align:center;">🚧</td>
<td style="text-align:center;"></td>
<td></td>
</tr>
<tr>
<td>Form</td>
<td style="text-align:center;">🚧</td>
<td style="text-align:center;"></td>
<td></td>
</tr>
<tr>
<td>Table</td>
<td style="text-align:center;">🚧</td>
<td style="text-align:center;"></td>
<td>Function is not fulfilled</td>
</tr>
<tr>
<td>Tooltip</td>
<td style="text-align:center;">😍</td>
<td style="text-align:center;"></td>
<td>Remove the dependency of Popper.js</td>
</tr>
<tr>
<td>Popup</td>
<td style="text-align:center;">😍</td>
<td style="text-align:center;"></td>
<td>May be need to merge with Tooltip</td>
</tr>
</tbody>
</table>