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(useStorage): add waitOnMounted option for SSR #3504

Merged
merged 3 commits into from Nov 9, 2023

Conversation

posva
Copy link
Contributor

@posva posva commented Oct 25, 2023

Close #3447

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

Additional context


🤖 Generated by Copilot at a84b5c3

Added a waitOnMounted option to useStorage to improve SSR compatibility. Updated the test file to cover the new option.

🤖 Generated by Copilot at a84b5c3

  • Add waitOnMounted option to useStorage function to delay reading the storage value until the component is mounted (link, link, link)
  • Import tryOnMounted helper from @vueuse/shared to implement the deferred update logic in useStorage (link)
  • Add test case for waitOnMounted option in useStorage/index.test.ts, using defineComponent, nextTick, and mount from vue-test-utils (link, link)

antfu
antfu previously approved these changes Nov 9, 2023
@antfu antfu added this pull request to the merge queue Nov 9, 2023
@posva
Copy link
Contributor Author

posva commented Nov 9, 2023

BTW: I think it’s worth checking with an native English speaker if the option name sounds good

@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to a conflict with the base branch Nov 9, 2023
@antfu
Copy link
Member

antfu commented Nov 9, 2023

Maybe readOnMounted or initOnMounted? To me, it's a bit unclear what to "wait" on

Copy link
Contributor Author

posva commented Nov 9, 2023

Sounds good to me!

@antfu antfu added this pull request to the merge queue Nov 9, 2023
Merged via the queue into vueuse:main with commit dc6f2e8 Nov 9, 2023
4 checks passed
@posva posva deleted the feat/waitOnMounted branch December 8, 2023 14:34
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.

Solve Hydration node mismatch for useStorage
2 participants