<Checkboxes>







Displays checkboxes with fixed multichoice options.
Only <OptionRoot>
is a valid child.
Use of <Checkboxes>
<Checkboxes
name="email"
isRequired={false}
labelHtml={{ en: 'Email' }}
hintHtml={{ en: 'E.g. user@example.com' }}
validationErrorRequiredHtml={{ en: 'Required' }}
validationErrorInvalidHtml={{ en: 'Invalid' }}
choosePromptHtml={{ en: 'Choose an email' }}
showOptionHints={false}
>
<OptionRoot>
<OptionGroup>
<Option />
<Option />
</OptionGroup>
<Option />
</OptionRoot>
</Checkboxes>
<Checkboxes>
's props
Prop | About | Type |
---|---|---|
choosePromptHtml | Localisable HTML: When multichoice is displayed in a | LocalisedHtml |
hintHtml | Localisable HTML: Hint content | LocalisedHtml |
isRequired | Whether users are required to fill in this form field. This setting affects | boolean |
labelHtml | Localisable HTML: Label content | LocalisedHtml |
name | The Name of the form control. Submitted with the form as part of a name:value pair in the | string |
showOptionHints | Whether to display option hints. In some cases (eg. | boolean |
tagsById | A list of tags for for this form field. | string[] |
validationErrorInvalidHtml | Localisable HTML: invalid validation content | LocalisedHtml |
validationErrorRequiredHtml | Localisable HTML: required validation content | LocalisedHtml |
id | Component Id. Must be unique within the form. | string |
hasChildrenById | Non-editable. Used to indicate that this component doesn't have children. | false |
hasTagsById | Non-editable. Used to indicate that this component has tags by id. | true |
isFormField | Non-editable. Used to indicate that this component is a form field. | true |
isMultichoice | Non-editable. Used to indicate that this component is a multichoice form field like | true |
options | If used in React this is non-editable. Only use this directly if constructing a document from JavaScript. | OptionNodes |
type | Non-editable. Type of component of | "Checkboxes" |