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: make useStorage key reactive #4464

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

EvgenyWas
Copy link
Contributor

@EvgenyWas EvgenyWas commented Jan 5, 2025

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 makes key argument for useStorage composable reactive. It means if we change the key the data value should be taken from the appropriate key in storage, otherwise if the storage's value doesn't exist we use a default value as a new value for the data value and apply it to the storage by the new key.

Due to Vue updates flush and pausing/resuming writing to storage on the data value update in the current implementation, it requires to use nextTick after the first change if we change data and key together independently on the order. For example:

const key = ref('key')
const data = useStorage(key,  0)

// BAD: changes the key but writes to storage by new one, not old one
data.value = 1
key.value = 'new-key'

// BAD: changes the key and data according to the new storage value, but skips the data update due to the data watch pause
key.value = 'new-key'
data.value = 1

// GOOD: writes to storage by the current key and then changes the key and data appropriately
data.value = 1
await nextTick()
key.value = 'new-key'

// GOOD: changes the key and then writes to storage by the new key
key.value = 'new-key'
nextTick(() => data.value = 1)

Implements #4289

Additional context

Additionally, updated useLocalStorage and useSessionStorage types according to the new type of the useStorage key.

@EvgenyWas EvgenyWas marked this pull request as ready for review January 5, 2025 13:50
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. enhancement New feature or request labels Jan 5, 2025
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

2 participants