JSPM

deprecated-prop-type

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 19917
  • Score
    100M100P100Q146031F
  • License ISC

React Prop Type to mark a prop as deprecated

Package Exports

  • deprecated-prop-type

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

Readme

deprecated-prop-type

deprectated prop type communicates to the developer that the marked prop should not be used.

Installation

yarn add deprecated-prop-type

# 

npm --save deprecated-prop-type

Usage

deprecated prop type takes two arguments: original prop type and reason for the deprecation. It will not show the warning if the original prop type failes.

import React from 'react';
import propTypes from 'prop-types';
import deprecated from 'deprecated-prop-type';

export default class MyComponent extends React.Component {
  static propTypes = {
    excludeDates: deprecated(propTypes.string, `Use excluded instead.`)
  }

  ...
}

Tests

npm install;
npm test

Credits

The code was taken from https://reactjs.org/warnings/dont-call-proptypes.html#fixing-the-false-positive-in-third-party-proptypes