diff --git a/packages/react/components/Number/index.mjs b/packages/react/components/Number/index.mjs index ec47f5da623..6f06a05dfaf 100644 --- a/packages/react/components/Number/index.mjs +++ b/packages/react/components/Number/index.mjs @@ -1,10 +1,19 @@ import React from 'react' +/** + * A component to display a number or character inside a circle + * + * @component + * @param {object} props - All component props + * @param {number|string} props.nr - The number to display + * @param {string} [props.color = secondary] - One of the DaisyUI color names + * @returns {JSX.Element} + */ export const NumberCircle = ({ nr, color = 'secondary' }) => ( {nr} diff --git a/packages/react/mkdocs.sh b/packages/react/mkdocs.sh index 93a796e3982..3dc11d45ee0 100755 --- a/packages/react/mkdocs.sh +++ b/packages/react/mkdocs.sh @@ -25,3 +25,4 @@ jsdoc -c jsdoc.json components/Mini/* > ../../sites/dev/prebuild/jsdoc/react/com jsdoc -c jsdoc.json components/Modal/* > ../../sites/dev/prebuild/jsdoc/react/components/modal.json jsdoc -c jsdoc.json components/Newsletter/* > ../../sites/dev/prebuild/jsdoc/react/components/newsletter.json jsdoc -c jsdoc.json components/Null/* > ../../sites/dev/prebuild/jsdoc/react/components/null.json +jsdoc -c jsdoc.json components/Number/* > ../../sites/dev/prebuild/jsdoc/react/components/number.json diff --git a/sites/dev/docs/reference/packages/react/components/number/_examples.js b/sites/dev/docs/reference/packages/react/components/number/_examples.js new file mode 100644 index 00000000000..729936f7195 --- /dev/null +++ b/sites/dev/docs/reference/packages/react/components/number/_examples.js @@ -0,0 +1,19 @@ +import React from 'react' +import { NumberCircle } from '@freesewing/react/components/Number' + +const colors = ['primary', 'secondary', 'accent', 'neutral', 'success', 'warning', 'error', 'info'] + +export const NumberCircleExample = () => ( +