Package Exports

tcomb-react

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 (tcomb-react) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Features

additional fine grained type checks, nestable at arbitrary level
optionally when a validation fails, the debugger kicks in so you can inspect the stack and quickly find out what's wrong
by default props are required, a saner default since it's quite easy to forget .isRequired
splitting props types and components allows component reflection and code reuse
easily integrable with tcomb-form to build awesome demos of your components

Example

// Alert.jsx file

var t = require('tcomb-react');

var AlertType = t.enums.of('info success danger warning');

var AlertProps = t.struct({
  type: AlertType,
  children: t.react.ReactNode
});

var Alert = React.createClass({

  propTypes: t.react.toPropTypes(AlertProps),

  render: function () {
    return (
      <div
      className={'alert alert-' + this.props.type}>
      {this.props.children}
      </div>
    );
  }

});

Build a component playground

See the demo live here.

var Playground = require('tcomb-react/Playground.jsx');

// tcomb-form options
var formOptions = {
  legend: 'My legend'
};

React.render(
  <Playground
    component={Alert}
    props={AlertProps}
    form={formOptions} />,
  document.getElementById('app')
);

Comparison table

Type	React	tcomb-react
array	array	Arr
boolean	bool	Bool
functions	func	Func
numbers	number	Num
objects	object	Obj
strings	string	Str
all	any	Any
regular expressions	✘	Re
dates	✘	Dat
errors	✘	Err
required prop	T.isRequired	T
optional prop	T	maybe(T)
custom types	✘	✓
tuples	✘	tuple([T, U, ...])
lists	arrayOf(T)	list(T)
instance	instanceOf(A)	T
dictionaries	objectOf(T)	dict(T, U) (keys are checked)
enums	oneOf(['a', 'b'])	enums.of('a b')
unions	oneOfType([T, U])	union([T, U])
duck typing	shape	struct
elements	element	ReactElement
nodes	node	ReactNode