angular-onscreen-material-keyboard/components/keyboard/keyboard.component.d.ts

This package is forked from ngx-material-keyboard with bug fixes and additional features

import { ElementRef, EventEmitter, OnInit } from '@angular/core';
import { AbstractControl } from '@angular/forms';
import { Observable } from 'rxjs';
import { MatKeyboardRef } from '../../classes/keyboard-ref.class';
import { KeyboardClassKey } from '../../enums/keyboard-class-key.enum';
import { IKeyboardIcons, IMatIcon } from '../../interfaces/keyboard-icons.interface';
import { IKeyboardLayout } from '../../interfaces/keyboard-layout.interface';
import { MatKeyboardService } from '../../services/keyboard.service';
/**
 * A component used to open as the default keyboard, matching material spec.
 * This should only be used internally by the keyboard service.
 */
export declare class MatKeyboardComponent implements OnInit {
    private _locale;
    private _keyboardService;
    private _darkTheme;
    private _isDebug;
    private _inputInstance$;
    private _keys;
    private _modifier;
    private _capsLocked;
    private _icons;
    locale?: string;
    layout: IKeyboardLayout;
    control: AbstractControl;
    keyboardRef: MatKeyboardRef<MatKeyboardComponent>;
    cssClass: boolean;
    enterClick: EventEmitter<void>;
    capsClick: EventEmitter<void>;
    altClick: EventEmitter<void>;
    shiftClick: EventEmitter<void>;
    get inputInstance(): Observable<ElementRef | null>;
    set icons(icons: IKeyboardIcons);
    set darkTheme(darkTheme: boolean);
    set isDebug(isDebug: boolean);
    get darkTheme$(): Observable<boolean>;
    get isDebug$(): Observable<boolean>;
    constructor(_locale: string, _keyboardService: MatKeyboardService);
    setInputInstance(inputInstance: ElementRef): void;
    attachControl(control: AbstractControl): void;
    ngOnInit(): void;
    /**
     * dismisses the keyboard
     */
    dismiss(): void;
    /**
     * checks if a given key is currently pressed
     * @param key
     * @param
     */
    isActive(key: (string | KeyboardClassKey)[]): boolean;
    getModifiedKey(key: (string | KeyboardClassKey)[]): string;
    getKeyIcon(key: (string | KeyboardClassKey)[]): IMatIcon;
    /**
     * listens to users keyboard inputs to simulate on virtual keyboard, too
     * @param event
     */
    onKeyDown(event: KeyboardEvent): void;
    /**
     * listens to users keyboard inputs to simulate on virtual keyboard, too
     * @param event
     */
    onKeyUp(event: KeyboardEvent): void;
    /**
     * bubbles event if submit is potentially triggered
     */
    onEnterClick(): void;
    /**
     * simulates clicking `CapsLock` key
     * @param targetState
     */
    onCapsClick(targetState?: boolean): void;
    onKeyClick(): void;
    /**
     * simulates clicking `Alt` key
     */
    onAltClick(): void;
    /**
     * simulates clicking `Shift` key
     */
    onShiftClick(): void;
    private _invertAltModifier;
    private _invertShiftModifier;
}