Skip to content

docs: inline Key components in useMagicKeys and useKeyModifier demos #4884

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
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: inline Key components in useMagicKeys and useKeyModifier demos #4884

wants to merge 2 commits into from
+40 −20

Conversation

broBinChen
Copy link
Contributor

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 enhances demo isolation and maintainability by removing external component dependencies in useMagicKeys and useKeyModifier demo files.

What this PR solves:

1. Playground Compatibility Issues

2. Demo Isolation and Maintainability

  • Eliminates cross-file dependencies between demo files
  • Each demo becomes completely self-contained and portable
  • Reduces maintenance burden by avoiding shared component changes affecting multiple demos
  • Improves code clarity - developers can understand the complete demo logic in a single file

Additional context

@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jul 16, 2025
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jul 16, 2025
@ilyaliao
Copy link
Member

@OrbisK Can't we just do it this way?

@OrbisK
Copy link
Collaborator

OrbisK commented Jul 18, 2025 •
edited
Loading

@OrbisK Can't we just do it this way?

It is possible, yes.

I thought about this before. I think we could have a direcotry like:

- demo.vue
- demo/
  - comp1.vue
  - comp2.vue
  - example.ts

and add all files from demo/ to the playground.

@ilyaliao
Copy link
Member

@OrbisK Can't we just do it this way?

It is possible, yes.

I thought about this before. I think we could have a direcotry like:

- demo.vue
- demo/
  - comp1.vue
  - comp2.vue
  - example.ts

and add all files from demo/ to the playground.

I think this approach is better because we have many demos with similar situations, and inlining might not be practical.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@OrbisK OrbisK OrbisK approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer 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.
3 participants
@broBinChen @ilyaliao @OrbisK
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy