sdk.form.toggleschema
Home > @matterway/sdk > Form > ToggleSchema
Form.ToggleSchema interface
Signature:
export interface ToggleSchema extends BaseFieldSchema, Pick<ToggleFieldProps, 'label' | 'placeholder' | 'readOnly' | 'defaultValue'>
Extends: BaseFieldSchema, Pick<ToggleFieldProps, 'label' | 'placeholder' | 'readOnly' | 'defaultValue'>
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| name | string | Name of the property in the result data. | |
| props? | Omit<ToggleFieldProps, 'required'> | (Optional) Additional custom props for the field component like: label. | |
| type | 'toggle' | The type of form field used to edit this value. | |
| validation? | BooleanValidation | (Optional) A list of validation rules for this field. |