Skip to content

Function: CheckboxListField()

ts
function CheckboxListField(props: UiCheckboxListFieldProps): Block;

Defined in: src/renderer/blocks/index.ts:767

Checkbox list field.

Parameters

ParameterType
propsUiCheckboxListFieldProps

Returns

Block

Examples

ts
CheckboxListField({
  name: 'interests',
  label: 'Interests',
  items: [
    {value: 'sports', label: 'Sports', description: 'Outdoor and team activities'},
    {value: 'music', label: 'Music', description: 'Listening and playing'},
    {value: 'reading', label: 'Reading', description: 'Books and articles'},
  ],
});
ts
CheckboxListField({
  name: 'permissions',
  label: 'Permissions',
  selectAll: true,
  items: [
    {value: 'read', label: 'Read access', description: 'View data'},
    {value: 'write', label: 'Write access', description: 'Modify data'},
    {value: 'delete', label: 'Delete access', description: 'Remove data'},
  ],
});

Matterway Assistant SDK Documentation