0.1.0 • Published 7 months ago
react-form-model-controller v0.1.0
react-form-model-controller
Boosts productivity through TypeScript IDE support, streamlines data serialization/deserialization and validation, and offers customizable UI with render props for seamless server communication. A class model-based React form system utilizing decorators and metadata reflection.
Description
This form system enhances productivity with TypeScript IDE support, simplifies data serialization/deserialization and validation, and provides customizable UI with render props for seamless server communication.
Demo
Get Started
npm install react-form-model-controlleryarn add react-form-model-controllerpnpm add react-form-model-controller
Features
Fully Supported TypeScript
- Our form system is built with full TypeScript support, ensuring that you can take full advantage of IDE assistance. This means better code completion, error detection, and overall productivity enhancements as you build your forms.
Frees you from dealing with server-side data interface changes
- Say goodbye to the headaches of data serialization and deserialization. With our Mapper decorators, you can separate concerns between UI and server data handling. This allows you to focus solely on the UI, making your code more maintainable and adaptable to server changes without any hassle
- Has mapper layer for data serialization/deserialization. just annotated @Mapper.Read / @Mapper.Write.
Built-in Validation
- Form validation is a critical aspect of any form management system. Our library comes with built-in validation support, ensuring your forms handle user input correctly and efficiently. You can define your validation logic and put it in to Field componet validator prop.
Customizable UI with Render Props
- Flexibility is at the core of our system. Using the render props pattern, you can tailor the UI to meet your specific needs. Whether you need a simple form or a complex, highly customized interface, our system provides the tools to make it happen.
Basic Usage
- Define model and create hook.
- Use created hook in your component.
Caveat
- Check your codebase settings(env) for decorator syntax.
APIS
Field Component Props
| Target | Description | Type | Required |
|---|---|---|---|
| name | Name of the field defined in the model | string | required |
| refValues | Fields that will trigger re-rendering and are included in the values | Array<keyof TFormModel> | optional |
| validator | Function to validate the field | (value: T) => string \| null \| undefined | optional |
| validateOnMount | Whether to validate the field when it is mounted | boolean | optional |
Field Component Children Arguments (Render-Props Arguments)
| Target | Description | Type |
|---|---|---|
| value | Value of the field | TValue |
| values | Values of the fields passed in refValues | Partial<TFormModel> |
| error | Error message | string \| undefined \| null |
| fieldHandler | Handler for the field corresponding to the Field component | (TValue) => void |
| getFieldHandler | Getter for a specific field handler | (key: TKey, value: TFormModel[TKey]) => void |
| getComplexFieldHandler | Getter for a handler used in complex field settings | (key: TKey, path: string (inferred by TypeScript), value: TValue) => void |
Controller
| Target | Description | Type |
|---|---|---|
| setValue | Updates the value of a specific field | (key: TKey, value: TFormModel[TKey]) => void |
| setValues | Updates the entire form model | (values: TFormModel) => void |
| validate | Validates a specific field | (key: TKey) => boolean |
| validateAll | Validates all fields | (key: TKey, value: TFormModel[TKey]) => boolean |
| undo | Undoes the last update (experimental) | () => void |
| reset | Resets the form to its initial state | () => void |
| subscribe | Subscribes to changes in specific form values. Listens for changes in the specified keys and triggers the provided callback function when those values change. | (keys: TKey[], listener: (values: Pick<NonNullable<TFormModel>, TKey>) => void |
| read | Fetches data from the server, converts it to the model format, and sets the form | (data: DataResponse) => void |
| write | Converts model data to the format expected by the server | () => WriteResult(server expected data) |