VSinerva/freesewing
1
0
Fork 0
Code Activity

[react] feat: Added docs for components/Uuid

Browse source
This commit is contained in:
joostdecock 2025-05-29 13:52:15 +02:00
parent b50228e0f9
commit d8705ecc75
4 changed files with 39 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

24
packages/react/components/Uuid/index.mjs
View file

@ -1,25 +1,29 @@
import React, { useState } from 'react'
import { shortUuid } from '@freesewing/utils'
import { Link } from '@freesewing/react/components/Link'
import { Link as WebLink } from '@freesewing/react/components/Link'
import { CopyToClipboardButton } from '@freesewing/react/components/Button'
/*
* Displays a UUID, but shorter
/**
* A component to display a short version of a (v4) UUID
*
* @param {object} props - All React props
* @param {string} uuid - The UUID
* @param {string} href - An optional href to make this UUID a link
* @param {string} label - An optional label to show in the loading status
* @component
* @param {object} props - All component props
* @param {React.FC} [props.Link = false] - An optional framework-specific Link component
* @param {string} props.uuid - The UUID
* @param {string} [props.href = false] - An optional href to make this into a link
* @param {string} [props.label = false] - An optional label to pass to the CopyToClipboardButton
* @returns {JSX.Element}
*/
export const Uuid = ({ uuid, href = false, label = false }) => {
export const Uuid = ({ uuid, href = false, label = "UUID", Link = false }) => {
const [full, setFull] = useState()
const short = shortUuid(uuid)
if (!Link) Link = WebLink
if (href === false)
return (
<span className="flex flex-row items-center">
<span className="daisy-badge daisy-badge-secondary font-mono">{shortUuid(uuid)}</span>
<CopyToClipboardButton content={uuid} label="UUID" sup />
<CopyToClipboardButton content={uuid} label={label} sup />
</span>
)
@ -28,7 +32,7 @@ export const Uuid = ({ uuid, href = false, label = false }) => {
<Link href={href} title={uuid}>
<span className="daisy-badge daisy-badge-secondary font-mono">{shortUuid(uuid)}</span>
</Link>
<CopyToClipboardButton content={uuid} label="UUID" sup label />
<CopyToClipboardButton content={uuid} label={label} sup />
</span>
)
}

1
packages/react/mkdocs.sh
View file

@ -39,3 +39,4 @@ jsdoc -c jsdoc.json components/Stats/* > ../../sites/dev/prebuild/jsdoc/react/co
jsdoc -c jsdoc.json components/Tab/* > ../../sites/dev/prebuild/jsdoc/react/components/tab.json
jsdoc -c jsdoc.json components/Table/* > ../../sites/dev/prebuild/jsdoc/react/components/table.json
jsdoc -c jsdoc.json components/Time/* > ../../sites/dev/prebuild/jsdoc/react/components/time.json
jsdoc -c jsdoc.json components/Uuid/* > ../../sites/dev/prebuild/jsdoc/react/components/uuid.json