ArkTS Widget Related Modules

Figure 1 ArkTS widget related modules WidgetModules

  • FormExtensionAbility: provides lifecycle callbacks invoked when a widget is created, destroyed, or updated.

  • FormExtensionContext: provides context for FormExtensionAbilities. You can use the APIs of this module to start FormExtensionAbilities.

  • formProvider: provides APIs related to the widget provider. You can use the APIs to update a widget, set the next update time for a widget, obtain widget information, and request a widget release.

  • formInfo: provides types and enums related to the widget information and state.

  • formBindingData: provides APIs for widget data binding. You can use the APIs to create a FormBindingData object and obtain related information.

  • Page Layout (Card.ets): provides APIs for a declarative paradigm UI.

    • ArkTS widget capabilities: include the postCardAction API used for interaction between the widget internal and the provider application and can be called only in the widget.
    • ArkTS widget capability list: lists the APIs, components, events, attributes, and lifecycle callbacks that can be used in ArkTS widgets.

  • Widget configuration: includes FormExtensionAbility configuration and widget configuration.

    • Configure FormExtensionAbility information under extensionAbilities in the module.json5 file.
    • Configure the widget configuration information (WidgetCard.ets) in the form_config.json file in resources/base/profile.