Interface
The base interface for both widgets and themes.
Properties
Property | Type | Notes |
---|---|---|
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. | |
any | You don't need to add this property in your code, this property is added at runtime. | |
string | This should be same as the | |
string | The name must be unique and same as folder name. | |
boolean | 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. | |
string | The widget/theme version. The format of the version must follow this pattern: MAJOR.MINOR.PATCH, see semver for details. |
exbVersion
Interface PropertyexbVersion: 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.
i18nMessages
Interface Propertyi18nMessages: 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.action<action name>_label: the action label.ext<extension name>_label: the extension label.layout<layout name>_label: the layout label.
label
Interface Propertylabel: string
This should be same as the _widgetLabel
value in translation/default.ts
notAllowAdd
notAllowAdd: boolean
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.
version
Interface Propertyversion: string
The widget/theme version. The format of the version must follow this pattern: MAJOR.MINOR.PATCH, see semver for details.