mirror of
https://github.com/ElemeFE/element.git
synced 2025-12-16 11:44:01 +08:00
component README update and fix
This commit is contained in:
49
packages/badge/README.md
Normal file
49
packages/badge/README.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# element-badge
|
||||
> A element-badge component for Vue.js.
|
||||
|
||||
## Demo
|
||||
http://element-component.github.io/element-badge
|
||||
|
||||
## Installation
|
||||
```shell
|
||||
npm i element-badge -D
|
||||
```
|
||||
|
||||
## Usage
|
||||
```javascript
|
||||
import Vue from 'vue'
|
||||
import ElBadge from 'element-badge'
|
||||
import 'element-theme-default/dist/badge.css'
|
||||
|
||||
Vue.use(ElBadge)
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```javascript
|
||||
import Vue from 'vue'
|
||||
import ElBadge from 'element-badge'
|
||||
|
||||
Vue.component('el-badge', ElBadge)
|
||||
```
|
||||
|
||||
### Attributes
|
||||
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|
||||
|------------- |---------------- |---------------- |---------------------- |-------- |
|
||||
| value | 显示值 | string, number | — | — |
|
||||
| max | 最大值,超过最大值会显示 '{max}+',要求 value 是 Number 类型 | number | — | — |
|
||||
| is-dot | 小圆点 | boolean | — | false |
|
||||
|
||||
## Development
|
||||
```shell
|
||||
make dev
|
||||
|
||||
## test
|
||||
make test
|
||||
|
||||
## build
|
||||
make build
|
||||
```
|
||||
|
||||
# License
|
||||
[MIT](https://opensource.org/licenses/MIT)
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"name": "el-badge",
|
||||
"name": "element-badge",
|
||||
"version": "0.0.0",
|
||||
"description": "A badge component for Vue.js.",
|
||||
"keywords": [
|
||||
|
||||
Reference in New Issue
Block a user