Skip to components
DEVELOPER REFERENCE · v4.0.0

Badge API

Props, callbacks and methods. Select an underlined type to explore its fields, allowed values and callback arguments.

Badge5 props0 callbacks0 methods

Props5

Badge props
NameTypeDescription
variantOptional"solid" | "neutral" | "accent" | undefinedNeutral counters or accent emphasis. Defaults to the existing solid badge.
shapeOptional"rounded" | "pill" | undefinedControls the badge corner shape.
childrenOptional
ComponentChildrenInspect type
Content rendered inside the component. Supply nodes from the framework adapter you are using.
classNameOptionalstring | undefinedAdditional CSS classes applied to the component root.
labelOptionalstring | undefinedLabel content or accessible name for the component, as rendered by this control.

Events and callbacks0

No component-specific events or callbacks.

Methods0

No component-specific imperative methods. Use props and callbacks to control this component.