VSinerva/freesewing
1
0
Fork 0
Code Activity

[react] feat: Added docs for components/Stats

Browse source
This commit is contained in:
joostdecock 2025-05-29 12:21:39 +02:00
parent 4ba8b50b2c
commit b6d947646c
3 changed files with 30 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
packages/react/components/Stats/index.mjs
View file

@ -45,6 +45,14 @@ const option = {
},
}
/**
* A component to display generic stats from the FreeSewing backend
*
* @component
* @param {object} props - All component props
* @param {React.FC} [props.Link = false] - An optional framework-specific Link component
* @returns {JSX.Element}
*/
export const Stats = ({ Link = false }) => {
if (!Link) Link = WebLink
const [stats, setStats] = useState()

1
packages/react/mkdocs.sh
View file

@ -35,3 +35,4 @@ jsdoc -c jsdoc.json components/Role/* > ../../sites/dev/prebuild/jsdoc/react/com
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
jsdoc -c jsdoc.json components/Stats/* > ../../sites/dev/prebuild/jsdoc/react/components/stats.json