diff --git a/packages/react/components/Mini/index.mjs b/packages/react/components/Mini/index.mjs index 96277b25ad9..ffcef08737b 100644 --- a/packages/react/components/Mini/index.mjs +++ b/packages/react/components/Mini/index.mjs @@ -1,6 +1,14 @@ import React from 'react' import { TipIcon, ChatIcon, WarningIcon } from '@freesewing/react/components/Icon' +/** + * A component to display a mini tip + * + * @component + * @param {object} props - All component props + * @param {JSX.Element} props.children - The component children, will be rendered inside the mini tip + * @returns {JSX.Element} + */ export const MiniTip = ({ children }) => (
@@ -12,6 +20,14 @@ export const MiniTip = ({ children }) => (
) +/** + * A component to display a mini note + * + * @component + * @param {object} props - All component props + * @param {JSX.Element} props.children - The component children, will be rendered inside the mini note + * @returns {JSX.Element} + */ export const MiniNote = ({ children }) => (
@@ -23,6 +39,14 @@ export const MiniNote = ({ children }) => (
) +/** + * A component to display a mini warning + * + * @component + * @param {object} props - All component props + * @param {JSX.Element} props.children - The component children, will be rendered inside the mini warning + * @returns {JSX.Element} + */ export const MiniWarning = ({ children }) => (
diff --git a/packages/react/mkdocs.sh b/packages/react/mkdocs.sh index 27938526ef9..4955731102d 100755 --- a/packages/react/mkdocs.sh +++ b/packages/react/mkdocs.sh @@ -21,3 +21,4 @@ jsdoc -c jsdoc.json components/Layout/* > ../../sites/dev/prebuild/jsdoc/react/c jsdoc -c jsdoc.json components/LineDrawing/* > ../../sites/dev/prebuild/jsdoc/react/components/linedrawing.json jsdoc -c jsdoc.json components/Link/* > ../../sites/dev/prebuild/jsdoc/react/components/link.json jsdoc -c jsdoc.json components/Logo/* > ../../sites/dev/prebuild/jsdoc/react/components/logo.json +jsdoc -c jsdoc.json components/Mini/* > ../../sites/dev/prebuild/jsdoc/react/components/mini.json diff --git a/sites/dev/docs/reference/packages/react/components/mini/_examples.js b/sites/dev/docs/reference/packages/react/components/mini/_examples.js new file mode 100644 index 00000000000..90a1b594ccb --- /dev/null +++ b/sites/dev/docs/reference/packages/react/components/mini/_examples.js @@ -0,0 +1,6 @@ +import React from 'react' +import { MiniNote, MiniTip, MiniWarning } from '@freesewing/react/components/Mini' + +export const MiniNoteExample = () => I am a note, a mini note +export const MiniTipExample = () => I am a tip, a mini tip +export const MiniWarningExample = () => I am a warning, a mini warning diff --git a/sites/dev/docs/reference/packages/react/components/mini/readme.mdx b/sites/dev/docs/reference/packages/react/components/mini/readme.mdx index cf5700cc2c7..66ec8615af6 100644 --- a/sites/dev/docs/reference/packages/react/components/mini/readme.mdx +++ b/sites/dev/docs/reference/packages/react/components/mini/readme.mdx @@ -2,6 +2,39 @@ title: Mini --- -:::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.mini.mjs' +import { + MiniNoteExample, + MiniTipExample, + MiniWarningExample, +} from './_examples.js' + + + + +The __Mini__ component family provides the following components: + +- [MiniNote](#mininote) +- [MiniTip](#minitip) +- [MiniWarning](#miniwarning) + +:::tip +These components are typically used when a +[Popout](/reference/packages/react/components/popout/) would take up too much +space. ::: + + +## MiniNote + + +## MiniTip + + +## MiniWarning + + + +