Skip to main content
Authoring options accepted by defineWidget.

Properties

string
Builder palette category.
ComponentType<Props & object>
required
React component rendered by the Remote DOM worker.
"inline" | "block" | "card" | "fullscreen"
Host layout treatment for the widget.
Partial<Props>
JSON-serializable props assigned to new widget instances.
string
Builder palette description of the widget’s purpose.
string
Human-readable builder palette name.
string
Icon identifier displayed in the builder palette.
string
Oldest portal SDK version that can host the widget.
Name
required
Stable URL-safe widget name used in the canonical widget type.
WidgetSourcePropertySchema
JSON-serializable property editor schema.
WidgetSourceResizable
Builder resize behavior and optional minimum dimensions.
readonly DeclarativeCapabilityUse | AnyPortalFunction[]
Type: DeclarativeCapabilityUseTyped portal functions and declarative capabilities used by the widget.