element-plus/docs/en-US/component/badge.md

2.1 KiB

title lang
Badge en-US

Badge

A number or status mark on buttons and icons.

Basic Usage

Displays the amount of new messages.

:::demo The amount is defined with value which accepts Number or String.

badge/basic

:::

Max Value

You can customize the max value.

:::demo The max value is defined by property max which is a Number. Note that it only works when value is also a Number.

badge/max

:::

Customizations

Displays text content other than numbers.

:::demo When value is a String, it can display customized text.

badge/customize

:::

Red Dot

Use a red dot to mark content that needs to be noticed.

:::demo Use the attribute is-dot. It is a Boolean.

badge/dot

:::

Badge API

Badge Attributes

Attribute Description Type Default
value display value. string | number ''
max maximum value, shows {max}+ when exceeded. Only works if value is a number. number 99
is-dot if a little dot is displayed. boolean false
hidden hidden badge. boolean false
type badge type. 'primary' | 'success' | 'warning' | 'danger' | 'info' 'danger'

Badge Slots

Name Description
default customize default content