mirror of
https://github.com/tusen-ai/naive-ui.git
synced 2024-12-15 04:42:23 +08:00
c4d7068f8d
# Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit. |
||
|---|---|---|
| build | ||
| demo | ||
| doc | ||
| packages | ||
| styles | ||
| test | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitignore | ||
| .npmignore | ||
| .stylelintrc.js | ||
| babel.config.js | ||
| index.html | ||
| index.js | ||
| package.json | ||
| README.md | ||
| think.md | ||
naive-ui
TuSimple Vue-Based Frontend Component Library
Documentation
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 dev - 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 | 😍 | ||
| Tag | 🚧 | ||
| Divider | 🚧 | ||
| Statistic | 🚧 | ||
| PopConfirm | 🚧 | ||
| Anchor | 🚧 | ||
| BackTop | 🚧 | ||
| Progress | 🚧 | ||
| Timeline | 🚧 | ||
| Card | 🚧 | ||
| Collapse | 🚧 | ||
| Cascader | 🚧 |
- 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...)