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(useCounter): initialValue support ref #3266

Merged
merged 3 commits into from Jul 30, 2023

Conversation

Rock070
Copy link
Contributor

@Rock070 Rock070 commented Jul 28, 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

make useCounter initialValue support ref.

const initial = ref(10)
const { count, inc, get } = useCounter(initial)

inc()
initial.value // 11
count.value // 11
get() // 11

Additional context


🤖 Generated by Copilot at e7f79e5

This pull request enhances the useCounter function to support reactive initial values and state, and updates the test file accordingly. It also fixes a bug in the reset function.

🤖 Generated by Copilot at e7f79e5

  • Add support for reactive references as initial values for useCounter (link, link, link)
  • Import toRef, toValue, and MaybeRef from shared/index in useCounter/index.ts (link)
  • Use toValue to get the actual value of initialValue and store it in _initialValue (link)
  • Use toRef to create a reactive reference for count (link)
  • Use _initialValue as the default value for reset (link)
  • Add test case for useCounter with reactive reference as initial value in useCounter/index.test.ts (link, link)
    • Import ref from vue-demi to create reactive references (link)
    • Test the counter methods with a reactive reference as initialValue (link)

Comment on lines 18 to 20
export function useCounter(initialValue: MaybeRef<number> = 0, options: UseCounterOptions = {}) {
let _initialValue = toValue(initialValue)
const count = toRef(initialValue)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a thought, if we only receive a MaybeRef here, is it appropriate to utilize ref and unref?

export function useCounter(initialValue: MaybeRef<number> = 0, options: UseCounterOptions = {}) {
  let _initialValue = unref(initialValue)
  const count = ref(initialValue)

  // ...
}

Copy link
Contributor Author

@Rock070 Rock070 Jul 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your advise, I think it's more appropriate for using ref & unref

@Rock070 Rock070 force-pushed the feat/use-counter-maybe-ref branch from dee3f2a to 97e40bc Compare July 29, 2023 06:48
@antfu antfu added this pull request to the merge queue Jul 30, 2023
Merged via the queue into vueuse:main with commit 6ae3a8c Jul 30, 2023
3 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

3 participants