How to handle a helper and a modifier with the same name?

[boris-petrov]

I'm using both @ember/render-modifiers and ember-render-helpers. The former adds a did-insert modifier (and obviously did-update and will-destroy) and the latter - a did-insert helper.

I don't think it's possible to handle that in Glint right now. What can I do?

[dfreeman]

I think this is something we're probably not super likely to officially support, as it's not really clear how to do it in a clean way and this problem goes away with strict mode.

That said, unofficially this is expressible using private APIs. As always, use these at your own risk—these types might change in any Glint release.

// ️⚠️ This code may break at any time! This version is current as of Glint 1.0.0-beta.1

import { ModifierReturn, DirectInvokable } from '@glint/template/-private/integration';
import { ContentValue } from '@glint/template';

declare module '@glint/environment-ember-loose/registry' {
  export default interface Registry {
    'did-insert': DirectInvokable<{
      (callback: () => void): ContentValue;
      <T extends Element>(element: T, callback: (el: T) => void): ModifierReturn;
    }>;
  }
}

[boris-petrov]

Actually I hit this with ember-keyboard’s on-key helper/modifier pair. In any case, if that’s not a supported use case, I’ll just suppress the errors for now. Thanks!

[dfreeman]

I think all you should need to change for this to keep working is to replace use of EmittableValue to import { ContentValue } from '@glint/template', since we have a public type for that now. If you can confirm that that works, I'll update the snippet here.

[boris-petrov]

It seems to work, yes. For reference, here's how I implemented the on-key helper/modifier from ember-keyboard:

type OnKeyHelperAndModifier = DirectInvokable<
  (
    args: { readonly priority?: number },
    key: string,
    callback: (event: KeyboardEvent, emberKeyboardEvent: KeyboardEvent) => void,
  ) => BoundModifier<Element> & ContentValue
>;

Thanks!

[chriskrycho]

I learned via this discussion that we made this public API in the most recent release, so I stand corrected (and happily so)!

[dfreeman]

Just to be extra clear for any future travelers: ContentValue (and AttrValue) are public, but the rest of this is still very much internal and subject to change at any time! 😄

[ijlee2]

An update for those who use @ember/render-modifiers and ember-render-helpers: I renamed the helpers in [email protected] so that there won't be name conflicts.

https://github.com/buschtoens/ember-render-helpers/releases/tag/v1.0.0