ion-badge

shadow

Badges are inline block elements that usually appear near another element. Typically they contain a number or other characters. They can be used as a notification that there are additional items associated with an element and indicate how many items there are. Badges are hidden if no content is passed in.

Basic Usage

Badges in Tab Buttons

Badges can be added inside a tab button, often used to indicate notifications or highlight additional items associated with the element.

info

Empty badges are only available for md mode.

Theming

Colors

CSS Properties

Properties

color

Description	The color to use from your application's color palette. Default options are: "primary", "secondary", "tertiary", "success", "warning", "danger", "light", "medium", and "dark". For more information on colors, see theming.
Attribute	color
Type	"danger" ｜ "dark" ｜ "light" ｜ "medium" ｜ "primary" ｜ "secondary" ｜ "success" ｜ "tertiary" ｜ "warning" ｜ string ｜ undefined
Default	undefined

hue

Description	Set to "bold" for a badge with vibrant, bold colors or to "subtle" for a badge with muted, subtle colors. Only applies to the ionic theme.
Attribute	hue
Type	"bold" ｜ "subtle" ｜ undefined
Default	undefined

mode

Description	The mode determines the platform behaviors of the component. This is a virtual property that is set once during initialization and will not update if you change its value after the initial render.
Attribute	mode
Type	"ios" ｜ "md"
Default	undefined

shape

Description	Set to "rectangular" for non-rounded corners. Set to "soft" for slightly rounded corners. Set to "round" for fully rounded corners. Defaults to "round" for the ionic theme, undefined for all other themes.
Attribute	shape
Type	"round ｜ rectangular" ｜ "soft" ｜ undefined
Default	undefined

size

Description	Set to "small" for a small badge. Set to "medium" for a medium badge. Set to "large" for a large badge, when it is empty (no text or icon). Defaults to "small" for the ionic theme, undefined for all other themes.
Attribute	size
Type	"large" ｜ "medium" ｜ "small" ｜ undefined
Default	undefined

theme

Description	The theme determines the visual appearance of the component. This is a virtual property that is set once during initialization and will not update if you change its value after the initial render.
Attribute	theme
Type	"ios" ｜ "md" ｜ "ionic"
Default	undefined

vertical

Description	Set to "top" to position the badge on top right absolute position of the parent element. Set to "bottom" to position the badge on bottom right absolute position of the parent element.
Attribute	vertical
Type	"bottom" ｜ "top" ｜ undefined
Default	undefined

Events

No events available for this component.

Methods

No public methods available for this component.

CSS Shadow Parts

No CSS shadow parts available for this component.

CSS Custom Properties

iOS

Name	Description
--background	Background of the badge
--color	Text color of the badge
--padding-bottom	Bottom padding of the badge
--padding-end	Right padding if direction is left-to-right, and left padding if direction is right-to-left of the badge
--padding-start	Left padding if direction is left-to-right, and right padding if direction is right-to-left of the badge
--padding-top	Top padding of the badge

MD

Name	Description
--background	Background of the badge
--color	Text color of the badge
--padding-bottom	Bottom padding of the badge
--padding-end	Right padding if direction is left-to-right, and left padding if direction is right-to-left of the badge
--padding-start	Left padding if direction is left-to-right, and right padding if direction is right-to-left of the badge
--padding-top	Top padding of the badge

Slots

No slots available for this component.