React High Order Form Component.
npm install
npm start
open https://localhost:8000/examples/
- Support react.js and even react-native
- Validate fields with async-validator
import { createForm } from 'rc-form';
class Form extends React.Component {
submit = () => {
this.props.form.validateFields((error, value) => {
console.log(error, value);
});
}
render() {
let errors;
const { getFieldProps, getFieldError } = this.props.form;
return (
<div>
<input {...getFieldProps('normal')}/>
<input {...getFieldProps('required', {
onChange(){}, // have to write original onChange here if you need
rules: [{required: true}],
})}/>
{(errors = getFieldError('required')) ? errors.join(',') : null}
<button onClick={this.submit}>submit</button>
</div>
);
}
}
export createForm()(Form);
Expo preview
Or a quicker version:
import { createForm } from 'rc-form';
class Form extends React.Component {
componentWillMount() {
this.requiredDecorator = this.props.form.getFieldDecorator('required', {
rules: [{required: true}],
});
}
submit = () => {
this.props.form.validateFields((error, value) => {
console.log(error, value);
});
}
render() {
let errors;
const { getFieldError } = this.props.form;
return (
<div>
{this.requiredDecorator(
<input
onChange={
// can still write your own onChange
}
/>
)}
{(errors = getFieldError('required')) ? errors.join(',') : null}
<button onClick={this.submit}>submit</button>
</div>
);
}
}
export createForm()(Form);
Option | Description | Type | Default |
---|---|---|---|
option.validateMessages | Preseted messages of async-validator | Object | {} |
option.onFieldsChange | Called when field changed, you can dispatch fields to redux store. | (props, changed, all): void | NOOP |
option.onValuesChange | Called when value changed. | (props, changed, all): void | NOOP |
option.mapProps | Get new props transfered to WrappedComponent. | (props): Object | props => props |
option.mapPropsToFields | Convert value from props to fields. Used for read fields from redux store. | (props): Object | NOOP |
option.fieldNameProp | Where to store the name argument of getFieldProps . |
String | - |
option.fieldMetaProp | Where to store the meta data of getFieldProps . |
String | - |
option.fieldDataProp | Where to store the field data | String | - |
option.withRef(deprecated) | Maintain an ref for wrapped component instance, use refs.wrappedComponent to access. |
boolean | false |
Note: use wrappedComponentRef instead of withRef after [email protected]
class Form extends React.Component { ... }
// deprecated
const EnhancedForm = createForm({ withRef: true })(Form);
<EnhancedForm ref="form" />
this.refs.form.refs.wrappedComponent // => The instance of Form
// Recommended
const EnhancedForm = createForm()(Form);
<EnhancedForm wrappedComponentRef={(inst) => this.formRef = inst} />
this.formRef // => The instance of Form
The returned function of createForm(). It will pass an object as prop form
with the following members to WrappedComponent:
Will create props which can be set on a input/InputComponent which support value and onChange interface.
After set, this will create a binding with this input.
<form>
<input {...getFieldProps('name', { ...options })} />
</form>
This input's unique name.
Option | Description | Type | Default |
---|---|---|---|
option.valuePropName | Prop name of component's value field, eg: checkbox should be set to checked ... |
String | 'value' |
option.getValueProps | Get the component props according to field value. | (value): Object | (value) => ({ value }) |
option.getValueFromEvent | Specify how to get value from event. | (e): any | See below |
option.initialValue | Initial value of current component. | any | - |
option.normalize | Return normalized value. | (value, prev, all): Object | - |
option.trigger | Event which is listened to collect form data. | String | 'onChange' |
option.validateTrigger | Event which is listened to validate. Set to falsy to only validate when call props.validateFields. | String | String[] |
option.rules | Validator rules. see: async-validator | Object[] | - |
option.validateFirst | Whether stop validate on first rule of error for this field. | boolean | false |
option.validate | Object[] | - | |
option.validate[n].trigger | Event which is listened to validate. Set to falsy to only validate when call props.validateFields. | String | String[] |
option.validate[n].rules | Validator rules. see: async-validator | Object[] | - |
option.hidden | Ignore current field while validating or gettting fields | boolean | false |
function defaultGetValueFromEvent(e) {
if (!e || !e.target) {
return e;
}
const { target } = e;
return target.type === 'checkbox' ? target.checked : target.value;
}
{
validateTrigger: 'onBlur',
rules: [{required: true}],
}
// is the shorthand of
{
validate: [{
trigger: 'onBlur',
rules: [required: true],
}],
}
Similar to getFieldProps
, but add some helper warnings and you can write onXX directly inside React.Node props:
<form>
{getFieldDecorator('name', otherOptions)(<input />)}
</form>
Get fields value by fieldNames.
Get field value by fieldName.
Get field react public instance by fieldName.
Set fields value by kv object.
Set fields initialValue by kv object. use for reset and initial display/value.
Set fields by kv object. each field can contain errors and value member.
Validate and get fields value by fieldNames.
options is the same as validate method of async-validator.
And add force
and scroll
. scroll
is the same as dom-scroll-into-view's function parameter config
.
Defaults to false. Whether to validate fields which have been validated(caused by validateTrigger).
Get inputs' validate errors.
Get input's validate errors.
Whether this input is validating.
Whether one of the inputs is validating.
Whether this input's value had been changed by user.
Whether one of the inputs' values had been changed by user.
Reset specified inputs. Defaults to all.
Whether the form is submitting.
Cause isSubmitting to return true, after callback called, isSubmitting return false.
createDOMForm enhancement, support props.form.validateFieldsAndScroll
validateFieldsAndScroll([fieldNames: String[]], [options: Object], callback: (errors, values) => void)
props.form.validateFields enhancement, support scroll to the first invalid form field
Defaults to first scrollable container of form field(until document).
-
Do not use stateless function component inside Form component: facebook/react#6534
-
you can not set same prop name as the value of validateTrigger/trigger for getFieldProps
<input {...getFieldProps('change',{
onChange: this.iWantToKnow // you must set onChange here or use getFieldDecorator to write inside <input>
})}>
- you can not use ref prop for getFieldProps
<input {...getFieldProps('ref')} />
this.props.form.getFieldInstance('ref') // use this to get ref
or
<input {...getFieldProps('ref',{
ref: this.saveRef // use function here or use getFieldDecorator to write inside <input> (only allow function)
})} />
npm test
npm run chrome-test
npm run coverage
open coverage/ dir
rc-form is released under the MIT license.