@vtaits/react-final-form-schema
v2.1.0
Published
Integration of react-final-form and @vtaits/form-schema
Downloads
357
Maintainers
Readme
@vtaits/react-final-form-schema
Integration of react-final-form and @vtaits/form-schema.
Installation
yarn add final-form react-final-form @vtaits/react-final-form-schema
or
npm install final-form react-final-form @vtaits/react-final-form-schema --save
Examples
Usage
import { Form } from '@vtaits/react-final-form-schema';
<Form
onSubmit={(values, rawValues) => {
// submit logic
}}
getFieldSchema={getFieldSchema}
getFieldType={getFieldType}
names={names}
mapErrors={(rawErrors, values, rawValues) => {
// map errors berore process with mapFieldErrors
}}
{...reactFinalFormProps}
>
{
(reactFinalFormRenderProps) => {
// render logic, e.g.
return (
<>
<FormField name="field1" />
<FormField name="field2" />
<hr />
<FormField name="field3" payload="payload" />
</>
);
}
}
</Form>
It similar to react-final-form
but there is some differences:
getFieldSchema
,getFieldType
,names
are required. They are described in @vtaits/form-schema;onSubmit
receives serialized values as first argument;mapErrors
(not required) can map submission errors of form to format offinal-form
;initialValuesPlaceholder
- new prop, initial runtime values of form during asynchronous initialization.
FormField
A component for rendering field by name according to its schema
Props
name
- required, string, name of field for render;payload
- not required, payload prop of nested field;parents
- not required, stack of parent fields for child field.
Type declaration
Type declaration is similar with @vtaits/form-schema but there is new prop:
component
- react component that will be rendered withFormField
. Receives next props:name
- string, name of field;fieldSchema
- any, result ofgetFieldSchema
by name of field;payload
- any, prop ofFormField
, can be helpful for arrays of repeating fields;getFieldSchema
- see @vtaits/form-schema;getFieldType
- see @vtaits/form-schema;parents
- prop ofFormField
, stack of parent fields above current field with runtime values.
Built-in field types
Dynamic
The field that depends from other fields. Example:
import { dynamic } from '@vtaits/react-final-form-schema/fields/dynamic';
const schema = {
type: 'dynamic',
getSchema: ({
otherField,
}, phase) => ({
type: 'string',
label: 'String field',
required: Boolean(otherField),
}),
};
const getFieldType = (fieldSchema) => {
if (fieldSchema.type === 'dynamic') {
return dynamic;
}
// ...
}
Parameters:
getSchema
- required, function, should return schema for render ornull
. Arguments:values
- object of values of form, depends from 2nd argument;phase
- current phase ('parse'
,'serialize'
,'render'
). If phase is'parse'
, 1st argument is initial values before parsing, otherwise it is current values of form.getFieldSchema
- see @vtaits/form-schema;getFieldType
- see @vtaits/form-schema;parents
- stack of parent fields above current field with runtime values;
getSchemaAsync
- not required, function. Can be used for asynchronous parsing. Similar togetSchema
but should returnPromise
with result schema;onShow
- not required, callback that called when field has shown. Arguments:form
- instance offinal-form
;name
- name of field;schema
- result schema of subfield;getFieldSchema
- currentgetFieldSchema
;getFieldType
- globalgetFieldType
;parents
- stack of parent fields above current field with runtime values;
onHide
- not required, callback that called when field has hidden. Arguments:form
- instance offinal-form
;name
- name of field;getFieldSchema
- currentgetFieldSchema
;getFieldType
- globalgetFieldType
;parents
- stack of parent fields above current field with runtime values.
Set
The group of fields. It's comfortable when the dynamic
field must render several fields. Example:
import { dynamic } from '@vtaits/react-final-form-schema/fields/dynamic';
import { set } from '@vtaits/react-final-form-schema/fields/set';
const schema = {
type: 'dynamic',
getSchema: ({
responsibleType,
}) => {
if (responsibleType !== 'human') {
return null;
}
return {
type: 'set',
schemas: {
firstName: {
type: 'string',
label: 'First name',
},
lastName: {
type: 'string',
label: 'Last name',
},
},
};
},
};
const getFieldType = (fieldSchema) => {
if (fieldSchema.type === 'dynamic') {
return dynamic;
}
if (fieldSchema.type === 'set') {
return set;
}
// ...
}
Parameters:
schemas
- required, object whose keys are field names and values are their schemas;render
- not required, render function. . Arguments:names
- fields names (keys of schemas);
Utils
checkValuesReady
import { useFormState } from 'react-final-form';
import { checkValuesReady } from '@vtaits/react-final-form-schema';
// ...
const {
values,
} = useFormState();
const isValuesReady: boolean = checkValuesReady(values);
If parsing if asynchronous it returns true
only after end of parsing;
If parsing if synchronous it always returns true
.
useValuesReady
import { useValuesReady } from '@vtaits/react-final-form-schema';
// ...
const isValuesReady: boolean = useValuesReady();
Hook that encapsulates receiving state of form and checking ready state.
useFormSchemaState
Hook that returns state for wrapper above react-final-form
. This is object with next values:
isValuesReady
- boolean, result ofuseValuesReady
.