Package Exports
- react-immutable-proptypes
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-immutable-proptypes) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
react-immutable-proptypes
PropType validators that work with Immutable.js.
About
I got tired of seeing React.PropTypes.instanceOf(Immutable.List)
or React.PropTypes.instanceOf(Immutable.Map)
as PropTypes for components that should be specifying an Immutable.List
of something or that an Immutable.Map
contains some keys. A little "googling" came up empty, unless you want to use Flow, which I do not. So, I wrote react-immutable-proptypes
.
Usage is simple, they work with and like any React.PropType.*
validator.
var ImmutablePropTypes = require('react-immutable-proptypes');
var MyReactComponent = React.createClass({
// ...
propTypes: {
myRequiredImmutableList: ImmutablePropTypes.listOf(
ImmutablePropTypes.contains({
someNumberProp: React.PropTypes.number.isRequired
})
).isRequired
}
// ...
});
Since version 0.1.7 there are convenience helpers for "primitive" Immutable.js objects.
propTypes: {
oldListTypeChecker: React.PropTypes.instanceOf(Immutable.List),
anotherWay: ImmutablePropTypes.list,
requiredList: ImmutablePropTypes.list.isRequired,
mapsToo: ImmutablePropTypes.map,
evenIterable: ImmutablePropTypes.iterable
}
Installation
Installing via npmjs
npm install --save react-immutable-proptypes
API
React-Immutable-PropTypes has:
Primitive Types
ImmutablePropTypes.list // Immutable.List.isList ImmutablePropTypes.map // Immutable.Map.isMap ImmutablePropTypes.orderedMap // Immutable.OrderedMap.isOrderedMap ImmutablePropTypes.set // Immutable.Set.isSet ImmutablePropTypes.orderedSet // Immutable.OrderedSet.isOrderedSet ImmutablePropTypes.stack // Immutable.Stack.isStack ImmutablePropTypes.seq // Immutable.Seq.isSeq ImmutablePropTypes.iterable // Immutable.Iterable.isIterable
ImmutablePropTypes.listOf
is based onReact.PropTypes.array
and is specific toImmutable.List
.ImmutablePropTypes.mapOf
is basically the same aslistOf
, but it is specific toImmutable.Map
.ImmutablePropTypes.setOf
is basically the same aslistOf
, but it is specific toImmutable.Set
.ImmutbalePropTypes.iterableOf
is the generic form of listOf/mapOf. It is useful when there is no need to validate anything other than Immutable.js compatible (ie.Immutable.Iterable
). Continue to uselistOf
and/ormapOf
when you know the type.ImmutablePropTypes.contains
(formerlyshape
) is based onReact.PropTypes.shape
and will try to work with anyImmutable.Iterable
. In practice, I would recommend limiting this toImmutable.Map
orImmutable.OrderedMap
. However, it is possible to abusecontains
to validate an array viaImmutable.List
.// ... aList: ImmutablePropTypes.contains({ 0: React.PropTypes.number.isRequired, 1: React.PropTypes.string.isRequired, 2: React.PropTypes.string }) // ... <SomeComponent aList={Immutable.List([1, '2'])} />
That said, don't do this. Please, just... don't.
These two validators cover the output of Immutable.fromJS
on standard JSON data sources.
RFC
Please send a message or, better yet, create an issue/pull request if you know a better solution, find bugs, or want a feature. For example, should listOf
work with Immutable.Seq
or Immutable.Range
. I can think of reasons it should, but it is not a use case I have at the present, so I'm less than inclined to implement it. Alternatively, we could add a validator for sequences and/or ranges.