lazy-widgets/dist/core/VirtualKeyboardRoot.d.ts

Typescript retained mode GUI for the HTML canvas API

import { VirtualKeyboardTemplate } from './VirtualKeyboardTemplate.js';
import { Root, RootProperties } from './Root.js';
import type { KeyboardDriver } from '../drivers/KeyboardDriver.js';
/**
 * Optional VirtualKeyboardRoot constructor properties.
 *
 * @category Core
 */
export interface VirtualKeyboardRootProperties extends RootProperties {
    /**
     * The keyboard template to use for the {@link VirtualKeyboard} Widget in a
     * {@link VirtualKeyboardRoot}.
     */
    keyboardTemplate?: VirtualKeyboardTemplate;
}
/**
 * A {@link Root} containing a single {@link VirtualKeyboard} widget.
 * Automatically disables itself if not needed, but
 * {@link VirtualKeyboardRoot#updateVisibility} must be called every frame for
 * this behaviour to occur.
 *
 * @category Core
 */
export declare class VirtualKeyboardRoot extends Root {
    /** The {@link KeyboardDriver} used by this root's virtual keyboard. */
    private readonly keyboardDriver;
    constructor(keyboardDriver: KeyboardDriver, properties?: VirtualKeyboardRootProperties);
    /**
     * Update the visibility of this root; if the keyboard driver has no focused
     * root, then the root is disabled, else, it is enabled. Call this method
     * on every frame to automatically enable/disable the root if needed
     */
    updateVisibility(): void;
}