Badge API

API documentation for Badge component

Badge#

Defines valid properties in Badge component.

name	type	default	description
ref	Ref<unknown>	null	The reference to the component instance.
pIf	boolean	true	Whether the component should be rendered.
style	CSSProperties \| ((instance?: BadgeInstance) => CSSProperties)	null	The style to apply to the component.
className	string \| ((instance?: BadgeInstance) => string)	null	The class name to apply to the component.
as	string \| number \| bigint \| boolean \| ComponentClass<any, any> \| FunctionComponent<any> \| ReactElement<unknown, string \| JSXElementConstructor<any>> \| Iterable<ReactNode, any, any> \| ReactPortal \| Promise<AwaitedReactNode>	null	The component type to render.
asChild	boolean	false	Whether the component should be rendered as a child component.
pt	SafeRecord<BadgePassThrough>	null	The pass-through props to pass to the component
ptOptions	PassThroughOptions	null	The pass-through options to pass to the component
unstyled	boolean	null	Whether the component should be rendered without classes.
dt	unknown	null	The design token to use for the component.
styles	StylesOptions<ComponentInstance>	null	The styles to use for the component.
children	ReactNode \| ((instance: BadgeInstance) => ReactNode)	null	The children to render.
shape	"circle"	null	Defines the shape of the badge.
size	"small" \| "large" \| "xlarge"	null	Size of the badge.
severity	"secondary" \| "info" \| "success" \| "warn" \| "danger" \| "contrast"	null	Severity type of the badge.
[key: string]	any	null
pt-{optionName}-*	-	null	Pass through attributes for customizing component. For more info, see Pass Through tab.

Defines passthrough(pt) options of Badge component.

name	type	default	description
root	BadgePassThroughType<HTMLAttributes<HTMLSpanElement>>	null	Used to pass attributes to the root's DOM element.

Instance of Badge component.

values
ComponentInstance<BadgeProps, BadgeState, BadgeExposes>

Defines valid properties in OverlayBadge component.

name	type	default	description
ref	Ref<unknown>	null	The reference to the component instance.
pIf	boolean	true	Whether the component should be rendered.
style	CSSProperties \| ((instance?: OverlayBadgeInstance) => CSSProperties)	null	The style to apply to the component.
className	string \| ((instance?: OverlayBadgeInstance) => string)	null	The class name to apply to the component.
as	string \| number \| bigint \| boolean \| ComponentClass<any, any> \| FunctionComponent<any> \| ReactElement<unknown, string \| JSXElementConstructor<any>> \| Iterable<ReactNode, any, any> \| ReactPortal \| Promise<AwaitedReactNode>	null	The component type to render.
asChild	boolean	false	Whether the component should be rendered as a child component.
pt	SafeRecord<OverlayBadgePassThrough>	null	The pass-through props to pass to the component
ptOptions	PassThroughOptions	null	The pass-through options to pass to the component
unstyled	boolean	null	Whether the component should be rendered without classes.
dt	unknown	null	The design token to use for the component.
styles	StylesOptions<ComponentInstance>	null	The styles to use for the component.
children	ReactNode \| ((instance: OverlayBadgeInstance) => ReactNode)	null	The children to render.
[key: string]	any	null
pt-{optionName}-*	-	null	Pass through attributes for customizing component. For more info, see Pass Through tab.

Defines passthrough(pt) options of OverlayBadge component.

name	type	default	description
root	OverlayBadgePassThroughType<HTMLAttributes<HTMLDivElement>>	null	Used to pass attributes to the root's DOM element.

Instance of OverlayBadge component.

values
ComponentInstance<OverlayBadgeProps, OverlayBadgeState, OverlayBadgeExposes>

Instance of useBadge headless.

values
HeadlessInstance<useBadgeProps, useBadgeState, useBadgeExposes>

On this page