API Reference

This reference is generated from the current Basalt 2.5 source comments. Use the Guides for task-oriented explanations and this section when you need exact properties, events, parameters, or return values.

Where to Start

• basalt — root Frames, state, layout tokens, scheduling, updates, and the application event loop.
• Element — shared geometry, visibility, styling, state, focus, events, bindings, and invalidation.
• Container — child trees, lookup, scrolling, layout, rendering, and event routing.
• BaseFrame — terminal-bound roots and focus ownership.
• state — writable Signals and Computed values.

The sidebar contains every generated core type, element, and optional module.

Elements

Every element is created through a parent container:

local button = frame:addButton({
    x = 2,
    y = 3,
    width = 12,
    text = "Save",
})

Open the element's page for its own properties and methods. Inherited behavior remains documented on Element and Container.

Frequently used entries include:

• Input, TextBox, and Button
• List, Dropdown, and ComboBox
• Table and Tree
• Canvas and Program

Optional Modules

Load a module before using the elements or fluent methods it registers:

local animation = basalt.use("animation")

See the Modules section in the sidebar for animation, responsive layouts, charts, images, BigFont, themes, XML, and debugging.