ComponentHandle

Defined in: api/node/typescript/index.ts:135 ↗

This interface describes the public API of a Slint component that is common to all instances. Use this to show() the window on the screen, access the window and subsequent window properties, or start the Slint event loop with run().

Accessors

window

Get Signature

get window(): Window

Defined in: api/node/typescript/index.ts:162 ↗

Returns the Window associated with this component instance. The window API can be used to control different aspects of the integration into the windowing system, such as the position on the screen.

Throws an error when accessed on non-windowed components such as ones inheriting from SystemTrayIcon.

Returns

Window

Methods

hide()

hide(): void

Defined in: api/node/typescript/index.ts:154 ↗

Hides the component’s window, so that it is not visible anymore.

Returns

void

---

run()

run(): Promise<unknown>

Defined in: api/node/typescript/index.ts:144 ↗

Shows the window and runs the event loop. The returned promise is resolved when the event loop is terminated, for example when the last window is closed and the last visible system tray icon is hidden, or when quitEventLoop is called.

This function is a convenience for calling show, followed by runEventLoop, and hide when the event loop’s promise is resolved.

Returns

Promise<unknown>

---

show()

show(): void

Defined in: api/node/typescript/index.ts:149 ↗

Shows the component’s window on the screen.

Returns

void