Skip to content

Checkbox ​

INFO

This component uses the checkbox from PrimeVue. It's full documentation can be found here. It does have some Codey specific features like automation ids, props and slots.

ts
import { XerCheckbox } from "@xerius/codey-components";

Showcases ​

Default ​

Grouped / List ​

As Container ​

With Subcontent ​

Without Option Control ​

Note

Using a component directly without XerOptionControl or <label> requires you to place the correct aria-label on the underlying component input element.

Props ​

All props from the Prime Checkbox can be provided. The full documentation can be found here.

Events ​

All events from the Prime Checkbox can be provided. The full documentation can be found here.

Slots ​

All slots from the Prime Checkbox can be provided. The full documentation can be found here.

Automation Ids ​

A data-automation-id needs to be provided to the component as Prime Vue based components do not have a default data-automation-id.