Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/react-component/form

React High Order Form Component(web & react-native)
https://github.com/react-component/form

Last synced: 2 days ago
JSON representation

React High Order Form Component(web & react-native)

Awesome Lists containing this project

README 

        
# rc-form



React High Order Form Component.



[![NPM version][npm-image]][npm-url]

[![build status][travis-image]][travis-url]

[![Test coverage][coveralls-image]][coveralls-url]

[![gemnasium deps][gemnasium-image]][gemnasium-url]

[![node version][node-image]][node-url]

[![npm download][download-image]][download-url]

[![Code Quality: Javascript][lgtm-badge]][lgtm-badge-url]

[![Total alerts][lgtm-alerts]][lgtm-alerts-url]



[npm-image]: http://img.shields.io/npm/v/rc-form.svg?style=flat-square

[npm-url]: http://npmjs.org/package/rc-form

[travis-image]: https://img.shields.io/travis/react-component/form.svg?style=flat-square

[travis-url]: https://travis-ci.org/react-component/form

[coveralls-image]: https://img.shields.io/coveralls/react-component/form.svg?style=flat-square

[coveralls-url]: https://coveralls.io/r/react-component/form?branch=master

[gemnasium-image]: http://img.shields.io/gemnasium/react-component/form.svg?style=flat-square

[gemnasium-url]: https://gemnasium.com/react-component/form

[node-image]: https://img.shields.io/badge/node.js-%3E=_0.10-green.svg?style=flat-square

[node-url]: http://nodejs.org/download/

[download-image]: https://img.shields.io/npm/dm/rc-form.svg?style=flat-square

[download-url]: https://npmjs.org/package/rc-form

[lgtm-badge]: https://img.shields.io/lgtm/grade/javascript/g/react-component/form.svg?logo=lgtm&logoWidth=18

[lgtm-badge-url]: https://lgtm.com/projects/g/react-component/form/context:javascript

[lgtm-alerts]: https://img.shields.io/lgtm/alerts/g/react-component/form.svg?logo=lgtm&logoWidth=18

[lgtm-alerts-url]: https://lgtm.com/projects/g/react-component/form/alerts



## Development



```

npm install

npm start

open http://localhost:8000/examples/

```



## Feature



* Support react.js and even react-native

* Validate fields with [async-validator](https://github.com/yiminghe/async-validator/)



## Install



[![rc-form](https://nodei.co/npm/rc-form.png)](https://npmjs.org/package/rc-form)



## Usage



```js

import { createForm, formShape } from 'rc-form';



class Form extends React.Component {

  static propTypes = {

    form: formShape,

  };



  submit = () => {

    this.props.form.validateFields((error, value) => {

      console.log(error, value);

    });

  }



  render() {

    let errors;

    const { getFieldProps, getFieldError } = this.props.form;

    return (

      


        

        

        {(errors = getFieldError('required')) ? errors.join(',') : null}

        submit

      


    );

  }

}



export createForm()(Form);

```



### Use with React Native



Expo preview   



![avatar](./examples/react-native/expo.jpg)



[View the source code](./examples/react-native/App.js)



Or a quicker version:



```js

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 (

      


        {this.requiredDecorator(

          

        )}

        {(errors = getFieldError('required')) ? errors.join(',') : null}

        submit

      


    );

  }

}



export createForm()(Form);

```



## createForm(option: Object) => (WrappedComponent: React.Component) => React.Component



| Option    | Description                              | Type       | Default |

|-----------|------------------------------------------|------------|---------|

| option.validateMessages | Preseted messages of [async-validator](https://github.com/yiminghe/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 transferred 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]



```jsx

class Form extends React.Component { ... }



// deprecated

const EnhancedForm = createForm({ withRef: true })(Form);



this.refs.form.refs.wrappedComponent // => The instance of Form



// Recommended

const EnhancedForm = createForm()(Form);

 this.formRef = inst} />

this.formRef // => The instance of Form

```



## (WrappedComponent: React.Component) => React.Component



The returned function of createForm(). It will pass an object as prop `form` with the following members to WrappedComponent:



### getFieldProps(name, option): Object { [valuePropName], [trigger], [validateTrigger] }



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.



```jsx



  



```



#### name: String



This input's unique name.



#### option: Object



| 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[] | 'onChange' |

| option.rules | Validator rules. see: [async-validator](https://github.com/yiminghe/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[] | 'onChange' |

| option.validate[n].rules | Validator rules. see: [async-validator](https://github.com/yiminghe/async-validator) | Object[] | - |

| option.hidden | Ignore current field while validating or gettting fields | boolean | false |

| option.preserve | Whether to preserve the value. That will remain the value when the field be unmounted and be mounted again | boolean | false |



##### Default value of `getValueFromEvent`



```js

function defaultGetValueFromEvent(e) {

  if (!e || !e.target) {

    return e;

  }

  const { target } = e;

  return target.type === 'checkbox' ? target.checked : target.value;

}

```



##### Tips



```js

{

  validateTrigger: 'onBlur',

  rules: [{required: true}],

}

// is the shorthand of

{

  validate: [{

    trigger: 'onBlur',

    rules: [{required: true}],

  }],

}

```



### getFieldDecorator(name:String, option: Object) => (React.Node) => React.Node



Similar to `getFieldProps`, but add some helper warnings and you can write onXX directly inside React.Node props:



```jsx



  {getFieldDecorator('name', otherOptions)()}



```



### getFieldsValue([fieldNames: String[]])



Get fields value by fieldNames.



### getFieldValue(fieldName: String)



Get field value by fieldName.



### getFieldInstance(fieldName: String)



Get field react public instance by fieldName.



### setFieldsValue(obj: Object)



Set fields value by kv object.



### setFieldsInitialValue(obj: Object)



Set fields initialValue by kv object. use for reset and initial display/value.



### setFields(obj: Object)



Set fields by kv object. each field can contain errors and value member.



### validateFields([fieldNames: String[]], [options: Object], callback: (errors, values) => void)



Validate and get fields value by fieldNames.



options is the same as validate method of [async-validator](https://github.com/yiminghe/async-validator).

And add `force`.



#### options.force: Boolean



Defaults to false. Whether to validate fields which have been validated(caused by validateTrigger).



### getFieldsError(names): Object{ [name]: String[] }



Get inputs' validate errors.



### getFieldError(name): String[]



Get input's validate errors.



### isFieldValidating(name: String): Bool



Whether this input is validating.



### isFieldsValidating(names: String[]): Bool



Whether one of the inputs is validating.



### isFieldTouched(name: String): Bool



Whether this input's value had been changed by user.



### isFieldsTouched(names: String[]): Bool



Whether one of the inputs' values had been changed by user.



### resetFields([names: String[]])



Reset specified inputs. Defaults to all.



### isSubmitting(): Bool (Deprecated)



Whether the form is submitting.



### submit(callback: Function) (Deprecated)



Cause isSubmitting to return true, after callback called, isSubmitting return false.



## rc-form/lib/createDOMForm(option): Function



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,  `scroll` is the same as [dom-scroll-into-view's function parameter `config`](https://github.com/yiminghe/dom-scroll-into-view#function-parameter).



#### options.container: HTMLElement



Defaults to first scrollable container of form field(until document).



## Notes



- Do not use stateless function component inside Form component: https://github.com/facebook/react/pull/6534



- you can not set same prop name as the value of validateTrigger/trigger for getFieldProps



```js



})}>

```



- you can not use ref prop for getFieldProps



```js



this.props.form.getFieldInstance('ref') // use this to get ref

```



or



```js

 (only allow function)

})} />

```



## Test Case



```

npm test

npm run chrome-test

```



## Coverage



```

npm run coverage

```



open coverage/ dir



## License



rc-form is released under the MIT license.