ActivityIconColor.md.html

<meta charset="utf-8">
(#) Ongoing activity icon is not white

!!! WARNING: Ongoing activity icon is not white
   This is a warning.

Id
:   `ActivityIconColor`
Summary
:   Ongoing activity icon is not white
Severity
:   Warning
Category
:   Usability: Icons
Platform
:   Android
Vendor
:   Android Open Source Project
Feedback
:   https://issuetracker.google.com/issues/new?component=192708
Since
:   8.3.0 (February 2024)
Affects
:   Kotlin and Java files, binary resource files and resource files
Editing
:   This check can *not* run live in the IDE editor
See
:   https://developer.android.com/training/wearables/ongoing-activity#best-practices
Implementation
:   [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-checks/src/main/java/com/android/tools/lint/checks/ActivityIconColorDetector.kt)
Tests
:   [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/ActivityIconColorDetectorTest.kt)

The resources passed to `setAnimatedIcon` and `setStaticIcon` should be
white with a transparent background, preferably a VectorDrawable or
AnimatedVectorDrawable.

(##) Example

Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
src/test/pkg/ForegroundOnlyWalkingWorkoutService.kt:9:Warning: The
animated icon for an ongoing activity should be white with a transparent
background [ActivityIconColor]
    .setAnimatedIcon(R.drawable.animated_walk)
                     ------------------------
src/test/pkg/ForegroundOnlyWalkingWorkoutService.kt:10:Warning: The
static icon for an ongoing activity should be white with a transparent
background [ActivityIconColor]
    .setStaticIcon(R.drawable.ic_walk)
                   ------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here is the source file referenced above:

`src/test/pkg/ForegroundOnlyWalkingWorkoutService.kt`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers
package test.pkg;

import androidx.wear.ongoing.OngoingActivity

class ForegroundOnlyWalkingWorkoutService {
    private fun generateNotification(mainText: String) {
        val ongoingActivity =
            OngoingActivity.Builder()
                .setAnimatedIcon(R.drawable.animated_walk)
                .setStaticIcon(R.drawable.ic_walk)
                .build()
    }
}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also visit the
[source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/ActivityIconColorDetectorTest.kt)
for the unit tests for this check to see additional scenarios.

(##) Suppressing

You can suppress false positives using one of the following mechanisms:

* Using a suppression annotation like this on the enclosing
  element:

  ```kt
  // Kotlin
  @Suppress("ActivityIconColor")
  fun method() {
     setAnimatedIcon(...)
  }
  ```

  or

  ```java
  // Java
  @SuppressWarnings("ActivityIconColor")
  void method() {
     setAnimatedIcon(...);
  }
  ```

* Using a suppression comment like this on the line above:

  ```kt
  //noinspection ActivityIconColor
  problematicStatement()
  ```

* Adding the suppression attribute `tools:ignore="ActivityIconColor"`
  on the problematic XML element (or one of its enclosing elements).
  You may also need to add the following namespace declaration on the
  root element in the XML file if it's not already there:
  `xmlns:tools="http://schemas.android.com/tools"`.

* Using a special `lint.xml` file in the source tree which turns off
  the check in that folder and any sub folder. A simple file might look
  like this:
  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="ActivityIconColor" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  Instead of `ignore` you can also change the severity here, for
  example from `error` to `warning`. You can find additional
  documentation on how to filter issues by path, regular expression and
  so on
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).

* In Gradle projects, using the DSL syntax to configure lint. For
  example, you can use something like
  ```gradle
  lintOptions {
      disable 'ActivityIconColor'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore ActivityIconColor ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>