WidgetManifest

Interface

The widget manifest

Inheritance: WidgetManifestManifest

Properties

dataActions optional
dataActions: DataActionProperty[]

The data actions provided by the widget

defaultSize optional
defaultSize: Size

The initial size the widget will be when added into an app.

dependency optional
dependency: string | string[]

Use this property to load third-party libraries. Pass an absolute URL to a library. See the Using third-party libraries guide for more information.

Alternatively, a widget can define its own dependencies by providing aDependencyDefine extension.

Pre-defined dependencies:

  • jimu-arcgis: will load the jimu-arcgis package that will load the ArcGIS API for JavaScript.
exbVersion
exbVersion: string

A widget may only support certain framework versions due to breaking API changes, so this property allows the widget/theme to define the framework version that it supports. This version check is not currently enforced, but will be enforced in the future.

excludeDataActions optional
excludeDataActions: string[]

Exclude those data actions in setting and runtime

extensions optional
extensions: ExtensionProperties[]

Extensions provided by the widget.

i18nMessages
i18nMessages: any

You don't need to add this property in your code, this property is added at runtime.

Save the current locale only, but not the default locale. The default string should be written in manifest. There are some conventional keys:widgetLabel: the widget label. _actionlabel: the action label. _extlabel: the extension label. _layout_label: the layout label.

label
label: string

This should be same as the _widgetLabel value in translation/default.ts

layouts optional
layouts: {}[]

Valid only when the hasEmbeddedLayout is true.

messageActions optional
messageActions: BaseActionProperty[]

The message actions provided by the widget.

name
name: string

The name must be unique and same as folder name.

properties optional
properties: WidgetManifestProperties

Widget manifest properties

publishMessages optional
publishMessages: MessageType | PublishMessageProperty[]

The message types published by the widget.

settingDependency optional
settingDependency: string | string[]

Dependency for setting component. See dependency

translatedLocales optional
translatedLocales: string[]

The translated locales the widget provides. Each entry should be a string representing the language version as defined in BCP 47. Examples of valid language codes include "en", "en-US", "fr", "fr-FR", "es-ES", etc. By convention, the default locale is listed first.

version
version: string

The widget/theme version.

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