useClipboard is a custom hook that handles copying content to clipboard.

Arguments

The useClipboard hook takes the following arguments:

Return value

The useClipboard hook returns an object with the following fields:

Import

import { useClipboard } from '@passfort/castle'
content_copy
Copy

Usage

function Example() {
  const [value, setValue] = useState('Hello world')
  const { hasCopied, onCopy } = useClipboard(value)

  const handleChange = (e) => setValue(e.target.value)

  return (
    <Stack>
      <Flex>
        <Input onChange={handleChange} value={value} placeholder="Welcome" />
        <Button onClick={onCopy} ml={2}>
          {hasCopied ? 'Copied' : 'Copy'}
        </Button>
      </Flex>
      <CodeBlock
        fullHeight
        canEdit
        code={`
`}
      />
    </Stack>
  )
}
function Example() {
  const [value, setValue] = useState('Hello world')
  const { hasCopied, onCopy } = useClipboard(value)

  const handleChange = (e) => setValue(e.target.value)

  return (
    <Stack>
      <Flex>
        <Input onChange={handleChange} value={value} placeholder="Welcome" />
        <Button onClick={onCopy} ml={2}>
          {hasCopied ? 'Copied' : 'Copy'}
        </Button>
      </Flex>
      <CodeBlock
        fullHeight
        canEdit
        code={`
`}
      />
    </Stack>
  )
}
content_copy
Copy
live example