Docs
Download

Interface

Panels, menus, buttons and fields: everything your add-on shows in Blender.

The interface nodes build what users see: a panel in the sidebar, a menu, a preferences page, or entries added to Blender's own menus. A root node (Panel, Menu, Pie Menu, Preferences, Add to Menu, ...) starts an interface flow, and the nodes connected after it draw from top to bottom. Find them under Add › Interface, the layout nodes under Add › Interface › Layouts and the icon nodes under Add › Interface › Icons.

Where it's drawn

NodeDoes
PanelA panel in an editor's sidebar, the Properties editor or another region
SubpanelA collapsible section inside a panel
PopoverA button opening a panel as a popup
MenuA dropdown button and the menu it opens
Pie MenuA menu around the mouse, opened with a shortcut
Open MenuOpens a menu, pie menu or panel at the mouse from a flow
Operator MenuOne entry per item of an operator's enum property
Menu ContentsDraws the entries of a menu in place
Add to MenuDraws into one of Blender's menus
Add to PanelDraws into one of Blender's panels
Add to HeaderDraws into an editor's header
PreferencesThe add-on's settings in Preferences › Add-ons
RedrawRedraws editors so panels show new values

Layout

NodeDoes
RowDraws its contents side by side
ColumnDraws its contents below each other
BoxA framed column
SplitTwo columns with a set share of the width
GridFills its contents into a grid
SeparatorSpace or a line
Set Layout StateGrays out or highlights what follows, sets how buttons run
Set Layout ScaleMakes what follows bigger, or a fixed size
Set Property LayoutLabels next to fields and keyframe dots, like Blender's panels
Reset LayoutContinues in the panel's own layout, outside rows and boxes
Set Context DataGives buttons after it data their operator reads from context
ProgressA progress bar or ring
Display PreviewThe rendered preview of a material, texture, light or world

Lists

NodeDoes
UI ListBlender's list widget for a collection, with a selected item
Draw For EachDraws its flow once per item of a list or collection

Fields and buttons

NodeDoes
ButtonA button that runs an operator
CheckboxA Boolean property as a checkbox or toggle
Number FieldAn Integer or Float property
Text FieldA String property as a field, text box or search field
Vector FieldA vector or color property
Enum MenuAn Enum property as a dropdown, buttons or icon previews
Pointer FieldA Pointer property, or Blender's data-block selector

Text

NodeDoes
LabelA line of text with an optional icon
Multiline LabelText wrapped over several lines
MarkdownText formatted with markdown
LinkA link that opens a web page

Icons

NodeDoes
IconOne of Blender's icons
Custom IconAn image as icon, shipped with the add-on
Display IconDraws an icon on its own, at any size
Icon from DataThe icon Blender shows for data or an enum item