ant-design-vue/components/badge/index.en_US.md

23 lines
841 B
Markdown
Raw Normal View History

2018-02-07 18:44:11 +08:00
## API
2018-03-09 17:50:33 +08:00
````html
<a-badge :count="5">
2018-02-07 18:44:11 +08:00
<a href="#" class="head-example" />
</a-badge>
2018-03-09 17:50:33 +08:00
````
2018-02-07 18:44:11 +08:00
2018-03-09 17:50:33 +08:00
```html
<a-badge :count="5" />
````
2018-02-07 18:44:11 +08:00
| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
2018-03-09 17:50:33 +08:00
| count | Number to show in badge | number\|string | |
2018-02-07 18:44:11 +08:00
| dot | Whether to display a red dot instead of `count` | boolean | `false` |
| offset | set offset of the badge dot, like [x, y] | [number, number] | - |
| overflowCount | Max count to show | number | 99 |
| showZero | Whether to show badge when `count` is zero | boolean | `false` |
| status | Set Badge as a status dot | `success` \| `processing` \| `default` \| `error` \| `warning` | `''` |
| text | If `status` is set, `text` sets the display text of the status `dot` | string | `''` |
2018-03-09 17:50:33 +08:00
| numberStyle | sets the display style of the status `dot` | object | '' |