hl

Root Hyprland Lua API object.

The global variable hl is an instance of HL.API.

Overview

• HL.API

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.dsp

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.layout
• hl.notification
• hl.plugin