adopted-ember-addons/ember-keyboard

Consider impact of glint on API design

lukemelia opened this issue · 4 comments

Before glint/gts, having a modifier and helper with the same name didn't cause any issues, but it is a point of annoyance when working with glint. It's not a show stopper, because .gts file authors can easily alias the helper or modifier when importing it, but it would be good to consider a plan to evolve the addon to be more friendly in its default naming.

We're running into this introducing Glint to our codebase—we use ember-keyboard quite a lot. If there are plans to rename one of them, or if we can figure out another solution, that'd be great! I'm also happy to help in any way. 😄

I think we need to consider renaming and doing a major release. Any ideas on names?

I'm wondering if there's a clear difference between the two: on-key modifier adds listeners to the element that applies it, whereas on-key the helper adds it to the document.

Could we use something like on-document-key for the helper and on-key for the modifier? Or something along those lines?