Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat(onClickOutside): add controls #4537

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

Merged
merged 10 commits into from
Feb 12, 2025

Conversation

sibbng
Copy link
Member

@sibbng sibbng commented Jan 25, 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

Gives end users more flexibility over triggering the listener. Technically unlocks fixing issues like #4104 and #3911 on end-user side. IMO after merging this PR we should close this issues and let end-users to decide what to do in their specific situation. I shared my thoughts on these PRs why they are not mergeable and clash with the goals of onClickOutside. This is like a never ending chase game. It's better end-users to handle situation base on their needs.

Additional context

@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. enhancement New feature or request labels Jan 25, 2025
Comment on lines 179 to 190
if (controller) {
return {
stop,
cancel: () => { shouldListen = false },
fire: (event: Event) => {
shouldListen = true
listener(event)
},
}
}

return stop
Copy link
Collaborator

@OrbisK OrbisK Jan 26, 2025

Choose a reason for hiding this comment

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

IMO the long-term return of the controller should be the default here.

Maybe we can do a backwards-comparable solution for now. Not sure if this is considered hacky or not:

What if we return something like this:

const useXY = ()=>{
  const controller /* is actually stop function */  = ()=>{
    // stop logic
  }
  controller.cancel = ()=>{
    shouldListen = false 
  }
  controller.stop = ()=>{
    // stop logic
  }
  controller.fire = (event)=>{
    shouldListen = true
    listener(event)
  }
  
  return controller
}

This should allow

const stop = useXY()
stop()

// AND
const {stop, fire, cancel} = useXY()
stop()
// ...

This means that we do not need an extra option.

Copy link
Member Author

@sibbng sibbng Jan 26, 2025

Choose a reason for hiding this comment

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

IMO the long-term return of the controller should be the default here.

That's what I think too.

This means that we do not need an extra option.

I considered this option but it feels like anti-pattern and look ugly. And more importantly this is a breaking change for types. Without controller, handler function's first argument receives PointerEvent type. When controller is enabled it becomes Event. Similar to when detectIframe enabled, it's FocusEvent | PointerEvent.

If we decide to pursue controller approach, in next major, we can drop overloads, default to Event (or even Event | undefined) and significantly simplify types.

Copy link
Collaborator

Choose a reason for hiding this comment

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

it feels like anti-pattern and look ugly

I agree with that. But it would ensure that a breaking change can also be a little softer.

If we decide to pursue controller approach, in next major, we can drop overloads, default to Event (or even Event | undefined) and significantly simplify types.

When we do, we might consider making sure that all composables return an object. That way we are consistent and future proof.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I considered this option but it feels like anti-pattern and look ugly. And more importantly this is a breaking change for types. Without controller, handler function's first argument receives PointerEvent type. When controller is enabled it becomes Event. Similar to when detectIframe enabled, it's FocusEvent | PointerEvent.

Just for reference, the vue 3.5 watcher does exactly this pattern: https://github.com/vuejs/core/blob/7ecd2a22c799d85b0c9857e48d97de5755197e87/packages/reactivity/src/watch.ts#L324-L328. Not to say it is not an anti-pattern.

Partially related: #4548 (comment)

OrbisK
OrbisK previously approved these changes Jan 28, 2025
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jan 28, 2025
OrbisK
OrbisK previously approved these changes Feb 11, 2025
@antfu antfu changed the title feat(onClickOutside): add controller feat(onClickOutside): add controls Feb 12, 2025
antfu
antfu previously approved these changes Feb 12, 2025
@antfu antfu dismissed stale reviews from OrbisK and themself via 2da8c60 February 12, 2025 02:22
@antfu antfu enabled auto-merge February 12, 2025 02:39
@antfu antfu added this pull request to the merge queue Feb 12, 2025
Merged via the queue into vueuse:main with commit ab116ab Feb 12, 2025
9 checks passed
@sibbng sibbng deleted the feat/onClickOutside/controller branch February 12, 2025 19:10
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:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants