https://github.com/react-component/form-validation
This project is deprecated, you can try https://github.com/react-component/form
https://github.com/react-component/form-validation
Last synced: 4 months ago
JSON representation
This project is deprecated, you can try https://github.com/react-component/form
- Host: GitHub
- URL: https://github.com/react-component/form-validation
- Owner: react-component
- Created: 2015-01-26T10:00:03.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2021-06-22T21:29:03.000Z (over 4 years ago)
- Last Synced: 2025-08-09T14:17:00.590Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 2.06 MB
- Stars: 85
- Watchers: 26
- Forks: 18
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
Awesome Lists containing this project
README
# rc-form-validation
---
FormValidation For React.
This project is obseleted,
you can try rc-form.
[![NPM version][npm-image]][npm-url]
[](http://spmjs.io/package/rc-form-validation)
[![build status][travis-image]][travis-url]
[](https://coveralls.io/r/react-component/form-validation)
[![gemnasium deps][gemnasium-image]][gemnasium-url]
[![node version][node-image]][node-url]
[![npm download][download-image]][download-url]
[](https://saucelabs.com/u/rc-form-validation)
[](https://saucelabs.com/u/rc-form-validation)
[npm-image]: http://img.shields.io/npm/v/rc-form-validation.svg?style=flat-square
[npm-url]: http://npmjs.org/package/rc-form-validation
[travis-image]: https://img.shields.io/travis/react-component/form-validation.svg?style=flat-square
[travis-url]: https://travis-ci.org/react-component/form-validation
[gemnasium-image]: http://img.shields.io/gemnasium/react-component/form-validation.svg?style=flat-square
[gemnasium-url]: https://gemnasium.com/react-component/form-validation
[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-validation.svg?style=flat-square
[download-url]: https://npmjs.org/package/rc-form-validation
## Feature
* support ie8,ie8+,chrome,firefox,safari
## install
[](https://npmjs.org/package/rc-form-validation)
## Usage
```js
var Validation = require('../');
var Validator = Validation.Validator;
React.render(
{state.formData.name.errors && state.formData.name.errors.length ?
{state.formData.name.errors.join(',')} : null}
{state.formData.pass.errors && state.formData.pass.errors.length ? {state.formData.pass.errors.join(',')} : null}
,container);
```
## API
### Validation
#### props
name
type
default
description
onValidate
Function
called when validator inside it starts to validate
#### methods
- validate(callback:function): validate all fields, call callback with isValid as parameter
- reset: reset validation to initial state, used for form reset
- forceValidate(fields:String[],callback:Function): validate specified fields, call callback with isValid as parameter. fields is component's name which is wrapped by Validator
### Validator
Validator 's children must be one component which support trigger handler and value/name prop such as
#### props
name
type
default
description
rules
Object|Array
see https://github.com/yiminghe/async-validator .
for example: {type:'string',min:4},[{type:'string',whitespace:true,required:true},{validator:validateFn}]
trigger
String
onChange
when to validate
### mixins
Validation.FieldMixin
provide the following methods:
#### setField
sync individual field which does not need validation
#### handleValidate
used as value for onValidate props of Validation
## Development
```
npm install
npm start
```
## Example
http://localhost:8010/examples/
online example: http://react-component.github.io/form-validation/examples/
## Test Case
http://localhost:8010/tests/runner.html?coverage
## Coverage
http://localhost:8010/node_modules/rc-server/node_modules/node-jscover/lib/front-end/jscoverage.html?w=http://localhost:8010/tests/runner.html?coverage
## License
rc-form-validation is released under the MIT license.