Dojo NG is being built in the open, one section at a time — follow along on Heptapod.

API REFERENCE · FORM CONTROLS

<dj-checkbox-group>

Multi-select group from options; submits each checked value under name. With required, at least one option must be checked.

Try it in the playground

@dojo-ng/checkbox-group · v0.1.2

npm install @dojo-ng/checkbox-group

import "@dojo-ng/checkbox-group";

Properties

PropertyAttributeTypeDefault
options options CheckboxOption[] []
value value string[] []
name name reflected string None
label label string None
orientation orientation "vertical""horizontal" "vertical"
disabled disabled boolean false
required required boolean false

Events

change

Methods

reportValidity()checkValidity()restoreFormState(state: File | string | FormData | null)

Types

The types that the properties above use, as they are declared in the source.

CheckboxOption

export interface CheckboxOption { value: string; label?: string; disabled?: boolean; }