Skip to content

feat(useClipboardItems): add options.immediate and expose read #4954

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

Jump to bottom
Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat(useClipboardItems): add options.immediate and expose read #4954

wants to merge 1 commit into from
+28 −12

Conversation

OrbisK
Copy link
Collaborator

@OrbisK OrbisK commented Aug 11, 2025 •
edited
Loading

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.
⚠️ Slowing down new functions

Warning: Slowing down new functions

As the VueUse audience continues to grow, we have been inundated with an overwhelming number of feature requests and pull requests. As a result, maintaining the project has become increasingly challenging and has stretched our capacity to its limits. As such, in the near future, we may need to slow down our acceptance of new features and prioritize the stability and quality of existing functions. Please note that new features for VueUse may not be accepted at this time. If you have any new ideas, we suggest that you first incorporate them into your own codebase, iterate on them to suit your needs, and assess their generalizability. If you strongly believe that your ideas are beneficial to the community, you may submit a pull request along with your use cases, and we would be happy to review and discuss them. Thank you for your understanding.

Description

This PR adds options.immediate to allow read onMounted. It does also exposes the read function for manual reads.

ToDos:

  • tests
  • discussion about options.immediate. This option is only used when options.read is set to true. Should we reuse read for this?
  /**
   * Enabled reading for clipboard
   *
   * @default false
   */
  read?: boolean | { immediate: boolean}
  • had to use shallowReadonly for content.. readonly did not work, possibly because some keys of ClipboardItem are already readonly?

@43081j @ilyaliao wdyt?

Additional context

@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. enhancement New feature or request new function labels Aug 11, 2025
@pkg-pr-new pkg.pr.new
Copy link

pkg-pr-new bot commented Aug 11, 2025

Open in StackBlitz

@vueuse/components

npm i https://pkg.pr.new/@vueuse/components@4954

@vueuse/core

npm i https://pkg.pr.new/@vueuse/core@4954

@vueuse/electron

npm i https://pkg.pr.new/@vueuse/electron@4954

@vueuse/firebase

npm i https://pkg.pr.new/@vueuse/firebase@4954

@vueuse/integrations

npm i https://pkg.pr.new/@vueuse/integrations@4954

@vueuse/math

npm i https://pkg.pr.new/@vueuse/math@4954

@vueuse/metadata

npm i https://pkg.pr.new/@vueuse/metadata@4954

@vueuse/nuxt

npm i https://pkg.pr.new/@vueuse/nuxt@4954

@vueuse/router

npm i https://pkg.pr.new/@vueuse/router@4954

@vueuse/rxjs

npm i https://pkg.pr.new/@vueuse/rxjs@4954

@vueuse/shared

npm i https://pkg.pr.new/@vueuse/shared@4954

commit: 658b373

@43081j
Copy link
Collaborator

43081j commented Aug 11, 2025

do you have an example of where we might want to do this?

as far as i understand, we react to cut/copy events so, after mount, the value should always reflect whats in clipboard. this might mean you don't need a read function?

@OrbisK

This comment was marked as outdated.

Sign in to view
@OrbisK
Copy link
Collaborator Author

OrbisK commented Aug 11, 2025 •
edited
Loading

If you want to manually read copy from outside the window

@OrbisK

This comment was marked as outdated.

Sign in to view
@OrbisK
Copy link
Collaborator Author

OrbisK commented Aug 11, 2025 •
edited
Loading

Maybe we should not go for mounted but for focus change 🤔 but I think it would be nice to have the opt in into manual mode. This way you can control if you want to prompt for the permission

@OrbisK OrbisK marked this pull request as draft August 11, 2025 11:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
enhancement New feature or request size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@OrbisK @43081j