HL.API

class HL.API

Root Hyprland Lua API object.

The global variable hl is an instance of HL.API. Public functions exposed on HL.API are documented under the names users call in config files, such as hl.monitor(), hl.bind(), and hl.config().

hl.monitor({
    output = "DP-1",
    mode = "2560x1440@60",
    position = "0x0",
    scale = 1,
})

Configuration

• hl.config()

• hl.device()

• hl.gesture()

• hl.layer_rule()

• hl.monitor()

• hl.permission()

• hl.window_rule()

• hl.workspace_rule()

• hl.animation()

• hl.curve()

Keybinds and dispatch

• hl.bind()

• hl.dispatch()

• hl.unbind()

• HL.DspNamespace

Queries

• hl.get_active_monitor()

• hl.get_active_special_workspace()

• hl.get_active_window()

• hl.get_active_workspace()

• hl.get_config()

• hl.get_current_submap()

• hl.get_cursor_pos()

• hl.get_last_window()

• hl.get_last_workspace()

• hl.get_layers()

• hl.get_monitor()

• hl.get_monitor_at()

• hl.get_monitor_at_cursor()

• hl.get_monitors()

• hl.get_urgent_window()

• hl.get_window()

• hl.get_windows()

• hl.get_workspace()

• hl.get_workspace_windows()

• hl.get_workspaces()

Events and runtime

• hl.define_submap()

• hl.env()

• hl.exec_cmd()

• hl.on()

• hl.timer()

• hl.version()

Namespaces

• HL.LayoutNamespace

• HL.NotificationNamespace

• HL.PluginNamespace

See also

HL.MonitorSpec

Example input schema type used by hl.monitor().

HL.Monitor

Example runtime object returned by monitor query functions.