Skip to content

feat(useScroll): add missing measure documentation #4727

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 3 commits into
base: main
Choose a base branch
from
Open

feat(useScroll): add missing measure documentation #4727

wants to merge 3 commits into from
+52 −4

Conversation

Matkolit
Copy link

@Matkolit Matkolit commented Apr 24, 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 addresses #4266 by:

  • Adding documentation for the measure function in the useScroll hook, including its purpose and usage example
  • Implementing a feature in the demo to showcase the measure function in action.
  • Applying whitespace-nowrap to an existing element to improve visual presentation.

Additional context

Please review the new documentation for clarity and accuracy, especially the examples provided for the measure function. Additionally, check if the demo feature aligns with the expected behavior described in #4266. Any feedback on the implementation for improvement would be appreciated!

@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. documentation Improvements or additions to documentation labels Apr 24, 2025
@Matkolit Matkolit changed the title Measure documentation feat(useScroll): Measure documentation Apr 24, 2025
@Matkolit Matkolit changed the title feat(useScroll): Measure documentation feat(useScroll): add missing measure documentation Apr 24, 2025
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Apr 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@OrbisK OrbisK OrbisK left review comments

@ilyaliao ilyaliao ilyaliao 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
@Matkolit @OrbisK @ilyaliao