react-bootstrap / react-prop-types

Additional PropTypes for React

DEPRECATED!!!!!!

USE https://github.com/react-bootstrap/prop-types-extra

(it's the same thing)

react-prop-types

Additional PropTypes for React.

Usage

import elementType from 'react-prop-types/lib/elementType';
// or
import { elementType } from 'react-prop-types';

const propTypes = {
  someProp: elementType,
};

If you want to minimize bundle size, import only the validators you use via:

import elementType from 'react-prop-types/lib/elementType'

Guide

Installation

$ npm i -S react
$ npm i -S react-prop-types

all(...validators)

This validator checks that all of the provided validators pass.

const propTypes = {
  vertical:  React.PropTypes.bool.isRequired,

  block: all(
    React.PropTypes.bool.isRequired,
    ({ block, vertical }) => (
      block && !vertical ?
        new Error('`block` requires `vertical` to be set to have any effect') :
        null
    ),
  ),
};

The provided validators will be validated in order, stopping on the first failure. The combined validator will succeed only if all provided validators succeed.

As in the example, this can be used to make a type assertion along with additional semantic assertions.

componentOrElement

Checks that the value is a ReactComponent or a DOMElement.

const propTypes = {
  container: componentOrElement,
  requiredContainer: componentOrElement.isRequired,
};

This ensures that the value is of the right type to pass to ReactDOM.findDOMNode(), for cases where you need a DOM node.

deprecated(validator, reason)

This validator will log a deprecation warning if the value is present.

const propTypes = {
  collapsable: deprecated(React.PropTypes.bool, 'Use `collapsible` instead.'),
};

If the collapsable prop above is specified, this validator will log the warning:

The prop `collapsable` of `MyComponent` is deprecated. Use `collapsible` instead.

This validator warns instead of failing on invalid values, and will still call the underlying validator if the deprecated value is present.

This validator will only warn once on each deprecation. To clear the cache of warned messages, such as for clearing state between test cases intended to fail on deprecation warnings, call deprecated._resetWarned().

elementType

Checks that the value is a React element type. This can be either a string (for DOM elements) or a ReactClass (for composite components).

const propTypes = {
  Component: elementType.isRequired,
};

This ensures that the value of is the right type for creating a ReactElement, such as with <Component {...props} />.

isRequiredForA11y(validator)

This validator checks that the value required for accessibility are present.

const propTypes = {
  id: isRequiredForA11y(React.PropTypes.string),
};

If the id prop above is not specified, the validator will fail with:

The prop `id` is required to make `MyComponent` accessible for users of assistive technologies such as screen readers.

react-prop-types's Issues

Fix upcoming PropTypes warning

This library will start emitting warnings with React 15.3.0.
Please fix it according to the guide:

https://github.com/facebook/react/blob/f9940415392a6187374cdad69022bfc9e2a392a3/docs/warnings/dont-call-proptypes.md#fixing-the-false-positive-in-third-party-proptypes

Thank you!

Warnings about requirements for assistive technologies.

See the issue in react bootstrap repo: react-bootstrap/react-bootstrap#1426

There was a suggestion to open an issue here instead.

Proptypes are used for required props. As id is not required, components shouldn't warn about those. It's imo pretty simple. It's easy to end up to ignore valid errors when there is unnecessary errors from bootstrap.

Bump Up Dependencies?

Should we bump up dependencies?

This library is currently an example in official documentation of how not to do propType validation

See https://facebook.github.io/react/warnings/dont-call-proptypes.html.

ToDo: Readme

To not forget.

Enable TravisCI

(coveralls.io I've already setup)

Somebody with admin rights in react-bootstrap organization,
enable please TravisCI for this project here https://travis-ci.org/profile/react-bootstrap
🍒

That's what I see

Uncaught TypeError: Cannot read property 'all' of undefined

I'm trying to follow the example however, I got the error below.

import CustomPropTypes from 'react-prop-types';

propTypes: {
text: CustomPropTypes.all(...)
}

Error:

Uncaught TypeError: Cannot read property 'all' of undefined

Also, when I console.log(), the value of CustomPropTypes is undefined.

console.log({CustomPropTypes});

Object {CustomPropTypes: undefined}

Can this be used outside of react-land?

After using propTypes in React, I wanted to have the same typechecking ability for non-react code.
I found this so far: https://www.npmjs.com/package/type-check

But I'd rather use the React propTypes solution if it's possible to do so.

Transfering package name

ping: @react-bootstrap/collaborators especially @AlexKVal who wrote the original code here.

The React team has been working towards splitting PropTypes out of react core and would like to use the name react-prop-types (for obvious reasons). I didn't personally see a problem with giving up the name but would like folks to weigh in if they do!

@acdlite said they'd help make sure we don't run into any issues (major version bump, a comment noting where the original went, etc) So from a technical prospective there shouldn't be any issues with packages that depend on this, except that to upgrade it we'll need to point to the new package.

Thoughts? concerns?