Log inGet started
World

Builtin Library

Branchmain
Branchesmainpublish
Commitdd348ac6c3

README.md

dockPanel

A single dockable panel inside a dockArea. Its widget id is the stable tab id the dockArea uses for reconciliation and for the <id>-close interaction fired when the tab is closed. Children form the tab's content subtree, rendered by the dockArea's TabViewer.

The module returns the widget builder function directly.

Builder

dockPanel(opts?) -> widget node. opts fields:

  • id (required) — the stable tab id.
  • title — the tab label shown in the dock tab bar; defaults to the panel id.
  • closable — whether the tab shows a close button (default true). On close the dockArea emits <id>-close.
  • float — when a NEW panel first appears with float = true, the dockArea opens it as a floating, movable, resizable dock-window over the content behind instead of in the focused leaf.
  • children, props, style.

Usage

local dockPanel = require("modules.zui.widget.dockPanel")
local widget = dockPanel({ id = "props", title = "Properties", children = {
    Z.lbl("Inspector body"),
}})