slint-ui
    Preparing search index...

    Interface ComponentHandle

    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().

    interface ComponentHandle {
        get window(): Window;
        hide(): any;
        run(): Promise<unknown>;
        show(): any;
    }
    Index

    Accessors

    window

    Methods

    hide run show

    Accessors

    • get window(): Window

      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.

      Returns Window

    Methods

    • 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 was closed, or quitEventLoop was 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>

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods