ng2-debounce-directive
v1.0.1
Published
Angular 2 directive to add debounce behaviour on elements based in a list of events
Downloads
9
Maintainers
Readme
@ng2-debounce-direcive
Angular 2 directive to add debounce behaviour on elements based in a list of events
Installation
To install this library, run:
$ npm install ng2-debounce-directive --save
Consuming your library
Once you have published your library to npm, you can import your library in any Angular application by running:
$ npm install ng2-debounce-directive
and then from your Angular AppModule
:
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
// Import your library
import { Debounce } from 'ng2-debounce-directive';
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
// Specify your library as an import
Debounce.forRoot()
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule { }
Once your library is imported, you can use its components, directives and pipes in your Angular application:
<!-- You can now use your library component in app.component.html -->
<input appDebounce [delay]="700" [events]="['keyup','mouseover',...]" (func)="some_binding_method()" [(ngModel)]="attribute">
Tested events
| Event name | Description |
| ----------- | ----------------------------------------------------------------------- |
| click | Fires on a mouse click on the element |
| dblclick | Fires on a mouse double-click on the element |
| mousedown | Fires when a mouse button is pressed down on an element |
| mousemove | Fires when the mouse pointer is moving while it is over an element |
| mouseout | Fires when the mouse pointer moves out of an element |
| mouseover | Fires when the mouse pointer moves over an element |
| mouseup | Fires when a mouse button is released over an element |
| wheel | Fires when the mouse wheel rolls up or down over an element |
| keydown | Fires when a user is pressing a key |
| keypress | Fires when a user presses a key |
| keyup | Fires when a user releases a key |
Development
To generate all *.js
, *.d.ts
and *.metadata.json
files:
$ npm run build
To lint all *.ts
files:
$ npm run lint
License
MIT © Jonathas