@opentui/solid/src/elements/hooks.d.ts

SolidJS renderer for OpenTUI

import { PasteEvent, Selection, Timeline, type CliRenderer, type KeyEvent, type TimelineOptions } from "@opentui/core";
export declare const RendererContext: import("solid-js").Context<CliRenderer | undefined>;
export declare const useRenderer: () => CliRenderer;
export declare const onResize: (callback: (width: number, height: number) => void) => void;
export declare const useTerminalDimensions: () => import("solid-js").Accessor<{
    width: number;
    height: number;
}>;
export interface UseKeyboardOptions {
    /** Include release events - callback receives events with eventType: "release" */
    release?: boolean;
}
/**
 * Subscribe to keyboard events.
 *
 * By default, only receives press events (including key repeats with `repeated: true`).
 * Use `options.release` to also receive release events.
 *
 * @example
 * // Basic press handling (includes repeats)
 * useKeyboard((e) => console.log(e.name, e.repeated ? "(repeat)" : ""))
 *
 * // With release events
 * useKeyboard((e) => {
 *   if (e.eventType === "release") keys.delete(e.name)
 *   else keys.add(e.name)
 * }, { release: true })
 */
export declare const useKeyboard: (callback: (key: KeyEvent) => void, options?: UseKeyboardOptions) => void;
export declare const usePaste: (callback: (event: PasteEvent) => void) => void;
/**
 * @deprecated renamed to useKeyboard
 */
export declare const useKeyHandler: (callback: (key: KeyEvent) => void, options?: UseKeyboardOptions) => void;
export declare const onFocus: (callback: () => void) => void;
export declare const onBlur: (callback: () => void) => void;
export declare const useSelectionHandler: (callback: (selection: Selection) => void) => void;
export declare const useTimeline: (options?: TimelineOptions) => Timeline;