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

fix(useClickAway): Fix click on self in shadowDOM will also trigger a callback #2528

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

molvqingtai
Copy link

@molvqingtai molvqingtai commented Nov 10, 2023

Description

<custom-element>
   #shadow-root
      <button ref={buttonRef}>button</button>
   #shadow-root
</custom-element>
useClickAway(
   buttonRef,
  (e) => {
    console.log(e.target) // custom-element
  },
  ['click']
)

As shown above, clicking the button in shadowDOM will also incorrectly trigger the callback, because in shadowDOM, the target has been forwarded to :host, that is, custom-element, and events within the shadowDOM are not visible to the outside.
This PR will solve the problem.

Reference: https://javascript.info/shadow-dom-events

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as before)

Checklist

  • Read the Contributing Guide
  • Perform a code self-review
  • Comment the code, particularly in hard-to-understand areas
  • Add documentation
  • Add hook's story at Storybook
  • Cover changes with tests
  • Ensure the test suite passes (yarn test)
  • Provide 100% tests coverage
  • Make sure code lints (yarn lint). Fix it with yarn lint:fix in case of failure.
  • Make sure types are fine (yarn lint:types).

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

1 participant