@allxsmith/bestax-bulma 5.62.0 → 5.63.0

package/dist/esm/helpers/useClipboard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useClipboard.js","sources":["../../../src/helpers/useClipboard.ts"],"sourcesContent":["import { useCallback, useEffect, useRef, useState } from 'react';\nimport { useLatestRef } from './useLatestRef';\n\n/** Options for useClipboard. */\nexport interface UseClipboardOptions {\n  /**\n   * How long `copied` stays `true` after a copy, in milliseconds. Another\n   * copy restarts it. `0` turns the timer off, as Toast's `0` does, so\n   * `copied` stays `true` until a later copy fails. A missing or `NaN` value\n   * uses the default, a negative one ends it at once, and `Infinity`, or\n   * anything longer than the longest delay `setTimeout` takes (2147483647 ms,\n   * about 24.8 days), is that longest delay.\n   * @defaultValue 2000\n   */\n  duration?: number;\n  /**\n   * Called with `true` after each copy that worked, a repeat included, and\n   * with `false` when `duration` runs out or a later copy fails.\n   */\n  onCopiedChange?: (copied: boolean) => void;\n  /**\n   * Called when neither the Clipboard API nor the copy command could write,\n   * with the Clipboard API's own error when it refused, or an `Error` saying\n   * neither could.\n   */\n  onCopyError?: (error: Error) => void;\n}\n\n/** What useClipboard returns. */\nexport interface UseClipboardResult {\n  /**\n   * Writes `text` to the clipboard, and resolves `true` once it's written or\n   * `false` when it couldn't be. It never rejects. Call it from a click or a\n   * key press, with no `await` before it: browsers only allow a write\n   * shortly after one. A call that a later one overtakes leaves `copied`,\n   * `error` and the callbacks to the later one, and doesn't fall back to the\n   * copy command once the later one has started.\n   */\n  copy: (text: string) => Promise<boolean>;\n  /**\n   * `true` for `duration` after a copy that worked, or, with a `duration` of\n   * `0`, until a later copy fails.\n   */\n  copied: boolean;\n  /** Why the last copy failed, or `null` after one that worked. */\n  error: Error | null;\n}\n\n/** How long `copied` lasts when `duration` doesn't say, in ms. */\nconst defaultDuration = 2000;\n\n/**\n * The longest delay `setTimeout` takes, in ms. A longer one, `Infinity`\n * included, runs at once.\n */\nconst longestDelay = 2 ** 31 - 1;\n\n/**\n * `duration` as a delay `setTimeout` keeps, or `null` for no timer: `null`\n * for `0`, as on Toast, the default when it's missing or `NaN` (or a\n * JavaScript caller's `null`), `0` for a negative one, which ends `copied` at\n * once, and the longest delay for `Infinity` or anything longer.\n */\nconst delayOf = (duration: number | null | undefined) => {\n  if (duration === 0) return null;\n  return duration == null || Number.isNaN(duration)\n    ? defaultDuration\n    : Math.min(Math.max(duration, 0), longestDelay);\n};\n\n/** The error a copy reports when nothing could write and nothing said why. */\nconst cannotCopy =\n  'The Clipboard API is missing or refused, and the copy command copied nothing.';\n\n/**\n * Copies `text` the way browsers did before the Clipboard API: it runs the\n * `copy` command and puts the text on the `copy` event that command fires.\n * Success is the event having fired, not the command's return value, which\n * WebKit reports as `false` for a copy that happened.\n *\n * This is the library's only call to the deprecated `document.execCommand`,\n * so it can go when browsers drop it. Until then it's what writes on a page\n * without the Clipboard API, such as one served over plain `http://`.\n *\n * @param text - The text to copy.\n * @returns Whether the `copy` event fired and took the text.\n */\nfunction copyWithCommand(text: string): boolean {\n  let written = false;\n  // WebKit enables the copy command only when something is selected or a\n  // `beforecopy` listener cancels that event, and nothing is selected here.\n  const enable = (event: Event) => event.preventDefault();\n  // On `window` while capturing, so it runs before the page's listeners on\n  // the document and its elements. The copy is this hook's own, so it's\n  // stopped there: a page's own copy handler, such as one that adds a\n  // credit line to whatever is copied, never sees it to rewrite it.\n  const onCopy = (event: ClipboardEvent) => {\n    if (!event.clipboardData) return;\n    event.clipboardData.setData('text/plain', text);\n    event.preventDefault();\n    event.stopImmediatePropagation();\n    written = true;\n  };\n  window.addEventListener('beforecopy', enable, true);\n  window.addEventListener('copy', onCopy, true);\n  try {\n    document.execCommand('copy');\n  } catch {\n    // An engine that refuses, or no longer has the command, can throw, and\n    // the event not firing already says so.\n  } finally {\n    window.removeEventListener('beforecopy', enable, true);\n    window.removeEventListener('copy', onCopy, true);\n  }\n  return written;\n}\n\n/**\n * Writes `text` through the Clipboard API, and through the copy command when\n * that's missing or refuses. Where it's missing, the copy command runs before\n * the first `await`, so it's still inside the click that called it. After a\n * refusal it runs once the refusal arrives, which writes only where the\n * browser still counts the click by then, and only if no later copy has\n * started in the meantime, which it would otherwise write over.\n *\n * @param text - The text to write.\n * @param isLatest - Whether this is still the latest copy.\n * @returns `null` once it's written, or why it couldn't be.\n */\nasync function writeToClipboard(\n  text: string,\n  isLatest: () => boolean\n): Promise<Error | null> {\n  let refusal: unknown = null;\n  // Read at the click, never while rendering, so there's always a navigator.\n  const { clipboard } = navigator;\n  if (clipboard?.writeText) {\n    try {\n      await clipboard.writeText(text);\n      return null;\n    } catch (reason) {\n      refusal = reason;\n    }\n  }\n  if (isLatest() && copyWithCommand(text)) return null;\n  return refusal instanceof Error ? refusal : new Error(cannotCopy);\n}\n\n/**\n * Copies text to the clipboard through the Clipboard API, falling back to the copy command where that's missing or refused, and keeps a `copied` flag for `duration` after a copy.\n *\n * It announces nothing. A trigger of your own says \"Copied\" in a\n * `role=\"status\"` region that's in the page before the click; `CopyButton`\n * is this hook with the button, the label and the announcement built in.\n *\n * A failed copy sets `error`, calls `onCopyError`, and ends `copied` if a\n * copy before it had set it. When copies overlap, only the latest one's\n * outcome sets the state and fires the callbacks, whichever finishes first.\n * Nothing changes and no callback fires once the component using it has\n * unmounted, though a write already under way still finishes.\n *\n * @function useClipboard\n * @param options - How long `copied` lasts, and the callbacks.\n * @returns `copy`, which writes, and the `copied` and `error` state.\n *\n * @example\n * const { copy, copied } = useClipboard();\n * <Button onClick={() => copy(url)}>{copied ? 'Copied' : 'Copy link'}</Button>\n */\nexport function useClipboard(\n  options: UseClipboardOptions = {}\n): UseClipboardResult {\n  const [copied, setCopied] = useState(false);\n  const [error, setError] = useState<Error | null>(null);\n  const optionsRef = useLatestRef(options);\n  const copiedRef = useRef(false);\n  const timerRef = useRef<ReturnType<typeof setTimeout> | undefined>(undefined);\n  const mountedRef = useRef(false);\n  // Counts the calls to `copy`, so only the latest one's outcome is kept.\n  const latestCallRef = useRef(0);\n\n  useEffect(() => {\n    mountedRef.current = true;\n    return () => {\n      mountedRef.current = false;\n      clearTimeout(timerRef.current);\n    };\n  }, []);\n\n  const copy = useCallback(\n    async (text: string) => {\n      latestCallRef.current += 1;\n      const call = latestCallRef.current;\n      const isLatest = () => call === latestCallRef.current;\n      const failure = await writeToClipboard(text, isLatest);\n      // A write overtaken by a later copy, which may finish first, reports\n      // through its promise only.\n      if (!mountedRef.current || !isLatest()) {\n        return failure === null;\n      }\n      clearTimeout(timerRef.current);\n      const { duration, onCopiedChange, onCopyError } = optionsRef.current;\n      const wasCopied = copiedRef.current;\n      copiedRef.current = failure === null;\n      setCopied(failure === null);\n      setError(failure);\n      if (failure) {\n        if (wasCopied) onCopiedChange?.(false);\n        onCopyError?.(failure);\n        return false;\n      }\n      onCopiedChange?.(true);\n      const delay = delayOf(duration);\n      if (delay !== null) {\n        timerRef.current = setTimeout(() => {\n          copiedRef.current = false;\n          setCopied(false);\n          optionsRef.current.onCopiedChange?.(false);\n        }, delay);\n      }\n      return true;\n    },\n    [optionsRef]\n  );\n\n  return { copy, copied, error };\n}\n"],"names":[],"mappings":";;;;;AAgDA;AACA,MAAM,eAAe,GAAG,IAAI;AAE5B;;;AAGG;AACH,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC;AAEhC;;;;;AAKG;AACH,MAAM,OAAO,GAAG,CAAC,QAAmC,KAAI;IACtD,IAAI,QAAQ,KAAK,CAAC;AAAE,QAAA,OAAO,IAAI;IAC/B,OAAO,QAAQ,IAAI,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,QAAQ;AAC9C,UAAE;AACF,UAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,YAAY,CAAC;AACnD,CAAC;AAED;AACA,MAAM,UAAU,GACd,+EAA+E;AAEjF;;;;;;;;;;;;AAYG;AACH,SAAS,eAAe,CAAC,IAAY,EAAA;IACnC,IAAI,OAAO,GAAG,KAAK;;;IAGnB,MAAM,MAAM,GAAG,CAAC,KAAY,KAAK,KAAK,CAAC,cAAc,EAAE;;;;;AAKvD,IAAA,MAAM,MAAM,GAAG,CAAC,KAAqB,KAAI;QACvC,IAAI,CAAC,KAAK,CAAC,aAAa;YAAE;QAC1B,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC;QAC/C,KAAK,CAAC,cAAc,EAAE;QACtB,KAAK,CAAC,wBAAwB,EAAE;QAChC,OAAO,GAAG,IAAI;AAChB,IAAA,CAAC;IACD,MAAM,CAAC,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,CAAC;IACnD,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC;AAC7C,IAAA,IAAI;AACF,QAAA,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC;IAC9B;AAAE,IAAA,MAAM;;;IAGR;YAAU;QACR,MAAM,CAAC,mBAAmB,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,CAAC;QACtD,MAAM,CAAC,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC;IAClD;AACA,IAAA,OAAO,OAAO;AAChB;AAEA;;;;;;;;;;;AAWG;AACH,eAAe,gBAAgB,CAC7B,IAAY,EACZ,QAAuB,EAAA;IAEvB,IAAI,OAAO,GAAY,IAAI;;AAE3B,IAAA,MAAM,EAAE,SAAS,EAAE,GAAG,SAAS;AAC/B,IAAA,IAAI,SAAS,EAAE,SAAS,EAAE;AACxB,QAAA,IAAI;AACF,YAAA,MAAM,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC;AAC/B,YAAA,OAAO,IAAI;QACb;QAAE,OAAO,MAAM,EAAE;YACf,OAAO,GAAG,MAAM;QAClB;IACF;AACA,IAAA,IAAI,QAAQ,EAAE,IAAI,eAAe,CAAC,IAAI,CAAC;AAAE,QAAA,OAAO,IAAI;AACpD,IAAA,OAAO,OAAO,YAAY,KAAK,GAAG,OAAO,GAAG,IAAI,KAAK,CAAC,UAAU,CAAC;AACnE;AAEA;;;;;;;;;;;;;;;;;;;;AAoBG;AACG,SAAU,YAAY,CAC1B,OAAA,GAA+B,EAAE,EAAA;IAEjC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC;IAC3C,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAe,IAAI,CAAC;AACtD,IAAA,MAAM,UAAU,GAAG,YAAY,CAAC,OAAO,CAAC;AACxC,IAAA,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC;AAC/B,IAAA,MAAM,QAAQ,GAAG,MAAM,CAA4C,SAAS,CAAC;AAC7E,IAAA,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC;;AAEhC,IAAA,MAAM,aAAa,GAAG,MAAM,CAAC,CAAC,CAAC;IAE/B,SAAS,CAAC,MAAK;AACb,QAAA,UAAU,CAAC,OAAO,GAAG,IAAI;AACzB,QAAA,OAAO,MAAK;AACV,YAAA,UAAU,CAAC,OAAO,GAAG,KAAK;AAC1B,YAAA,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC;AAChC,QAAA,CAAC;IACH,CAAC,EAAE,EAAE,CAAC;IAEN,MAAM,IAAI,GAAG,WAAW,CACtB,OAAO,IAAY,KAAI;AACrB,QAAA,aAAa,CAAC,OAAO,IAAI,CAAC;AAC1B,QAAA,MAAM,IAAI,GAAG,aAAa,CAAC,OAAO;QAClC,MAAM,QAAQ,GAAG,MAAM,IAAI,KAAK,aAAa,CAAC,OAAO;QACrD,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC;;;QAGtD,IAAI,CAAC,UAAU,CAAC,OAAO,IAAI,CAAC,QAAQ,EAAE,EAAE;YACtC,OAAO,OAAO,KAAK,IAAI;QACzB;AACA,QAAA,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC;QAC9B,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,UAAU,CAAC,OAAO;AACpE,QAAA,MAAM,SAAS,GAAG,SAAS,CAAC,OAAO;AACnC,QAAA,SAAS,CAAC,OAAO,GAAG,OAAO,KAAK,IAAI;AACpC,QAAA,SAAS,CAAC,OAAO,KAAK,IAAI,CAAC;QAC3B,QAAQ,CAAC,OAAO,CAAC;QACjB,IAAI,OAAO,EAAE;AACX,YAAA,IAAI,SAAS;AAAE,gBAAA,cAAc,GAAG,KAAK,CAAC;AACtC,YAAA,WAAW,GAAG,OAAO,CAAC;AACtB,YAAA,OAAO,KAAK;QACd;AACA,QAAA,cAAc,GAAG,IAAI,CAAC;AACtB,QAAA,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC;AAC/B,QAAA,IAAI,KAAK,KAAK,IAAI,EAAE;AAClB,YAAA,QAAQ,CAAC,OAAO,GAAG,UAAU,CAAC,MAAK;AACjC,gBAAA,SAAS,CAAC,OAAO,GAAG,KAAK;gBACzB,SAAS,CAAC,KAAK,CAAC;gBAChB,UAAU,CAAC,OAAO,CAAC,cAAc,GAAG,KAAK,CAAC;YAC5C,CAAC,EAAE,KAAK,CAAC;QACX;AACA,QAAA,OAAO,IAAI;AACb,IAAA,CAAC,EACD,CAAC,UAAU,CAAC,CACb;AAED,IAAA,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE;AAChC;;"}