ontario-badge

Use badges to indicate the status of a page or section.

Do not use a badge to bring a user’s attention to important content.

Usage guidance

Please refer to the Ontario Design System for current documentation guidance for badges.

Configuration

Once the component package has been installed (see Ontario Design System Component Library for installation instructions), the badge component can be added directly into the project's code, and can be customized by updating the properties outlined here. Please see the examples below for how to configure the component.

Examples

Example of a badge component, where the user is explicitly passing in content through the label property.

HTML

<ontario-badge label="Not started"></ontario-badge>

React

<OntarioBadge label="Not started"></OntarioBadge>

Angular

<ontario-badge [label]="'Not started'"></ontario-badge>

This is another example of a badge. This time, the content is passed as a child of the ontario-badge component. A colour option is also passed.

HTML

<ontario-badge colour="light-teal">Completed</ontario-badge>

React

<OntarioBadge colour="lightTeal">Completed</OntarioBadge>

Angular

<ontario-badge [colour]="'lightTeal'">Completed</ontario-badge>

Completed

Technical Note: SSR (Server-Side Rendering) Considerations

The Ontario Badge component supports two ways of defining labels:

• Via the label prop (as a string)
• Via slotted children placed between the component's opening and closing tags

While both approaches work in the browser, only the label prop is reliably rendered during Server-Side Rendering (SSR).

SSR-safe example:

During SSR, fallback content using host.textContent is not reliably available. This is why it is recommended to pass the badge label through the label prop.

<OntarioBadge label="In progress"></OntarioBadge>

Properties

Property	Attribute	Description	Type	Default
ariaLabelText	aria-label-text	An aria label for screen readers. Used to provide more context to screen readers if necessary. This property is optional.	string | undefined	undefined
colour	colour	The colour of the badge.	"black" | "dark-grey" | "green" | "grey" | "light-teal" | "red" | "teal" | "white" | "yellow"	'teal'
label	label	The label for the badge. Offical guidance is to keep the label length within 15 characters.	string	undefined

Dependencies

Used by

• ontario-task

Graph

---

Built with StencilJS