[feature]: ignoreEventCondition option

[alpinagyok]

Hey!

Changes

• added ignoreEventCondition option

Why

We need a bit finer control of when to ignore events. As an example, checking event.target.closest() by role/css

Wdyt? 😄

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
react-hotkeys-hook	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 11, 2023 5:25pm

[JohannesKlauss]

Thank you for your contribution!
I am happy to merge this, but before that, please add some tests for that feature and add its API to the API documentation. Also I am not too happy about the name of the option. Maybe something like ignoreEventWhen is a more precise naming?

[alpinagyok]

Agree with the name 👍, thanks for the comment. Will add tests and docs in a moment

[alpinagyok]

@JohannesKlauss, done 👌

[JohannesKlauss]

This text is now doubled

[alpinagyok]

fixed 👍

[JohannesKlauss]

Thank you for your work!

[isti115]

Sorry to bump this already merged PR, but just out of curiosity I'd like to ask what the difference between filter and ignoreEventWhen is apart from the predicate being negated? Having both of these options only for the sake of one being affected by filterPreventDefault and the other not seems to be a bit redundant to me at first, but there might be something that I`m overlooking.

Also, if ignoreEventWhen is determined to be necessary, it should probably also be documented in the Options table of the top level README.

[alpinagyok]

@isti115, I didn't know those existed 😄. but now that I look at it, there's no mention of filter in the code. maybe it's a leftover documentation? probably a question for the maintainer

[isti115]

@alpinagyok Wow, sorry for not checking thoroughly enough, you're completely right, it seems to have been removed at some point during the move to version 4 as far as I can tell from the commit history. I'll submit a PR to remove it from the documentation as well.