[react] feat: Added docs for components/Spinner

packages/react/components/Spinner/index.mjs

@@ -1,7 +1,12 @@
 import React from 'react'
 
-/*
- * A simple spinner
+/**
+ * A component to render a loading spinner
+ *
+ * @component
+ * @param {object} props - All component props
+ * @param {strign} [props.className = 'tw:h-6 tw:w-6'] - CSS classes to apply to the spinner
+ * @returns {JSX.Element}
  */
 export const Spinner = ({ className = 'tw:h-6 tw:w-6' }) => (
   <svg

packages/react/mkdocs.sh

@@ -34,3 +34,4 @@ jsdoc -c jsdoc.json components/Profile/* > ../../sites/dev/prebuild/jsdoc/react/
 jsdoc -c jsdoc.json components/Role/* > ../../sites/dev/prebuild/jsdoc/react/components/role.json
 jsdoc -c jsdoc.json components/SignIn/* > ../../sites/dev/prebuild/jsdoc/react/components/signin.json
 jsdoc -c jsdoc.json components/SignUp/* > ../../sites/dev/prebuild/jsdoc/react/components/signup.json
+jsdoc -c jsdoc.json components/Spinner/* > ../../sites/dev/prebuild/jsdoc/react/components/spinner.json

sites/dev/docs/reference/packages/react/components/spinner/_examples.js

@@ -0,0 +1,9 @@
+import React from 'react'
+import { Spinner } from '@freesewing/react/components/Spinner'
+
+export const SpinnerExample = () => (
+  <>
+    <Spinner />
+    <Spinner className="tw:w-24 tw:h-24 tw:text-warning" />
+  </>
+)

sites/dev/docs/reference/packages/react/components/spinner/readme.mdx

@@ -2,6 +2,24 @@
 title: Spinner
 ---
 
-:::note
-This page is yet to be created
-:::
+
+import { DocusaurusDoc } from '@freesewing/react/components/Docusaurus'
+import { ComponentDocs } from '@site/src/components/component-docs.js'
+import * as jsdoc from '@site/prebuild/jsdoc/components.spinner.mjs'
+import { SpinnerExample } from './_examples.js'
+
+<DocusaurusDoc>
+
+- [Components](#components)
+
+## Components
+
+The **Spinner** component family provides the following components:
+
+- [Spinner](#spinner)
+
+### Spinner
+
+<ComponentDocs docs={jsdoc.jsdocSpinner} example={SpinnerExample} />
+
+</DocusaurusDoc>