diff --git a/packages/react/components/Spinner/index.mjs b/packages/react/components/Spinner/index.mjs index e7a5ef96401..c487c5293a2 100644 --- a/packages/react/components/Spinner/index.mjs +++ b/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' }) => ( ../../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 diff --git a/sites/dev/docs/reference/packages/react/components/spinner/_examples.js b/sites/dev/docs/reference/packages/react/components/spinner/_examples.js new file mode 100644 index 00000000000..0f19082b1e4 --- /dev/null +++ b/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 = () => ( + <> + + + +) diff --git a/sites/dev/docs/reference/packages/react/components/spinner/readme.mdx b/sites/dev/docs/reference/packages/react/components/spinner/readme.mdx index 791076fbc18..ef0878bc652 100644 --- a/sites/dev/docs/reference/packages/react/components/spinner/readme.mdx +++ b/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' + + + +- [Components](#components) + +## Components + +The **Spinner** component family provides the following components: + +- [Spinner](#spinner) + +### Spinner + + + +