(#) Replace usage of `Switch` widget !!! WARNING: Replace usage of `Switch` widget This is a warning. Id : `UseSwitchCompatOrMaterialCode` Summary : Replace usage of `Switch` widget Severity : Warning Category : Correctness Platform : Any Vendor : Android Open Source Project Identifier : androidx.appcompat Feedback : https://issuetracker.google.com/issues/new?component=460343 Min : Lint 7.0 Compiled : Lint 8.0 and 8.1 Artifact : [androidx.appcompat:appcompat](androidx_appcompat_appcompat.md.html) Since : 1.2.0 Affects : Kotlin and Java files Editing : This check runs on the fly in the IDE editor Implementation : [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/appcompat/appcompat-lint/src/main/kotlin/androidx/appcompat/widget/SwitchUsageCodeDetector.kt) Tests : [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/appcompat/appcompat-lint/src/test/kotlin/androidx/appcompat/lint/widget/SwitchUsageCodeDetectorTest.kt) Copyright Year : 2020 Use `SwitchCompat` from AppCompat or `MaterialSwitch` from Material library. (##) Example Here is an example of lint warnings produced by this check: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text com/example/CustomSwitch.kt:6:Warning: Use SwitchCompat from AppCompat or MaterialSwitch from Material library [UseSwitchCompatOrMaterialCode] class CustomSwitch(context: Context): Switch(context) ------ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Here is the source file referenced above: `com/example/CustomSwitch.kt`: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers package com.example import android.content.Context import android.widget.Switch class CustomSwitch(context: Context): Switch(context) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can also visit the [source code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/appcompat/appcompat-lint/src/test/kotlin/androidx/appcompat/lint/widget/SwitchUsageCodeDetectorTest.kt) for the unit tests for this check to see additional scenarios. The above example was automatically extracted from the first unit test found for this lint check, `SwitchUsageCodeDetector.testExtendCoreSwitch`. To report a problem with this extracted sample, visit https://issuetracker.google.com/issues/new?component=460343. (##) Including !!! This is not a built-in check. To include it, add the below dependency to your project. ``` // build.gradle.kts implementation("androidx.appcompat:appcompat:1.7.0") // build.gradle implementation 'androidx.appcompat:appcompat:1.7.0' // build.gradle.kts with version catalogs: implementation(libs.appcompat) # libs.versions.toml [versions] appcompat = "1.7.0" [libraries] # For clarity and text wrapping purposes the following declaration is # shown split up across lines, but in TOML it needs to be on a single # line (see https://github.com/toml-lang/toml/issues/516) so adjust # when pasting into libs.versions.toml: appcompat = { module = "androidx.appcompat:appcompat", version.ref = "appcompat" } ``` 1.7.0 is the version this documentation was generated from; there may be newer versions available. [Additional details about androidx.appcompat:appcompat](androidx_appcompat_appcompat.md.html). (##) 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("UseSwitchCompatOrMaterialCode") fun method() { problematicStatement() } ``` or ```java // Java @SuppressWarnings("UseSwitchCompatOrMaterialCode") void method() { problematicStatement(); } ``` * Using a suppression comment like this on the line above: ```kt //noinspection UseSwitchCompatOrMaterialCode problematicStatement() ``` * 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 <?xml version="1.0" encoding="UTF-8"?> <lint> <issue id="UseSwitchCompatOrMaterialCode" severity="ignore" /> </lint> ``` 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 'UseSwitchCompatOrMaterialCode' } ``` In Android projects this should be nested inside an `android { }` block. * For manual invocations of `lint`, using the `--ignore` flag: ``` $ lint --ignore UseSwitchCompatOrMaterialCode ...` ``` * Last, but not least, using baselines, as discussed [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).