BadgeIconProperties
Icon settings for a — the icon itself plus its placement and behaviour inside the pill. All four properties are tightly coupled (the placement / gap / icon-only flags are only meaningful when an Icon is set) so they live together in a single nested object.
TypeScript
export interfaceProperties
| Property | Type | Description | Default |
|---|---|---|---|
| Gap | number | Pixel gap between the icon and the badge text. Falls back to the badge Density preset when omitted; ignored when is true. | |
| Icon | AdaptableIcon | Icon to display in the badge. | |
| IconOnly | boolean | Only show the icon and no badge text. | |
| Position | 'Start' | 'End' | Position of the icon in the badge — 'Start' or 'End'. | 'Start' |
Property Details
Gap
Pixel gap between the icon and the badge text. Falls back to the badge Density preset when omitted; ignored when is true.
TypeScript
Gap?: number;Property Value
number
Icon
Icon to display in the badge.
TypeScript
Icon: AdaptableIcon;Property Value
IconOnly
Only show the icon and no badge text.
TypeScript
IconOnly?: boolean;Property Value
boolean
Position
Position of the icon in the badge — 'Start' or 'End'.
TypeScript
Position?: 'Start' | 'End';Default Value
'Start'
Property Value
'Start' | 'End'