How react-component/field-form works
Project Type and Purpose
• This is an open‑source React form component library (rc-field-form) designed to provide a performant, hook‑based API for building and validating forms in React (and React Native). It is not a full‑stack app but a front‑end UI library distributed via npm.
File‑Structure Analysis
• Top‑level: configuration files (.eslintrc.js, tsconfig.json), build scripts (.dumirc.ts, fatherrc.ts), documentation (docs/), examples (docs/examples/), tests (tests/), source code (src/), and utility scripts.
• src/: the core modules:
• Form.tsx & Field.tsx & List.tsx: React components
• useForm.ts & useWatch.ts: custom hooks
• *Context.tsx: React Context providers for form state and field registration
• utils/: state‑ and validation‑helper functions (e.g., validateUtil.ts, valueUtil.ts, asyncUtil.ts)
• External dependency: @rc-component/async-validator for schema‑based validation.
Key Insights from README
• Emphasizes hook‑based form instance via Form.useForm()
• Context API under the hood to register fields, track state (touched, validating, errors)
• Validation orchestration returning Promises, removing legacy callback patterns
• Designed for React and React Native, with a small, focused API surface (Form, Field, List, useForm, useWatch)
Main Components
a. Form Instance & Hook Layer
• useForm() hook → returns FormInstance object (methods: getFieldsValue, validateFields, setFieldsValue, etc.)
b. Form Component Layer
• <Form> component wraps children in <FormContext.Provider value={formInstance}>
c. Field Component Layer
• <Field> registers itself on mount via FormContext
• Internally uses <FieldContext.Provider> to pass down meta (value, errors, onChange handlers)
d. Component Layer
• <List> builds on similar patterns to dynamically add/remove field arrays via ListContext and ListOperations
e. Watch Hook
• useWatch() consumes FormContext to subscribe to specific value changes
f. Utility Modules
• validateUtil & asyncUtil: validation orchestration
• valueUtil & NameMap: value access and manipulation by name paths
Relationships and Data Flow
• useForm() → initialises FormInstance
• Form consumes FormInstance → provides context to children
• Field reads context → calls registerField() → on events, calls setFieldsValue() on FormInstance → triggers context updates
• validateFields() uses async-validator via validateUtil → updates field errors in context → rerenders registered Field components
• useWatch() subscribes to context change events for specific field value(s)
Architectural Patterns and Principles
• Context + Hooks for decoupled state management
• Single source of truth (FormInstance)
• Declarative registration/unregistration of fields (mount/unmount)
• Promise‑based validation pipeline replacing callback patterns
• Separation of concerns: UI components (Form/Field), state orchestration (contexts/hooks), utilities (value, validation)