Type Alias: SchemaFormProps
SchemaFormProps:
Omit<FormProps,"schema"|"validator"> &object
SchemaForm component props.
Type declaration
| Name | Type | Description |
|---|---|---|
advancedProperties | Record<string, AdvancedProperty> | Additional schema for fields that are out of the default string, number, integer, object, array, boolean and null set for the form schema. The field set for advanced properties contain the same types as the default one, but add other fields such as email, password, select, radio, checkbox, checkboxes and switch. |
advancedPropertiesMapper | AdvancedPropertiesMapper | Custom mapper for the advanced properties. The default mapper for the form component is described in the example below. The rest of the SchemaForm props extend from react-jsonschema-form (opens in a new tab). Example { "string": "string", "email": "string", "password": "string", "array": "array", "select": "string", "radio": "string", "checkbox": "boolean", "checkboxes": "array", "switch": "boolean" } |
buttonComponent | ComponentType<SubmitButtonProps<any, RJSFSchema, any>> | Custom component for the form submit button |
buttonTitle | string | Title for the form submit button |
schema | RJSFSchema | Object that defines the structure of the form, containing information about field names, properties and formatting. Comprehensive guide available at the schema docs (opens in a new tab). |
title | ReactNode | The title of the form, usually displayed on top of the fields |
validator | FormProps["validator"] | Validation helper for the form structure. @rjsf/validator-ajvx provided by ajv (opens in a new tab), is generally used for this purpose. It is implemented on the form via the HTML5 Validation (opens in a new tab) |
Defined in
packages/react-material-ui/src/components/SchemaForm/SchemaForm.tsx:22 (opens in a new tab)