Skip to main content

Component

The Component widget is an instance that embeds a separately built component master into a screen. Reuse one component in many places, and every instance picks up the edits you make to the master.

info

This widget is locked on the Free plan. It's available on the Pro and Enterprise plans.

Definition and role

The Component widget draws a copy — an instance — of a component master you built earlier. An instance follows the master's widget structure, but you can override properties per instance or give variables different initial values.

  • Category: Contents
  • Reference target: a component master, specified by id

Features

FeatureDescription
Component instantiationPlaces a component master you built earlier on the screen. When the master is edited, the instance updates automatically.
Property overrideOverride an inner widget's properties per instance to display it differently. Revert the override and it follows the master value again.
Variable initial valuesGive component variables different initial values in each instance.
Variable exposure and bindingRead and write the variables a component exposes from a script, and get an event when a value changes.

How to use

  1. Open the Contents category in the left widget palette.
  2. Drag and drop the Component item onto the canvas.
  3. In the Properties panel on the right, choose the component master to display (id).
  4. Adjust per-instance property overrides and variable initial values if needed.

Properties

PropertyDescriptionDefaultValue / type
idIdentifier of the component master to displayEmpty (no component selected)String (component master ID)

Notes and tips

note

The Component widget appears on screen only once you set the component master to display (id). Without it, nothing is drawn.

warning

If a component contains itself directly or indirectly — a circular reference — that instance isn't drawn and shows an error indicator instead. Nesting depth is limited as well.

Learn more

tip

For the full set of Widget Control members (Property, Method, Event) you can script on this widget, visit Component Widget Control.