useClipboard

Hook that manages a copy to clipboard

browser

medium

test coverage

Last changed: 8 months ago

TIP

This hook uses navigator.clipboard browser api to provide enhanced functionality. Make sure to check for compatibility with different browsers when using this api

Installation

Library

CLI

Manual

import { useClipboard } from '@siberiacancode/reactuse';

Usage

const { value, copy } = useClipboard();

Demo

source

Api

Parameters

Name	Type	Default	Note
params.enabled?	boolean	false	Whether the copy to clipboard is enabled

Returns

UseCopyToClipboardReturn

Type declaration

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

Source • Demo

Contributors

D

debabin

N

Nursultan Zianurov