WidgetConfig Interface
Configuration from which a widget is created.
Extends
Properties
Name | Type | Description | |
---|---|---|---|
labelKey Readonly | undefined | string | If set, it is used to define a key that is used to look up a localized string. | |
tooltipKey Readonly | undefined | string | If set, it is used to define a key that is used to look up a localized string. |
Inherited properties
Name | Type | Inherited from | Description |
---|---|---|---|
allowedPanels Readonly | undefined | | Widget | Stage panels to which this widget can be docked. |
badge Readonly | undefined | BadgeType | Widget | |
canFloat Readonly | boolean | CanFloatWidgetOptions | Widget | Set to false to disable floating of a widget. |
canPopout Readonly | undefined | boolean | Widget | Describes if the widget can be popped out to a separate window. |
content Readonly | undefined | ReactNode | Widget | Content of the Widget. |
defaultState Readonly | undefined | WidgetState | Widget | Defaults to Floating if widget is not allowed to dock to any panels. |
icon Readonly | undefined | IconSpec | Widget | |
id Readonly | string | Widget | |
label Readonly | string | ConditionalStringValue | Widget | |
priority Readonly | undefined | number | Widget | |
tooltip Readonly | string | ConditionalStringValue | Widget |
Defined in
Last Updated: 05 April, 2024
Found something wrong, missing, or unclear on this page?
Raise an issue in our repo.