react-custom-proptypes
React Custom PropTypes exposes a simple API for creating precisely defined, dependency-free, and chainable React PropType validators.
Check out the examples for various use cases.
Installation
$ npm install react react-dom react-custom-proptypes --save
createPropType
Syntax
createPropType(callback[, description])
Parameters
callback
: function
Function that returns a boolean representing the validation of the proptype, taking a single argument: prop
, the value of the prop
description
: string
Optional. Use this value to specify a helpful description.
Usage
import React from 'react';import createPropType from 'react-custom-proptypes'; const Card = <div> <div>propssuit</div> <div>propsvalue</div> </div>; const suitPropType = ; const valuePropType = ; CardpropTypes = suit: suitPropTypeisRequired value: valuePropTypeisRequired; ;
createIteratorPropType
Syntax
createIteratorPropType(callback[, description])
Parameters
callback
: function
Function that returns a boolean representing the validation of the proptype, taking two arguments:
prop
- the value of the propkey
- the key of the current element being processed in the iterable object.
description
: string
Optional. Use this value to specify a helpful description.
Usage
import React PropTypes from 'react';import createIteratorPropType from 'react-custom-proptypes'; const TweetFeed = <div> propstweets </div>; TweetFeedpropTypes = tweets: PropTypesisRequired; ;
Contributing
Issues and pull requests are welcome.
$ git clone https://github.com/jackrzhang/react-custom-proptypes$ cd react-custom-proptypes$ npm install
Please run linting and tests prior to commits.
$ npm run lint$ npm test