Skip to content

WorkspaceProps

A native component within hitokage that displays workspace information.

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

See ComponentProps

Example

monitor = hitokage.monitor.get_primary()

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

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

The mounted API is documented here: Workspace

Attributes:

attr class

class: (string|table<number, string>)?

Type: (string|table<number, string>?

Optional css class names. Either space-delimited classes, or an array of class names. Built-in hitokage components will always contain their type as a class name.

Example

class = "red blue green"
or 
class = {"red", "blue", "green"}

View gtk4 documentation

attr format

format: string?

Type: string?

attr halign

halign: ('Baseline'|'Center'|'End'|'Fill'|'Start'...(+1))?

Type: ('Baseline'|'Center'|'End'|'Fill'|'Start'...(+1))?

Sets the horizontal alignment of widget. Defaults to 'Fill'

View gtk4 documentation

attr height_request

height_request: integer?

Type: integer?

Override for height request of the widget. If this is -1, the natural request will be used.

View gtk4 documentation

attr hexpand

hexpand: boolean?

Type: boolean?

Whether to expand horizontally. Defaults to false

View gtk4 documentation

attr id

id: string?

Type: string?

A unique identifier.

This is not enforced or checked by hitokage, it is simply used in utility methods such as Bar:get_child_by_id or Box:get_child_by_id.

attr item_height

item_height: integer?

Type: integer?

attr item_width

item_width: integer?

Type: integer?

@codyduong TODO add some descriptions here

attr valign

valign: ('Baseline'|'Center'|'End'|'Fill'|'Start'...(+1))?

Type: ('Baseline'|'Center'|'End'|'Fill'|'Start'...(+1))?

Sets the vertical alignment of widget. Defaults to 'Fill'.

View gtk4 documentation

attr vexpand

vexpand: boolean?

Type: boolean?

Whether to expand vertically. Defaults to false

View gtk4 documentation

attr width_request

width_request: integer?

Type: integer?

Override for width request of the widget. If this is -1, the natural request will be used.

View gtk4 documentation