mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-24 02:58:09 +01:00
14d85b1332
A few inconsistencies in JSDoc formatting have been fixed throughout the project. Many issues remain; these were just the few things that were easy to fix with a regular expression. The changes include: * Using lower-case for primitive types, but capitalizing non-primitive types * Separating the parameter identifier and the description with a dash * Omitting a dash between the return type and the return description * Ensuring the parameter type is first and the identifier is second (in a few places it was backwards) * Using square brackets to denote when a parameter is optional, rather than putting "(optional)" in the parameter description * Including a type and identifier with every parameter * Fixing inconsistent spacing, except where it's used for alignment * Remove incorrectly formatted `@deprecated` tags that reference non- existent properties * Remove lone comment block without accompanying function Additionally, one parameter was renamed for clarity.
29 lines
644 B
JavaScript
29 lines
644 B
JavaScript
import { useState, useCallback } from 'react'
|
|
import copyToClipboard from 'copy-to-clipboard'
|
|
import { useTimeout } from './useTimeout'
|
|
|
|
/**
|
|
* useCopyToClipboard
|
|
*
|
|
* @param {number} [delay=3000] - delay in ms
|
|
*
|
|
* @return {[boolean, Function]}
|
|
*/
|
|
const DEFAULT_DELAY = 3000
|
|
|
|
export function useCopyToClipboard(delay = DEFAULT_DELAY) {
|
|
const [copied, setCopied] = useState(false)
|
|
const startTimeout = useTimeout(() => setCopied(false), delay, false)
|
|
|
|
const handleCopy = useCallback(
|
|
(text) => {
|
|
setCopied(true)
|
|
startTimeout()
|
|
copyToClipboard(text)
|
|
},
|
|
[startTimeout],
|
|
)
|
|
|
|
return [copied, handleCopy]
|
|
}
|