改进 widget

本页详细介绍了从 Android 12（API 级别 31）开始提供的可选 widget 增强功能。这些功能是可选的，但实现和提升用户的 widget 体验非常简单。

使用动态配色

从 Android 12 开始，微件可以为按钮、背景和其他组件使用设备主题颜色。这可以实现更顺畅的过渡，并在不同的 widget 之间保持一致。

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

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

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

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

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

• ?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.widget 采用深色主题。

提示： 我们建议您使用 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 助理显示 widget 来响应相关的用户语音指令。通过将 widget 配置为响应内置 intent (BII)，您的应用可以在 Android 和 Android Auto 等 Google 助理 surface 上主动显示 widget。用户可以选择将 Google 助理显示的 widget 固定到其启动器上，以鼓励将来的互动。

例如，您可以为锻炼应用配置锻炼摘要 widget，以便执行触发 GET_EXERCISE_OBSERVATION BII 的用户语音指令。当用户通过发出“Hey Google, how many miles have I run this week on ExampleApp?”这样的请求触发此 BII 时，Google 助理会主动显示您的 widget。

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

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

Android 12 可让您通过添加动态 widget 预览和 widget 说明来改进应用的 widget 选择器体验。

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

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

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

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

我们建议使用与实际 widget 相同的布局，并采用真实的默认值或测试值。大多数应用使用相同的 previewLayout 和 initialLayout。如需了解如何创建准确的预览布局，请参阅本页中的以下部分。

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

构建准确预览的推荐方法

如需实现可缩放的 widget 预览，请使用 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"）。

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

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

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

向后兼容可缩放的 widget 预览

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

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

为微件添加说明

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

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

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

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

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

您可以在以前的 Android 版本上使用 descriptionRes 属性，但微件选择器会忽略该属性。

实现更流畅的过渡

从 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 开始，如果广播接收器或服务是从 widget 点击的 PendingIntent 发起的，则应用仍然可以从该 activity 启动 activity。不过，新的应用动画不会用于从广播接收器或服务启动的应用，这会导致用户体验不佳。

您的应用可以在以前的 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);