ng2-click-outside

ng2-click-outside

Demo

Angular 2 directive for handling click events outside an element. Useful for things like reacting to clicking outside of a dropdown menu or modal dialog.

Like binding to a regular Angular 2 click event, you can do something like this:

<div (clickOutside)="onClickedOutside($event)">My element</div>

Installation

npm install --save ng2-click-outside

Usage

Add ClickOutsideModule to your list of module imports:

import { ClickOutsideModule } from 'ng2-click-outside';

@NgModule({
  declarations: [AppComponent],
  imports: [BrowserModule, ClickOutsideModule],
  bootstrap: [AppComponent]
})
class AppModule {}

You can then use the directive in your templates:

@Component({
  selector: 'app',
  template: `
    <div (clickOutside)="onClickedOutside($event)">Click outside this</div>
  `
})
export class AppComponent {
  onClickedOutside(e: Event) {
    console.log('Clicked outside:', e);
  }
}

Options

attachOutsideOnClick

By default, the outside click event handler is automatically. You can explicitely set this to true so that the handler is only set when the element is clicked. The outside click event handler will then be removed after a click outside has occurred.

Default: false

exclude

A comma-seperated string of DOM element queries to exclude when clicking outside of the element.