Form Components
checkbox-component
Overview
The checkbox-component component is a UI component that allows users to select a checkbox.
This component is used in the scheduling form to input checkbox type inputs.
| Version | 2.0.4 |
| Install (React) | npm install @nylas/react |
| Import (React) | import { CheckboxComponent } from '@nylas/react'; |
| Import (CDN) | You do not need to individually import the component, just import the parent component either nylas-scheduling or nylas-scheduler-editor. |
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
checked | The default value of the checkbox. This is the value that is displayed when the checkbox is rendered. | boolean | undefined | undefined | |
label | The label of the checkbox. This is displayed next to the checkbox. | string | '' | |
name | The name of the checkbox. This is used to identify the checkbox when submitting a form. | string | 'checkbox' | |
readOnly | The property to make the checkbox read-only. If true, the checkbox cannot be edited. | boolean | false | |
required | Whether the checkbox is required. If true, the checkbox must be checked when submitting a form. Default is false. If the checkbox is required and not checked, an error message is displayed. | boolean | false |
Events
| Event | Description | Type |
|---|---|---|
nylasFormCheckboxToggled | This event is fired when the checkbox is toggled. | CustomEvent<{ checked: boolean; name: string; label: string; }> |
Shadow Parts
| Part | Description |
|---|---|
"checkbox-label-span" |
Graph
Built with StencilJS