(#) Use `LayoutReference.withChainParams()` to define margins for elements in a Chain !!! WARNING: Use `LayoutReference.withChainParams()` to define margins for elements in a Chain This is a warning. Id : `IncorrectChainMarginsUsage` Summary : Use `LayoutReference.withChainParams()` to define margins for elements in a Chain Severity : Warning Category : Correctness Platform : Any Vendor : Android Open Source Project Identifier : androidx.constraintlayout.compose Feedback : https://issuetracker.google.com/issues/new?component=323867&template=1023345 Min : Lint 8.7+ Compiled : Lint 8.7+ Artifact : [androidx.constraintlayout:constraintlayout-compose](androidx_constraintlayout_constraintlayout-compose.md.html) Since : 1.1.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:/constraintlayout/constraintlayout-compose-lint/src/main/java/androidx/constraintlayout/compose/lint/ConstraintLayoutDslDetector.kt) Tests : [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/constraintlayout/constraintlayout-compose-lint/src/test/java/androidx/constraintlayout/compose/lint/ConstraintLayoutDslDetectorTest.kt) Copyright Year : 2022 If you understand how a chain works, it might seem obvious to add margins by re-creating the constraints with the desired margin. However, in Compose, helpers will ignore custom constraints in favor of their layout implementation. So instead, use `LayoutReference.withChainParams()` to define margins for Chains. (##) Including !!! This is not a built-in check. To include it, add the below dependency to your project. ``` // build.gradle.kts implementation("androidx.constraintlayout:constraintlayout-compose:1.1.0") // build.gradle implementation 'androidx.constraintlayout:constraintlayout-compose:1.1.0' // build.gradle.kts with version catalogs: implementation(libs.constraintlayout.compose) # libs.versions.toml [versions] constraintlayout-compose = "1.1.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: constraintlayout-compose = { module = "androidx.constraintlayout:constraintlayout-compose", version.ref = "constraintlayout-compose" } ``` 1.1.0 is the version this documentation was generated from; there may be newer versions available. [Additional details about androidx.constraintlayout:constraintlayout-compose](androidx_constraintlayout_constraintlayout-compose.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("IncorrectChainMarginsUsage") fun method() { problematicStatement() } ``` or ```java // Java @SuppressWarnings("IncorrectChainMarginsUsage") void method() { problematicStatement(); } ``` * Using a suppression comment like this on the line above: ```kt //noinspection IncorrectChainMarginsUsage 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="IncorrectChainMarginsUsage" 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 'IncorrectChainMarginsUsage' } ``` In Android projects this should be nested inside an `android { }` block. * For manual invocations of `lint`, using the `--ignore` flag: ``` $ lint --ignore IncorrectChainMarginsUsage ...` ``` * Last, but not least, using baselines, as discussed [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).