Controls Reference

Controls reference

Drag a control from the Toolbox onto the canvas, or double-click it to add it at the top left. Every control has an Id (lowercase, unique on the screen), a position and size in GUI pixels, and the shared appearance and behavior settings described in Properties and appearance.

Control	What it is	Main properties	Events
Button	A clickable button.	Text, colors or a PNG skin, corner radius	click
Label	Text. Can show variables with ${name}.	Text, font, alignment, optional background fill	–
Image	A PNG from your project or a Minecraft resource.	Texture	–
Text Box	A single-line text field.	Value (the starting text)	text_changed, submit (Enter)
Checkbox	An on/off box.	Value (true/false), Text	checked, unchecked
Slider	Drag to pick a number.	Value, Minimum, Maximum	value_changed
Progress Bar	A bar showing a value in a range.	Value, Minimum, Maximum, Foreground (bar color)	–
Dropdown	Pick one option from a list. In Minecraft, clicking cycles through the options.	Options (separated by |), Value (zero-based index)	value_changed
Panel	A rectangle that can hold other controls. Use it for backgrounds and sections.	Background, border, radius, PNG skin	–
Scroll Panel	A panel whose contents scroll when they're taller than it.	Same as Panel	–
Item Icon	A Minecraft item's icon, including modded items.	Item (namespace:item_id)	–
Item List	A scrollable list of items with optional row buttons.	Value (JSON rows), RowHeight, PrimaryLabel, SecondaryLabel, ShowItemId, Reusable row template	item_click, item_primary, item_secondary
Texture Region	Part of a larger image (sprite-sheet style).	Texture, TextureX/Y (where the region starts), TextureWidth/Height (full image size)	–

Every control also has three hover events: hover, mouse_enter and mouse_leave. They run client actions only, at most four times a second.

Notes on specific controls

Button and Panel skins: choose a PNG in Appearance to replace the solid color. Transparency in the PNG is kept, and Radius rounds the corners. See Assets and items.

Label backgrounds: labels can have a fill that covers their whole box, or no fill for plain text on whatever is behind.

Text Box in Minecraft supports typing at the end of the text, Backspace, paste and Enter to submit. It isn't a full desktop text editor.

Scroll Panel: set other controls' Parent panel to the scroll panel (see Panels and parenting). Contents below the bottom edge scroll into view with the mouse wheel. Scroll panels can be nested; the wheel scrolls the innermost one first.

Item Icon shows the real item model in Minecraft. The editor shows the item's texture as a preview. See Assets and items for the item picker.

Item List has its own page: Item lists and row templates.

Values and binding

• ${name} in Text, Tooltip and similar fields is replaced with the screen variable name. For example, a label with text Altitude: ${altitude} shows the current altitude value.
• A Checkbox's Value is true or false. A Slider's and Progress Bar's are numbers. A Dropdown's is the selected option's index, starting at 0.
• Scripts and actions change values at runtime; see Events and actions.