The third parameter to `addEventListener` about react-spatial-navigation

[asgvard]

Hi,

The third parameter should be optional? At least according to MDN. Not sure why it throws an exception in this case.
But perhaps you can add this if this is an issue. Just maybe to name it like "keyListenerOptions", because from the init method prospective it's not clear which listeners is it related to (even though it's only keys).

[yarikleto]

For old browsers, the third parameter is required. If the addEventListener and removeEventListener (sometimes) don't have the third parameter, a browser throws an exception.

[shirakaba]

@alfimois If we're going to provide keyListenerOptions for the sake of backwards compatibility, it shouldn't strictly be implemented as a boolean (that would better be called keyListenerUseCapture). It would be better to implement it as an options object (for the sake of newer browsers) that falls back to boolean if necessary (for older browsers):

https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#Safely_detecting_option_support

In older versions of the DOM specification, the third parameter of addEventListener() was a Boolean value indicating whether or not to use capture. Over time, it became clear that more options were needed. Rather than adding more parameters to the function (complicating things enormously when dealing with optional values), the third parameter was changed to an object which can contain various properties defining the values of options to configure the process of removing the event listener.

Because older browsers (as well as some not-too-old browsers) still assume the third parameter is a Boolean, you need to build your code to handle this scenario intelligently. You can do this by using feature detection for each of the options you're interested in.

I don't know what the default (backwards-compatible) options for each property on a keyListenerOptions object would be, however 😕

[shirakaba]

@alfimois Nonetheless, in case you need it, I've created a branch from v2.9.2 that implements keyListenerUseCapture: https://github.com/shirakaba/react-spatial-navigation/tree/shirakaba/listener-use-capture. I won't be maintaining this branch to keep it up-to-date with upstream updates, however.

You can install it with:

npm install --save "git+ssh://[email protected]:shirakaba/react-spatial-navigation.git#shirakaba/listener-use-capture"

# or with yarn:

yarn add "git+ssh://[email protected]:shirakaba/react-spatial-navigation.git#shirakaba/listener-use-capture"

[yarikleto]

Oh, thanks:D