diff --git a/addon-test-support/@ember/test-helpers/dom/trigger-event.ts b/addon-test-support/@ember/test-helpers/dom/trigger-event.ts index 25e590523..175d2154a 100644 --- a/addon-test-support/@ember/test-helpers/dom/trigger-event.ts +++ b/addon-test-support/@ember/test-helpers/dom/trigger-event.ts @@ -53,6 +53,23 @@ registerHook('triggerEvent', 'start', (target: Target, eventType: string) => { * } * } * ) + * + * + * @example + * + * Using `triggerEvent` to simulate a mouseleave event + * + * `triggerEvent` provides a way to to trigger any [Event](https://developer.mozilla.org/en-US/docs/Web/API/Event) + * The `options` param can contain any sub set of properties from each of the Event sub-types. + * If supplied, the `options.relatedTarget` has to be an HTML `Element`. + * + * + * const target = find('#zone') + * triggerEvent( + * target, + * 'mouseleave', + * { relatedTarget: target } + * ) */ export default function triggerEvent( target: Target,