@studiometa/js-toolkit/services/KeyService.d.ts

A set of useful little bits of JavaScript to boost your project! 🚀

import type { ServiceConfig, ServiceInterface } from './AbstractService.js';
import { AbstractService } from './AbstractService.js';
export interface KeyServiceProps {
    event: KeyboardEvent;
    triggered: number;
    direction: 'up' | 'down' | 'none';
    isUp: boolean;
    isDown: boolean;
    ENTER: boolean;
    SPACE: boolean;
    TAB: boolean;
    ESC: boolean;
    LEFT: boolean;
    UP: boolean;
    RIGHT: boolean;
    DOWN: boolean;
}
export type KeyServiceInterface = ServiceInterface<KeyServiceProps>;
export declare class KeyService extends AbstractService<KeyServiceProps> {
    static config: ServiceConfig;
    previousEvent: Event | null;
    props: KeyServiceProps;
    updateProps(event: KeyboardEvent): KeyServiceProps;
    handleEvent(event: KeyboardEvent): void;
}
/**
 * Use the keyboard service.
 * @link https://js-toolkit.studiometa.dev/api/services/useKey.html
*/
export declare function useKey(): KeyServiceInterface;