(#) Modifier.offset{ } is preferred over Modifier.offset() for `State` backed arguments !!! WARNING: Modifier.offset{ } is preferred over Modifier.offset() for `State` backed arguments This is a warning. Id : `UseOfNonLambdaOffsetOverload` Summary : Modifier.offset{ } is preferred over Modifier.offset() for `State` backed arguments Severity : Warning Category : Performance Platform : Any Vendor : Jetpack Compose Identifier : androidx.compose.foundation Feedback : https://issuetracker.google.com/issues/new?component=612128 Min : Lint 8.7+ Compiled : Lint 8.7+ Artifact : [androidx.compose.foundation:foundation-android](androidx_compose_foundation_foundation-android.md.html) Since : 1.5.0 Affects : Kotlin and Java files and test sources Editing : This check runs on the fly in the IDE editor Implementation : [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/compose/foundation/foundation-lint/src/main/java/androidx/compose/foundation/lint/NonLambdaOffsetModifierDetector.kt) Tests : [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/compose/foundation/foundation-lint/src/test/java/androidx/compose/foundation/lint/NonLambdaOffsetModifierDetectorTest.kt) Copyright Year : 2022 `Modifier.offset()` is recommended to be used with static arguments only to avoid unnecessary recompositions. `Modifier.offset{ }` is preferred in the cases where the arguments are backed by a `State`. (##) Example Here is an example of lint warnings produced by this check: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text src/test/test.kt:17:Warning: State backed values should use the lambda overload of Modifier.offset [UseOfNonLambdaOffsetOverload] Modifier.offset(offsetStateful.value, yAxis) ------ src/test/test.kt:18:Warning: State backed values should use the lambda overload of Modifier.offset [UseOfNonLambdaOffsetOverload] Modifier.absoluteOffset(0.dp, offsetStateful.value) -------------- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Here is the source file referenced above: `src/test/test.kt`: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers package test import androidx.compose.foundation.layout.absoluteOffset import androidx.compose.foundation.layout.offset import androidx.compose.runtime.Composable import androidx.compose.runtime.mutableStateOf import androidx.compose.runtime.remember import androidx.compose.ui.Modifier import androidx.compose.ui.unit.dp @Composable fun ComposableFunction() { val offsetStateful = remember { mutableStateOf(0.dp) } val yAxis = 10.dp Modifier.offset(offsetStateful.value, yAxis) Modifier.absoluteOffset(0.dp, offsetStateful.value) } ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can also visit the [source code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/compose/foundation/foundation-lint/src/test/java/androidx/compose/foundation/lint/NonLambdaOffsetModifierDetectorTest.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, `NonLambdaOffsetModifierDetector.nonLambdaOffset_usingStateLocalVariable_shouldWarn`. To report a problem with this extracted sample, visit https://issuetracker.google.com/issues/new?component=612128. (##) Including !!! This is not a built-in check. To include it, add the below dependency to your project. ``` // build.gradle.kts implementation("androidx.compose.foundation:foundation-android:1.11.0-alpha06") // build.gradle implementation 'androidx.compose.foundation:foundation-android:1.11.0-alpha06' // build.gradle.kts with version catalogs: implementation(libs.foundation.android) # libs.versions.toml [versions] foundation-android = "1.11.0-alpha06" [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: foundation-android = { module = "androidx.compose.foundation:foundation-android", version.ref = "foundation-android" } ``` 1.11.0-alpha06 is the version this documentation was generated from; there may be newer versions available. NOTE: These lint checks are **also** made available separate from the main library. You can also use `androidx.compose.foundation:foundation-lint:1.11.0-alpha06`. [Additional details about androidx.compose.foundation:foundation-android](androidx_compose_foundation_foundation-android.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("UseOfNonLambdaOffsetOverload") fun method() { offset(...) } ``` or ```java // Java @SuppressWarnings("UseOfNonLambdaOffsetOverload") void method() { offset(...); } ``` * Using a suppression comment like this on the line above: ```kt //noinspection UseOfNonLambdaOffsetOverload 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="UseOfNonLambdaOffsetOverload" 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 'UseOfNonLambdaOffsetOverload' } ``` In Android projects this should be nested inside an `android { }` block. * For manual invocations of `lint`, using the `--ignore` flag: ``` $ lint --ignore UseOfNonLambdaOffsetOverload ...` ``` * Last, but not least, using baselines, as discussed [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).