ng-hotkeys
Version:
ng-hotkeys for Angular 14+
58 lines (57 loc) • 1.72 kB
TypeScript
import { AfterViewInit, OnChanges, OnDestroy, OnInit, SimpleChanges } from "@angular/core";
import { NgHotkeysService } from './ng-hotkeys.service';
import { ShortcutInput, ShortcutEventOutput } from "./ng-hotkeys.interfaces";
import { Observable } from "rxjs";
import * as i0 from "@angular/core";
/**
* A component to bind global shortcuts, can be used multiple times across the app
* will remove registered shortcuts when element is removed from DOM.
*/
export declare class NgHotkeysComponent implements OnInit, AfterViewInit, OnChanges, OnDestroy {
private keyboard;
/**
* A list of shortcuts.
*/
shortcuts: ShortcutInput[] | ShortcutInput;
/**
* @ignore
* list of registered keyboard shortcuts
* used for clean up on NgDestroy.
*/
private clearIds;
/**
* @ignore
*/
private _disabled;
/**
* Disable all shortcuts for this component.
*/
set disabled(value: any);
/**
* @ignore
* @param {NgHotkeysService} keyboard
*/
constructor(keyboard: NgHotkeysService);
/**
* @ignore
*/
ngOnInit(): void;
/**
* Select a key to listen to, will emit when the selected key is pressed.
*/
select(key: string): Observable<ShortcutEventOutput>;
/**
* @ignore
*/
ngAfterViewInit(): void;
/**
* @ignore
*/
ngOnChanges(changes: SimpleChanges): void;
/**
* @ignore
*/
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<NgHotkeysComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<NgHotkeysComponent, "ng-hot-keys", never, { "shortcuts": "shortcuts"; "disabled": "disabled"; }, {}, never, never, false>;
}