Skip to content

Latest commit

 

History

History
305 lines (194 loc) · 11 KB

form-props.md

File metadata and controls

305 lines (194 loc) · 11 KB
Raw

<Form /> props

acceptcharset

The value of this prop will be passed to the accept-charset HTML attribute on the form.

action

The value of this prop will be passed to the action HTML attribute on the form.

Note that this just renders the action attribute in the HTML markup. There is no real network request being sent to this action on submit. Instead, react-jsonschema-form catches the submit event with event.preventDefault() and then calls the onSubmit function, where you could send a request programmatically with fetch or similar.

autoComplete

The value of this prop will be passed to the autocomplete HTML attribute on the form.

autocomplete

Deprecated, same functionality as autoComplete

className

The value of this prop will be passed to the class HTML attribute on the form.

children

You can provide custom buttons to your form via the Form component's children. If no children are provided, by default a Submit button will be rendered.

For other ways to modify the default Submit button, see both the Submit Button Options and the SubmitButton Template documentation.

import { RJSFSchema } from "@rjsf/utils";
import validator from "@rjsf/validator-ajv8";

const schema: RJSFSchema = {
  type: "string"
};

render((
  <Form schema={schema} validator={validator}>
    <div>
      <button type="submit">Submit</button>
      <button type="button">Cancel</button>
    </div>
  </Form>
), document.getElementById("app"));

Warning: There needs to be a button or an input with type="submit" to trigger the form submission (and then the form validation).

customValidate

Formerly the validate prop. The customValidate prop requires a function that specifies custom validation rules for the form. See Validation for more information.

disabled

It's possible to disable the whole form by setting the disabled prop. The disabled prop is then forwarded down to each field of the form.

import { RJSFSchema } from "@rjsf/utils";
import validator from "@rjsf/validator-ajv8";

const schema: RJSFSchema = {
  type: "string"
};

render((
  <Form schema={schema} validator={validator} disabled />
), document.getElementById("app"));

If you just want to disable some fields, see the ui:disabled parameter in uiSchema.

readonly

It's possible to make the whole form read-only by setting the readonly prop. The readonly prop is then forwarded down to each field of the form.

import { RJSFSchema } from "@rjsf/utils";
import validator from "@rjsf/validator-ajv8";

const schema: RJSFSchema = {
  type: "string"
};

render((
  <Form schema={schema} validator={validator} readonly />
), document.getElementById("app"));

If you just want to make some fields read-only, see the ui:readonly parameter in uiSchema.

enctype

The value of this prop will be passed to the enctype HTML attribute on the form.

extraErrors

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. See Validation for more information.

ErrorList

You can pass a React component to this prop to customize how form errors are displayed. See Validation for more information.

fields

Dictionary of registered fields in the form. See Custom Widgets and Fields for more information.

formContext

You can provide a formContext object to the Form, which is passed down to all fields and widgets. Useful for implementing context aware fields and widgets. Setting {readonlyAsDisabled: false} on the formContext will make the antd theme treat readOnly fields as disabled.

formData

Often you'll want to prefill a form with existing data; this is done by passing a formData prop object matching the schema.

id

The value of this prop will be passed to the id HTML attribute on the form.

idPrefix

To avoid collisions with existing ids in the DOM, it is possible to change the prefix used for ids (the default is root).

import { RJSFSchema } from "@rjsf/utils";
import validator from "@rjsf/validator-ajv8";

const schema: RJSFSchema = {
  type: "string"
};

render((
  <Form schema={schema} validator={validator} idPrefix={"rjsf_prefix"}/>
), document.getElementById("app"));

This will render <input id="rjsf_prefix_key"> instead of <input id="root_key">

idSeparator

To avoid using a path separator that is present in field names, it is possible to change the separator used for ids (the default is _).

import { RJSFSchema } from "@rjsf/utils";
import validator from "@rjsf/validator-ajv8";

const schema: RJSFSchema = {
  type: "object",
  properties: {
    first: {
      type: "string"
    }
  }
};

render((
  <Form schema={schema} validator={validator} idSeparator={"/"}/>
), document.getElementById("app"));

This will render <input id="root/first"> instead of <input id="root_first"> when rendering first.

liveOmit

If omitExtraData and liveOmit are both set to true, then extra form data values that are not in any form field will be removed whenever onChange is called. Set to false by default.

liveValidate

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.

method

The value of this prop will be passed to the method HTML attribute on the form.

name

The value of this prop will be passed to the name HTML attribute on the form.

noHtml5Validate

If set to true, turns off HTML5 validation on the form. Set to false by default.

noValidate

If set to true, turns off all validation. Set to false by default.

omitExtraData

If set to true, then extra form data values that are not in any form field will be removed whenever onSubmit is called. Set to false by default.

onBlur

Sometimes you may want to trigger events or modify external state when a field has been touched, so you can pass an onBlur handler, which will receive the id of the input that was blurred and the field value.

onChange

If you plan on being notified every time the form data are updated, you can pass an onChange handler, which will receive the same first argument as onSubmit any time a value is updated in the form. It will also receive, as the second argument, the id of the field which experienced the change. Generally, this will be the id of the field for which input data is modified. In the case of adding/removing of new fields in arrays or objects with additionalProperties and the rearranging of items in arrays, the id will be that of the array or object itself, rather than the item/field being added, removed or moved.

onError

To react when submitted form data are invalid, pass an onError handler. It will be passed the list of encountered errors:

import { RJSFSchema } from "@rjsf/utils";
import validator from "@rjsf/validator-ajv8";

const schema: RJSFSchema = {
  type: "string"
};
const onError = (errors) => console.log("I have", errors.length, "errors to fix");

render((
  <Form schema={schema} validator={validator} onError={onError} />
), document.getElementById("app"));

onFocus

Sometimes you may want to trigger events or modify external state when a field has been focused, so you can pass an onFocus handler, which will receive the id of the input that is focused and the field value.

onSubmit

You can pass a function as the onSubmit prop of your Form component to listen to when the form is submitted and its data are valid. It will be passed a result object having a formData attribute, which is the valid form data you're usually after. The original event will also be passed as a second parameter:

import { RJSFSchema } from "@rjsf/utils";
import validator from "@rjsf/validator-ajv8";

const schema: RJSFSchema = {
  type: "string"
};
const onSubmit = ({formData}, e) => console.log("Data submitted: ",  formData);

render((
  <Form schema={schema} validator={validator} onSubmit={onSubmit} />
), document.getElementById("app"));

Note: If there are fields in the formData that are not represented in the schema, they will be retained by default. If you would like to remove those extra values on form submission, you may need to set the omitExtraData and/or liveOmit props.

schema

Required! Form schema. We support JSON schema draft-07 by default. See Schema Reference for more information.

showErrorList

When this prop is set to top or bottom, a list of errors (or the custom error list defined in the ErrorList) will also show at the bottom or top of the form. When set to false, only inline input validation errors will be shown. Set to top by default. See Validation for more information.

tagName

It's possible to change the default form tag name to a different HTML tag, which can be helpful if you are nesting forms. However, native browser form behaviour, such as submitting when the Enter key is pressed, may no longer work.

<Form
  tagName="div"
  ...
/>

You can also provide a class/function component.

const CustomForm = props => <form {...props} style={...} className={...} />
// ...
<Form
  tagName={CustomForm}
  ...
/>

target

The value of this prop will be passed to the target HTML attribute on the form.

templates

Dictionary of registered templates in the form. See Custom Templates for more information.

transformErrors

A function can be passed to this prop in order to make modifications to the default errors resulting from JSON Schema validation. See Validation for more information.

uiSchema

Form uiSchema. See uiSchema Reference for more information.

validator

Required! An implementation of the ValidatorType interface that is needed for form validation to work. @rjsf/validator-ajv8 exports the implementation of this interface from RJSF version 4.

widgets

Dictionary of registered widgets in the form. See Custom Widgets and Fields for more information.