ScaffolderRJSFFormProps
Home > @backstage/plugin-scaffolder-react
> ScaffolderRJSFFormProps
The properties that are passed to the Form
Signature:
export interface ScaffolderRJSFFormProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>
Properties
Property |
Modifiers |
Type |
Description |
---|---|---|---|
ElementType |
(Optional) _internalFormWrapper is currently used by the semantic-ui theme to provide a custom wrapper around | ||
string |
(Optional) The value of this prop will be passed to the | ||
string |
(Optional) The value of this prop will be passed to the NOTE: this just renders the | ||
string |
(Optional) The value of this prop will be passed to the | ||
ReactNode |
(Optional) The optional children for the form, if provided, it will replace the default | ||
string |
(Optional) The value of this prop will be passed to the | ||
CustomValidator<T, S, F> |
(Optional) Formerly the | ||
boolean |
(Optional) It's possible to disable the whole form by setting the | ||
string |
(Optional) The value of this prop will be passed to the | ||
Experimental_DefaultFormStateBehavior |
(Optional) Optional configuration object with flags, if provided, allows users to override default form state behavior Currently only affecting minItems on array fields and handling of setting defaults based on the value of | ||
ErrorSchema<T> |
(Optional) This prop allows passing in custom errors that are augmented with the existing JSON Schema errors on the form; it can be used to implement asynchronous validation | ||
ScaffolderRJSFRegistryFieldsType<T, S, F> |
(Optional) The dictionary of registered fields in the form | ||
boolean | ((error: RJSFValidationError) => void) |
(Optional) If set to true, then the first field with an error will receive the focus when the form is submitted with errors | ||
F |
(Optional) You can provide a NOTE: Setting | ||
T |
(Optional) The data for the form, used to prefill a form with existing data | ||
string |
(Optional) The value of this prop will be passed to the | ||
string |
(Optional) To avoid collisions with existing ids in the DOM, it is possible to change the prefix used for ids; Default is | ||
string |
(Optional) To avoid using a path separator that is present in field names, it is possible to change the separator used for ids (Default is | ||
boolean |
(Optional) If | ||
boolean |
(Optional) If set to true, the form will perform validation and show any validation errors whenever the form data is changed, rather than just on submit | ||
string |
(Optional) The value of this prop will be passed to the | ||
string |
(Optional) The value of this prop will be passed to the | ||
boolean |
(Optional) If set to true, turns off HTML5 validation on the form; Set to | ||
boolean |
(Optional) If set to true, turns off all validation. Set to | ||
boolean |
(Optional) If set to true, then extra form data values that are not in any form field will be removed whenever | ||
(id: string, data: any) => void |
(Optional) Sometimes you may want to trigger events or modify external state when a field has been touched, so you can pass an | ||
(data: IChangeEvent<T, S, F>, id?: string) => void |
(Optional) If you plan on being notified every time the form data are updated, you can pass an | ||
(errors: RJSFValidationError[]) => void |
(Optional) To react when submitted form data are invalid, pass an | ||
(id: string, data: any) => void |
(Optional) Sometimes you may want to trigger events or modify external state when a field has been focused, so you can pass an | ||
(data: IChangeEvent<T, S, F>, event: FormEvent<any>) => void |
(Optional) You can pass a function as the | ||
boolean |
(Optional) It's possible to make the whole form read-only by setting the | ||
Ref<Form<T, S, F>> |
(Optional) Support receiving a React ref to the Form | ||
S |
The JSON schema object for the form | ||
false | 'top' | 'bottom' |
(Optional) When this prop is set to | ||
ElementType |
(Optional) It's possible to change the default | ||
string |
(Optional) The value of this prop will be passed to the | ||
Partial<Omit<TemplatesType<T, S, F>, 'ButtonTemplates'>> & { ButtonTemplates?: Partial<TemplatesType<T, S, F>['ButtonTemplates']>; } |
(Optional) The dictionary of registered templates in the form; Partial allows a subset to be provided beyond the defaults | ||
ErrorTransformer<T, S, F> |
(Optional) A function can be passed to this prop in order to make modifications to the default errors resulting from JSON Schema validation | ||
Registry['translateString'] |
(Optional) Optional string translation function, if provided, allows users to change the translation of the RJSF internal strings. Some strings contain replaceable parameter values as indicated by | ||
UiSchema<T, S, F> |
(Optional) The uiSchema for the form | ||
ValidatorType<T, S, F> |
An implementation of the | ||
RegistryWidgetsType<T, S, F> |
(Optional) The dictionary of registered widgets in the form |