Advanced prop type definitions #105
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,70 @@ | ||
| import React from 'react'; | ||
| import cx from 'classnames'; | ||
| import PropTypes from 'prop-types'; | ||
| import FunctionDefinition from './FunctionDefinition'; | ||
| import Markdown from 'react-markdown'; | ||
| import ReferenceExample from './ReferenceExample'; | ||
| import styles from './PropList.module.scss'; | ||
| import { format } from 'date-fns'; | ||
|
|
||
| const PropTypeInfo = ({ type }) => { | ||
| switch (type.raw) { | ||
| case 'func': | ||
| return ( | ||
| <FunctionDefinition | ||
| returnValue={type.meta.returnValue} | ||
| params={type.meta.params} | ||
| /> | ||
| ); | ||
| case 'arrayOf': { | ||
| const { itemTypes } = type.meta; | ||
|
|
||
| return itemTypes.raw === 'oneOf' ? ( | ||
| <div className={styles.listLike}> | ||
| <div>{'<Array of'}</div> | ||
| <div className={styles.arg}> | ||
| <PropTypeInfo type={itemTypes} /> | ||
| </div> | ||
| <div>{'>'}</div> | ||
| </div> | ||
| ) : ( | ||
| <PropTypeInfo type={itemTypes} /> | ||
| ); | ||
| } | ||
| case 'oneOf': | ||
| return ( | ||
| <div className={styles.listLike}> | ||
| <div>{'<One of'}</div> | ||
| <div className={styles.arg}> | ||
| {type.meta.constants.map((constant) => ( | ||
| <div key={constant}>{constant},</div> | ||
|
There was a problem hiding this comment. We might want to trim off the There was a problem hiding this comment. The only reason I didn't do that was only because One Core has trailing commas:
This isn't to say this is our desired result for the new dev site, but just the reason I did this to begin with. Should we do the same? Or remove the last comma? FYI, |
||
| ))} | ||
| </div> | ||
| <div>{'>'}</div> | ||
| </div> | ||
| ); | ||
| case 'oneOfType': | ||
| return type.meta.types.map((type, idx) => ( | ||
| <PropTypeInfo key={idx} type={type} /> | ||
| )); | ||
| case 'shape': | ||
| return ( | ||
| <div className={styles.shape}> | ||
| <h4>shape</h4> | ||
| <PropList propTypes={type.meta.types} /> | ||
| </div> | ||
| ); | ||
| default: | ||
| return null; | ||
| } | ||
| }; | ||
|
|
||
| PropTypeInfo.propTypes = { | ||
| type: PropTypes.shape({ | ||
| raw: PropTypes.string.isRequired, | ||
| meta: PropTypes.object, | ||
| }), | ||
| }; | ||
|
|
||
| const PropList = ({ propTypes }) => { | ||
| if (propTypes.length === 0) { | ||
|
|
@@ -11,26 +74,55 @@ const PropList = ({ propTypes }) => { | |
| return ( | ||
| <div> | ||
| {propTypes.map( | ||
| ({ | ||
| name, | ||
| description, | ||
| deprecation, | ||
| examples, | ||
| isRequired, | ||
| type, | ||
| defaultValue, | ||
| }) => { | ||
| return ( | ||
| <div key={name} className={styles.container}> | ||
| <div className={styles.info}> | ||
| <h3> | ||
| {name} | ||
| {isRequired && ( | ||
| <span className={styles.flagged}>required</span> | ||
| )} | ||
| {deprecation && ( | ||
| <span className={styles.flagged}>deprecated</span> | ||
| )} | ||
| </h3> | ||
| <div className={styles.type}>{type.name}</div> | ||
| {defaultValue !== undefined && ( | ||
| <div className={styles.default}> | ||
| <p>DEFAULT</p> | ||
| <p>{String(defaultValue)}</p> | ||
| </div> | ||
| )} | ||
| </div> | ||
| <div className={styles.propInfo}> | ||
| {deprecation && ( | ||
| <div className={styles.deprecation}> | ||
| <div className={styles.deprecationDate}> | ||
| Due {format(new Date(deprecation.date), 'MMMM do, yyyy')} | ||
| </div> | ||
| <Markdown | ||
| className={styles.markdownContainer} | ||
| source={deprecation.description} | ||
| /> | ||
| </div> | ||
| )} | ||
| <Markdown | ||
| className={cx(styles.details, styles.markdownContainer)} | ||
| source={description} | ||
| /> | ||
| <PropTypeInfo type={type} /> | ||
| {examples.map((example, idx) => ( | ||
| <ReferenceExample key={idx} example={example} /> | ||
| ))} | ||
| </div> | ||
| </div> | ||
| ); | ||
|
|
@@ -45,8 +137,15 @@ PropList.propTypes = { | |
| PropTypes.shape({ | ||
| name: PropTypes.string.isRequired, | ||
| description: PropTypes.string, | ||
| deprecation: PropTypes.shape({ | ||
|
There was a problem hiding this comment. if a PropType doesn't take the shape value (for example there's no deprecation) will this value be null/undefined? There was a problem hiding this comment. That is correct! You can see it set explicitly to I don't set the |
||
| date: PropTypes.number, | ||
| description: PropTypes.string, | ||
| }), | ||
| isRequired: PropTypes.bool, | ||
| type: PropTypes.shape({ | ||
| ...PropTypeInfo.propTypes.type, | ||
| name: PropTypes.string.isRequired, | ||
| }), | ||
| defaultValue: PropTypes.string, | ||
| }) | ||
| ), | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
recursive react! never thought about doing this but this is super cool
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes! Its not often that you need it (I can only think of 1 other time I've done this), but super useful when you do need it. It helped me so much here.