packages/js/components/src/dynamic-form/README.md
A component to handle form state and provide input helper props.
const initialValues = { firstName: '' };
<DynamicForm
fields={ fields }
onSubmit={ ( values ) => {
setSubmitted( values );
} }
isBusy={ false }
onChange={ () => {} }
validate={ () => ( {} ) }
submitLabel="Submit"
/>;
| Name | Type | Default | Description |
|---|---|---|---|
fields | {} or [] | [] | An object to describe the structure and types of all fields, matching the structure returned by the Settings API |
isBusy | Boolean | false | Boolean indicating busy state of submit button |
onSubmit | Function | noop | Function to call when a form is submitted with valid fields |
onChange | Function | noop | Function to call when any values on the form are changed |
validate | Function | noop | A function that is passed a list of all values and should return an errors object with error response |
submitLabel | String | "Proceed" | Label for submit button. |
Please reference the WordPress settings API documentation to better understand the structure expected for the fields property. This component accepts the object returned via the settings property when querying a gateway via the API, or simply the array provided by Object.values(settings).