Skip to content

Implement read-only useClipboard #201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
erayerdin wants to merge 2 commits into
base: main
Choose a base branch
from
+12 −3
Open

Implement read-only useClipboard #201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34a26ba
add options to useClipboard
erayerdin May 27, 2026
0662aa6
do not read clipboard if options.read is true
erayerdin May 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions packages/core/src/useClipboard/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,20 @@ import { useEventListener } from '../useEventListener'
import { defaultWindow } from '../utils/browser'
import type { UseClipboard } from './interface'

export const useClipboard: UseClipboard = (): readonly [
export const useClipboard: UseClipboard = (options = { read: false }): readonly [
string,
(txt: string) => Promise<void>,
] => {
const [text, setText] = useState('')

const read = options.read ?? false

const updateText = useCallback(async () => {
// if read-only, do not run
if (read) {
return
}

// Check if document is focused before attempting to read clipboard
if (!document.hasFocus()) {
return
Expand All @@ -23,7 +30,7 @@ export const useClipboard: UseClipboard = (): readonly [
// Handle cases where clipboard access is denied or unavailable
console.warn('Failed to read clipboard:', error)
}
}, [])
}, [read])

useEventListener('copy', updateText)
useEventListener('cut', updateText)
Expand Down
4 changes: 3 additions & 1 deletion packages/core/src/useClipboard/interface.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@
* @returns 返回只读元组.
* @returns_zh-Hant 返回唯讀元組.
*/
export type UseClipboard = () => readonly [string, (txt: string) => Promise<void>]
export type UseClipboard = (options?: {
read?: boolean
}) => readonly [string, (txt: string) => Promise<void>]