feat: Add method examples to the reference template

newrelic · Jun 5, 2020 · 811b122 · 811b122
1 parent 3f642f3
commit 811b122
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/src/hooks/useComponentDoc.js b/src/hooks/useComponentDoc.js
@@ -209,6 +209,7 @@ const useComponentDoc = (componentName) => {
             description: methodDocs?.text,
             returnValue: methodDocs?.tags.return?.[0] ?? { type: 'undefined' },
             params: methodDocs?.tags.param,
+            examples: methodDocs?.tags.examples ?? [],
           };
         }),
     };

diff --git a/src/templates/ReferenceTemplate.js b/src/templates/ReferenceTemplate.js
@@ -94,6 +94,13 @@ const ReferenceTemplate = ({ data }) => {
                     params={method.params}
                     returnValue={method.returnValue}
                   />
+                  {method.examples.map((example, i) => (
+                    <ComponentExample
+                      key={i}
+                      className={styles.componentExample}
+                      example={example}
+                    />
+                  ))}
                 </Fragment>
               ))}
             </section>