feat: Add prop type examples for each component

newrelic · Jun 8, 2020 · 0d5fb69 · 0d5fb69
1 parent 521801f
commit 0d5fb69
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/src/components/PropList.js b/src/components/PropList.js
@@ -3,6 +3,7 @@ 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';
 
@@ -72,6 +73,7 @@ const PropList = ({ propTypes }) => {
           name,
           description,
           deprecation,
+          examples,
           isRequired,
           type,
           defaultValue,
@@ -113,6 +115,9 @@ const PropList = ({ propTypes }) => {
                   source={description}
                 />
                 <PropTypeInfo type={type} />
+                {examples.map((example, idx) => (
+                  <ReferenceExample key={idx} example={example} />
+                ))}
               </div>
             </div>
           );

diff --git a/src/utils/propTypeInfo.js b/src/utils/propTypeInfo.js
@@ -156,6 +156,7 @@ export const getPropTypeDefinition = (component, name, propType) => {
     description: propDocs?.text,
     deprecation: propDocs?.tags?.deprecated?.[0] ?? null,
     isRequired: propMeta?.some((item) => item.name === 'isRequired') ?? false,
+    examples: propDocs?.tags?.examples ?? [],
     type: {
       meta: getTypeMeta(name, propType, { component }),
       raw: getRawTypeName(propType),