WidgetManifestProperties

Interface

Properties that declare the widget capability. Some properties are automatically generated on compilation, and some need to be set in the manifest.json.

Properties

PropertyTypeNotes
boolean

Default value is false. If true, the widget can provide some data records to the batch data action.

boolean

Default value is false. If true, the widget can provide some data records to the data action.

boolean

Default value is false. If true, the widget will be shown in the MapWidgetSelector.

boolean

Default value is false. By default, a widget is constrained in the layout. Set this property as true will make the widget overflow out of the layout.

boolean

Default value is false. If true, the widget can provide a repeat data source.

boolean

Default value is false. By default, a widget does not have background and the background set in the layout style will take effect. If it is true, the background setting in the layout style will be hidden.

boolean

Default value is true.

boolean

Default value is false. If true, flips the icon on RTL.

boolean

This property is automatically set. If runtime/builder-support.tsx exists, this property is true.

boolean

This property is automatically set. If config.json exists, this property is true.

boolean

Default value is true. If false, the builder will not load the setting page. One use case of setting the value to false is when a widget supports inline editing, as it does not need to show the setting page even though it has config.

boolean

Default value is false. If true, the framework will create the layouts for the widget, see layouts property.

boolean

This property is automatically set. If runtime/widget.tsx exists, this property is true.

boolean

This property is automatically set. If setting/setting.tsx exists, this property is true.

boolean

Default value is false. A widget controller widget is used to control (open/close) other widgets.

boolean

Default value is true. If true, the children layout items are constrained in the widget.

boolean

Default value is false.

boolean

Default value is true. If true, the height/width of the widget can be set to auto.

boolean

Default value is false. If true, an edit button will show when widget is selected.

boolean

Default value is false. If true, the widget can be put in a list.

boolean

Default value is false. Set this property to true, the widget can use <ViewportVisibilityContext.Consumer> to get whether the widget is in the browser viewport.

canConsumeBatchDataAction

optional
Interface Property
canConsumeBatchDataAction: boolean

Default value is false. If true, the widget can provide some data records to the batch data action.

canConsumeDataAction

optional
Interface Property
canConsumeDataAction: boolean

Default value is false. If true, the widget can provide some data records to the data action.

canCreateMapView

Interface Property
canCreateMapView: boolean

Default value is false. If true, the widget will be shown in the MapWidgetSelector.

canCrossLayoutBoundary

optional
Interface Property
canCrossLayoutBoundary: boolean

Default value is false. By default, a widget is constrained in the layout. Set this property as true will make the widget overflow out of the layout.

canProvideRepeatDataSource

optional
Interface Property
canProvideRepeatDataSource: boolean

Default value is false. If true, the widget can provide a repeat data source.

coverLayoutBackground

optional
Interface Property
coverLayoutBackground: boolean

Default value is false. By default, a widget does not have background and the background set in the layout style will take effect. If it is true, the background setting in the layout style will be hidden.

deactivateOtherWidgets

optional
Interface Property
deactivateOtherWidgets: boolean

Default value is true.

For map widget, we can set this as false to enable other widgets to interact with map. True, means when this widget is activated, all other widgets will be deactivated. False, means when this widget is activated, will not change other widget's state.

This means there may be more than one active widgets.

flipIcon

optional
Interface Property
flipIcon: boolean

Default value is false. If true, flips the icon on RTL.

hasBuilderSupportModule

Interface Property
hasBuilderSupportModule: boolean

This property is automatically set. If runtime/builder-support.tsx exists, this property is true.

hasConfig

Interface Property
hasConfig: boolean

This property is automatically set. If config.json exists, this property is true.

hasConfigInSettingPage

Interface Property
hasConfigInSettingPage: boolean

Default value is true. If false, the builder will not load the setting page. One use case of setting the value to false is when a widget supports inline editing, as it does not need to show the setting page even though it has config.

hasEmbeddedLayout

Interface Property
hasEmbeddedLayout: boolean

Default value is false. If true, the framework will create the layouts for the widget, see layouts property.

hasMainClass

Interface Property
hasMainClass: boolean

This property is automatically set. If runtime/widget.tsx exists, this property is true.

hasSettingPage

Interface Property
hasSettingPage: boolean

This property is automatically set. If setting/setting.tsx exists, this property is true.

isWidgetController

optional
Interface Property
isWidgetController: boolean

Default value is false. A widget controller widget is used to control (open/close) other widgets.

lockChildren

Interface Property
lockChildren: boolean

Default value is true. If true, the children layout items are constrained in the widget.

needActiveState

optional
Interface Property
needActiveState: boolean

Default value is false.

When user click a widget, we can activate the widget (change the widget state to active), but not all widget needs this active state. So, for performance reason, we do not activate a widget by default.

When this property is true, and when a widget is activated, we'll use deactivateOtherWidgets to check whether deactivate other widgets.

supportAutoSize

Interface Property
supportAutoSize: boolean

Default value is true. If true, the height/width of the widget can be set to auto.

supportInlineEditing

Interface Property
supportInlineEditing: boolean

Default value is false. If true, an edit button will show when widget is selected.

supportRepeat

Interface Property
supportRepeat: boolean

Default value is false. If true, the widget can be put in a list.

watchViewportVisibility

optional
Interface Property
watchViewportVisibility: boolean

Default value is false. Set this property to true, the widget can use <ViewportVisibilityContext.Consumer> to get whether the widget is in the browser viewport.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.