Function: defineCanvasWidget()

defineCanvasWidget<P>(type, metadataOf): void

Defines the React component to be a canvas widget.

A component cannot be rendered by canvas as widget unless explicitly defined as such using this function.

Example:

function MyWidget(props) {
   ...
}

defineCanvasWidget(MyWidget, element => ({
    element,
    attachment: 'viewport'
}));

Type Parameters

Type Parameter
`P`

Parameter	Type
`type`	`ComponentType`<`P`>
`metadataOf`	(`element`) => `CanvasWidgetDescription`

void