改进 widget

本页详细介绍了从 Android 12（API 级别 31）开始提供的可选 widget 增强功能。这些功能并非必需的，但实现起来很简单，并且可以改善用户的 widget 体验。

使用动态配色

从 Android 12 开始，微件可以为按钮、背景及其他组件使用设备主题颜色。这样可使过渡更流畅，而且还能在不同的微件之间保持一致。

实现动态配色的方法有两种：

• 在根布局中使用系统的默认主题 (@android:style/Theme.DeviceDefault.DayNight)。

• 使用 Material 3 主题 (Theme.Material3.DynamicColors.DayNight) 用于 Android 设备 库开始，从适用于 Android 的 Material 组件开始提供 v1.6.0。

在根布局中设置主题后，您可以在根布局或其任何子布局中使用常见的颜色属性来获取动态颜色。

您可以使用的一些颜色属性示例如下：

• ?attr/primary
• ?attr/primaryContainer
• ?attr/onPrimary
• ?attr/onPrimaryContainer

在使用 Material 3 主题的以下示例中，设备的主题颜色为 “紫色”。强调色和微件背景可适应浅色和深色 如图 1 和图 2 所示。

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
  xmlns:app="http://schemas.android.com/apk/res-auto"
  android:layout_width="match_parent"
  android:layout_height="match_parent"
  android:background="?attr/colorPrimaryContainer"
  android:theme="@style/Theme.Material3.DynamicColors.DayNight">

  <ImageView
    ...
    app:tint="?attr/colorPrimaryContainer"
    android:src="@drawable/ic_partly_cloudy" />

    <!-- Other widget content. -->

</LinearLayout>

图 1. 采用浅色主题的 widget。

图 2.采用深色主题的微件。

提示：建议使用 Material 3 主题，以遵循 Material Design 准则，确保在不同设备之间保持一致性并实现向后兼容性。

动态配色的向后兼容性

动态配色仅适用于搭载 Android 12 的设备 或更高版本。如需为较低版本提供自定义主题，请使用默认主题属性创建一个包含自定义颜色和新限定符 (values-v31) 的默认主题。

下面是一个使用 Material 3 主题的示例：

/values/styles.xml

<resources>
  <style name="MyWidgetTheme" parent="Theme.Material3.DynamicColors.DayNight">
    <!-- Override default colorBackground attribute with custom color. -->
    <item name="android:colorBackground">@color/my_background_color</item>

    <!-- Add other colors/attributes. -->

  </style>
</resources>

/values-v31/styles.xml

<resources>
  <!-- Do not override any color attribute. -->
  <style name="MyWidgetTheme" parent="Theme.Material3.DynamicColors.DayNight" />
</resources>

/layout/my_widget_layout.xml

<resources>
  <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    ...
    android:background="?android:attr/colorBackground"
    android:theme="@style/MyWidgetTheme" />
</resources>

注意： 请参阅样式和主题，了解 有关如何处理不同样式、颜色、属性和主题的深度指南。

启用语音支持

与应用有关的 Action 可让 Google 助理 显示微件以响应相关的用户语音指令。通过配置 微件响应内置 intent (BII)、您的 应用可以主动在 Google 助理界面（例如 Android 和 Android Auto。用户可以选择将 Google 助理显示的 widget 固定到启动器，从而鼓励用户日后继续互动。

例如，您可以为锻炼应用配置“锻炼摘要”微件 执行触发 GET_EXERCISE_OBSERVATION BII。当用户通过发出“Hey Google，我本周在 ExampleApp 上跑了多少英里？”这样的请求来触发此 BII 时，Google 助理会主动显示您的 widget。

有数十个 BII，涵盖多个类别的用户互动， 让几乎所有 Android 应用都能增强其语音微件。如需开始使用，请参阅将与应用有关的 Action 与 Android widget 集成。

改进应用的微件选择器体验

Android 12 可让您改进 通过添加动态微件预览和微件说明来调整您的应用。

向微件选择器添加可缩放的微件预览

从 Android 12 开始，微件选择器中显示的微件预览可缩放。您可以以 XML 布局的形式提供它，并将布局设置为 默认大小。以前，微件预览是静态可绘制资源，在某些情况下，会导致预览在添加到主屏幕后不能准确地反映微件的显示方式。

如需实现可缩放的微件预览，请改用 appwidget-provider 元素的 previewLayout 属性来提供 XML 布局：

<appwidget-provider
    android:previewLayout="@layout/my_widget_preview">
</appwidget-provider>

我们建议使用与实际微件相同的布局，并使用真实的默认值或测试值。大多数应用使用相同的 previewLayout 和 initialLayout。对于 有关创建准确预览布局的指南，请参阅 页面。

我们建议您同时指定 previewLayout 和 previewImage 属性， 以便在用户设备处于登录状态时，您的应用可以回退到使用 previewImage 不支持 previewLayout。previewLayout 属性优先 previewImage 属性。

构建准确预览的推荐方法

如需实现可缩放的微件预览，请使用 appwidget-provider 元素的 previewLayout 属性来提供 XML 布局：

<appwidget-provider
    ...
    android:previewLayout="@layout/my_widget_preview">
</appwidget-provider>

图 3. 默认显示在 3x3 区域内的微件预览，但由于其 XML 布局，可以放入 3x1 区域。

为了显示准确的预览，您可以直接提供实际的 widget 具有默认值的布局，请执行以下操作：

• 为 TextView 元素设置 android:text="@string/my_widget_item_fake_1"。

  注意 ：使用 tools 标记设置的值，例如 tools:text="@string/my_wdiget_item_fake_1"，不会在预览中显示。

• 设置默认或占位图片或图标，例如 android:src="@drawable/my_widget_icon"，适用于 ImageView 组件。

如果没有默认值，预览可能会显示不正确的值或空值。这种方法的一个重要优势是，您可以提供本地化的预览内容。

如需详细了解针对包含 ListView、GridView 或 StackView 的更复杂的预览的推荐方法，请参阅构建包含动态项的精确预览。

向后兼容可缩放的 widget 预览

若要让 Android 11（API 级别 30）或更低版本上的微件选择器显示 widget，请指定 previewImage 属性。

如果您更改微件的外观，请更新预览图片。

为微件添加说明

从 Android 12 开始，请为微件提供要由微件选择器显示的说明。

图 4. 显示 widget 及其说明的示例 widget 选择器。

使用 <appwidget-provider> 元素的 description 属性为微件提供说明：

<appwidget-provider
    android:description="@string/my_widget_description">
</appwidget-provider>

注意： 请简明扼要。没有字符数限制，但表示形式和 可用的说明空间可能会因设备而异。

您可以使用 descriptionRes 属性，但它会被 widget 忽略。 选择器。

实现更流畅的过渡

从 Android 12 开始，启动器提供更顺畅的过渡 当用户从 widget 启动您的应用时触发。

为了实现这种改进的过渡，请使用 @android:id/background 或 android.R.id.background 标识背景元素：

// Top-level layout of the widget.
<LinearLayout
    android:id="@android:id/background">
</LinearLayout>

警告：避免使用广播 trampoline。从 Android 12 开始，应用仍可以从 如果广播接收器或服务是从微件点击的 PendingIntent。不过，新的应用动画将不会用于从广播接收器或服务启动的应用，这会导致用户体验不佳。

您的应用可以在旧版 Android 上使用 @android:id/background 但不会遭到破坏，但会被忽略。

使用 RemoteViews 的运行时修改

从 Android 12 开始，您可以充分利用 提供对 RemoteViews 的运行时修改的 RemoteViews 方法 属性。如需查看所添加方法的完整列表，请参阅 RemoteViews API 参考文档。

以下代码示例展示了如何使用其中的几种方法。

Kotlin

// Set the colors of a progress bar at runtime.
remoteView.setColorStateList(R.id.progress, "setProgressTintList", createProgressColorStateList())

// Specify exact sizes for margins.
remoteView.setViewLayoutMargin(R.id.text, RemoteViews.MARGIN_END, 8f, TypedValue.COMPLEX_UNIT_DP)

Java

// Set the colors of a progress bar at runtime.
remoteView.setColorStateList(R.id.progress, "setProgressTintList", createProgressColorStateList());

// Specify exact sizes for margins.
remoteView.setViewLayoutMargin(R.id.text, RemoteViews.MARGIN_END, 8f, TypedValue.COMPLEX_UNIT_DP);