From e9bbc71cfca575dc294bd97f4036ae971c91bad5 Mon Sep 17 00:00:00 2001 From: Julien Le Coupanec Date: Thu, 15 Mar 2018 20:08:09 -0700 Subject: [PATCH] React: Typechecking with proptypes --- frontend/react.js | 104 ++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 100 insertions(+), 4 deletions(-) diff --git a/frontend/react.js b/frontend/react.js index 30c3cbf..3ef9a5a 100644 --- a/frontend/react.js +++ b/frontend/react.js @@ -1,8 +1,104 @@ /* ******************************************************************************************* - * GLOBAL CONFIG - * Vue.config is an object containing Vue’s global configurations. - * You can modify its properties listed below before bootstrapping your application. - * https://vuejs.org/v2/api/#Global-Config + * REACT.JS CHEATSHEET + * https://reactjs.org/ * ******************************************************************************************* */ +``` +npm install --save react // declarative and flexible JavaScript library for building UI +npm install --save react-dom // serves as the entry point of the DOM-related rendering paths +npm install --save prop-types // runtime type checking for React props and similar objects +``` + + +/* ******************************************************************************************* + * TYPECHECKING WITH PROPTYPES + * https://reactjs.org/docs/typechecking-with-proptypes.html + * ******************************************************************************************* */ + + +import PropTypes from 'prop-types'; + +MyComponent.propTypes = { + // You can declare that a prop is a specific JS type. By default, these + // are all optional. + optionalArray: PropTypes.array, + optionalBool: PropTypes.bool, + optionalFunc: PropTypes.func, + optionalNumber: PropTypes.number, + optionalObject: PropTypes.object, + optionalString: PropTypes.string, + optionalSymbol: PropTypes.symbol, + + // Anything that can be rendered: numbers, strings, elements or an array + // (or fragment) containing these types. + optionalNode: PropTypes.node, + + // A React element. + optionalElement: PropTypes.element, + + // You can also declare that a prop is an instance of a class. This uses + // JS's instanceof operator. + optionalMessage: PropTypes.instanceOf(Message), + + // You can ensure that your prop is limited to specific values by treating + // it as an enum. + optionalEnum: PropTypes.oneOf(['News', 'Photos']), + + // An object that could be one of many types + optionalUnion: PropTypes.oneOfType([ + PropTypes.string, + PropTypes.number, + PropTypes.instanceOf(Message) + ]), + + // An array of a certain type + optionalArrayOf: PropTypes.arrayOf(PropTypes.number), + + // An object with property values of a certain type + optionalObjectOf: PropTypes.objectOf(PropTypes.number), + + // An object taking on a particular shape + optionalObjectWithShape: PropTypes.shape({ + color: PropTypes.string, + fontSize: PropTypes.number + }), + + // You can chain any of the above with `isRequired` to make sure a warning + // is shown if the prop isn't provided. + requiredFunc: PropTypes.func.isRequired, + + // A value of any data type + requiredAny: PropTypes.any.isRequired, + + // You can also specify a custom validator. It should return an Error + // object if the validation fails. Don't `console.warn` or throw, as this + // won't work inside `oneOfType`. + customProp: function(props, propName, componentName) { + if (!/matchme/.test(props[propName])) { + return new Error( + 'Invalid prop `' + propName + '` supplied to' + + ' `' + componentName + '`. Validation failed.' + ); + } + }, + + // You can also supply a custom validator to `arrayOf` and `objectOf`. + // It should return an Error object if the validation fails. The validator + // will be called for each key in the array or object. The first two + // arguments of the validator are the array or object itself, and the + // current item's key. + customArrayProp: PropTypes.arrayOf(function(propValue, key, componentName, location, propFullName) { + if (!/matchme/.test(propValue[key])) { + return new Error( + 'Invalid prop `' + propFullName + '` supplied to' + + ' `' + componentName + '`. Validation failed.' + ); + } + }) +}; + +// Specifies the default values for props: +MyComponent.defaultProps = { + name: 'Stranger' +};