ember-click-outside-modifier

ember-click-outside-modifier

Ember modifier to react on clicks outside an element without stopping the event propagation. Great for closing dialogues, menus among other things.

If you need more control on click outside - take a look at ember-click-outside

Inspired by v-click-outside

Compatibility

• Ember.js v3.20 or above
• Ember CLI v2.13 or above
• Embroider or ember-auto-import >= 2.0.0 (this is v2 addon)

Installation

ember install ember-click-outside-modifier

Usage

<div {{click-outside this.onClickOutside}}></div>

You can also provide specific events that you want to bind to with the event or events named arguments.

<div {{click-outside this.onClickOutside event='mouseup'}}></div>
<div {{click-outside this.onClickOutside events=(array 'click' 'mouseup')}}></div>

Usage with Glint

ember-click-outside-modifier is a glint enabled addon. Add this to your types/global.d.ts file:

import '@glint/environment-ember-loose';

import type EmberClickOutsideRegistry from 'ember-click-outside-modifier/template-registry';

declare module '@glint/environment-ember-loose/registry' {
  export default interface Registry extends EmberClickOutsideRegistry, /* other addon registries */ {
    // local entries
  }
}

For the entire guide, please refer to Using Addons section on the glint handbook.

Types are made available through package.json exports field.

Usage with <template> tag

For usage in gts or gjs files, modifier are exported from the index:

import { clickOutside } from 'ember-click-outside-modifier';

<template>
  <div {{clickOutside this.handleClickOutside}}>
    Lorem ipsum.
  </div>
</template>

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License.

Changelog

v4.1.0 (2023-08-09)

:rocket: Enhancement

• #38 Glint Support (@SergeAstapov)
• #32 Winden ember-modifier version range to allow v4 (@SergeAstapov)
• #33 Remove engines field from addon package.json (@SergeAstapov)
• #24 auto-publish unstable packages to NPM (@SergeAstapov)

:memo: Documentation

• #23 Improve contributing docs (@SergeAstapov)

:house: Internal

• #37 replace publish-unstable with push-dist (@SergeAstapov)
• #28 Add 4.4 and 4.8 LTS ember-try scenarios (@SergeAstapov)
• #26 Rename addon folder to ember-click-outside-modifier (@SergeAstapov)
• #25 Use release-it hook to copy .md files at publish time (@SergeAstapov)
• #22 run npx ember-cli-update --to=v4.3.0 to align with blueprint (@SergeAstapov)
• #21 add eslint-plugin-qunit per latest blueprint (@SergeAstapov)

Committers: 1

• Sergey Astapov (@SergeAstapov)