Workspace

A userdata which corresponds to the mounted version of WorkspaceProps

A native component within hitokage that displays workspace information.

This is in the particular context of running hitokage with a window/tiling manager:

• komorebi
• TODO (not supported) glazewm

This userdata can be retrieved using:

• Box:get_child_by_id
• Box:get_children
• Bar:get_child_by_id
• Bar:get_children

Example

monitor = hitokage.monitor.get_primary()

---@type WorkspaceProps
workspace_props = { id = "workspace1", Workspace = { halign = "Start", item_height = 24, item_width = 24 } }

bar = monitor:attach({
  children = {
    Workspace = workspace_props,
  },
})

workspace1 = bar:get_child_by_id("workspace1")

Attributes:

• type

Methods:

• get_item_height
• get_item_width
• get_type
• set_item_height
• set_item_width

attr type

type: 'Workspace'

Type: 'Workspace'

method get_item_height

function get_item_height() -> integer

Get the item width

Returns:

• integer

method get_item_width

function get_item_width() -> integer

Get the item width

Returns:

• integer

method get_type

function get_type() -> 'Workspace'

Get the type of widget

return #1:
    | 'Workspace'

Returns:

• 'Workspace'

method set_item_height

function set_item_height(height: integer) -> nil

Set the item width

Parameters:

• height

  (integer)

Returns:

• nil

method set_item_width

function set_item_width(width: integer) -> nil

Set the item width

Parameters:

• width

  (integer)

Returns:

• nil