Properties

Generated from LuaLS class and field annotations.

Common Value Types

EasyBarBoolLike

Boolean-like values accepted by some properties. EasyBar accepts both native Lua booleans and the string forms "on" and "off".

Value
boolean

Value	Meaning
"on"	String form treated as enabled or visible.
"off"	String form treated as disabled or hidden.

EasyBarIconLike

Accepted shorthand forms for icon content.

Value
string\|number\|boolean\|EasyBarIconProps

EasyBarLabelLike

Accepted shorthand forms for label content.

Value
string\|number\|boolean\|EasyBarLabelProps

EasyBarPosition

Placement string for a node. At the root level this is usually left, center, or right; popup children use popup.<parent-id>.

Value
string

EasyBarRootPosition

Root-level bar positions used by top-level nodes.

Value	Meaning
"left"	Left bar region.
"center"	Center bar region.
"right"	Right bar region.

Property Tables

EasyBarBackgroundProps

Modifiers: exact.

Shared surface styling fields used by nodes and popups.

Property	Type	Description
color (optional)	string	Background fill color.
border_color (optional)	string	Border stroke color.
border_width (optional)	number	Border width in points.
corner_radius (optional)	number	Corner radius in points.
padding_left (optional)	number	Left padding in points.
padding_right (optional)	number	Right padding in points.
padding_top (optional)	number	Top padding in points.
padding_bottom (optional)	number	Bottom padding in points.

EasyBarFontProps

Modifiers: exact.

Font override fields used by label and icon content.

Property	Type	Description
size (optional)	number	Font size in points.

EasyBarIconProps

Modifiers: exact.

Detailed icon configuration used when a plain icon value is not enough.

Property	Type	Description
string (optional)	string	Icon glyph text.
color (optional)	string	Hex color override for the icon.
font (optional)	EasyBarFontProps	Icon font overrides.
image (optional)	string\|EasyBarImage	Image path or structured image source to render instead of icon text.
image_size (optional)	number	Image size in points.
image_corner_radius (optional)	number	Image corner radius in points.
padding_right (optional)	number	Additional layout spacing between the icon and following inline content.
offset_x (optional)	number	Horizontal visual icon offset in points without changing layout spacing.
offset_y (optional)	number	Vertical visual icon offset in points without changing layout spacing.

EasyBarImage

Modifiers: exact.

Image configuration for nodes that render an image instead of text.

Property	Type	Description
path (optional)	string	Filesystem path of an image. Mutually exclusive with svg.
svg (optional)	string	Inline SVG source. Mutually exclusive with path.
size (optional)	number	Image size in points.
corner_radius (optional)	number	Image corner radius in points.

EasyBarLabelProps

Modifiers: exact.

Detailed label configuration used when a plain label value is not enough.

Property	Type	Description
string (optional)	string	Label text.
color (optional)	string	Hex color override for the label.
font (optional)	EasyBarFontProps	Label font overrides.

EasyBarMarginProps

Modifiers: exact.

Outer spacing fields that push a node away from surrounding content.

Property	Type	Description
margin_left (optional)	number	Left margin in points.
margin_right (optional)	number	Right margin in points.
margin_top (optional)	number	Top margin in points.
margin_bottom (optional)	number	Bottom margin in points.

EasyBarNodeProps

Modifiers: exact.

The main property table accepted by easybar.add(...) and node:set(...).

Property	Type	Description
position (optional)	EasyBarPosition	Root nodes use left, center, or right; popup children use popup.<id>.
order (optional)	integer	Render order within one bar position.
drawing (optional)	EasyBarBoolLike	Whether the node is visible.
parent (optional)	string	Parent node id for nested layout.
width (optional)	number	Width in points.
height (optional)	number	Height in points.
opacity (optional)	number	Opacity from 0 to 1.
y_offset (optional)	number	Vertical offset in points.
interval (optional)	number	Polling interval in seconds.
on_interval (optional)	fun()	Interval callback executed on this widget's own interval schedule.
color (optional)	string	Primary foreground color.
icon (optional)	EasyBarIconLike	Icon table or shorthand value.
label (optional)	EasyBarLabelLike	Label table or shorthand value.
image (optional)	EasyBarImage	Standalone image content.
background (optional)	EasyBarBackgroundProps	Background and padding styling.
margin (optional)	EasyBarMarginProps	Margin overrides for individual edges.
popup (optional)	EasyBarPopupProps	Popup container properties.
context_menu (optional)	EasyBarContextMenuEntry[]	Native right-click menu. Use node:unset("context_menu") to remove it.
spacing (optional)	number	Child spacing for rows, groups, and popup content.
value (optional)	number	Current scalar value for progress/slider nodes.
min (optional)	number	Minimum value for progress/slider nodes.
max (optional)	number	Maximum value for progress/slider nodes.
step (optional)	number	Slider step size.
values (optional)	number[]	Sparkline sample values.
line_width (optional)	number	Sparkline stroke width.
padding_x (optional)	number	Horizontal padding shorthand.
padding_y (optional)	number	Vertical padding shorthand.
paddingX (optional)	number	Horizontal padding shorthand.
paddingY (optional)	number	Vertical padding shorthand.
margin_x (optional)	number	Horizontal margin shorthand.
margin_y (optional)	number	Vertical margin shorthand.
marginX (optional)	number	Horizontal margin shorthand.
marginY (optional)	number	Vertical margin shorthand.
margin_left (optional)	number	Left margin in points.
margin_right (optional)	number	Right margin in points.
margin_top (optional)	number	Top margin in points.
margin_bottom (optional)	number	Bottom margin in points.

EasyBarPopupProps

Modifiers: exact.

Container-level popup properties for visibility, layout, and surface styling.

Property	Type	Description
drawing (optional)	EasyBarBoolLike	Whether popup content is shown.
background (optional)	EasyBarBackgroundProps	Popup background styling.
spacing (optional)	number	Child spacing inside the popup container.
width (optional)	number	Popup width in points.
height (optional)	number	Popup height in points.
opacity (optional)	number	Opacity from 0 to 1.
y_offset (optional)	number	Vertical offset in points.
padding_x (optional)	number	Horizontal popup padding shorthand.
padding_y (optional)	number	Vertical popup padding shorthand.
paddingX (optional)	number	Horizontal popup padding shorthand.
paddingY (optional)	number	Vertical popup padding shorthand.
padding_left (optional)	number	Left popup padding in points.
padding_right (optional)	number	Right popup padding in points.
padding_top (optional)	number	Top popup padding in points.
padding_bottom (optional)	number	Bottom popup padding in points.
margin_x (optional)	number	Horizontal popup margin shorthand.
margin_y (optional)	number	Vertical popup margin shorthand.
marginX (optional)	number	Horizontal popup margin shorthand.
marginY (optional)	number	Vertical popup margin shorthand.
margin_left (optional)	number	Left popup margin in points.
margin_right (optional)	number	Right popup margin in points.
margin_top (optional)	number	Top popup margin in points.
margin_bottom (optional)	number	Bottom popup margin in points.