Badge
areas: content
Small numerical value or status descriptor for UI elements. Badge is used as a container block, describing its content block.
Block
content
0
1
2
3
4
5
6
7
8
9
0
1
2
3
4
5
6
7
8
9
0
1
2
3
4
5
6
7
8
9
Block Setup
id: block_id
type: Badge
properties:
count: 1
offset: []
Settings
Badge JSON Schema Definition
type: object
properties:
properties:
additionalProperties: false
properties:
color:
description: Customize Badge dot color
type: string
count:
description: Text to show in badge.
type:
- number
- string
dot:
default: false
description: Whether to display a red dot instead of count
type: boolean
icon:
description: >-
Name of an Ant Design Icon or properties of an Icon block to use an icon
in badge.
type:
- string
- object
offset:
description: Set offset of the badge dot, array of numbers for x and y offset ([x,y])
items:
type: number
type: array
overflowCount:
default: 99
description: Max count to show
type: number
showZero:
default: false
description: Whether to show badge when count is zero
type: boolean
status:
default: null
description: Set Badge as a status dot
enum:
- success
- processing
- default
- error
- warning
type: string
text:
description: If status is set, text sets the display text of the status dot
type: string
title:
description: Text to show when hovering over the badge
type: string
type: object