ColorScheme

interface ColorScheme : ComposableProperties<ERROR CLASS: Symbol not found for androidx.compose.material3.ColorScheme>

封装了 Material Design 3 的颜色方案(Color Scheme)。

颜色方案包含了一组命名的颜色参数,旨在确保和谐统一的视觉效果、文本的可访问性,并区分 UI 元素和表面。 此接口允许在自动化脚本中查询当前主题的颜色值,或通过声明式的方式自定义主题颜色。

Material 颜色系统基于一系列色调调色板,这些调色板共同创建了浅色和深色方案。

了解更多关于颜色的信息,请参阅 Material Design 颜色

Author

M8Test, [email protected], https://m8test.com

Functions

Link copied to clipboard
abstract fun getBackground(): Color?

获取背景色(Background)。出现在可滚动内容后面的基础背景色。

Link copied to clipboard
abstract fun getError(): Color?

获取错误色(Error)。用于指示组件中的错误,例如文本字段中的无效输入。

Link copied to clipboard
abstract fun getErrorContainer(): Color?

获取错误容器颜色(ErrorContainer)。错误状态的首选色调容器颜色。

Link copied to clipboard
abstract fun getInverseOnSurface(): Color?

获取反向表面上使用的颜色(InverseOnSurface)。与 getInverseSurface 形成良好对比,用于其上的文本和图标。

Link copied to clipboard
abstract fun getInversePrimary(): Color?

获取反向主色(InversePrimary)。在需要反色方案的地方(例如深色 SnackBar 上的按钮)用作“主色”。

Link copied to clipboard
abstract fun getInverseSurface(): Color?

获取反向表面颜色(InverseSurface)。与 getSurface 形成强烈对比,适用于例如 SnackBar 的背景。

Link copied to clipboard
abstract fun getOnBackground(): Color?

获取背景色上使用的颜色(OnBackground)。用于显示在背景色之上的文本和图标。

Link copied to clipboard
abstract fun getOnError(): Color?

获取错误色上使用的颜色(OnError)。用于显示在错误色之上的文本和图标。

Link copied to clipboard
abstract fun getOnErrorContainer(): Color?

获取错误容器上使用的颜色(OnErrorContainer)。用于显示在 getErrorContainer 之上的内容。

Link copied to clipboard
abstract fun getOnPrimary(): Color?

获取主色上使用的颜色(OnPrimary)。用于显示在主色之上的文本和图标。

Link copied to clipboard
abstract fun getOnPrimaryContainer(): Color?

获取主色容器上使用的颜色(OnPrimaryContainer)。用于显示在 getPrimaryContainer 之上的内容。

Link copied to clipboard
abstract fun getOnSecondary(): Color?

获取次色上使用的颜色(OnSecondary)。用于显示在次色之上的文本和图标。

Link copied to clipboard

获取次色容器上使用的颜色(OnSecondaryContainer)。用于显示在 getSecondaryContainer 之上的内容。

Link copied to clipboard
abstract fun getOnSurface(): Color?

获取表面上使用的颜色(OnSurface)。用于显示在表面颜色之上的文本和图标。

Link copied to clipboard
abstract fun getOnSurfaceVariant(): Color?

获取表面变体上使用的颜色(OnSurfaceVariant)。用于显示在 getSurfaceVariant 之上的内容。

Link copied to clipboard
abstract fun getOnTertiary(): Color?

获取三级颜色上使用的颜色(OnTertiary)。用于显示在三级颜色之上的文本和图标。

Link copied to clipboard
abstract fun getOnTertiaryContainer(): Color?

获取三级颜色容器上使用的颜色(OnTertiaryContainer)。用于显示在 getTertiaryContainer 之上的内容。

Link copied to clipboard
abstract fun getOutline(): Color?

获取轮廓色(Outline)。用于边界的细微颜色,如输入框的边框。提供足够的对比度以满足无障碍要求。

Link copied to clipboard
abstract fun getOutlineVariant(): Color?

获取轮廓变体色(OutlineVariant)。用于装饰性元素的边界,当不需要强对比度时使用,例如分割线。

Link copied to clipboard
abstract fun getPrimary(): Color?

获取主色(Primary)。主色是应用屏幕和组件中最频繁显示的颜色,例如用于按钮背景。

Link copied to clipboard
abstract fun getPrimaryContainer(): Color?

获取主色容器颜色(PrimaryContainer)。用于需要比主色更少强调的元素的填充色。

Link copied to clipboard
abstract fun getScrim(): Color?

获取遮罩色(Scrim)。用于遮挡内容的覆盖层颜色,例如对话框后面的半透明背景。

Link copied to clipboard
abstract fun getSecondary(): Color?

获取次色(Secondary)。次色提供了更多方式来强调和区分产品,适用于浮动操作按钮、选择控件、高亮文本等。

Link copied to clipboard
abstract fun getSecondaryContainer(): Color?

获取次色容器颜色(SecondaryContainer)。

Link copied to clipboard
abstract fun getSurface(): Color?

获取表面颜色(Surface)。影响组件表面(如卡片、底部栏和菜单)的基础颜色。

Link copied to clipboard
abstract fun getSurfaceBright(): Color?

获取明亮表面(SurfaceBright)。无论在浅色还是深色模式下,总是比 getSurface 更亮。

Link copied to clipboard
abstract fun getSurfaceContainer(): Color?

获取表面容器(SurfaceContainer)。影响组件容器(如卡片、菜单)的 getSurface 变体。

Link copied to clipboard

获取高强调表面容器(SurfaceContainerHigh)。用于需要比 getSurfaceContainer 更多强调的内容。

Link copied to clipboard

获取最高强调表面容器(SurfaceContainerHighest)。用于需要比 getSurfaceContainerHigh 更多强调的内容。

Link copied to clipboard
abstract fun getSurfaceContainerLow(): Color?

获取低强调表面容器(SurfaceContainerLow)。用于需要比 getSurfaceContainer 更少强调的内容。

Link copied to clipboard

获取最低强调表面容器(SurfaceContainerLowest)。用于需要比 getSurfaceContainerLow 更少强调的内容。

Link copied to clipboard
abstract fun getSurfaceDim(): Color?

获取暗淡表面(SurfaceDim)。无论在浅色还是深色模式下,总是比 getSurface 更暗。

Link copied to clipboard
abstract fun getSurfaceTint(): Color?

获取表面色调(SurfaceTint)。此颜色将由应用色调海拔的组件使用,并覆盖在 getSurface 之上。海拔越高,此颜色越明显。

Link copied to clipboard
abstract fun getSurfaceVariant(): Color?

获取表面变体颜色(SurfaceVariant)。getSurface 的另一种选择,用于区分不同的表面区域。

Link copied to clipboard
abstract fun getTertiary(): Color?

获取三级颜色(Tertiary)。用于平衡主色和次色,或对特定元素(如输入字段)引起高度注意。

Link copied to clipboard
abstract fun getTertiaryContainer(): Color?

获取三级颜色容器(TertiaryContainer)。

Link copied to clipboard
abstract fun isLight(): Boolean

检查此颜色方案是否专为浅色模式设计。

Link copied to clipboard
abstract fun setBackground(colorBuilder: Color.() -> Unit)

设置背景色(Background)。

Link copied to clipboard
abstract fun setError(colorBuilder: Color.() -> Unit)

设置错误色(Error)。

Link copied to clipboard
abstract fun setErrorContainer(colorBuilder: Color.() -> Unit)

设置错误容器颜色(ErrorContainer)。

Link copied to clipboard
abstract fun setInverseOnSurface(colorBuilder: Color.() -> Unit)

设置反向表面上使用的颜色(InverseOnSurface)。

Link copied to clipboard
abstract fun setInversePrimary(colorBuilder: Color.() -> Unit)

设置反向主色(InversePrimary)。

Link copied to clipboard
abstract fun setInverseSurface(colorBuilder: Color.() -> Unit)

设置反向表面颜色(InverseSurface)。

Link copied to clipboard
abstract fun setLight(isLight: Boolean)

设置此颜色方案是否为浅色模式。这会影响某些组件(如状态栏)的默认行为。

Link copied to clipboard
abstract fun setOnBackground(colorBuilder: Color.() -> Unit)

设置背景色上使用的颜色(OnBackground)。

Link copied to clipboard
abstract fun setOnError(colorBuilder: Color.() -> Unit)

设置错误色上使用的颜色(OnError)。

Link copied to clipboard
abstract fun setOnErrorContainer(colorBuilder: Color.() -> Unit)

设置错误容器上使用的颜色(OnErrorContainer)。

Link copied to clipboard
abstract fun setOnPrimary(colorBuilder: Color.() -> Unit)

设置主色上使用的颜色(OnPrimary)。

Link copied to clipboard
abstract fun setOnPrimaryContainer(colorBuilder: Color.() -> Unit)

设置主色容器上使用的颜色(OnPrimaryContainer)。

Link copied to clipboard
abstract fun setOnSecondary(colorBuilder: Color.() -> Unit)

设置次色上使用的颜色(OnSecondary)。

Link copied to clipboard
abstract fun setOnSecondaryContainer(colorBuilder: Color.() -> Unit)

设置次色容器上使用的颜色(OnSecondaryContainer)。

Link copied to clipboard
abstract fun setOnSurface(colorBuilder: Color.() -> Unit)

设置表面上使用的颜色(OnSurface)。

Link copied to clipboard
abstract fun setOnSurfaceVariant(colorBuilder: Color.() -> Unit)

设置表面变体上使用的颜色(OnSurfaceVariant)。

Link copied to clipboard
abstract fun setOnTertiary(colorBuilder: Color.() -> Unit)

设置三级颜色上使用的颜色(OnTertiary)。

Link copied to clipboard
abstract fun setOnTertiaryContainer(colorBuilder: Color.() -> Unit)

设置三级颜色容器上使用的颜色(OnTertiaryContainer)。

Link copied to clipboard
abstract fun setOutline(colorBuilder: Color.() -> Unit)

设置轮廓色(Outline)。

Link copied to clipboard
abstract fun setOutlineVariant(colorBuilder: Color.() -> Unit)

设置轮廓变体色(OutlineVariant)。

Link copied to clipboard
abstract fun setPrimary(colorBuilder: Color.() -> Unit)

设置主色(Primary)。

Link copied to clipboard
abstract fun setPrimaryContainer(colorBuilder: Color.() -> Unit)

设置主色容器颜色(PrimaryContainer)。

Link copied to clipboard
abstract fun setScrim(colorBuilder: Color.() -> Unit)

设置遮罩色(Scrim)。通常是带有透明度的黑色。

Link copied to clipboard
abstract fun setSecondary(colorBuilder: Color.() -> Unit)

设置次色(Secondary)。

Link copied to clipboard
abstract fun setSecondaryContainer(colorBuilder: Color.() -> Unit)

设置次色容器颜色(SecondaryContainer)。

Link copied to clipboard
abstract fun setSurface(colorBuilder: Color.() -> Unit)

设置表面颜色(Surface)。

Link copied to clipboard
abstract fun setSurfaceBright(colorBuilder: Color.() -> Unit)

设置明亮表面(SurfaceBright)。

Link copied to clipboard
abstract fun setSurfaceContainer(colorBuilder: Color.() -> Unit)

设置表面容器(SurfaceContainer)。

Link copied to clipboard
abstract fun setSurfaceContainerHigh(colorBuilder: Color.() -> Unit)

设置高强调表面容器(SurfaceContainerHigh)。

Link copied to clipboard
abstract fun setSurfaceContainerHighest(colorBuilder: Color.() -> Unit)

设置最高强调表面容器(SurfaceContainerHighest)。

Link copied to clipboard
abstract fun setSurfaceContainerLow(colorBuilder: Color.() -> Unit)

设置低强调表面容器(SurfaceContainerLow)。

Link copied to clipboard
abstract fun setSurfaceContainerLowest(colorBuilder: Color.() -> Unit)

设置最低强调表面容器(SurfaceContainerLowest)。

Link copied to clipboard
abstract fun setSurfaceDim(colorBuilder: Color.() -> Unit)

设置暗淡表面(SurfaceDim)。

Link copied to clipboard
abstract fun setSurfaceTint(colorBuilder: Color.() -> Unit)

设置表面色调(SurfaceTint)。通常与主色相同。

Link copied to clipboard
abstract fun setSurfaceVariant(colorBuilder: Color.() -> Unit)

设置表面变体颜色(SurfaceVariant)。

Link copied to clipboard
abstract fun setTertiary(colorBuilder: Color.() -> Unit)

设置三级颜色(Tertiary)。

Link copied to clipboard
abstract fun setTertiaryContainer(colorBuilder: Color.() -> Unit)

设置三级颜色容器(TertiaryContainer)。