Stop handled key events propagating

[johnjesse]

What: Stop the propagation of keydown events that have been handled by downshift

Why: If I am using downshift inside a component that is also handling key events then it shouldn't be receiving them if downshift has already taken action

How: using event.stopPropagation()

Checklist:

• Documentation "N/A" - I think there's nothing to add to the documentation about this, the user can still disable this behaviour (as they could before) by setting event.preventDownshiftDefault, so I don't think there needs to be a new addition to the dos?
• Tests
• Ready to be merged
  
• Added myself to contributors table - the add-contributors script failed on my windows machine
  

This fixes issue #630

[johnjesse]

Also, running the tests locally
npm run build-and-test failed for me... within the build-and-test script, not sure what the error was
npm run test:cypress had one failing test

but I think this might just be my machine, as they both failed locally before my changes,

[kentcdodds]

Excellent. Thank you!

[kentcdodds]

I wonder if we should use stopPropagation for every event 🤔 (and not just these specific keys).

[johnjesse]

Potentially, I think if we are calling preventDefault it's a good indicator that we probably want to call stopPropagation.

I would be a little wary of overusing stopPropagation. Calling stopPropagation is effectively cancelling the event and saying that no-one else can handle it. I have also sees varying accounts for when/if you should call stop propagation, see https://css-tricks.com/dangers-stopping-event-propagation/ for instance.

I think we can safely use stopPropagation when you are convinced that nothing else should be doing something with that event (it feels like this is probably generally true). In our case, you are using the keyboard interaction to navigate the downshift control/select an element/close the downshift control. In all cases the keyboard interaction is within the context of the downshift control and doing something to that control. The same keys should not be being re-used for some other functionality whilst we're within the context of downshift. Maybe we review the other event handlers and decide if they fit the same criteria?

[kentcdodds]

That makes sense. I think we'll stick with this until someone complains 👍 Thanks!

[kentcdodds]

🎉 This PR is included in version 3.1.7 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀