KBadge

A number or status mark on buttons and icons.

Install

pnpmyarnnpm

bash

pnpm add @ikun-ui/badge

bash

yarn add @ikun-ui/badge

bash

npm install @ikun-ui/badge

Displays the amount of new messages.

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

¹²

⁶⁶

You can customize the max value.

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

¹²

²⁵⁺

Displays text content other than numbers.

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

^one

^new

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

Use the attribute isDot. It is a Boolean.

🎤&💃

Name	Type	Default	Description
value	`string` / `number`	`''`	display value.
max	`number`	`99`	maximum value, shows {max}+ when exceeded. Only works if value is a number.
isDot	`boolean`	`false`	if a little dot is displayed.
show	`boolean`	`true`	show badge.
type	`primary` / `success` / `error` / `warning` / `info`	`error`	badge type.
cls	`string`	`''`	Additional class for component
attrs	`Record<string, string>`	`{}`	Additional attributes

Name	Description
default	Customize default content