Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat(useClipboardItems): new function#3477

Merged
antfu merged 8 commits intovueuse:mainfrom
Doctor-wu:feature/support_customize_clipboard_item
Nov 9, 2023
Merged

feat(useClipboardItems): new function#3477
antfu merged 8 commits intovueuse:mainfrom
Doctor-wu:feature/support_customize_clipboard_item

Conversation

@Doctor-wu
Copy link
Member

@Doctor-wu Doctor-wu commented Oct 16, 2023 •
edited by ghost
Loading

support to pass a parameter |transform2ClipboardItems| to customize clipboardItems

fix #3450

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

Currently, useClipboard only support writeText, but sometimes we need to specify mime type.
So I add a |transform2ClipboardItems| optional property in options, people can customize their ClipboardItems.
As a result, useClipboard now use the navigator.clipboard.write instead of navigator.clipboard.writeText.

fix #3450

Additional context

🤖 Generated by Copilot at 207ed0e

Add support for customizing clipboard data in useClipboard function. The new parameter transform2ClipboardItems lets the user specify how to convert the input value to a list of clipboard items.

🤖 Generated by Copilot at 207ed0e

  • Add a new parameter transform2ClipboardItems to useClipboard to customize the clipboard data (link, link, link)

okxiaoliang4
okxiaoliang4 previously approved these changes Oct 20, 2023
View reviewed changes
@Doctor-wu
Copy link
Member Author

Doctor-wu commented Oct 20, 2023

@okxiaoliang4 @antfu could you please approve the check?

antfu
antfu reviewed Oct 21, 2023
View reviewed changes
Copy link
Member

@antfu antfu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure about this. useClipboard is designed to work with plain text (as the returned ref holds strings). For custom ClipboardItem, I think it might be better to handle it on the userland. Even if it could be a composable, it would better be useClipboardItems and handle bi-directional reactivity (if it's not possible to work bi-directional, then it would become out-of-scope of VueUse)

@Doctor-wu
Copy link
Member Author

Doctor-wu commented Oct 22, 2023

I am not sure about this. useClipboard is designed to work with plain text (as the returned ref holds strings). For custom ClipboardItem, I think it might be better to handle it on the userland. Even if it could be a composable, it would better be useClipboardItems and handle bi-directional reactivity (if it's not possible to work bi-directional, then it would become out-of-scope of VueUse)

@antfu Thx for replying and that make senses. Thus I'm going to try to add a useClipboardItems function, and refactor the useClipboard function based on useClipboardItems

@Doctor-wu Doctor-wu force-pushed the feature/support_customize_clipboard_item branch from eb1411a to 0cb4dd9 Compare October 23, 2023 14:28
@antfu antfu changed the title feat(useClipboard): support customize clipboardItems feat(useClipboardItems): new function Nov 9, 2023
@antfu antfu enabled auto-merge November 9, 2023 17:05
@antfu antfu added this pull request to the merge queue Nov 9, 2023
Merged via the queue into vueuse:main with commit 1aa50f8 Nov 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@antfu antfu antfu approved these changes

@okxiaoliang4 okxiaoliang4 Awaiting requested review from okxiaoliang4

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Support setting mime when using useClipboard for copying

3 participants

@Doctor-wu @antfu @okxiaoliang4