Documentation
    Preparing search index...

    Interface WmService

    Minimal shell-facing window-manager service contract.

    interface WmService {
        state: {
            get(): { activeWorkspace: WorkspaceId; focusedWindowId: string | null };
        };
        window: {
            close(id: string): void;
            create(
                opts: { class: string; iframeSrc?: string; title: string },
            ): string | null;
            focus(id: string): void;
            move(id: string, toWorkspace: WorkspaceId): void;
        };
        workspace: {
            list(): { id: WorkspaceId; windowCount: number }[];
            switch(id: WorkspaceId): void;
        };
        destroy(): void;
    }
    Index

    Properties

    state window workspace

    Methods

    destroy

    Properties

    state: {
        get(): { activeWorkspace: WorkspaceId; focusedWindowId: string | null };
    }

    Read-only service state accessors.

    Type Declaration

    • get: function
      • get(): { activeWorkspace: WorkspaceId; focusedWindowId: string | null }

        Get focused-window and active-workspace state.

        Returns { activeWorkspace: WorkspaceId; focusedWindowId: string | null }

    window: {
        close(id: string): void;
        create(
            opts: { class: string; iframeSrc?: string; title: string },
        ): string | null;
        focus(id: string): void;
        move(id: string, toWorkspace: WorkspaceId): void;
    }

    Window lifecycle and focus operations.

    Type Declaration

    • close: function
      • close(id: string): void

        Close a window.

        Parameters

        • id: string

        Returns void

    • create: function
      • create(
            opts: { class: string; iframeSrc?: string; title: string },
        ): string | null

        Create a new window and return its id, or null when the host rejects it.

        Parameters

        • opts: { class: string; iframeSrc?: string; title: string }

        Returns string | null

    • focus: function
      • focus(id: string): void

        Focus a window.

        Parameters

        • id: string

        Returns void

    • move: function
    workspace: {
        list(): { id: WorkspaceId; windowCount: number }[];
        switch(id: WorkspaceId): void;
    }

    Workspace operations.

    Type Declaration

    Methods

    • Release service state held by this instance.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods