4a3ce4cc1d
Add comprehensive reference documentation for: - Vitest: environments, projects/workspaces, type testing, vi utilities - Pinia: HMR, Nuxt integration, SSR setup - Vue: built-in components (Transition, Teleport, Suspense, KeepAlive) and advanced directives
94 lines
2.6 KiB
Markdown
94 lines
2.6 KiB
Markdown
---
|
|
category: Browser
|
|
related:
|
|
- useClipboard
|
|
---
|
|
|
|
# useClipboardItems
|
|
|
|
Reactive [Clipboard API](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API). Provides the ability to respond to clipboard commands (cut, copy, and paste) as well as to asynchronously read from and write to the system clipboard. Access to the contents of the clipboard is gated behind the [Permissions API](https://developer.mozilla.org/en-US/docs/Web/API/Permissions_API). Without user permission, reading or altering the clipboard contents is not permitted.
|
|
|
|
## Difference from `useClipboard`
|
|
|
|
`useClipboard` is a "text-only" function, while `useClipboardItems` is a [ClipboardItem](https://developer.mozilla.org/en-US/docs/Web/API/ClipboardItem) based function. You can use `useClipboardItems` to copy any content supported by [ClipboardItem](https://developer.mozilla.org/en-US/docs/Web/API/ClipboardItem).
|
|
|
|
## Usage
|
|
|
|
```vue
|
|
<script setup lang="ts">
|
|
import { useClipboardItems } from '@vueuse/core'
|
|
|
|
const mime = 'text/plain'
|
|
const source = ref([
|
|
new ClipboardItem({
|
|
[mime]: new Blob(['plain text'], { type: mime }),
|
|
})
|
|
])
|
|
|
|
const { content, copy, copied, isSupported } = useClipboardItems({ source })
|
|
</script>
|
|
|
|
<template>
|
|
<div v-if="isSupported">
|
|
<button @click="copy(source)">
|
|
<!-- by default, `copied` will be reset in 1.5s -->
|
|
<span v-if="!copied">Copy</span>
|
|
<span v-else>Copied!</span>
|
|
</button>
|
|
<p>
|
|
Current copied: <code>{{ content || 'none' }}</code>
|
|
</p>
|
|
</div>
|
|
<p v-else>
|
|
Your browser does not support Clipboard API
|
|
</p>
|
|
</template>
|
|
```
|
|
|
|
## Type Declarations
|
|
|
|
```ts
|
|
export interface UseClipboardItemsOptions<
|
|
Source,
|
|
> extends ConfigurableNavigator {
|
|
/**
|
|
* Enabled reading for clipboard
|
|
*
|
|
* @default false
|
|
*/
|
|
read?: boolean
|
|
/**
|
|
* Copy source
|
|
*/
|
|
source?: Source
|
|
/**
|
|
* Milliseconds to reset state of `copied` ref
|
|
*
|
|
* @default 1500
|
|
*/
|
|
copiedDuring?: number
|
|
}
|
|
export interface UseClipboardItemsReturn<Optional> extends Supportable {
|
|
content: Readonly<Ref<ClipboardItems>>
|
|
copied: Readonly<ShallowRef<boolean>>
|
|
copy: Optional extends true
|
|
? (content?: ClipboardItems) => Promise<void>
|
|
: (text: ClipboardItems) => Promise<void>
|
|
read: () => void
|
|
}
|
|
/**
|
|
* Reactive Clipboard API.
|
|
*
|
|
* @see https://vueuse.org/useClipboardItems
|
|
* @param options
|
|
*
|
|
* @__NO_SIDE_EFFECTS__
|
|
*/
|
|
export declare function useClipboardItems(
|
|
options?: UseClipboardItemsOptions<undefined>,
|
|
): UseClipboardItemsReturn<false>
|
|
export declare function useClipboardItems(
|
|
options: UseClipboardItemsOptions<MaybeRefOrGetter<ClipboardItems>>,
|
|
): UseClipboardItemsReturn<true>
|
|
```
|