实现 Glance 主题

Glance 提供了一个用于管理色彩主题的 API。对于其他样式属性(例如 TextStyle),请声明顶级变量。

添加颜色

Glance 原生提供 Material 颜色的实现。如需使用内置主题,请使用 GlanceTheme 封装顶级可组合项,如以下示例所示。

在支持动态配色的设备上,此主题派生自用户特定的平台颜色。在其他设备上,此功能会回退到 Material 基准主题。通过 GlanceTheme.colors,使用已封装主题中的颜色来设置样式。您可以在需要颜色的任意位置使用主题中的这些值。

override suspend fun provideGlance(context: Context, id: GlanceId) {

    provideContent {
        GlanceTheme {
            MyContent()
        }
    }
}

@Composable
private fun MyContent() {

    Image(
        colorFilter = ColorFilter.tint(GlanceTheme.colors.secondary),
        // ...

    )
}

如需自定义主题,您可以将 colors 传递给 GlanceTheme。Glance 提供了 androidx.glance:glance-material 互操作性库(适用于 Material 2)和 androidx.glance:glance-material3(适用于 Material 3 颜色支持)。

例如,将应用的现有 Material 颜色提供给 ColorProviders API,以创建 Glance 配色方案,如以下代码段所示:

// Remember, use the Glance imports
// import androidx.glance.material3.ColorProviders

// Example Imports from your own app
// import com.example.myapp.ui.theme.DarkColors
// import com.example.myapp.ui.theme.LightColors

object MyAppWidgetGlanceColorScheme {

    val colors = ColorProviders(
        light = LightColors,
        dark = DarkColors
    )
}

将配色方案中的颜色提供给封装所有可组合项的 GlanceTheme,如以下示例所示:

override suspend fun provideGlance(context: Context, id: GlanceId) {
    // ...

    provideContent {
        GlanceTheme(colors = MyAppWidgetGlanceColorScheme.colors) {
            MyContent()
        }
    }
}

@Composable
private fun MyContent() {

    Image(
        colorFilter = ColorFilter.tint(GlanceTheme.colors.secondary),
        // ...
    )
}

如果您希望在支持的情况下使用壁纸中的动态颜色,否则使用应用的配色方案,则可以在 GlanceTheme 中有条件地传递应用的配色方案。如以下代码段所示:

override suspend fun provideGlance(context: Context, id: GlanceId) {

    provideContent {
        GlanceTheme(
            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S)
                GlanceTheme.colors
            else
                MyAppWidgetGlanceColorScheme.colors
        ) {
            MyContent()
        }
    }
}

@Composable
private fun MyContent() {
    // ...
    Image(
        colorFilter = ColorFilter.tint(GlanceTheme.colors.secondary),
        // ...
    )
}

添加形状

如需为应用 widget 提供特殊形状或阴影,请使用 Android Drawables API。

例如,以下代码段展示了如何创建可绘制对象(形状):

<shape xmlns:android="http://schemas.android.com/apk/res/android">
    <corners android:radius="16dp"/>
    <stroke android:color="@color/outline_color" android:width="1dp"/>
</shape>

将其提供给目标可组合项:

GlanceModifier.background(
    imageProvider = ImageProvider(R.drawable.button_outline)
)