[react] feat: Merged Button and CopyToClipboardButton

2025-05-10 14:19:57 +02:00 · 2025-05-10 14:19:57 +02:00 · e58177dedb
commit e58177dedb
parent 749b6b9da7
14 changed files with 105 additions and 122 deletions
--- a/packages/react/components/Account/Apikeys.mjs
+++ b/packages/react/components/Account/Apikeys.mjs
@ -29,7 +29,7 @@ import { ModalWrapper } from '@freesewing/react/components/Modal'
 import { NumberCircle } from '@freesewing/react/components/Number'
 import { StringInput, FormControl, ListInput } from '@freesewing/react/components/Input'
 import { DisplayRow } from './shared.mjs'
-import { CopyToClipboardButton } from '@freesewing/react/components/CopyToClipboardButton'
+import { CopyToClipboardButton } from '@freesewing/react/components/Button'
 import { TimeAgo, TimeToGo } from '@freesewing/react/components/Time'
 import { KeyVal } from '@freesewing/react/components/KeyVal'

--- a/packages/react/components/Account/Mfa.mjs
+++ b/packages/react/components/Account/Mfa.mjs
@ -15,7 +15,7 @@ import { NoIcon, LockIcon } from '@freesewing/react/components/Icon'
 import { PasswordInput } from '@freesewing/react/components/Input'
 import { Popout } from '@freesewing/react/components/Popout'
 import { NumberCircle } from '@freesewing/react/components/Number'
-import { CopyToClipboardButton } from '@freesewing/react/components/CopyToClipboardButton'
+import { CopyToClipboardButton } from '@freesewing/react/components/Button'

 /**
 * A component to manage the user's MFA settings
--- a/packages/react/components/Button/index.mjs
+++ b/packages/react/components/Button/index.mjs
@ -1,4 +1,64 @@
-import React from 'react'
+import React, { useContext, useState } from 'react'
+import { copyToClipboard } from '@freesewing/utils'
+import ReactDOMServer from 'react-dom/server'
+import { CopyIcon, OkIcon } from '@freesewing/react/components/Icon'
+import { LoadingStatusContext } from '@freesewing/react/context/LoadingStatus'
+
+const strip = (html) =>
+  typeof DOMParser === 'undefined'
+    ? html
+    : new DOMParser().parseFromString(html, 'text/html').body.textContent || ''
+
+const handleCopied = (content, setCopied, setLoadingStatus, label) => {
+  copyToClipboard(content)
+  setCopied(true)
+  setLoadingStatus([
+    true,
+    label ? `${label} copied to clipboard` : 'Copied to clipboard',
+    true,
+    true,
+  ])
+  setTimeout(() => setCopied(false), 1000)
+}
+
+/**
+ * A component to copy something to the clipboard
+ *
+ * @component
+ * @param {object} props - All component props
+ * @param {JSX.element} props.children - The component children
+ * @param {string} props.content - The content that should be copied to the clipboard
+ * @param {string} props.label - The label to show when the content is copied
+ * @param {boolean} props.sup - Set this to true to render as superscript (above the line)
+ * @returns {JSX.Element}
+ */
+export const CopyToClipboardButton = ({ children, content, label = false, sup = false }) => {
+  const [copied, setCopied] = useState(false)
+  const { setLoadingStatus } = useContext(LoadingStatusContext)
+
+  const style = sup ? 'tw:w-4 tw:h-4 tw:-mt-4 tw:-ml-1' : 'tw:w-5 tw:h-5'
+
+  return (
+    <button
+      className={
+        (copied ? 'tw:text-success ' : '') +
+        'tw:daisy-btn tw:w-full tw:daisy-btn-ghost tw:lg:w-auto tw:hover:bg-transparent tw:hover:border-transparent tw:group tw:hover:shadow-none'
+      }
+      onClick={() => handleCopied(content, setCopied, setLoadingStatus, label)}
+    >
+      {sup ? children : null}
+      {copied ? (
+        <OkIcon
+          className={`${style} tw:text-success-content tw:bg-success tw:rounded-full tw:p-1`}
+          stroke={4}
+        />
+      ) : (
+        <CopyIcon className={`${style} tw:text-inherit tw:group-hover:text-secondary`} />
+      )}
+        {sup ? null : children}
+    </button>
+  )
+}

 /**
 * A button with an icon and a label, something which we commonly use across our UI.
--- a/packages/react/components/CopyToClipboardButton/index.mjs
+++ b/packages/react/components/CopyToClipboardButton/index.mjs
@ -1,61 +0,0 @@
-import React, { useContext, useState } from 'react'
-import { copyToClipboard } from '@freesewing/utils'
-import ReactDOMServer from 'react-dom/server'
-import { CopyIcon, OkIcon } from '@freesewing/react/components/Icon'
-import { LoadingStatusContext } from '@freesewing/react/context/LoadingStatus'
-
-const strip = (html) =>
-  typeof DOMParser === 'undefined'
-    ? html
-    : new DOMParser().parseFromString(html, 'text/html').body.textContent || ''
-
-const handleCopied = (content, setCopied, setLoadingStatus, label) => {
-  copyToClipboard(content)
-  setCopied(true)
-  setLoadingStatus([
-    true,
-    label ? `${label} copied to clipboard` : 'Copied to clipboard',
-    true,
-    true,
-  ])
-  setTimeout(() => setCopied(false), 1000)
-}
-
-/**
- * A component to copy something to the clipboard
- *
- * @component
- * @param {object} props - All component props
- * @param {JSX.element} props.children - The component children
- * @param {string} props.content - The content that should be copied to the clipboard
- * @param {string} props.label - The label to show when the content is copied
- * @param {boolean} props.sup - Set this to true to render as superscript (above the line)
- * @returns {JSX.Element}
- */
-export const CopyToClipboardButton = ({ children, content, label = false, sup = false }) => {
-  const [copied, setCopied] = useState(false)
-  const { setLoadingStatus } = useContext(LoadingStatusContext)
-
-  const style = sup ? 'tw:w-4 tw:h-4 tw:-mt-4 tw:-ml-1' : 'tw:w-5 tw:h-5'
-
-  return (
-    <button
-      className={
-        (copied ? 'tw:text-success ' : '') +
-        'tw:daisy-btn tw:w-full tw:daisy-btn-ghost tw:lg:w-auto tw:hover:bg-transparent tw:hover:border-transparent tw:group tw:hover:shadow-none'
-      }
-      onClick={() => handleCopied(content, setCopied, setLoadingStatus, label)}
-    >
-      {sup ? children : null}
-      {copied ? (
-        <OkIcon
-          className={`${style} tw:text-success-content tw:bg-success tw:rounded-full tw:p-1`}
-          stroke={4}
-        />
-      ) : (
-        <CopyIcon className={`${style} tw:text-inherit tw:group-hover:text-secondary`} />
-      )}
-        {sup ? null : children}
-    </button>
-  )
-}
--- a/packages/react/components/CuratedSet/index.mjs
+++ b/packages/react/components/CuratedSet/index.mjs
@ -12,6 +12,18 @@ import { Spinner } from '@freesewing/react/components/Spinner'
 import { Markdown } from '@freesewing/react/components/Markdown'
 import { KeyVal } from '@freesewing/react/components/KeyVal'

+/**
+ * A component to render a lineup of curated measurements sets.
+ *
+ * You need to provide either a clickHandler or a method to resolve the URL to link to as the href prop.
+ *
+ * @component
+ * @param {object} props - All component props
+ * @param {React.Component} props.Link - A framework specific Link component for client-side routing
+ * @param {function} [props.clickHandler = false] - An optional function to call when a set is clicked
+ * @param {function} [props.href = false] - An optional function that should return the URL to be used for a given set
+ * @returns {JSX.Element}
+ */
 export const CuratedSetLineup = ({ href = false, clickHandler = false, Link = false }) => {
  if (!Link) Link = WebLink
  // Hooks
@ -86,6 +98,15 @@ export const CuratedSetLineup = ({ href = false, clickHandler = false, Link = fa
  )
 }

+/**
+ * A component to render a curated measurements set
+ *
+ * @component
+ * @param {object} props - All component props
+ * @param {React.Component} props.Link - A framework specific Link component for client-side routing
+ * @param {number} props.id - The ID of the curated set
+ * @returns {JSX.Element}
+ */
 export const CuratedSet = ({ Link = false, id = false }) => {
  if (!Link) Link = WebLink
  // Hooks
--- a/packages/react/components/Editor/components/views/ExportView.mjs
+++ b/packages/react/components/Editor/components/views/ExportView.mjs
@ -8,7 +8,7 @@ import React, { useState } from 'react'
 // Components
 import { H1, H2, H3, H5 } from '@freesewing/react/components/Heading'
 import { HeaderMenu } from '../HeaderMenu.mjs'
-import { CopyToClipboardButton } from '@freesewing/react/components/CopyToClipboardButton'
+import { CopyToClipboardButton } from '@freesewing/react/components/Button'
 import { Highlight } from '@freesewing/react/components/Highlight'
 import { EditIcon, CodeIcon, TipIcon, PrintIcon } from '@freesewing/react/components/Icon'

--- a/packages/react/components/Highlight/index.mjs
+++ b/packages/react/components/Highlight/index.mjs
@ -1,5 +1,5 @@
 import React from 'react'
-import { CopyToClipboardButton } from '@freesewing/react/components/CopyToClipboardButton'
+import { CopyToClipboardButton } from '@freesewing/react/components/Button'

 const defaultTitles = {
  js: 'Javascript',
--- a/packages/react/components/Uuid/index.mjs
+++ b/packages/react/components/Uuid/index.mjs
@ -1,7 +1,7 @@
 import React, { useState } from 'react'
 import { shortUuid } from '@freesewing/utils'
 import { Link } from '@freesewing/react/components/Link'
-import { CopyToClipboardButton } from '@freesewing/react/components/CopyToClipboardButton'
+import { CopyToClipboardButton } from '@freesewing/react/components/Button'

 /*
 * Displays a UUID, but shorter