English · Русский
A form renderer on top of JSON Schema and react-final-form. A single schema describes both the value and how it is rendered: validation rules are standard Draft-07 keywords, and what a node is drawn with is the nodeParameters extension.
- Entry point:
@gravity-ui/dynamic-forms. - Status: stable API.
- Two layers:
core(headless engine) andkit(ready-made entities and layouts on@gravity-ui/uikit).
The previous DynamicField / DynamicView API is available from @gravity-ui/dynamic-forms/deprecated. SchemaRenderer imports from the removed /unstable entry point move to the package root. See the migration guide for the full transition and docs/deprecated for the previous API documentation.
npm install --save-dev @gravity-ui/dynamic-forms- How to use — quick start, the
nameprop, modes, what to pick. - API reference — components, hooks, props, constants, utilities,
kitexports, types. - Schema —
nodeParameters, flags, annotations, keywords,stringNumber,$ref. - Runtime — node lifecycle, value coercion, validation, errors, events, patches.
- Kit — layouts, entity catalog, service components, styles.
- Extension — custom entities, layouts, validators, config, standalone renderer.
- Migration — moving from the previous main API or
/unstable, converting Spec, compatibility through/deprecated. - Caveats and limitations — code-verified discrepancies, limitations and bugs.
src/lib is a form engine where both the form and the values overview are built from a single JSON Schema. The core layer has no controls of its own: everything rendered comes from the config. Validation runs through json-schema-library (Draft-07) plus the custom stringNumber keyword. The kit layer provides a ready registry: 30 entity keys across 6 node types, 7 layout keys, service components, the useExpanded hook, error texts and the specToJsonSchema converter from the old Spec format.
- Schema and config.
useSchemaRendererclonesschemaand stores state in a service field with a validator. - Nodes.
SchemaRendererNodetakes the subschema by pointer, registers afinal-formfield, picksentityandlayout. - Change. A value edit, via
validateFields, triggers only the service field validator. - Errors. The validator spreads errors by name into
srState.errors; nodes with a changed message re-render. - Imperative.
useSchemaRendererToolspatches the schema and adds external errors, restarting validation.
| Package | Role | Why |
|---|---|---|
react / react-dom / react-is |
peer | 18, 19. Rendering. |
final-form / react-final-form |
peer | Form, fields, submit, subscriptions. |
@gravity-ui/uikit |
peer | Version 8. Kit controls: TextInput, Select, Checkbox, etc. |
json-schema-library |
runtime | Draft-07 validation and the custom stringNumber keyword. |
decimal.js |
runtime | Number comparison and scale in stringNumber and *_with_scale. |
@gravity-ui/date-components, date-utils |
runtime | DateInput and DateValue. |
@gravity-ui/icons |
runtime | iconName in Alert, Label, TextContent. |
@gravity-ui/i18n |
runtime | Localization of error texts. |
@bem-react/classname, lodash, uuid |
runtime | Classes, utilities, keys. |
| Monaco | external | Not bundled. Passed via userContext.MonacoEditor. |
Certain components include text tokens (words and phrases) that are available in two languages: en (the default) and ru. To set the language, use the configure function:
// index.js
import {configure, Lang} from '@gravity-ui/dynamic-forms';
configure({lang: Lang.Ru});To start the development server with storybook execute the following command:
npm ci
npm run dev