MobX Schema Form

MobX Schema Form is part of a collection of loosely-coupled components for managing, rendering and validating forms in MobX-based apps.

Detailed Documentation:

https://alexhisen.gitbooks.io/mobx-forms/

mobx-schema-form Overview

mobx-schema-form renders form widgets (by default Material Design) based on schema and form definition in json-schema-form format. Includes intelligent real-time validation and display of validation error message in each widget.

mobx-schema-form is a syntax-compatible wrapper around the low-level utils of react-schema-form. By default, mobx-schema-form uses React-Toolbox widgets instead of material-ui and wires up the widgets to work with MobX FormStore. It also adds some improvements primarily in the area of validation.

Features

• React-Toolbox is faster and lighter than Material-UI and uses easily themable/customizable CSS Modules instead of inline styles.
• Declarative form rendering and validation with added support for conditionally-rendered alternate widgets for the same model property (this works correctly in version 1.9.8+).
• Virtually zero code for a complete implementation
• Mobx-reactive conditional rendering of fields or groups of fields in fieldsets
• Easy styling/customization of each widget on a per-field basis
• Provides facilities for form-wide validation (i.e. of required fields when you hit the Save button) in addition to intelligent real-time field-level validation.
• (NEW in v1.10) Allows fields to be conditionally required using the new requiredCondition property in the form field metadata.
• Fields that are currently not rendered (based on their conditions) are omitted from form-wide validation.
• (NEW in v1.5) When fields stop being rendered based on their conditions they can optionally be set to null or other value.
• In addition to the built-in schema/tv4-based validation, supports custom validations and server-returned validation errors.
• Values from text, etc input fields have their white space trimmed on blur and non-numeric characters cannot be entered into form fields with schema type of numeric/integer (but negative integers and decimals such as 1.01 can still be keyed-in correctly).
• Radios or Dropdowns can be used for nullable Boolean values with automatic datatype conversion from strings such as 'off, no, false' to false and empty strings to null.
• (NEW in v1.6) When using React 16, you can have mobx-schema-form just return the array of rendered fields without a wrapper.
• (NEW in v1.8) MobxSchemaForm accepts optional child component to which fields are passed as children, so it can further wrap each field if necessary
• (NEW in v1.9) Text/Number inputs can be formatted (as-you-type) with a mask supported by react-input-mask
• (NEW in v1.11) Fields can be marked as readOnly:true in the form field metadata, which allows them to use computed (getter) properties in the model (supported in MobX FormStore 1.3.3+).
• (NEW in v1.14.1) Alternatively fields can have a readOnlyCondition in the form field metadata to be conditionally read-only.

Requirements

mobx-schema-form requires React 15 or 16, MobX 2.2+, 3.x, 4.x or 5.x, mobx-react 3.5+, 4.x or 5.x and expects models to be instances of MobX FormStore or objects in the modelShape (with at minimum data and dataErrors object properties). Unlike FormStore, which is published as a UMD module to NPM, mobx-schema-form is published in CommonJS ES5 format. In addition, default use of MobxSchemaForm requires React-Toolbox, which in turn requires your environment to be able to load SASS (React-Toolbox 1.x) or PostCSS/cssnext (React-Toolbox 2.x) files via require/import - i.e. properly configured webpack.

Installation

npm install --save mobx-schema-form

Note that npm will issue a warning about an unmet peer dependency of material-ui for react-schema-form. You can safely ignore it. The portion of react-schema-form we use does not require material-ui.

As of v1.7, react-toolbox is now a peer dependency, so you must install it yourself with npm install react-toolbox.

Minimal Usage Example

1import React from 'react';
2import { observer } from 'mobx-react';
3import { MobxSchemaForm } from 'mobx-schema-form';
4import SaveButton from 'mobx-schema-form/lib/SaveButton';
5import model from './myStore.js'; // a singleton instance of MobX FormStore
6
7/* eslint-disable quotes, quote-props, comma-dangle */
8// typically this would be in an external static json file
9const schemaJson = {
10  "schema": {
11    "type": "object",
12    "title": "MySchema",
13    "properties": {
14      "email": {
15        "title": "Email",
16        "type": "string",
17        "pattern": "^[A-Za-z0-9!#-'\\*\\+\\-/=\\?\\^_`\\{-~]+(\\.[A-Za-z0-9!#-'\\*\\+\\-/=\\?\\^_`\\{-~]+)*@[A-Za-z0-9!#-'\\*\\+\\-/=\\?\\^_`\\{-~]+(\\.[A-Za-z0-9!#-'\\*\\+\\-/=\\?\\^_`\\{-~]+)*$",
18        "validationMessage": {
19          "default":"Email must be of proper format: abc@xyz.com",
20          "302": "Email is required"
21        }
22      }
23    },
24    "required": ["email"]
25  },
26  "form": [
27    {
28      "key": "email",
29      "type": "email"
30    }
31  ]
32};
33/* eslint-enable */
34
35@observer class MyForm extends React.Component {
36  render() {
37    return (
38      <form>
39        <MobxSchemaForm
40          schema={schemaJson.schema}
41          form={schemaJson.form}
42          model={model}
43        />
44        <SaveButton
45          model={model}
46          options={{ allowCreate: true, saveAll: true }}
47          label="Save"
48          disabled={!model.status.canSave}
49          type="submit"
50        />
51      </form>
52    );
53  }
54}

Note that MobxSchemaForm uses the same props as react-schema-form's SchemaForm, except what react-schema-form calls model is actually model.data in mobx-schema-form. It also supports 'option' for compatibility with SchemaForm, though the correct form in MobxSchemaForm is 'options' plural.

React Hot Loader 3 compatibility

If you use react-hot-loader, you may find that Radio widgets are non-functional. In the current beta of React-Toolbox 2.x, you can work-around this issue by placing this code somewhere in your app (like an index.js):

1import { overrideComponentTypeChecker } from 'react-toolbox/lib/utils/is-component-of-type';
2
3// Work-around for react-hot-loader issue in React-Toolbox - see https://github.com/react-toolbox/react-toolbox/pull/1164
4overrideComponentTypeChecker((classType, reactElement) => {
5  return reactElement && (
6    reactElement.type === classType ||
7    reactElement.type.name === classType.displayName
8  );
9});