Skip to content

useClipboard

Hook that manages a copy to clipboard

browser
medium
test coverage
Last changed: 6 months ago

Installation

Library
CLI
Manual
typescript
import { useClipboard } from '@siberiacancode/reactuse';

Usage

typescript
const { value, copy } = useClipboard();
## Demo

Api

Parameters

NameTypeDefaultNote
params.enabled?booleanfalseWhether the copy to clipboard is enabled

Returns

UseCopyToClipboardReturn

Type declaration

typescript
export interface UseCopyToClipboardReturn {
  /** The copied value */
  value: string | null;
  /** Function to copy to clipboard  */
  copy: (value: string) => Promise<void>;
}

export interface UseCopyToClipboardParams {
  /** Whether the copy to clipboard is enabled */
  enabled: boolean;
}

Source

SourceDemo

Contributors

D
debabin
debabin
N
Nursultan Zianurov
Nursultan Zianurov

Released under the MIT License.