import KeyManager from '~/models/KeyManager.js'

public class | source

KeyManager

Centralizes key management. .shared is for document. You can create your own for a specific element.

Priority:

Meta handlers
Generic handlers

Static Member Summary

Static Public Members
public static get	shared

Constructor Summary

Public Constructor
public	constructor(target: HTMLElement) New key manager.

Method Summary

Public Methods
public	addTarget(target: HTMLElement) Adds another target
public	clear() Removes all listeners.
public	createGlobal(): KeyManager Creates a global instance
public	register(key: string, callback: Function): Function Registers an event for a key.
public	registerMeta(key: string, callback: Function): Function Registers an event for a key combo w/ meta e.g, ctrl or command.
public	registerObservable(): Observable Register and returns an observable

Static Public Members

public static get shared source

Public Constructors

public constructor(target: HTMLElement) source

New key manager. Generally you want to use the global KeyManager.shared

Params:

Name	Type	Attribute	Description
target	HTMLElement		Target to watch for

Public Methods

public addTarget(target: HTMLElement) source

Adds another target

Params:

Name	Type	Attribute	Description
target	HTMLElement

public clear() source

Removes all listeners.

public createGlobal(): KeyManager source

Creates a global instance

Return:

KeyManager

public register(key: string, callback: Function): Function source

Registers an event for a key.

Params:

Name	Type	Attribute	Description
key	string		A key matching `event.key` to be watched for
callback	Function		Called when finished

Return:

Function

Call to remove handler

Throw:

Error

Will throw an error if already registered.

public registerMeta(key: string, callback: Function): Function source

Registers an event for a key combo w/ meta e.g, ctrl or command.

Params:

Name	Type	Attribute	Description
key	string		A key matching `event.key` to be watched for
callback	Function		Called when finished

Return:

Function

call to remove handler.

Throw:

Error

Will throw an error if already registered.

public registerObservable(): Observable source

Return:

Observable