Skip to content
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.

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

feat(useRafFn): option fpsLimit #3459

Merged
merged 3 commits into from Oct 7, 2023
Merged

feat(useRafFn): option fpsLimit #3459

merged 3 commits into from Oct 7, 2023

Conversation

f820602h
Copy link
Contributor

@f820602h f820602h commented Oct 6, 2023

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

Modern mobile devices have seen significant improvements in screen refresh rates, some even supporting dynamic FPS.If developers use requestAnimationFrame for animations, it can result in inconsistent animation speed.

While developers can enhance this on their own, proactively providing this option would be more DX-friendly.

Additional context


🤖 Generated by Copilot at 76a0296

Added an option to limit the FPS of useRafFn and improved its performance. This allows users to fine-tune the animation or rendering effects created by the function.

🤖 Generated by Copilot at 76a0296

  • Add fpsLimit option to useRafFn hook to limit the maximum frames per second (link, link, link)
  • Destructure fpsLimit from options parameter and calculate interval based on it (link)
  • Check interval against delta to determine if current frame is valid or not (link)
  • Return early and request another animation frame if delta is too small (link)

@f820602h f820602h changed the title feat: option fpsLimit for useRafFn feat(useRafFn): option fpsLimit Oct 6, 2023
@antfu antfu enabled auto-merge October 7, 2023 07:07
@antfu antfu added this pull request to the merge queue Oct 7, 2023
Merged via the queue into vueuse:main with commit 8e4c01b Oct 7, 2023
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants