Documentation Template

Jump to bottom

AmadeusW edited this page Sep 12, 2021 · 3 revisions

<ComponentName>

The <ComponentName> component is a component that <ComponentPurpose>

Import

<Show how to import component>

<Link to source code>

Usage (Optional)

Here's a basic usage example of the <ComponentName> component:

Common Feature 1

<Display the component>
<Show uneditable, formatted code to create what is displayed above>

Common Feature 2

<Display the component>
<Show uneditable, formatted code to create what is displayed above>

Common Feature XXX

<Display the component>
<Show uneditable, formatted code to create what is displayed above>

Props

Prop 1

<Description of prop>
<Type of prop>

Prop 2

<Description of prop>
<Type of prop>

Prop XXX

<Description of prop>
<Type of prop>

Refer to this for an example