useClipboardItems

v0.0.15testeddemo

Reactive async Clipboard API with rich `ClipboardItem` support (read/write images, HTML, and arbitrary MIME types — not just text). SSR-safe; uses passive `copy`/`cut` listeners and guards stale async writes.

Source Tests

Examples

const { content, copy, copied, isSupported } = useClipboardItems();
copy([new ClipboardItem({ 'text/plain': new Blob(['hello'], { type: 'text/plain' }) })]);

// Copy a lazily/asynchronously resolved value, kept in sync with the system clipboard
const { content } = useClipboardItems({ read: true });
copy(async () => buildClipboardItems());

Demo

Loading demo…

Signatures

export function useClipboardItems(options?: UseClipboardItemsOptions<undefined>): UseClipboardItemsReturn<false>;

export function useClipboardItems(options: UseClipboardItemsOptions<MaybeRefOrGetter<ClipboardItems>>): UseClipboardItemsReturn<true>;

Parameters

Parameter	Type	Default	Description
`options`?	`UseClipboardItemsOptions<MaybeRefOrGetter<ClipboardItems> \| undefined>`	`{}`	Options

Returns

UseClipboardItemsReturn<boolean>`isSupported`, `content`, `copied`, `copyPending`, `copy`, and `read`