Color.md

Color theming

The Material 3 color theming system can be used to create a color scheme that reflects your brand or style.

The Material 3 color theming system uses an organized approach to apply colors to your UI. Material components use theme colors and their variations to style backgrounds, text, and more.

Design & API Documentation

• Material Design guidelines: Color

Using The Color Theming System

All Material 3 components use a Widget.Material3 style, and these styles reference color attributes from the Material 3 theme (Theme.Material3). It is easy to customize those color attributes across your app by simply overriding them in your theme. We provide three accent color groups (Primary, Secondary, Tertiary), each with 4-5 color roles that you can customize to represent your brand color:

Color Role	Android Attribute	Light Theme Baseline (Dynamic) Color	Dark Theme Baseline (Dynamic) Color
Primary	colorPrimary	#ff6750a4 (system_accent1_600)	#ffd0bcff (system_accent1_200)
On Primary	colorOnPrimary	white (system_accent1_0)	#ff381e72 (system_accent1_800)
Primary Container	colorPrimaryContainer	#ffeaddff (system_accent1_100)	#ff4f378b (system_accent1_700)
On Primary Container	colorOnPrimaryContainer	#ff21005d (system_accent1_900)	#ffeaddff (system_accent1_100)
Inverse Primary	colorPrimaryInverse	#ffd0bcff (system_accent1_200)	#ff6750a4 (system_accent1_600)
Secondary	colorSecondary	#ff625b71 (system_accent2_600)	#ffccc2dc (system_accent2_200)
On Secondary	colorOnSecondary	white (system_accent2_0)	#ff332d41 (system_accent2_800)
Secondary Container	colorSecondaryContainer	#ffe8def8 (system_accent2_100)	#ff4a4458 (system_accent2_700)
On Secondary Container	colorOnSecondaryContainer	#ff1d192b (system_accent2_900)	#ffe8def8 (system_accent2_100)
Tertiary	colorTertiary	#ff7d5260 (system_accent3_600)	#ffefb8c8 (system_accent3_200)
On Tertiary	colorOnTertiary	white (system_accent3_0)	#ff492532 (system_accent3_800)
Tertiary Container	colorTertiaryContainer	#ffffd8e4 (system_accent3_100)	#ff633b48 (system_accent3_700)
On Tertiary Container	colorOnTertiaryContainer	#ff31111d (system_accent3_900)	#ffffd8e4 (system_accent3_100)

By changing these color attributes, you can easily change the styles of all the Material components that use your theme.

The Material Design color theming system provides additional colors which don't represent your brand, but define your UI and ensure accessible color combinations. These additional color attributes are as follows:

Color Role	Android Attribute	Light Theme Baseline (Dynamic) Color	Dark Theme Baseline (Dynamic) Color
Error	colorError	#ffb3261e (Same)	#fff2b8b5 (Same)
On Error	colorOnError	white (Same)	#ff601410 (Same)
Error Container	colorErrorContainer	#fff9dedc (Same)	#ff8c1d18 (Same)
On Error Container	colorOnErrorContainer	#ff410e0b (Same)	#fff9dedc (Same)
Outline	colorOutline	#ff79747e (system_neutral2_500)	#ff938f99 (system_neutral2_400)
Outline Variant	colorOutlineVariant	#ffcac4d0 (system_neutral2_200)	#ff49454f (system_neutral2_700)
Background	android:colorBackground	#fffffbfe (system_neutral1_10)	#ff1c1b1f (system_neutral1_900)
On Background	colorOnBackground	#ff1c1b1f (system_neutral1_900)	#ffe6e1e5 (system_neutral1_100)
Surface	colorSurface	#fffffbfe (system_neutral1_10)	#ff1c1b1f (system_neutral1_900)
On Surface	colorOnSurface	#ff1c1b1f (system_neutral1_900)	#ffe6e1e5 (system_neutral1_100)
Surface Variant	colorSurfaceVariant	#ffe7e0ec (system_neutral2_100)	#ff49454f (system_neutral2_700)
On Surface Variant	colorOnSurfaceVariant	#ff49454f (system_neutral2_700)	#ffcac4d0 (system_neutral2_200)
Inverse Surface	colorSurfaceInverse	#ff313033 (system_neutral1_800)	#ffe6e1e5 (system_neutral1_100)
Inverse On Surface	colorOnSurfaceInverse	#fff4eff4 (system_neutral1_50)	#ff313033 (system_neutral1_800)

Using Surface Colors

Material 3 uses primary colored elevation overlays to present a visual hierarchy with different elevations in both light and dark themes. Material 3 themes enable this by default with setting ?attr/elevationOverlayColor to ?attr/colorPrimary.

Elevation overlays use the following theme attributes:

Attribute Name	Description	Default Value
elevationOverlayEnabled	Whether the elevation overlay functionality is enabled.	true
elevationOverlayColor	The color used for the elevation overlays, applied at an alpha based on elevation.	colorPrimary

If inheriting from the Theme.Material3 theme or a descendant, you most likely do not have to set these attributes yourself because Material themes use the defaults shown above.

The elevation overlays will be applied to surface colors to create tonal variations. Within the Material 3 color palette, there are five predefined surface tonal variations (Surface1-5) which are used as the default surface colors (by applying different elevations) of different Material 3 components. However, these surface tonal colors are NOT implemented as color resources, but their actual color values are calculated on the fly with the ?attr/elevationOverlayColor, as mentioned above.

In a practical scenario, you have three ways to include those tonal surface colors in your app:

Material Design Components

The easiest way to use surface colors with tonal variations is with Material Design Components, which have built-in support for tonal surface colors/elevation overlays. You can customize surface colors of those components by changing their elevation.

Here is a list of Material components that support elevation overlays. These components have colorSurface set as the default background color and can be elevated:

• Top App Bar
• Bottom App Bar
• Bottom Navigation
• Button
• Floating Action Button
• Chip
• Tabs
• Card
• Dialog
• Menu
• Bottom Sheet
• Navigation Drawer
• Switch
• Date Picker
• Time Picker

SurfaceColors enums

If using Material Design Components is not an option in your use case, you may want to consider getting those tonal surface colors on the fly, by using the convenient enums we provide in the Material Library. For example, if you want to get the color hex value of Surface1, you can do:

int colorSurface1 = SurfaceColors.SURFACE_1.getColor(context);

This will return the calculated tonal surface color corresponding to the Surface1 definition and your ?attr/elevationOverlayColor setting in your themes.

MaterialShapeDrawable or ElevationOverlayProvider (advanced)

If you have a complicated use case, you can check if com.google.android.material.shape.MaterialShapeDrawable or com.google.android.material.elevation.ElevationOverlayProvider would serve your needs. These two classes provide a set of APIs to help you calculate and render blended colors according to different background colors and elevations, with the same elevation overlay formula used across the Material libraries. Use them carefully to ensure a consistent look and feel for your app.

Using dynamic colors

Starting from Android S, the framework provides the ability to support dynamic colors in your UI based on the user's wallpaper or color choice on the device.

To help in the application of dynamic colors, the Material 3 library provides 3 theme overlays to be used on the base Material 3 themes:

• ThemeOverlay.Material3.DynamicColors.Light
• ThemeOverlay.Material3.DynamicColors.Dark
• ThemeOverlay.Material3.DynamicColors.DayNight (select day/night mode automatically.)

To make it easier to implement dynamic color solutions, the Material 3 library provides a helper class to apply dynamic colors: com.google.android.material.color.DynamicColors. There are several ways to use this helper class according to different scenarios:

Apply dynamic colors to all activities in the app

In your application class’ onCreate() method, call:

DynamicColors.applyToActivitiesIfAvailable(this);

This will register an ActivityLifeCycleCallbacks to your application and if the app is running on Android S+ it will attempt to apply the dynamic color theme overlay specified by R.attr.dynamicColorThemeOverlay in your app/activity theme in the onActivityPreCreated() callback method.

If you are using Material 3 themes, R.attr.dynamicColorThemeOverlay will be ThemeOverlay.Material3.DynamicColors.Light/Dark by default.

You can also have finer control over theme overlay deployment by providing a precondition when calling the method:

DynamicColors.applyToActivitiesIfAvailable(this, (activity, themeResId) -> {
  // ...implement your own logic here. Return `true` if dynamic colors should be applied.
});

Or provide your own customized dynamic color theme overlays, likely inheriting from the Material3 theme overlays above, by doing:

DynamicColors.applyToActivitiesIfAvailable(this, R.style.ThemeOverlay_MyApp_DynamicColors_DayNight);

Note: If you are applying your own non-dynamic theme overlays to override Material colors in certain activities, fragments, layouts, etc., the dynamic colors will be overwritten by your theme overlays as well because dynamic colors are applied before activities are created. If that’s not the desired behavior you want, you will need to either stop overriding Material colors in your theme overlays or customize them with a proper dynamic color definition.

Apply dynamic colors to a specific activity

You can also opt to apply dynamic colors to a few specific activities, by calling the following method in your activities’ onCreate() method (or before you inflate anything from it):

DynamicColors.applyToActivityIfAvailable(this);

If the app is running on Android S+, dynamic colors will be applied to the activity. You can also apply a custom theme overlay or a precondition as depicted in the application section above.

Apply dynamic colors to all activities in the app using DynamicColorsOptions

You also have the option to apply dynamic colors to all activities in the app by passing in a DynamicColorsOptions object. When constructing DynamicColorsOptions, you may optionally specify a customized theme overlay, likely inheriting from the Material3 theme overlays above and/or a precondition, to have finer control over theme overlay deployment. You may also optionally specify an OnAppliedCallback function, which will be called after dynamic colors have been applied:

DynamicColorsOptions dynamicColorOptions =
    new DynamicColorsOptions.Builder()
        .setThemeOverlay(themeOverlay)
        .setPrecondition(precondition)
        .setOnAppliedCallback(onAppliedCallback)
        .build()
DynamicColors.applyToActivitiesIfAvailable(application, dynamicColorOptions);

Apply dynamic colors to a specific activity using DynamicColorsOptions

You can also apply dynamic colors to a specific activity in the app by passing in the specific activity and a DynamicColorsOptions object:

DynamicColorsOptions dynamicColorOptions =
    new DynamicColorsOptions.Builder()
        .setThemeOverlay(themeOverlay)
        .setPrecondition(precondition)
        .setOnAppliedCallback(onAppliedCallback)
        .build()
DynamicColors.applyToActivityIfAvailable(activity, dynamicColorOptions);

Apply dynamic colors to a specific fragment/view

Applying dynamic colors to a few of the views in an activity is more complex. The easiest solution is to create a themed context to create the view. We provide a helper method for this purpose:

context = DynamicColors.wrapContextIfAvailable(context);

This method will return a context with the dynamic color theme overlay applied, if dynamic colors are available on the device.

Note: No matter which approach you follow, you will have to have M3 base themes (for example Theme.Material3.DayNight.NoActionBar) applied first to make dynamic color theme overlays work, because they use all of the same color theme attributes.

Custom Colors

Material 3 uses a purple hue for default accent colors if dynamic colors are not available. If you need different brand colors in your app, you may want to define custom colors for your theme. Keep in mind that the default Material 3 styles generally use colors in the following combinations:

Container Color	Content Color
Surface / Surface Variant	On Surface / On Surface Variant / Primary / Secondary / Error
Primary	On Primary
Primary Container	On Primary Container
Secondary	On Secondary
Secondary Container	On Secondary Container
Tertiary	On Tertiary
Tertiary Container	On Tertiary Container

So if you change one of those colors, you may want to change their related colors to maintain the visual consistency and the contrast requirement of Material components.

These color theme attributes can be customized in a theme that inherits from one of the "baseline" Theme.Material3.* themes. Dynamic color theme overlays (ThemeOverlay.Material3.DynamicColors.*) can be applied on top of a customized "baseline" theme.

[Important] Be careful to maintain the same luminance level when creating custom colors so the contrast requirement won't be broken. For example, since the default Primary color in light theme has a luminance level of 40, it would be best to use a luminance level of 40 with your custom Primary color as well, in order to avoid accidentally breaking the contrast requirement in certain components.

Defining custom colors

When creating app colors, do not use the same name as the color slot:

<resources>
  <color name="color_primary">...</color>
  <color name="color_surface">...</color>
</resources>

Instead use literal names relevant to the RGB value, for example:

<resources>
  <color name="brand_blue">...</color>
  <color name="brand_grey">...</color>
</resources>

Theming an Individual Component

If you want to change the color of just one instance of a component without changing theme-level attributes, create a new component style that extends from a Widget.Material3 style.

For example, if you want to change MaterialButton so that it uses colorSecondary for its background tint rather than the default color, define your own button style that extends from a Material Design style and set the mapping yourself:

<style name="Widget.MyApp.Button" parent="Widget.Material3.Button">
  <item name="backgroundTint">?attr/colorSecondary</item>
</style>

You would then apply the Widget.MyApp.Button style to any buttons you want to have this alternate style.

Theming All Instances of One Component

If you want to change the default styles for all instances of a component, for example 'MaterialButton', modify the materialButtonStyle attribute in your theme.

<style name="Theme.MyApp" parent="Theme.Material3.Light.NoActionBar">
  ...
  <item name="materialButtonStyle">@style/Widget.MyApp.Button</item>
  ...
</style>

This will set the default style of any 'MaterialButtons' in the app to Widget.MyApp.Button. Similar default style attributes exist for most other components, for example tabStyle, chipStyle, and textInputStyle.

Theme Attribute Mapping

All MDC-Android components have been updated to use the theme attributes described above, when applicable.

To understand how the high-level theme attributes map to specific parts of each component, please refer directly to the component's documentation.

Using Color Harmonization

Color harmonization solves the problem of "How do we ensure any particular Reserved color (eg. those used for semantic or brand) looks good next to a user's dynamically-generated color?"

Harmonize a color with colorPrimary

To make it easier to implement color harmonization to ensure visual cohesion in any M3 themes with dynamic colors enabled, MDC-Android provides the following MaterialColors helper method in the com.google.android.material.color package:

In your application class or activity/fragment/view, call:

int harmonizedColor = MaterialColors.harmonizeWithPrimary(context, colorToHarmonize);

This method will find the context theme's colorPrimary, and shift the hue of the input color, colorToHarmonize, towards the hue of colorPrimary. This will leave the input color recognizable while still meaningfully shifting it towards colorPrimary.

Note: If the input color colorToHarmonize is the same as colorPrimary, harmonization won't happen and colorToHarmonize will be returned.

Color Resources Harmonization

We've provided the HarmonizedColors and HarmonizedColorsOptions classes in the com.google.android.material.color package for color resources harmonization. HarmonizedColorsOptions.Builder is a Builder class and to construct a HarmonizedColorsOptions. You can optionally pass in an array of resource ids for the color resources you'd like to harmonize, a HarmonizedColorAttributes object and/or the color attribute to harmonize with:

HarmonizedColorsOptions options =
    new HarmonizedColorsOptions.Builder()
        .setColorResourceIds(colorResources)
        .setColorAttributes(HarmonizedColorAttributes.create(attributes))
        .setColorAttributeToHarmonizeWith(colorAttributeResId)
        .build();

In the HarmonizedColorsOptions class, we also provided a convenience method createMaterialDefaults(), with Error colors being harmonized by default.

HarmonizedColorsOptions options = HarmonizedColorsOptions.createMaterialDefaults();
HarmonizedColors.applyToContextIfAvailable(context, options);

If you need to harmonize color resources at runtime to a context and use the harmonized color resources in xml, call:

HarmonizedColors.applyToContextIfAvailable(context, harmonizedColorsOptions);

To return a new Context with color resources being harmonized, call:

HarmonizedColors.wrapContextIfAvailable(context, harmonizedColorsOptions);

HarmonizedColorAttributes

Static Factory Methods	Description
HarmonizedColorAttributes.create(int[] attributes)	Provides an int array of attributes for harmonization
HarmonizedColorAttributes.create(int[] attributes, int themeOverlay)	Provides a themeOverlay, along with the int array of attributes from the theme overlay for harmonization.
HarmonizedColorAttributes.createMaterialDefaults()	Provides a default implementation of HarmonizedColorAttributes, with Error colors being harmonized.

If the first static factory method is used, the color resource's id and value of the attribute will be resolved at runtime and the color resources will be harmonized.

Note: The way we harmonize color attributes is by looking up the color resource the attribute points to, and harmonizing the color resource directly. If you are looking to harmonize only color resources, in most cases when constructing HarmonizedColorsOptions, the setColorResourceIds(colorResources) method should be enough.

If you're concerned about accidentally overwriting color resources, the second static factory method should be used. In this method, instead of the color resource that the color attribute is pointing to in the main theme/context being harmonized directly, the color resources pointed by the color attributes after the theme overlay is applied will be harmonized. In the theme overlay, the color resources pointed by the color attributes are dummy values, to avoid color resources that the color attributs are pointing to in the main theme/context be overridden.

Here is an example of how we harmonize Error colors with theme overlay, to avoid accidentally overriding the resources from the main theme/context. We have an array of color attributes defined as:

private static final int[] HARMONIZED_MATERIAL_ATTRIBUTES =
      new int[] {
        R.attr.colorError,
        R.attr.colorOnError,
        R.attr.colorErrorContainer,
        R.attr.colorOnErrorContainer
      };

And a theme overlay defined as:

<style name="ThemeOverlay.Material3.HarmonizedColors" parent="">
    <item name="colorError">@color/material_harmonized_color_error</item>
    <item name="colorOnError">@color/material_harmonized_color_on_error</item>
    <item name="colorErrorContainer">@color/material_harmonized_color_error_container</item>
    <item name="colorOnErrorContainer">@color/material_harmonized_color_on_error_container</item>
</style>

With this theme overlay, instead of directly overwriting the resources that colorError, colorOnError, colorErrorContainer, and colorOnErrorContainer point to in the main theme/context, we would:

1. look up the resource values in the Context themed by the theme overlay
2. retrieve the harmonized resources with Primary
3. override @color/material_harmonized_color_error, @color/material_harmonized_color_on_error, etc. with the harmonized colors

That way the Error roles in the theme overlay would point to harmonized resources.

If you would like to harmonize additional color attributes along with harmonizing Error roles by default, the HarmonizedColorAttributes would look like:

HarmonizedColorAttributes.create(
    ArrayUtils.addAll(createMaterialDefaults().getAttributes(), myAppAttributes),
    R.style.ThemeOverlay_MyApp_HarmonizedColors);

Note: For your custom theme overlay R.style.ThemeOverlay_MyApp_HarmonizedColors, we recommend you to extend from our theme overlay at R.style.ThemeOverlay_Material3_HarmonizedColors.

You can also use color resources harmonization separate from dynamic colors if needed, but the general use case for color resources harmonization is after dynamic colors have been applied, to ensure visual cohesion for reserved colors (e.g. semantic colors) in a M3 theme with dynamic colors enabled. A Material suggested default when applying dynamic colors, is to harmonize M3 Error colors in the callback when constructing DynamicColorsOptions:

DynamicColorsOptions dynamicColorOptions =
    new DynamicColorsOptions.Builder(activity)
        ...
        .setOnAppliedCallback(
            activity ->
                HarmonizedColors.applyToContextIfAvailable(
                    activity,
                    HarmonizedColorsOptions.createMaterialDefaults()))
        .build()
DynamicColors.applyToActivityIfAvailable(activity, dynamicColorOptions);

For color ressources harmonization in a fragment/view, you would use the context generated from applying dynamic colors when constructing HarmonizedColorsOptions and call wrapContextIfAvailable(harmonizedColorsOptions) to apply resources harmonization:

Context newContext = DynamicColors.wrapContextIfAvailable(getContext());

HarmonizedColorsOptions options =
    new HarmonizedColorsOptions.Builder()
        .setColorResources(colorResources)
        .build();
Context harmonizedContext = HarmonizedColors.wrapContextIfAvailable(newContext, options);
// Usage example with the new harmonizedContext.
MaterialColors.getColor(harmonizedContext, R.attr.customColor, -1);

Note: This is only supported for API 30 and above.

Color role mapping utilities

M3 schemes also include roles for much of the semantic meaning and other conventional uses of color that products are identified with. A single color scheme currently consists of 4 roles for utility colors. The ColorRoles class is available in the com.google.android.material.color package and has getter methods defined for each utility color role. The luminance level value [0, 100] will be shifted for each color role based on the theme LightTheme or DarkTheme, and the Hue and Chroma values of the color role will stay the same.

ColorRoles properties

Name	Method	Description
Accent	getAccent	The accent color, used as the main color from the color role.
On Accent	getOnAccent	Used for content such as icons and text on top of the Accent color.
Accent Container	getAccentContainer	Used with less emphasis than the accent color.
On Accent Container	getOnAccentContainer	Used for content such as icons and text on top of the accent_container color.

The library provides the following two helper methods in the MaterialColors class which return the above-mentioned ColorRoles object:

ColorRoles colorRoles = MaterialColors.getColorRoles(context, color);

or

ColorRoles colorRoles = MaterialColors.getColorRoles(color, /* isLightTheme= */ booleanValue);