ControlDefinition

Defines a custom control component that can be rendered in the UI at various breakpoints.

Properties

id

Type:

string (required)

Unique control identifier.

label

Type:

string (required)

Accessible label for the control.

render

Type:

ComponentType (required)

A React/Preact component to render. Receives Context as props (or PluginContext when used in a plugin manifest).

Copy
const MyControl = ({ context }) => {
  const { appState, pluginState } = context
  return <div>Custom control content</div>
}

mobile

Type:

ControlBreakpointConfig (required)

Mobile breakpoint configuration. See Breakpoint Configuration below.

tablet

Type:

ControlBreakpointConfig (required)

Tablet breakpoint configuration. See Breakpoint Configuration below.

desktop

Type:

ControlBreakpointConfig (required)

Desktop breakpoint configuration. See Breakpoint Configuration below.

Breakpoint Configuration

Each breakpoint (mobile, tablet, desktop) accepts the following properties:

slot

Type:

string (required)

The slot where the control should appear at this breakpoint. Slots are named regions in the UI layout.