Skip to main content

WidgetContainer

Interfaces

WidgetContainerProps

Properties

PropertyTypeDescriptionDefined in
heightstringHeight of the widget container.canvas/components/WidgetContainer.tsx:21
idstringID of the widget.canvas/components/WidgetContainer.tsx:13
setSetting(setting: WidgetSetting) => voidCallback function to update the setting of the specific widget.canvas/components/WidgetContainer.tsx:17
settingWidgetSettingThe setting of the widget.canvas/components/WidgetContainer.tsx:15
widthstringWidth of the widget container.canvas/components/WidgetContainer.tsx:19

Functions

default()

default(__namedParameters): Element

The widget container component that wraps around each user widget.

It wraps the widget in a draggable container with a grip handle on the top right corner on hover. It adds no padding within the container to allow users to have full control over the appearance.

If the child (i.e., the widget) throws a rendering error, it will be caught by the error boundary and displayed with the ErrorDisplay component.

Parameters

ParameterType
__namedParametersPropsWithChildren<WidgetContainerProps>

Returns

Element

Defined in

canvas/components/WidgetContainer.tsx:34