hy3

hl.config({ general = { layout = "hy3" } })

hl.config({
	plugin = { hy3 = {
		-- policy controlling what happens when a node is removed from a group,
		-- leaving only a group
		-- 0 = remove the nested group
		-- 1 = keep the nested group
		-- 2 = keep the nested group only if its parent is a tab group
		node_collapse_policy = <int>, -- default: 2

		-- when a workspace holds a single window, treat it as fullscreen for tab bar
		-- purposes: the bar is hidden for it
		no_gaps_when_only = <int>, -- default: 0

		-- offset from group split direction when only one window is in a group
		group_inset = <int>, -- default: 10

		-- if a tab group will automatically be created for the first window spawned in a workspace
		tab_first_window = <bool>,

		-- (fork) tag windows with hy3's grouping state - hy3_grouped when inside any
		-- group, hy3_tabbed when inside a tab group - so windowrules can react to it.
		-- backported from upstream PR #327.
		tag_windows = <bool>, -- default: false

		-- tab group settings
		tabs = {
			-- height of the tab bar
			height = <int>, -- default: 22

			-- padding between the tab bar and its focused node
			padding = <int>, -- default: 5

			-- the tab bar should animate in/out from the top instead of below the window
			from_top = <bool>, -- default: false

			-- radius of tab bar corners
			radius = <int>, -- default: 6

			-- tab bar border width
			border_width = <int>, -- default: 2

			-- render the window title on the bar
			render_text = <bool>, -- default: true

			-- center the window title
			text_center = <bool>, -- default: true

			-- font to render the window title with
			text_font = <string>, -- default: Sans

			-- height of the window title
			text_height = <int>, -- default: 8

			-- left padding of the window title
			text_padding = <int>, -- default: 3

			colors = {
				-- active tab bar segment colors
				active = <color>, -- default: rgba(33ccff40)
				active_border = <color>, -- default: rgba(33ccffee)
				active_text = <color>, -- default: rgba(ffffffff)

				-- active tab bar segment colors for bars on an unfocused monitor
				active_alt_monitor = <color>, -- default: rgba(60606040)
				active_alt_monitor_border = <color>, -- default: rgba(808080ee)
				active_alt_monitor_text = <color>, -- default: rgba(ffffffff)

				-- focused tab bar segment colors (focused node in unfocused container)
				focused = <color>, -- default: rgba(60606040)
				focused_border = <color>, -- default: rgba(808080ee)
				focused_text = <color>, -- default: rgba(ffffffff)

				-- inactive tab bar segment colors
				inactive = <color>, -- default: rgba(30303020)
				inactive_border = <color>, -- default: rgba(606060aa)
				inactive_text = <color>, -- default: rgba(ffffffff)

				-- urgent tab bar segment colors
				urgent = <color>, -- default: rgba(ff223340)
				urgent_border = <color>, -- default: rgba(ff2233ee)
				urgent_text = <color>, -- default: rgba(ffffffff)

				-- locked tab bar segment colors
				locked = <color>, -- default: rgba(90903340)
				locked_border = <color>, -- default: rgba(909033ee)
				locked_text = <color>, -- default: rgba(ffffffff)
			},

			-- if tab backgrounds should be blurred
			-- Blur is only visible when the above colors are not opaque.
			blur = <bool>, -- default: true

			-- opacity multiplier for tabs
			-- Applies to blur as well as the given colors.
			opacity = <float>, -- default: 1.0
		},

		-- autotiling settings
		autotile = {
			-- enable autotile
			enable = <bool>, -- default: false

			-- make autotile-created groups ephemeral
			ephemeral_groups = <bool>, -- default: true

			-- if a window would be squished smaller than this width, a vertical split will be created
			-- -1 = never automatically split vertically
			-- 0 = always automatically split vertically
			-- <number> = pixel width to split at
			trigger_width = <int>, -- default: 0

			-- if a window would be squished smaller than this height, a horizontal split will be created
			-- -1 = never automatically split horizontally
			-- 0 = always automatically split horizontally
			-- <number> = pixel height to split at
			trigger_height = <int>, -- default: 0

			-- a space or comma separated list of workspace ids where autotile should be enabled
			-- it's possible to create an exception rule by prefixing the definition with "not:"
			-- workspaces = "1,2" -- autotiling will only be enabled on workspaces 1 and 2
			-- workspaces = "not:1,2" -- autotiling will be enabled on all workspaces except 1 and 2
			workspaces = <string>, -- default: all
		},

		-- (fork) directional focus never leaves a special (scratchpad) workspace for
		-- another monitor - at the edge of the scratchpad's layout, focus stays put
		special_focus_trap = <bool>, -- default: false

		-- (fork) move_window at the edge of the layout hands the node to the
		-- adjacent monitor instead of wrapping it into a new group
		movewindow_monitor_fallthrough = <bool>, -- default: false

		-- (fork) move_window also moves a focused *floating* window - snapped to
		-- the work-area edge in that direction, like hyprland's own movewindow, and
		-- across monitors once against the edge if movewindow_monitor_fallthrough
		-- is also on
		movewindow_floating = <bool>, -- default: false

		-- (fork) change_focus "raise" stops at the workspace group instead of
		-- wrapping back to the focused window, the way "lower" already stops at one
		changefocus_raise_stops = <bool>, -- default: false

		-- (fork) on a workspace managed by another layout, move_focus, move_window,
		-- swap_window, toggle_floating and move_to_monitor delegate to hyprland's
		-- native actions instead of doing nothing - one set of binds covers hy3
		-- and foreign layouts
		layout_fallback = <bool>, -- default: false

		-- (fork) move_window swaps the focused window with its neighbour instead
		-- of inserting it into the tree - the swap_window operation on the move
		-- bind. once/visible/monitor/warp are ignored on this path, and with
		-- layout_fallback the foreign-layout delegation flips to a swap too
		movewindow_swap = <bool>, -- default: false
	} },
})

local hy3 = hl.plugin.hy3

-- all factories return dispatcher functions and dispatchers return no values
-- option tables are optional except for focus_tab

hy3.make_group("h" | "v" | "tab" | "opposite", {
	toggle = true | false,              -- default: false
	ephemeral = true | false | "force", -- default: false
})

hy3.change_group("h" | "v" | "tab" | "untab" | "toggletab" | "opposite")

hy3.set_ephemeral(true | false | "true" | "false")

hy3.move_focus("l" | "r" | "u" | "d" | "left" | "right" | "up" | "down", {
	visible = true | false, -- default: false
	warp = true | false,    -- default: follows cursor:no_warps
})

hy3.toggle_focus_layer({
	warp = true | false, -- default: follows cursor:no_warps
})

hy3.warp_cursor()

hy3.move_window("l" | "r" | "u" | "d" | "left" | "right" | "up" | "down", {
	once = true | false,    -- default: false
	visible = true | false, -- default: false
	monitor = true | false, -- (fork) default: follows plugin:hy3:movewindow_monitor_fallthrough
	warp = true | false,    -- (fork) default: follows cursor:no_warps. only read when the move crosses a monitor
})

hy3.move_to_workspace("<workspace>", {
	follow = true | false, -- default: false
	warp = true | false,   -- default: follows cursor:no_warps when follow = true
})

hy3.change_focus("top" | "bottom" | "raise" | "lower" | "tab" | "tabnode")

-- direction and index are mutually exclusive
hy3.focus_tab({
	direction = "l" | "r" | "left" | "right",
	mouse = "ignore" | "prioritize_hovered" | "require_hovered", -- default: "ignore"
	wrap = true | false, -- default: false
})

hy3.focus_tab({
	index = <number>,
	mouse = "ignore" | "prioritize_hovered" | "require_hovered", -- default: "ignore"
	wrap = true | false, -- default: false
})

hy3.set_swallow(true | false | "true" | "false" | "toggle") -- alpha quality

hy3.kill_active()

-- alpha quality
hy3.expand("expand" | "shrink" | "base" | "maximize" | "fullscreen", {
	fullscreen = "" | "intermediate_maximize" | "fullscreen_maximize" | "maximize_only",
})

hy3.lock_tab(nil | "" | "toggle" | "lock" | "unlock")

hy3.equalize({
	scope = "" | "group" | "workspace", -- default: "group"
	workspace = true | false,           -- overrides scope if present
	recursive = true | false,           -- overrides workspace if present
})

hy3.debug_nodes()

-- (fork) additions

hy3.move_to_monitor("l" | "r" | "u" | "d" | "+1" | "-1" | "current" | "<name>" | "<id>", {
	follow = true | false, -- default: false
	warp = true | false,   -- default: follows cursor:no_warps when follow = true
})

hy3.toggle_floating({
	workspace = "<workspace>", -- default: the workspace underneath the scratchpad
	warp = true | false,       -- default: follows cursor:no_warps
})

hy3.swap_window("l" | "r" | "u" | "d" | "left" | "right" | "up" | "down")