Commands

The model runs 23 commands. Each one takes a JSON payload, checked against its JSON Schema, and returns a CommandResult: { ok: true, value }, or { ok: false, error }. Run one with model.run(name, payload) (typed by your registry), or give it as untrusted JSON to model.dispatch({ command, payload }), which validates it first. model.commands() returns this same list with the schemas, ready to become tool definitions for an assistant.

Every command can return invalid_payload (the payload does not match its schema, with the path of each problem), vetoed (a middleware refused it), queued (a middleware ran it while another command was running) and middleware_error; each command lists the ones its own rules add: not_found (a node it names is missing) and refused (a rule of the layout refuses the change). See the command bus for the results, the middleware and the events.

The payload types below use T, your registry (see typed data): a tab's data is checked against its component.

Tabs

tab.add

Add a new tab. component names what the tab shows and data holds its state (validated when the app registered a data schema). to is a tabset, a row, a border or a layout id; location center adds it to that tabset or border at index (-1 appends), an edge of a tabset splits it, an edge of a root row docks the tab to that side of the layout.

Payload (TabAddPayload<T>)

Result ({ tab: string })

Errors: not_found, refused, besides those every command can return.

model.run("tab.add", {
    component: "editor",
    data: {
        name: "a.ts",
        path: "/a.ts"
    },
    to: "tabset-1"
});

{ "command": "tab.add", "payload": {"component":"editor","data":{"name":"a.ts","path":"/a.ts"},"to":"tabset-1"} }

tab.select

Select a tab, making it visible. In a tabset the tabset also becomes the active one; in a border the border's panel opens. Selecting the selected tab changes nothing.

Payload ({ tab: string })

Result ({ tab: string })

Errors: not_found, besides those every command can return.

model.run("tab.select", {
    tab: "tab-1"
});

{ "command": "tab.select", "payload": {"tab":"tab-1"} }

tab.close

Close a tab and remove it from the layout. Refused for a pinned tab or one whose enableClose is false.

Payload ({ tab: string })

Result ({ tab: string })

Errors: not_found, refused, besides those every command can return.

model.run("tab.close", {
    tab: "tab-1"
});

{ "command": "tab.close", "payload": {"tab":"tab-1"} }

tab.move

Move a tab to another place: into a tabset or border at an index (location center), beside a tabset (an edge location splits it), or to an edge of a layout (to a root row or a layout id, with an edge location). Refused where the tab or the target does not allow it.

Payload (TabMovePayload)

Result ({ tab: string })

Errors: not_found, refused, besides those every command can return.

model.run("tab.move", {
    tab: "tab-1",
    to: "tabset-2",
    location: "right"
});

{ "command": "tab.move", "payload": {"tab":"tab-1","to":"tabset-2","location":"right"} }

tab.update

Replace a tab's data (and optionally switch its component). data is the whole new value, not a patch; it is validated when the app registered a schema for the component.

Payload (TabUpdatePayload<T>)

Result ({ tab: string })

Errors: not_found, besides those every command can return.

model.run("tab.update", {
    tab: "tab-1",
    component: "editor",
    data: {
        name: "b.ts",
        path: "/b.ts"
    }
});

{ "command": "tab.update", "payload": {"tab":"tab-1","component":"editor","data":{"name":"b.ts","path":"/b.ts"}} }

tab.pin

Pin (value true) or unpin a tab of a tabset. Pinned tabs sit at the start of the strip, cannot be closed and cannot be dragged out of their tabset.

Payload ({ tab: string; value: boolean })

Result ({ tab: string })

Errors: not_found, refused, besides those every command can return.

model.run("tab.pin", {
    tab: "tab-1",
    value: true
});

{ "command": "tab.pin", "payload": {"tab":"tab-1","value":true} }

tab.popout

Open a tab in a new browser window (a window layout). rect is the window's screen rect; a default is used without one. Refused when the tab does not allow popouts, is pinned or is already in a window.

Payload ({ tab: string; rect?: Rect })

Result ({ window: string })

Errors: not_found, refused, besides those every command can return.

model.run("tab.popout", {
    tab: "tab-1"
});

{ "command": "tab.popout", "payload": {"tab":"tab-1"} }

tab.configure

Change a tab's behaviour flags and size limits. A null value removes the tab's own value so the layout default applies.

Payload (TabConfigurePayload)

Result ({ tab: string })

Errors: not_found, besides those every command can return.

model.run("tab.configure", {
    tab: "tab-1",
    enableClose: false
});

{ "command": "tab.configure", "payload": {"tab":"tab-1","enableClose":false} }

Tabsets

tabset.activate

Make a tabset the active one of its layout.

Payload ({ tabset: string })

Result ({ tabset: string })

Errors: not_found, besides those every command can return.

model.run("tabset.activate", {
    tabset: "tabset-1"
});

{ "command": "tabset.activate", "payload": {"tabset":"tabset-1"} }

tabset.maximize

Maximize a tabset so it fills its layout (value true), or restore it (value false). Maximizing also makes it active. Refused when the tabset does not allow it or is the only tabset of its layout.

Payload ({ tabset: string; value: boolean })

Result ({ tabset: string })

Errors: not_found, refused, besides those every command can return.

model.run("tabset.maximize", {
    tabset: "tabset-1",
    value: true
});

{ "command": "tabset.maximize", "payload": {"tabset":"tabset-1","value":true} }

tabset.close

Close a tabset: its closable tabs close, and the tabset is removed once empty. Refused when the tabset's enableClose is false.

Payload ({ tabset: string })

Result ({ closed: string[] })

Errors: not_found, refused, besides those every command can return.

model.run("tabset.close", {
    tabset: "tabset-1"
});

{ "command": "tabset.close", "payload": {"tabset":"tabset-1"} }

tabset.move

Move a whole tabset: merge its tabs into another tabset (location center), place it beside a tabset (an edge), or dock it to an edge of a layout.

Payload (TabsetMovePayload)

Result ({ tabset: string })

Errors: not_found, refused, besides those every command can return.

model.run("tabset.move", {
    tabset: "tabset-1",
    to: "main",
    location: "bottom"
});

{ "command": "tabset.move", "payload": {"tabset":"tabset-1","to":"main","location":"bottom"} }

tabset.popout

Open a whole tabset in a new browser window. Refused when any of its tabs does not allow popouts, when it is empty, or when it is already in a window.

Payload ({ tabset: string; rect?: Rect })

Result ({ window: string })

Errors: not_found, refused, besides those every command can return.

model.run("tabset.popout", {
    tabset: "tabset-1"
});

{ "command": "tabset.popout", "payload": {"tabset":"tabset-1"} }

tabset.configure

Change a tabset's behaviour flags, size limits or data. A null value removes the tabset's own value so the layout default applies (data: null removes the data).

Payload (TabsetConfigurePayload<T>)

Result ({ tabset: string })

Errors: not_found, besides those every command can return.

model.run("tabset.configure", {
    tabset: "tabset-1",
    enableMaximize: false
});

{ "command": "tabset.configure", "payload": {"tabset":"tabset-1","enableMaximize":false} }

Rows

row.resize

Set the relative weights of a row's children, one positive number per child in order (the splitters issue this while dragged).

It may run as a step of a continuous gesture: model.run(…, { transient: true }).

Payload ({ row: string; weights: number[] })

Result ({ row: string })

Errors: not_found, besides those every command can return.

model.run("row.resize", {
    row: "row-1",
    weights: [
        30,
        70
    ]
});

{ "command": "row.resize", "payload": {"row":"row-1","weights":[30,70]} }

row.configure

Set (or, with null, remove) a row's data.

Payload (RowConfigurePayload<T>)

Result ({ row: string })

Errors: not_found, besides those every command can return.

model.run("row.configure", {
    row: "row-1",
    data: {
        name: "Editors"
    }
});

{ "command": "row.configure", "payload": {"row":"row-1","data":{"name":"Editors"}} }

Borders

border.resize

Set the size in px of a border's panel (of its selected tab when that tab has its own border size). The size is clamped to the border's min and max.

It may run as a step of a continuous gesture: model.run(…, { transient: true }).

Payload ({ border: string; size: number })

Result ({ border: string; size: number })

Errors: not_found, besides those every command can return.

model.run("border.resize", {
    border: "border_left",
    size: 240
});

{ "command": "border.resize", "payload": {"border":"border_left","size":240} }

border.configure

Open or close a border's panel (open), switch it between docked and overlay (mode), show or hide it, or change its sizes, flags or data. Opening selects its first tab when none is selected. A null value removes the border's own value so the layout default applies.

Payload (BorderConfigurePayload<T>)

Result ({ border: string })

Errors: not_found, refused, besides those every command can return.

model.run("border.configure", {
    border: "border_left",
    open: true
});

{ "command": "border.configure", "payload": {"border":"border_left","open":true} }

Windows

window.close

Close a popout window layout: its tabs move back into the main layout's active tabset (its first tabset when none is active), and the window closes.

Payload ({ window: string })

Result ({ tabs: string[] })

Errors: not_found, besides those every command can return.

model.run("window.close", {
    window: "window-1"
});

{ "command": "window.close", "payload": {"window":"window-1"} }

window.configure

Record a popout window's screen rect (the engine does this when the window moves or resizes, so a saved layout reopens it in place).

It may run as a step of a continuous gesture: model.run(…, { transient: true }).

Payload ({ window: string; rect: Rect })

Result ({ window: string })

Errors: not_found, besides those every command can return.

model.run("window.configure", {
    window: "window-1",
    rect: {
        x: 100,
        y: 80,
        width: 800,
        height: 600
    }
});

{ "command": "window.configure", "payload": {"window":"window-1","rect":{"x":100,"y":80,"width":800,"height":600}} }

The layout

layout.configure

Change the layout defaults: the default behaviour of tabs, tabsets and borders, and layout settings (root orientation, edge docking). Fields are merged; a null value removes one.

Payload ({ defaults: LayoutDefaultsPatch })

Result (Record<never, never>)

No fields.

Errors: only those every command can return.

model.run("layout.configure", {
    defaults: {
        tab: {
            enableClose: false
        }
    }
});

{ "command": "layout.configure", "payload": {"defaults":{"tab":{"enableClose":false}}} }

layout.load

Replace the whole layout with a JSON v1 document (a saved layout, an undo step, a remote sync). Nodes keep their identity by id, so tabs whose ids survive keep their mounted content.

Payload ({ layout: LayoutJson<T> })

Result ({ added: string[]; removed: string[] })

Errors: only those every command can return.

model.run("layout.load", {
    layout: {
        version: 1,
        root: {
            type: "row",
            children: [
                {
                    type: "tabset",
                    children: [
                        {
                            component: "editor",
                            data: {
                                name: "a.ts"
                            }
                        }
                    ]
                }
            ]
        }
    }
});

{ "command": "layout.load", "payload": {"layout":{"version":1,"root":{"type":"row","children":[{"type":"tabset","children":[{"component":"editor","data":{"name":"a.ts"}}]}]}}} }

Batches

batch

Run several commands in order as one atomic step: if any fails, none applies. Emits one change event. Nested batches are flattened.

It may run as a step of a continuous gesture: model.run(…, { transient: true }).

Payload ({ commands: BatchEntry<T>[] })

Result ({ results: unknown[] })

Errors: those of the commands it runs (the first failure, at its path in commands); nothing applies unless all succeed.

model.run("batch", {
    commands: [
        {
            command: "tab.close",
            payload: {
                tab: "tab-1"
            }
        },
        {
            command: "tab.close",
            payload: {
                tab: "tab-2"
            }
        }
    ]
});

{ "command": "batch", "payload": {"commands":[{"command":"tab.close","payload":{"tab":"tab-1"}},{"command":"tab.close","payload":{"tab":"tab-2"}}]} }