Google Git
Sign in
android / platform / prebuilts / checkcolor / refs/heads/android13-qpr3-c-s10-release
commit47d4cfb86c5001ef70ef9f9fbed6db04209f1775[log] [tgz]
authorEmber Rose <[email protected]>Fri Feb 04 17:29:26 2022 +0000
committerAutomerger Merge Worker <[email protected]>Fri Feb 04 17:29:26 2022 +0000
tree4195a8a40c9bd7c36fba36d4f782984370666e1b
parent783b39e6b8b498b4217346f5dae17b5da097990e [diff]
parent383d3e0bf16bb52e1c62b3044354caaab498d8fd [diff]
Update checkcolor.py hashbang to Python 3 am: ee59816895 am: 8b7e6cc073 am: 4f8c37e10d am: 383d3e0bf1

Original change: https://android-review.googlesource.com/c/platform/prebuilts/checkcolor/+/1971582

Change-Id: I01a621d1fc21f4e6759f15f9329b11838ec882c1
tree: 4195a8a40c9bd7c36fba36d4f782984370666e1b
  1. checkcolor.jar
  2. checkcolor.py
  3. README.md
README.md

Lint check for hardcoded colors

What is this lint check for

This check detects whether hardcoded colors have been added in a CL.

Starting in Android O, multiple device themes will exist on devices, enabling changing the look and feel of all system UI. In order to make that effort possible, colors in component that uses this check must be specified using theme attributes, rather than hardcoded colors. Otherwise, when the theme changes, this UI will not update properly.

Examples of hardcoded colors

Color files

<!-- File: res/values/colors.xml -->
<?xml version="1.0" encoding="utf-8"?>
<resources>
    <color name="hardcoded_color">#FFFFFF</color>
</resources>

Layout files

<!-- File: res/layout/my_layout.xml -->
<?xml version="1.0" encoding="utf-8"?>
<TextView
    android:textColor="#FF000000" />

Or

<!-- File: res/layout/my_layout.xml -->
<?xml version="1.0" encoding="utf-8"?>
<TextView
    android:textColor="@color/hardcoded_color" />

Style files

<!-- File: res/values/styles.xml -->
<style name="MyStyle">
    <item name="android:textColor">#ff3c3c3c</item>
</style>

How to fix it

Use attributes in theming as much as possible

Here are some tips to choose the colors.

Choose colors for text

Use color attributes specified in the theme. Some examples:

  1. textColorPrimary
  2. textColorSecondary
  3. colorAccent

Choose colors for icon

For vector drawable, please use full opacity color as fillColor and tint it with theme attribute. example

Others

Please check the following table for more available options.

AttributeDescription
colorAccentBright complement to the primary branding color. By default, this is the color applied to framework controls (via colorControlActivated).
colorForegroundColor for foreground imagery. Most text and image colors will be based on some alpha of colorForeground.
colorBackgroundColor of background imagery, ex. full-screen windows.
colorBackgroundFloatingColor of background imagery for floating components, ex. dialogs, popups, and cards.
colorPrimaryThe primary branding color for the app. This is the color applied to the action bar background.
colorPrimaryDarkDark variant of the primary branding color. By default, this is the color applied to the status bar (via statusBarColor) and navigation bar (via navigationBarColor).
colorErrorColor used for error states and things that need to be drawn to the users attention.
textColorPrimary (colorPrimaryText)Is now constructed out of colorForeground and primaryContentAlpha.
textColorSecondary (colorSecondaryText)Is now constructed out of colorForeground and primaryContentAlpha.

How to bypass it

We strongly discourage bypassing color lint check.

However, if you need to bypass the check, please update the baseline.xml by running following command in package root folder(i.e. package/app/Settings/)

export ANDROID_LINT_JARS=$(gettop)/prebuilts/checkcolor/checkcolor.jar
lint --check HardCodedColor --xml color-check-baseline.xml .

After update the baseline.xml, your hardcoded color will be ignored in check. Please submit the new baseline.xml within your cl.

Contact us

  1. For help to remove hardcoded colors or report issue in color check, please contact [email protected]