ComposeFoundationFlags
-
Cmn
@ExperimentalFoundationApi
object ComposeFoundationFlags
This is a collection of flags which are used to guard against regressions in some of the "riskier" refactors or new feature support that is added to this module. These flags are always "on" in the published artifact of this module, however these flags allow end consumers of this module to toggle them "off" in case this new path is causing a regression.
These flags are considered temporary, and there should be no expectation for these flags be around for an extended period of time. If you have a regression that one of these flags fixes, it is strongly encouraged for you to file a bug ASAP.
Usage:
In order to turn a feature off in a debug environment, it is recommended to set this to false in as close to the initial loading of the application as possible. Changing this value after compose library code has already been loaded can result in undefined behavior.
class MyApplication : Application() { override fun onCreate() { ComposeFoundationFlags.SomeFeatureEnabled = false super.onCreate() } }
In order to turn this off in a release environment, it is recommended to additionally utilize R8 rules which force a single value for the entire build artifact. This can result in the new code paths being completely removed from the artifact, which can often have nontrivial positive performance impact.
-assumevalues class androidx.compose.foundation.ComposeFoundationFlags { public static boolean SomeFeatureEnabled return false }
Summary
Public properties |
||
|---|---|---|
Boolean |
When Pager was used with a keyboard in RTL the pages would bounce indefinitely due to the bring into view animation. |
Cmn
|
Boolean |
With this flag on, Pager will use Cache Window as the default prefetching strategy, instead of 1 item in the direction of the scroll. |
Cmn
|
Boolean |
If this flag is enabled, for lazy layout implementations that use |
Cmn
|
Boolean |
Whether to use more immediate coroutine dispatching in |
Cmn
|
Boolean |
Whether to use the new context menu API and default implementations in |
Cmn
|
Boolean |
With this flag on we don't use suspend pointer input as part of Modifier.clickable implementation as an optimization. |
Cmn
|
Boolean |
Selecting flag to enable the use of new PausableComposition in lazy layout prefetch. |
Cmn
|
Boolean |
Whether to use the new smart selection feature in |
Cmn
|
Public properties
isBringIntoViewRltBouncyBehaviorInPagerFixEnabled
var isBringIntoViewRltBouncyBehaviorInPagerFixEnabled: Boolean
When Pager was used with a keyboard in RTL the pages would bounce indefinitely due to the bring into view animation. If this flag is off the fix for that behavior will be disabled.
isCacheWindowForPagerEnabled
var isCacheWindowForPagerEnabled: Boolean
With this flag on, Pager will use Cache Window as the default prefetching strategy, instead of 1 item in the direction of the scroll. The window used will be 1 view port AFTER the currently composed items, this includes visible and items composed through beyond bounds.
isCacheWindowRefillFixEnabled
var isCacheWindowRefillFixEnabled: Boolean
If this flag is enabled, for lazy layout implementations that use androidx.compose.foundation.lazy.layout.LazyLayoutCacheWindow, if the dataset changes, the window mechanism will understand that it needs to re-fill the window from scratch. This is because there is no good way for the window to know that a possible non-visible item has changed. For instance, if C and D are 2 items in the cache window and later they're removed from the dataset, the cache window won't know it until it tries to prefetch them.
isDetectTapGesturesImmediateCoroutineDispatchEnabled
var isDetectTapGesturesImmediateCoroutineDispatchEnabled: Boolean
Whether to use more immediate coroutine dispatching in detectTapGestures and detectTapAndPress, true by default.
isNewContextMenuEnabled
var isNewContextMenuEnabled: Boolean
Whether to use the new context menu API and default implementations in SelectionContainer, and all BasicTextFields. If false, the previous context menu that has no public APIs will be used instead.
isNonSuspendingPointerInputInClickableEnabled
var isNonSuspendingPointerInputInClickableEnabled: Boolean
With this flag on we don't use suspend pointer input as part of Modifier.clickable implementation as an optimization.
isPausableCompositionInPrefetchEnabled
var isPausableCompositionInPrefetchEnabled: Boolean
Selecting flag to enable the use of new PausableComposition in lazy layout prefetch. This change allows us to distribute work we need to do during the prefetch better, for example we can only perform the composition for parts of the LazyColumn's next item during one ui frame, and then continue composing the rest of it in the next frames.
isSmartSelectionEnabled
var isSmartSelectionEnabled: Boolean
Whether to use the new smart selection feature in androidx.compose.foundation.text.selection.SelectionContainer and all androidx.compose.foundation.text.BasicTextFields.