WidgetManifest

The data actions provided by the widget

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

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.

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.

Exclude those data actions in setting and runtime

Extensions provided by the widget.

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

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

Valid only when the hasEmbeddedLayout is true.

The message actions provided by the widget.

The name must be unique and same as folder name.

Whether the widget can be added to the app, default is false. Widgets that will be deprecated can set this property to true. The code is still available, but the widget will not be shown in the widget list.

Widget manifest properties

The message types published by the widget.

The license that the widget requires to work. An icon will be displayed on the widget card if this property is set.

Dependency for setting component. See WidgetManifest.dependency

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.

Declare the URL parameters that the widget supports

The widget/theme version. The format of the version must follow this pattern: MAJOR.MINOR.PATCH, see semver for details.