Skip to content

Lua Reference

This section is generated from the EasyBar LuaLS stub and is meant to answer "what is the exact API surface?" quickly.

Use these pages for exact types, event names, and property tables. For usage patterns and architecture, use the hand-written guides.

Generated pages

  • Functions Top-level easybar.* calls and node handle methods.
  • Node kinds Literal kind values plus the easybar.kind.* namespace.
  • Events Runtime event names, payloads, and the easybar.events.* namespace.
  • Properties Property tables used by nodes, labels, icons, popups, and layout styling.
  1. Start with Lua Overview for the node-based mental model.
  2. Read Functions to learn how widgets are created and updated.
  3. Keep Events and Properties open while building widgets.

Source of truth

The source of truth is the public LuaLS stub:

Sources/EasyBarApp/Lua/easybar_api.lua

If this reference is wrong, update the stub and regenerate the docs.