zui docs v0.0.5
GitHub ↗
Models and utilities Container Native Qt

Cursor Surface

Cursor Surface is a native Zui container in the models and utilities catalog, with 8 component-specific properties.

Usage

Ruby example

Paste this complete Builder example inside the app surface from the Quickstart. Replace illustrative asset paths with files from your project.

Ruby
cursor_surface cursor: 1, current: 0, outline: true, bordered: true, foreground: "#f5f5f0", accent: "#b7ff5a" do
  label "Keyboard-controlled surface"
end
API

Component properties

8 component-specific values, plus shared item and layout properties.

cursorCursor configuration for Cursor Surface.property
currentCurrent configuration for Cursor Surface.property
outlineOutline configuration for Cursor Surface.property
borderedBordered configuration for Cursor Surface.property
foregroundForeground configuration for Cursor Surface.property
accentAccent configuration for Cursor Surface.property
fillFill configuration for Cursor Surface.property
current_fillCurrent fill configuration for Cursor Surface.property
Show 17 shared item properties
visibleenabledopacityscalerotationzwidthheightfill_widthfill_heightpreferred_widthpreferred_heightminimum_widthminimum_heightmaximum_widthmaximum_heightlayout_alignment
Interaction

Events

Subscribe with on widget, :event and keep behavior in Ruby.

clickNative event payload