Function Checkbox

Checkbox(
props: BaseFieldProps<boolean>,
): { node: HTMLDivElement; data: () => { value: boolean } }

Checkbox component for boolean values

Parameters

props: BaseFieldProps<boolean>

Returns { node: HTMLDivElement; data: () => { value: boolean } }

Example

using consentField = app.scene(Checkbox, {
  defaultProps: {
    id: 'consent',
    label: 'I consent to participate in this study',
    validate: (value) => value || 'You must provide consent to continue',
  },
});
const data = await consentField.show();
console.log(data.value); // boolean