swing-ui 0.1.25 → 1.0.1

package/types/typedefs.d.ts

@@ -0,0 +1,1626 @@
+/**
+ * An error event object received by the {@link UIComponent#onError |onError()} handler callback when error occurs.
+ */
+type ErrorEvent = {
+    /**
+     * - The component that triggered the event.
+     */
+    target: object;
+    /**
+     * - An error message.
+     */
+    messsage: string;
+};
+/**
+ * A dispose event object received by the {@link UIComponent#onDispose |onDispose()} handler callback when a component gets disposed.
+ */
+type DisposeEvent = {
+    /**
+     * - The component that triggered the event.
+     */
+    target: object;
+};
+/**
+ * Drop event received by the {@link UIComponent#onDropEvents |onDropEvents()} handler callback.
+ */
+type DropEvent = {
+    /**
+     * - The component that triggered the event.
+     */
+    target: object;
+    /**
+     * - The component being dragged onto this component.
+     *    Present only for component-to-component dragging, and when `DataType.Components` is allowed for dropping.
+     */
+    source?: object | undefined;
+    /**
+     * - Descendent of the target component over which the event occurred. Only present for event types `dragover` and `drop`, if target is a container and the event occurred over one of target'a descendent.
+     */
+    overComponent?: object | undefined;
+    /**
+     * - One of `dragenter`, `dragover`, `dragleave`, `drop`.
+     */
+    type: string;
+    /**
+     * - One of the values of enum DragDropAction. Present when applicable.
+     */
+    action?: string | undefined;
+    /**
+     * - Contains the data being dragged/dropped. NOTE: On macOS data is actually present only when type is `drop`, otherwise data types are present, but data is set to `null`.
+     */
+    data?: object | undefined;
+    /**
+     * - X position of the pointer relative to this component. Present when type is `dragstart` or `drop`.
+     */
+    x?: number | undefined;
+    /**
+     * - Y position of the pointer relative to this component. Present when type is `dragstart` or `drop`.
+     */
+    y?: number | undefined;
+    /**
+     * - X position of the pointer relative to the screen. Present when type is `dragstart` or `drop`.
+     */
+    screenX?: number | undefined;
+    /**
+     * - Y position of the pointer relative to the screen. Present when type is `dragstart` or `drop`.
+     */
+    screenY?: number | undefined;
+    /**
+     * - Selected indexes of a `List` component whose items are being dragged. Present only when dragging List items.
+     */
+    selected?: number[] | undefined;
+};
+/**
+ * Drag event received by the {@link UIComponent#onDragEvents |onDragEvents()} handler callback.
+ */
+type DragEvent = {
+    /**
+     * - The component that triggered the event.
+     */
+    target: object;
+    /**
+     * - One of `dragstart`, `dragend`, `cancel`.
+     */
+    type: string;
+    /**
+     * - One of the values of enum DragDropAction. Present when applicable.
+     */
+    action?: string | undefined;
+    /**
+     * - X position of the pointer relative to this component. Present when type is `dragstart` or `dragend`.
+     */
+    x?: number | undefined;
+    /**
+     * - Y position of the pointer relative to this component. Present when type is `dragstart` or `dragend`.
+     */
+    y?: number | undefined;
+    /**
+     * - X position of the pointer relative to the screen. Present when type is `dragstart` or `dragend`.
+     */
+    screenX?: number | undefined;
+    /**
+     * - Y position of the pointer relative to the screen. Present when type is `dragstart` or `dragend`.
+     */
+    screenY?: number | undefined;
+    /**
+     * - Indicates a pointing device button involved in dragging. Value of `MouseButton` enum.
+     */
+    button?: number | undefined;
+    /**
+     * - Keyboard modifiers (bitmask or flags). Present when type is `dragstart`.
+     */
+    modifiers?: number | undefined;
+    /**
+     * - Human-readable keyboard modifiers. Present when type is `dragstart`.
+     */
+    modifiersText?: string | undefined;
+    /**
+     * - Indicates if ALT key was pressed. Present when type is `dragstart`.
+     */
+    alt?: boolean | undefined;
+    /**
+     * - Indicates if SHIFT key was pressed. Present when type is `dragstart`.
+     */
+    shift?: boolean | undefined;
+    /**
+     * - Indicates if CTRL key was pressed. Present when type is `dragstart`.
+     */
+    ctrl?: boolean | undefined;
+    /**
+     * - Selected indexes of a `List` component whose items are being dragged. Present only when dragging List items.
+     */
+    selected?: number[] | undefined;
+};
+/**
+ * Change event received by the {@link UIComponent#onChange |onChange()} handler callback.
+ */
+type ChangeEvent = {
+    /**
+     * - The component that triggered the event.
+     */
+    target: object;
+    /**
+     * - One of `change`, `changing`.
+     *  `change` - when value has changed and is no longer being modified by the user.
+     *  `changing` - when the value is still being modified, e.g. while moving a Slider knob.
+     */
+    type: string;
+    /**
+     * - Indicates if the change was made by user interacting with the component. `false` means the change was done programmatically.
+     */
+    interactive?: boolean | undefined;
+    /**
+     * - One of `inserted`, `removed`. Present for some text editing components, indicates the action performed.
+     */
+    action?: string | undefined;
+    /**
+     * - The position at which text was inserted. Present when `action` is present.
+     */
+    position?: number | undefined;
+    /**
+     * - The number of characters inserted or removed. Present when `action` is present.
+     */
+    length?: number | undefined;
+};
+/**
+ * Ancestor event received by the {@link UIComponent#onAncestorEvents |onAncestorEvents()} handler callback.
+ */
+type AncestorEvent = {
+    /**
+     * - The component that triggered the event.
+     */
+    target: object;
+    /**
+     * - One of `add`, `remove`, `move`.
+     */
+    type: string;
+    /**
+     * - The ancestor component related to this event.
+     */
+    ancestor: object;
+};
+/**
+ * Scroll event received by the {@link UIComponent#onScroll |onScroll()} handler callback.
+ */
+type ScrollEvent = {
+    /**
+     * - The component that triggered the event.
+     */
+    target: object;
+    /**
+     * - One of `horizontal`, `vertical`.
+     */
+    type: string;
+    /**
+     * - The new horizontal scroll position.
+     */
+    x: number;
+    /**
+     * - The new vertical scroll position.
+     */
+    y: number;
+    /**
+     * - The maximum horizontal scroll position.
+     */
+    maxX: number;
+    /**
+     * - The maximum vertical scroll position.
+     */
+    maxY: number;
+};
+/**
+ * Caret event received by the {@link UIComponent#onCaretEvents |onCaretEvents()} handler callback.
+ */
+type CaretEvent = {
+    /**
+     * - The component that triggered the event.
+     */
+    target: object;
+    /**
+     * - Always `change`.
+     */
+    type: string;
+    /**
+     * - The new caret position.
+     */
+    position: number;
+    /**
+     * - Start position of selected text.
+     */
+    selectionStart: number;
+    /**
+     * - End position of selected text.
+     */
+    selectionEnd: number;
+    /**
+     * - Line number where the caret is located. Present in components like `DocumentEditor`.
+     */
+    line?: number | undefined;
+    /**
+     * - Column number (offset from line start) of the caret. Present in multi-line components like `DocumentEditor`.
+     */
+    column?: number | undefined;
+    /**
+     * - Text formatting information at the caret’s position. Present only for `DocumentEditor` when HTML is enabled.
+     */
+    styles?: object | undefined;
+    /**
+     * - HTML tag hierarchy at the caret’s position. Present only for `DocumentEditor` when HTML is enabled.
+     */
+    path?: string[] | undefined;
+};
+/**
+ * Action event received by the {@link UIComponent#onAction |onAction()} handler callback.
+ */
+type ActionEvent = {
+    /**
+     * - The component that triggered the event.
+     */
+    target: object;
+    /**
+     * - The command string, usually the button text or a custom value set with `.command("")`.
+     */
+    command: string;
+    /**
+     * - Keyboard modifiers (bitmask or flags).
+     */
+    modifiers?: number | undefined;
+    /**
+     * - Indicates if ALT key was pressed.
+     */
+    alt?: boolean | undefined;
+    /**
+     * - Indicates if SHIFT key was pressed.
+     */
+    shift?: boolean | undefined;
+    /**
+     * - Indicates if CTRL key was pressed.
+     */
+    ctrl?: boolean | undefined;
+    /**
+     * - One of `action` or `index_change`. Present when applicable.
+     */
+    type: string;
+    /**
+     * - Mouse X position relative to the component.
+     */
+    x?: number | undefined;
+    /**
+     * - Mouse Y position relative to the component.
+     */
+    y?: number | undefined;
+    /**
+     * - Mouse X position relative to the screen.
+     */
+    screenX?: number | undefined;
+    /**
+     * - Mouse Y position relative to the screen.
+     */
+    screenY?: number | undefined;
+    /**
+     * - Indicates if the action was triggered by user interaction (not programmatically).
+     */
+    interactive?: boolean | undefined;
+    /**
+     * - Indicates selection state when applicable.
+     */
+    selected?: boolean | undefined;
+};
+/**
+ * Mouse event received by the {@link UIComponent#onMouseEvents |onMouseEvents()} handler callback.
+ */
+type MouseEvent = {
+    /**
+     * - The component that triggered the event.
+     */
+    target: object;
+    /**
+     * - One of `click`, `down`, `up`, `enter`, `leave`.
+     */
+    type: string;
+    /**
+     * - Button number. One of {@link MouseButton} enum values. Present when type is `click`, `down`, or `up`.
+     */
+    button?: number | undefined;
+    /**
+     * - Number of times the button was clicked. Present only when applicable, such as when type is `click`.
+     */
+    clicks?: number | undefined;
+    /**
+     * - Keyboard modifiers (bitmask or flags).
+     */
+    modifiers?: number | undefined;
+    /**
+     * - Indicates if ALT key was pressed.
+     */
+    alt?: boolean | undefined;
+    /**
+     * - Indicates if SHIFT key was pressed.
+     */
+    shift?: boolean | undefined;
+    /**
+     * - Indicates if CTRL key was pressed.
+     */
+    ctrl?: boolean | undefined;
+    /**
+     * - Mouse X position relative to the component. Present when applicable.
+     */
+    x?: number | undefined;
+    /**
+     * - Mouse Y position relative to the component. Present when applicable.
+     */
+    y?: number | undefined;
+    /**
+     * - Mouse X position relative to the primary screen. Present when applicable.
+     */
+    screenX?: number | undefined;
+    /**
+     * - Mouse Y position relative to the primary screen. Present when applicable.
+     */
+    screenY?: number | undefined;
+};
+/**
+ * Mouse motion event received by the {@link UIComponent#onMouseMotion |onMouseMotion()} handler callback.
+ */
+type MouseMotionEvent = {
+    /**
+     * - The component that triggered the event.
+     */
+    target: object;
+    /**
+     * - One of `move`, `drag`.
+     */
+    type: string;
+    /**
+     * - Button number. One of `MouseButton` enum values. Present when applicable.
+     */
+    button?: number | undefined;
+    /**
+     * - Keyboard modifiers (bitmask or flags).
+     */
+    modifiers?: number | undefined;
+    /**
+     * - Mouse X position relative to the component.
+     */
+    x: number;
+    /**
+     * - Mouse Y position relative to the component.
+     */
+    y: number;
+    /**
+     * - Mouse X position relative to the screen.
+     */
+    screenX: number;
+    /**
+     * - Mouse Y position relative to the screen.
+     */
+    screenY: number;
+};
+/**
+ * Mouse wheel event received by the {@link UIComponent#onMouseWheel |onMouseWheel()} or {@link SwingUI#onMouseWheel |ui.onMouseWheel()} handler callback.
+ */
+type MouseWheelEvent = {
+    /**
+     * - The component that triggered the event.
+     */
+    target: object;
+    /**
+     * - One of: `pixels`, `line`, or `pages`.
+     */
+    type: string;
+    /**
+     * - Amount of units scrolled in horizontal direction.
+     */
+    deltaX: number;
+    /**
+     * - Amount of units scrolled in vertical direction.
+     */
+    deltaY: number;
+    /**
+     * - Tells how many `pixels`, `line`, or `pages` to scroll, depending on teh `type`.
+     */
+    scrollAmount: number;
+    /**
+     * - Number of wheel "clicks" rotated. Can be zero until a full click is accumulated on high-resolution wheels.
+     */
+    rotation: number;
+    /**
+     * - Mouse X position relative to the screen.
+     */
+    screenX: number;
+    /**
+     * - Mouse Y position relative to the screen.
+     */
+    screenY: number;
+    /**
+     * - Mouse X position relative to the component. (not present for global event)
+     */
+    x?: number | undefined;
+    /**
+     * - Mouse Y position relative to the component. (not present for global event)
+     */
+    y?: number | undefined;
+    /**
+     * - Button number. One of `MouseButton` enum values. Present when applicable.
+     */
+    button?: number | undefined;
+    /**
+     * - Keyboard modifiers (bitmask or flags).
+     */
+    modifiers?: number | undefined;
+    /**
+     * - Indicates if ALT key was pressed.
+     */
+    alt?: boolean | undefined;
+    /**
+     * - Indicates if SHIFT key was pressed.
+     */
+    shift?: boolean | undefined;
+    /**
+     * - Indicates if CTRL key was pressed.
+     */
+    ctrl?: boolean | undefined;
+};
+/**
+ * Key event received by the {@link UIComponent#onKey |onKey()} handler callback.
+ */
+type KeyEvent = {
+    /**
+     * - The component that triggered the event.
+     */
+    target: object;
+    /**
+     * - One of `up`, `down`, `type`.
+     */
+    type: string;
+    /**
+     * - Numeric code associated with the key.
+     */
+    keyCode: number;
+    /**
+     * - Unique id assigned to a key depending on the current keyboard layout. Not present for global ui.onKey() events.
+     */
+    extendedKeyCode?: number | undefined;
+    /**
+     * - The character produced by the key. Present only for `type` events.
+     */
+    keyChar?: string | undefined;
+    /**
+     * - Keyboard modifiers (bitmask or flags).
+     */
+    modifiers?: number | undefined;
+    /**
+     * - Human-readable representation of modifiers.
+     */
+    modifiersText?: string | undefined;
+    /**
+     * - Indicates if ALT key was pressed.
+     */
+    alt?: boolean | undefined;
+    /**
+     * - Indicates if SHIFT key was pressed.
+     */
+    shift?: boolean | undefined;
+    /**
+     * - Indicates if CTRL key was pressed.
+     */
+    ctrl?: boolean | undefined;
+    /**
+     * - Indicates if META (Windows or Command) key was pressed.
+     */
+    meta?: boolean | undefined;
+    /**
+     * - One of `standard`, `numpad`, `left`, `right`. Present for `up` and `down` events.
+     */
+    keyLocation?: string | undefined;
+};
+/**
+ * Focus event received by the {@link UIComponent#onFocusEvents |onFocusEvents()} handler callback.
+ */
+type FocusEvent = {
+    /**
+     * - The component that triggered the event.
+     */
+    target: object;
+    /**
+     * - One of `focus`, `blur`.
+     */
+    type: string;
+    /**
+     * - One of `Unknown`, `Activation`, `TraversalForward`, `TraversalBackward`.
+     */
+    cause: string;
+    /**
+     * - Indicates if the focus change is temporary (lost and is expected to return, or gained after being lost tempararily).
+     */
+    temporary: boolean;
+    /**
+     * - Indicates if the focus was changed by user interaction. If `false`, then it was changed programmatically.
+     */
+    interactive: boolean;
+};
+/**
+ * Component event received by the {@link UIComponent#onComponentEvents |onComponentEvents()} handler callback.
+ */
+type ComponentEvent = {
+    /**
+     * - The component that triggered the event.
+     */
+    target: object;
+    /**
+     * - One of `resize`, `move`, `show`, `hide`.
+     */
+    type: string;
+    /**
+     * - Indicates if the event was triggered by user interaction (not programmatically). Present for `move` and `resize` for component like Window, InternalWindow.
+     */
+    interactive?: boolean | undefined;
+    /**
+     * - New X position of the component.
+     */
+    x?: number | undefined;
+    /**
+     * - New Y position of the component.
+     */
+    y?: number | undefined;
+    /**
+     * - New width of the component. Present when type is `resize`.
+     */
+    width?: number | undefined;
+    /**
+     * - New height of the component. Present when type is `resize`.
+     */
+    height?: number | undefined;
+    /**
+     * - New width of the content area. Present for `resize` when component is `Window` or `InternalWindow`.
+     */
+    innerWidth?: number | undefined;
+    /**
+     * - New height of the content area. Present for `resize` when component is `Window` or `InternalWindow`.
+     */
+    innerHeight?: number | undefined;
+};
+/**
+ * Container event received by the {@link UIComponent#onContainerEvents |onContainerEvents()} handler callback.
+ */
+type ContainerEvent = {
+    /**
+     * - The container component that triggered the event.
+     */
+    target: object;
+    /**
+     * - One of `add`, `remove`.
+     */
+    type: string;
+    /**
+     * - The child component that was added or removed.
+     */
+    child: object;
+};
+/**
+ * Property change event received by the {@link UIComponent#onPropertyChange |onPropertyChange()} handler callback.
+ */
+type PropertyChangeEvent = {
+    /**
+     * - The component that triggered the event.
+     */
+    target: object;
+    /**
+     * - Always `change`.
+     */
+    type: string;
+    /**
+     * - The property that was changed.
+     */
+    property: string;
+    /**
+     * - Previous value of the changed property.
+     */
+    oldValue: any;
+    /**
+     * - New value of the changed property.
+     */
+    newValue: any;
+};
+/**
+ * Popup list event received by the onPopupEvents() handler callback in ComboBox, Menu and ContextMenu components.
+ */
+type PopupEvent = {
+    /**
+     * - The component that triggered the event.
+     */
+    target: object;
+    /**
+     * - One of `show`, `hide`, `cancel`.
+     */
+    type: string;
+    /**
+     * - Component's X position relative to invoker. For `Menu` component it's only present when invoker is not `null`.
+     */
+    x?: number | undefined;
+    /**
+     * - Component's Y position relative to invoker. For `Menu` component it's only present when invoker is not `null`.
+     */
+    y?: number | undefined;
+    /**
+     * - Indicates if the popup was triggered by user's interaction (not programmatically).
+     */
+    interactive: boolean;
+    /**
+     * - X position of a `Menu` component relative to default screen.
+     */
+    screenX?: number | undefined;
+    /**
+     * - Y position of a `Menu` component relative to default screen.
+     */
+    screenY?: number | undefined;
+    /**
+     * - UI Component that invoked the popup, or `null` if it was invoked programmatically.
+     */
+    invoker?: object | undefined;
+};
+/**
+ * Event object passed to hyperlink event handlers in {@link DocumentEditor#onLinkEvents}.
+ */
+type LinkEvent = {
+    /**
+     * - The component that triggered the event.
+     */
+    target: DocumentEditor;
+    /**
+     * - The event type: `click`, `mouseenter`, or `mouseleave`.
+     */
+    type: string;
+    /**
+     * - The `href` attribute of the `<a>` tag.
+     */
+    url: string;
+    /**
+     * - The text content of the hyperlink.
+     */
+    text: string;
+    /**
+     * - Whether the Shift key was pressed.
+     */
+    shift: boolean;
+    /**
+     * - Whether the Ctrl key was pressed.
+     */
+    ctrl: boolean;
+    /**
+     * - Whether the Alt key was pressed.
+     */
+    alt: boolean;
+    /**
+     * - Keyboard modifiers mask.
+     */
+    modifiers: string;
+    /**
+     * - String representation of the keyboard modifiers.
+     */
+    modifiersText: string;
+};
+/**
+ * Event object passed to MediaPlayer event handlers.
+ */
+type PlayerEvent = {
+    /**
+     * - Type of the event: `loadstart`, `loadedmetadata`, `seeking`, `timeupdate`, `play`, `stop`, `subtitle`.
+     */
+    type: string;
+    /**
+     * - Type of media loaded in the player: `File`, `InputDevice`, `URL`.
+     */
+    mediaType?: string | undefined;
+    /**
+     * - A {@link Media} object containing details about the loaded media.
+     */
+    media?: Media | undefined;
+    /**
+     * - Current playback time in seconds.
+     */
+    currentTime?: number | undefined;
+    /**
+     * - Total duration of the media in seconds. Present when `type` is `timeupdate`.
+     */
+    duration?: number | undefined;
+    /**
+     * - Reason for stopping playback: `Pause`, `EndOfMediaFile`.
+     */
+    reason?: string | undefined;
+    /**
+     * - Index of a subtitle since the player started playing (not from the beginning of the video}. (Only present when event type is `subtitle`).
+     */
+    index?: number | undefined;
+    /**
+     * - Time when to show the subtitle relative to the position when the video started (not to the beginning of the video). (Only present when event type is `subtitle`).
+     */
+    fromTime?: string | undefined;
+    /**
+     * - Time when to show the subtitle relative to the position when the video started (not to the beginning of the video). (Only present when event type is `subtitle`).
+     */
+    toTime?: string | undefined;
+    /**
+     * - Subtitle text. (Only present when event type is `subtitle`).
+     */
+    text?: string | undefined;
+};
+/**
+ * Represents an event related to a Window and InternalWindow component. Used for handling window state changes
+ * such as activation, minimization, maximization, hiding, showing, and closing.
+ */
+type WindowEvent = {
+    /**
+     * - The window component that triggered the event.
+     */
+    target: Window | InternalWindow;
+    /**
+     * - The event type. One of: `activate`, `deactivate`, `minimize`, `restore`, `closing`, `close`, `show`.
+     */
+    type: string;
+    /**
+     * - Indicates if the event was triggered by the user's interaction with the window.
+     */
+    interactive: boolean;
+};
+/**
+ * Represents a window state change event. Used when a window changes its state
+ * such as minimized, maximized, or restored.
+ */
+type WindowStateEvent = {
+    /**
+     * - The window component that triggered the event.
+     */
+    target: Window;
+    /**
+     * - The event type. Always `change` for state changes.
+     */
+    type: string;
+    /**
+     * - The new state of the window.
+     */
+    state: Window.State;
+    /**
+     * - The previous state of the window.
+     */
+    new_state: Window.State;
+    /**
+     * - Indicates if the state change was triggered by the user's interaction with the window.
+     */
+    interactive: boolean;
+};
+/**
+ * Represents an application event used in `{@link SwingUI#onAppEvents |ui.onAppEvents(callback)}`.
+ */
+type AppEvent = {
+    /**
+     * - One of event types: `about`, `foreground`, `background`, `searchTerm`, `files`, `print`, `uri`, `preferences`, `quit`, `screenSleep`, `screenAwake`, `systemSleep`, `systemAwake`
+     */
+    type: string;
+    /**
+     * - File list. Present when type is `files` or `print`.
+     */
+    files?: string[] | undefined;
+    /**
+     * - Present when type is `files`.
+     */
+    searchTerm?: string | undefined;
+};
+/**
+ * Represents a table row event triggered by a `{@link Table}` component `{@link Table#onRowEvents}` events.
+ */
+type RowEvent = {
+    /**
+     * - The Table component that triggered the event.
+     */
+    target: Table;
+    /**
+     * - Type of the row event: `insert`, `remove`, `update`.
+     */
+    type: string;
+    /**
+     * - Index of the affected row. Present when a single row is affected.
+     */
+    row?: number | undefined;
+    /**
+     * - Column index of the affected cell. Only present when type is `update`.
+     * A value of `-1` means all columns in the row were affected.
+     */
+    column?: number | undefined;
+    /**
+     * - Start index of affected row range. Present when multiple rows are affected.
+     */
+    fromRow?: number | undefined;
+    /**
+     * - End index of affected row range. Present when multiple rows are affected.
+     */
+    toRow?: number | undefined;
+    /**
+     * - Only present when type is `update`.
+     * `true` if the update was triggered by user interaction, `false` if done programmatically.
+     */
+    interactive?: boolean | undefined;
+};
+/**
+ * Represents a table column event triggered by a `{@link Table}` component.
+ */
+type ColumnEvent = {
+    /**
+     * - The Table component that triggered the event.
+     */
+    target: Table;
+    /**
+     * - Type of the column event: `insert`, `remove`, `move`, `resize`;
+     */
+    type: string;
+    /**
+     * - Column index. Present when type is `insert`, `remove`, or `resize`.
+     */
+    index?: number | undefined;
+    /**
+     * - Previous column index. Present when type is `move`.
+     */
+    fromIndex?: number | undefined;
+    /**
+     * - New column index. Present when type is `move`.
+     */
+    toIndex?: number | undefined;
+    /**
+     * - Previous column size. Present when type is `resize`.
+     */
+    fromSize?: number | undefined;
+    /**
+     * - New column size. Present when type is `resize`.
+     */
+    toSize?: number | undefined;
+    /**
+     * - Present for `move` events. `true` if triggered by user interaction, `false` if done programmatically.
+     */
+    interactive?: boolean | undefined;
+};
+/**
+ * Represents a table sort event triggered by a `{@link Table}` component.
+ */
+type SortEvent = {
+    /**
+     * - The Table component that triggered the event.
+     */
+    target: Table;
+    /**
+     * - Sort order state: `Table.SortOrder.None`, `Table.SortOrder.Ascending`, or `Table.SortOrder.Descending`.
+     */
+    type: Table.SortOrder;
+    /**
+     * - Column index. Present when type is not `Table.SortOrder.None`.
+     */
+    column?: number | undefined;
+    /**
+     * - New column index after reordering. Present when type is not `Table.SortOrder.None`.
+     */
+    newOrderColumn?: number | undefined;
+    /**
+     * - `true` if triggered by user interaction, `false` if triggered programmatically.
+     */
+    interactive: boolean;
+};
+/**
+ * Represents an event triggered by a performing a keyboard shortcut (one key or a key combination) on a component.
+ */
+type ShortcutEvent = {
+    /**
+     * - The component that triggered the event.
+     */
+    target: UIComponent;
+    /**
+     * - One of values from {@link ShortcutScope} enum.
+     */
+    scope: ShortcutScope;
+    /**
+     * - User provided action string, or the key exactly as user specifed it (not normalized).
+     */
+    action: string;
+    /**
+     * - The keyboard key or a key combination that triggered the shortcut (normalized, might be not exactly same as user specified).
+     */
+    key: string;
+};
+/**
+ * Shape event received by the {@link Panel#onShapeEvents |onShapeEvents()} and {@link Window#onShapeEvents |Window.onShapeEvents()} handler callback.
+ */
+type ShapeEvent = {
+    /**
+     * - The Panel component that triggered the event.
+     */
+    target: object;
+    /**
+     * - One of `add`, `remove`, `click`, `mousedown`, `mouseup`, `mouseenter`, `mouseleave`.
+     */
+    type: string;
+    /**
+     * - X position of the pointer relative to the target component.
+     */
+    x?: number | undefined;
+    /**
+     * - Y position of the pointer relative to the target component.
+     */
+    y?: number | undefined;
+    /**
+     * - Index of the shape that triggered the event.
+     */
+    shapeIndex: number;
+    /**
+     * - `true` if mouse is down while moving, otherwise `false`.
+     */
+    dragging?: boolean | undefined;
+    /**
+     * - `true` if Alt key was pressed on keyboard when event was emitted.
+     */
+    alt?: boolean | undefined;
+    /**
+     * - `true` if Shift key was pressed on keyboard when event was emitted.
+     */
+    shift?: boolean | undefined;
+    /**
+     * - `true` if Control key was pressed on keyboard when event was emitted.
+     */
+    ctrl?: boolean | undefined;
+    /**
+     * - Modifiers used when the event was emitted.
+     */
+    modifiers?: string | undefined;
+    /**
+     * - Description of used modifiers.
+     */
+    modifiersText?: string | undefined;
+};
+/**
+ * List item object used in {@link ComboBox}, {@link List}, and {@link Tree} components.
+ */
+type ListItem = {
+    /**
+     * - Item text. (Required for a new list item).
+     */
+    text?: string | undefined;
+    /**
+     * - Value that can be used by software logic to identify this item.
+     */
+    id?: string | number | undefined;
+    /**
+     * - Additional value to be stored in the item for later use.
+     */
+    value?: string | number | undefined;
+    /**
+     * - Absolute/relative path to icon image, base64 encoded image string, or `null` to remove icon.
+     */
+    icon?: string | null | undefined;
+    /**
+     * - Item text color as a 6-character hex string (e.g. `#665500`).
+     */
+    color?: string | undefined;
+    /**
+     * - Item background color as a 6-character hex string (e.g. `#665500`).
+     */
+    background?: string | undefined;
+    /**
+     * - Tooltip text shown when hovering the item (only in List and Tree components).
+     */
+    tooltip?: string | undefined;
+    /**
+     * - {@link Font} formatted object.
+     */
+    font?: Font | undefined;
+    /**
+     * - In some cases items are returned with `index` property to indicate their position within component.
+     */
+    index?: number | undefined;
+    /**
+     * - For Tree component nodes only! An array of child nodes.
+     */
+    children?: ListItem[] | undefined;
+};
+/**
+ * Font object used in most UI components, {@link ListItem}, {@link TableColumn}, {@link Text} shape and other text-rendering components.
+ */
+type Font = {
+    /**
+     * - Font family name (e.g., `"sans-serif"`).
+     */
+    name?: string | FontFamily;
+    /**
+     * - Font size in pixels.
+     */
+    size?: number | undefined;
+    /**
+     * - Whether the text is bold.
+     */
+    bold?: boolean | undefined;
+    /**
+     * - Whether the text is italic.
+     */
+    italic?: boolean | undefined;
+    /**
+     * - Whether the text is underlined.
+     */
+    underlined?: boolean | undefined;
+    /**
+     * - Whether the text has a strikethrough.
+     */
+    strikethrough?: boolean | undefined;
+    /**
+     * - Text direction: `"ltr"` or `"rtl"`.
+     */
+    direction?: string | undefined;
+    /**
+     * - Enable or disable kerning.
+     */
+    kerning?: boolean | undefined;
+    /**
+     * - Enable or disable font ligatures.
+     */
+    ligatures?: boolean | undefined;
+    /**
+     * - Letter spacing adjustment: -1, 0 (default), or 1.
+     */
+    tracking?: number | undefined;
+};
+/**
+ * Border object used to define the visual border of UI components like Panel, Label, Button, TextField, TextArea and more.
+ */
+type Border = {
+    /**
+     * - (Required) The border style.
+     */
+    style: BorderStyle;
+    /**
+     * - Border size in pixels. Must be >= 1.
+     */
+    size?: number | undefined;
+    /**
+     * - Inner padding as a space-separated string of four integer values: `"top right bottom left"`. Example: `"5 10 5 10"`. Can be set even when `style` is `"none"`.
+     */
+    padding?: string | undefined;
+    /**
+     * - Border color. Only applicable for `"line"` or `"dashed"` styles.
+     */
+    color?: string | undefined;
+    /**
+     * - If `true`, renders rounded corners for `"line"` style, or rounded dashes for `"dashed"` style. Only applicable for `"line"` or `"dashed"` styles.
+     */
+    rounded?: boolean | undefined;
+    /**
+     * - Length of each dash. Only applicable for `"dashed"` style.
+     */
+    length?: number | undefined;
+    /**
+     * - Length of the gaps between dashes. Only applicable for `"dashed"` style.
+     */
+    spacing?: number | undefined;
+    /**
+     * - Starting offset of the dash pattern. Can be used to animate dashes. Only applicable for `"dashed"` style.
+     */
+    offset?: number | undefined;
+    /**
+     * - Label text displayed at the top-left of the border, creating a titled border effect.
+     */
+    text?: string | undefined;
+    /**
+     * - Placement of the border label text. Accepts a combination of: `"left"`, `"center"`, `"right"`, `"leading"`, `"trailing"`, `"top"`, `"bottom"`, `"above"`, `"below"`. `"above"` and `"below"` refer to placement relative to the border line itself. Defaults to `"top left"`.
+     */
+    alignment?: string | undefined;
+    /**
+     * - Font used to render the border label text.
+     */
+    font?: Font | undefined;
+};
+/**
+ * Table column configuration object used in {@link Table} components.
+ */
+type TableColumn = {
+    /**
+     * - The text to be displayed in the column header. (Required when creating a new column)
+     */
+    text?: string | undefined;
+    /**
+     * - Type of component to display/edit cell data. Possible values:
+     * - `text` - Plain text or HTML.
+     * - `password` - Masked password text field.
+     * - `textarea` - Multi-line text field.
+     * - `icon` - Displays an image loaded from the cell's value as a URL or path. Use table.onAction(callback) for click events.
+     * - `button` - A string of button names separated by `"|"`. Use table.onAction(callback) for click events.
+     * - `checkbox` - Boolean check mark selection component.
+     * - `combobox` - Drop-down list of values, can be editable.
+     * - `progress` - Progress bar showing integer value 0–100.
+     */
+    type?: string | undefined;
+    /**
+     * - Initial desired width of the column.
+     */
+    width?: number | undefined;
+    /**
+     * - Minimum width column can be resized to.
+     */
+    minWidth?: number | undefined;
+    /**
+     * - Maximum width column can be resized to.
+     */
+    maxWidth?: number | undefined;
+    /**
+     * - Whether text fields are editable.
+     */
+    editable?: boolean | undefined;
+    /**
+     * - Number of clicks required to enter edit mode. Takes effect only when `editable` is `true`.
+     */
+    clicksToEdit?: number | undefined;
+    /**
+     * - Indicates if the column can be resized by the user.
+     */
+    resizable?: boolean | undefined;
+    /**
+     * - Indicates if column auto-resizes with table (Has no effect if the table's auto-resize mode is Table.AutoResize.None).
+     */
+    autoResize?: boolean | undefined;
+    /**
+     * - Whether the column is hidden by collapsing its width to 0.
+     */
+    hidden?: boolean | undefined;
+    /**
+     * - Indicates a column with primary data, such as a URL or file path, used as the data source for list generation or drag-and-drop operations.
+     */
+    primary?: boolean | undefined;
+    /**
+     * - Sorting mode. `Table.Sorting.None` disables sorting.
+     */
+    sorting?: Table.Sorting;
+    /**
+     * - List of values to choose from in a ComboBox component when type is `combobox`.
+     */
+    options?: string[] | undefined;
+    /**
+     * - The character used to mask input for the `password` type.
+     */
+    character?: string | undefined;
+    /**
+     * - Icon shown in the column header. Value can be a local file path, URI, or base64 encoded image string.
+     */
+    icon?: string | undefined;
+    /**
+     * - For `"icon"` type, fixed width/height of the icon (largest dimension).
+     */
+    iconSize?: number | undefined;
+    /**
+     * - For `"icon"` type, number of images cached in RAM.
+     */
+    cacheCapacity?: number | undefined;
+    /**
+     * - Tooltip for the column header.
+     */
+    tooltip?: string | undefined;
+    /**
+     * - Text color of cells of the column.
+     */
+    color?: string | null | undefined;
+    /**
+     * - Background color of cells of the column.
+     */
+    background?: string | null | undefined;
+    /**
+     * - Text color of a column header.
+     */
+    headerColor?: string | null | undefined;
+    /**
+     * - Background color of a column header.
+     */
+    headerBackground?: string | null | undefined;
+    /**
+     * - Font of cells of a column.
+     */
+    font?: Font | null | undefined;
+    /**
+     * - Font of a column header.
+     */
+    headerFont?: Font | null | undefined;
+    /**
+     * - Minimum value for progress bar component when type is `progress`.
+     */
+    min?: number | undefined;
+    /**
+     * - Maximum value for progress bar component when type is `progress`.
+     */
+    max?: number | undefined;
+    /**
+     * - Whether to display the value as text inside the progress bar component when type is `progress`.
+     */
+    showText?: boolean | undefined;
+    /**
+     * - Text alignment in cells of the column. Maximum one horizontal and one vertical alignment keywords: 'center','left','right','leading','trailing','top','bottom'.
+     */
+    align?: string | undefined;
+    /**
+     * - Text alignment of a column header. Maximum one horizontal and one vertical alignment keywords: 'center','left','right','leading','trailing','top','bottom'.
+     */
+    headerAlign?: string | undefined;
+};
+/**
+ * Table cell coordinates containing column and row property.
+ */
+type Cell = {
+    /**
+     * - a column index of the cell
+     */
+    column: number;
+    /**
+     * - a row index of the cell
+     */
+    row: number;
+};
+/**
+ * Describes metadata and streams of the media.
+ */
+type Media = {
+    /**
+     * - Duration of the media in seconds. Not present for live streams.
+     */
+    duration?: number | undefined;
+    /**
+     * - Array of video streams available in the media.
+     */
+    videoStreams: VideoStream[];
+    /**
+     * - Array of audio streams available in the media.
+     */
+    audioStreams: AudioStream[];
+    /**
+     * - Array of subtitle streams available in the media.
+     */
+    subtitleStreams: SubtitleStream[];
+};
+/**
+ * Describes a video stream in the media.
+ */
+type VideoStream = {
+    /**
+     * - Original width of the video frame in pixels.
+     */
+    sampleWidth: number;
+    /**
+     * - Original height of the video frame in pixels.
+     */
+    sampleHeight: number;
+    /**
+     * - Display width of the video.
+     */
+    width: number;
+    /**
+     * - Display height of the video.
+     */
+    height: number;
+    /**
+     * - Pixel aspect ratio (e.g., `"1:1"`).
+     */
+    pixelAspectRatio: string;
+    /**
+     * - Display aspect ratio (e.g., `"16:9"`).
+     */
+    displayAspectRatio: string;
+    /**
+     * - Frame rate of the video stream.
+     */
+    frameRate: number;
+    /**
+     * - Codec used to encode the video stream (e.g., `"h264"`).
+     */
+    codec: string;
+    /**
+     * - Pixel format of the video stream (e.g., `"yuv420p"`).
+     */
+    pixelFormat: string;
+    /**
+     * - Whether the video stream is progressive or interlaced.
+     */
+    progressive: boolean;
+    /**
+     * - Indicates if this is the default video stream.
+     */
+    default: boolean;
+};
+/**
+ * Describes an audio stream in the media.
+ */
+type AudioStream = {
+    /**
+     * - Sample rate of the audio stream in Hz.
+     */
+    sampleRate: number;
+    /**
+     * - Number of audio channels (1 - mono, 2 - stereo, etc.)
+     */
+    channels: number;
+    /**
+     * - Bit depth of the audio samples.
+     */
+    bitDepth: number;
+    /**
+     * - Codec used to encode the audio stream (e.g., `"aac"`).
+     */
+    codec: string;
+    /**
+     * - Indicates if this is the default audio stream.
+     */
+    default: boolean;
+};
+/**
+ * Describes a subtitle stream in the media.
+ */
+type SubtitleStream = {
+    /**
+     * - Language of the subtitle stream (e.g., `"en"`).
+     */
+    language: string;
+    /**
+     * - Codec used for the subtitle stream (e.g., `"srt"`).
+     */
+    codec: string;
+    /**
+     * - Indicates if this is the default subtitle stream.
+     */
+    default: boolean;
+};
+/**
+ * Represents a video input device, such as WebCam, video capture device, etc. Used when getting input devices with {@link MediaPlayer#videoInputDevices |videoInputDevices} getter and when setting input device with {@link MediaPlayer#setInputDevice |setInputDevice()} method.
+ */
+type VideoDevice = {
+    /**
+     * - Name of the video input device (only present when retrieving a list of video input devices).
+     */
+    name?: string | undefined;
+    /**
+     * - ID of the video input device.
+     */
+    id: string;
+    /**
+     * - List of available video formats (only present when retrieving a list of video input devices).
+     */
+    formats?: VideoFormat[] | undefined;
+    /**
+     * - Chosen video format to use (required when setting a video input device).
+     */
+    format?: VideoFormat | undefined;
+};
+/**
+ * Represents a video format for a VideoDevice. When using this VideoFormat for video input device, make sure that either "pixel_format" or "vcodec" is specified as it was set when you retrieved the supported formats.
+ */
+type VideoFormat = {
+    /**
+     * - Video frame size in pixels (e.g., "1920x1080").
+     */
+    size: string;
+    /**
+     * - Minimum available frame rate (e.g., 7.5). (provided when retrieving video input devices)
+     */
+    min_fps?: number | undefined;
+    /**
+     * - Maximum available frame rate (e.g., 30). (provided when retrieving video input devices)
+     */
+    max_fps?: number | undefined;
+    /**
+     * - Frame rate in frames per second (required when setting a video input device).
+     */
+    fps?: number | undefined;
+    /**
+     * - Frame image pixel format coming out of the device (e.g., "yuyv422"). If this is present, then `vcodec` is absent.
+     */
+    pixel_format?: string | undefined;
+    /**
+     * - Encoded video format that the video device supports (e.g., "mjpeg", "h264"). If this is present, then `pixel_format` is absent.
+     */
+    vcodec?: string | undefined;
+};
+/**
+ * Represents an audio input or output device, such as a microphone, audio card, etc.
+ */
+type AudioDevice = {
+    /**
+     * - Name of the audio device (required when setting an audio input device).
+     */
+    name: string;
+    /**
+     * - ID of the audio device.
+     */
+    id?: string | undefined;
+    /**
+     * - List of available audio formats provided when retrieving a list of installed audio devices.
+     */
+    formats?: AudioFormat[] | undefined;
+    /**
+     * - Specifies the chosen audio format to use (only when setting audio input device).
+     */
+    format?: AudioFormat | undefined;
+};
+/**
+ * Represents an audio format for an audio device.
+ */
+type AudioFormat = {
+    /**
+     * - Number of audio channels. (1-Mono, 2-Stereo, etc.)
+     */
+    channels: number;
+    /**
+     * - Bits per audio sample.
+     */
+    bits: number;
+    /**
+     * - Sample rate in Hz (only available for audio input devices).
+     */
+    rate?: number | undefined;
+    /**
+     * - Audio encoding (e.g., "PCM_UNSIGNED", "PCM_SIGNED"); (only available for audio output device formats).
+     */
+    encoding?: string | undefined;
+};
+/**
+ * Represents a point in 2D space with X and Y coordinates. Used when setting or getting position of UI component, Shape position, or Shape's anchor.
+ */
+type Point = {
+    /**
+     * - The x-coordinate.
+     */
+    x: number;
+    /**
+     * - The y-coordinate.
+     */
+    y: number;
+};
+/**
+ * Represents the size of a 2D object. Used when setting or getting the size of UI component, Shape size, and more.
+ */
+type Size = {
+    /**
+     * - The width dimension.
+     */
+    width: number;
+    /**
+     * - The height dimension.
+     */
+    height: number;
+};
+/**
+ * Options object for configuring file or directory selection dialogs. Used in {@link Window#chooseFile}.
+ */
+type FileChooserOptions = {
+    /**
+     * - `true` to select directories, `false` to select files.
+     */
+    directory: boolean;
+    /**
+     * - `true` to display a Save dialog, `false` for an Open dialog.
+     */
+    save: boolean;
+    /**
+     * - `true` to allow selection of multiple files or folders.
+     */
+    multiple: boolean;
+    /**
+     * - `true` to display hidden files.
+     */
+    hidden: boolean;
+    /**
+     * - File type filter string (e.g. `"Documents:doc,docx,txt,rtf|Music:mp3,m4a,ogg,wma|Images:gif,jpg,jpeg,bmp,webp"`).
+     */
+    filter: string;
+    /**
+     * - Initial directory path or file path to open in the dialog.
+     */
+    path: string;
+};
+/**
+ * Options object that hold optional video filters to be applied to video by FFMPEG for MediaPlayer component. Used in {@link MediaPlayer#videoFilters}.
+ */
+type VideoFilters = {
+    /**
+     * - A number of degrees to rotate the video by.
+     */
+    rotate?: number | undefined;
+    /**
+     * - `h` for horizontal, `v` for vertical.
+     */
+    flip?: string | undefined;
+    /**
+     * - `gray`, `sepia`, or `negative`.
+     */
+    color?: string | undefined;
+    /**
+     * - A number between 1 and -1. Default is 0.
+     */
+    brightness?: number | undefined;
+    /**
+     * - A number between 0.0 and 2.0. Default is 1.
+     */
+    contrast?: number | undefined;
+    /**
+     * - A number between 0.0 and 3.0. Default is 1.
+     */
+    saturation?: number | undefined;
+    /**
+     * - A number between 0.1 and 10.0. Default is 1.
+     */
+    gamma?: number | undefined;
+    /**
+     * - Allows to insert any custom video filters separated by comma. Must be compatible with `ffmpeg -vf` option.
+     */
+    custom?: string | undefined;
+};
+/**
+ * An object returned by ui.fileStat(path), which contains information about a file or directory.
+ */
+type FileStat = {
+    /**
+     * - Indicates if the entry is a regular file
+     */
+    isFile: boolean;
+    /**
+     * - Indicates if the entry is a directory
+     */
+    isDirectory: boolean;
+    /**
+     * - Indicates if the entry is a symbolic link
+     */
+    isSymlink: boolean;
+    /**
+     * - Device ID containing the file
+     */
+    dev: number;
+    /**
+     * - Device ID (if special file)
+     */
+    rdev: number;
+    /**
+     * - Number of hard links
+     */
+    nlink: number;
+    /**
+     * - User ID of the file owner
+     */
+    user: number;
+    /**
+     * - Group ID of the file owner
+     */
+    group: number;
+    /**
+     * - Size of the file in bytes
+     */
+    size: number;
+    /**
+     * - File mode (permissions and file type)
+     */
+    mode: number;
+    /**
+     * - Last access time
+     */
+    atime: Date;
+    /**
+     * - Last modification time (e.g. 2025-11-10T08:13:44.386Z)
+     */
+    mtime: Date;
+    /**
+     * - Last status change time (e.g. 2025-11-10T08:13:44.386Z)
+     */
+    ctime: Date;
+    /**
+     * - File creation time (e.g. 2025-11-10T08:13:44.386Z)
+     */
+    birthtime: Date;
+};
+/**
+ * An object returned and accepted by .scrollbars() method for components with scroll bars, which contains scroll bar settings for horizontal and vertical scroll bars.
+ */
+type Scrollbars = {
+    /**
+     * - Visibility of horizontal scroll bar: `true` = visible, `false` = hidden, `null` = auto.
+     */
+    horizontal?: boolean | null | undefined;
+    /**
+     * - Visibility of horizontal scroll bar: `true` = visible, `false` = hidden, `null` = auto.
+     */
+    vertical?: boolean | null | undefined;
+};