Log inGet started
World

Builtin Library

Branchmain
Branchesmainpublish
Commit8d45df8664

README.md

shell

Pre-built shells for common app shapes. Each shell is a function taking a single props table; missing fields fall back to sensible defaults. See docs/specs/ui-v3-architecture.md Layer 5 for the canonical signatures.

Exports

  • Shell.docked — toolbar + body + status layout. See docked.module/.
  • Shell.canvas — node-graph editor with bezier connections. See canvas.module/.
  • Shell.inspector — form-with-fields-and-actions pane. See inspector.module/.
  • Shell.tabApp — visibility-driven tabbed app with per-tab refresh scheduler. See tabApp.module/.

Usage

local Shell = require("@builtin::modules.zui.shell")
Shell.docked { top = ..., center = ..., bottom = ... }
Shell.tabApp { name = "system_tools", tabs = ..., tabOrder = ... }

Notes

  • This module is a pure aggregator: it does nothing but re-export the four shell submodules. Each shell owns its own behaviour, defaults, and contract; consult the respective submodule for the prop shapes.
  • Missing slots in any shell are skipped cleanly — there are no empty containers, no wasted space.