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.runtime.ComposeFoundationFlags { public static boolean SomeFeatureEnabled return false }
Summary
Public properties |
||
|---|---|---|
Boolean |
Selecting flag to enable Drag Gesture "Pick-up" on drag gesture detectors. |
Cmn
|
Boolean |
Selecting flag to enable the use of automatic nested prefetch. |
Cmn
|
Boolean |
Whether to use more immediate coroutine dispatching in |
Cmn
|
Boolean |
Flag that enables an optimized implementation for the |
Cmn
|
Boolean |
Enables Compose trigger for calling androidx.compose.ui.node.DelegatableNode.dispatchOnScrollChanged callbacks during scroll events. |
Cmn
|
Boolean |
Selecting flag to enable the use of new PausableComposition in lazy layout prefetch. |
Cmn
|
Public properties
DragGesturePickUpEnabled
var DragGesturePickUpEnabled: Boolean
Selecting flag to enable Drag Gesture "Pick-up" on drag gesture detectors. This also applies to Draggables and Scrollables which use gesture detectors as well. Any parent drag detector will continue to monitor the event stream until the gesture terminates (all pointers are lifted), if a child gives up an event, the parent gesture detector will "pick-up" and continue the gesture until all pointers are up.
isAutomaticNestedPrefetchEnabled
var isAutomaticNestedPrefetchEnabled: Boolean
Selecting flag to enable the use of automatic nested prefetch. When this is enabled, nested prefetching using the default Prefetch Strategies androidx.compose.foundation.lazy.LazyListPrefetchStrategy and androidx.compose.foundation.lazy.grid.LazyGridPrefetchStrategy or Cache Window will be automatically defined by the number of visible items in the nested LazyLayout.
isDetectTapGesturesImmediateCoroutineDispatchEnabled
var isDetectTapGesturesImmediateCoroutineDispatchEnabled: Boolean
Whether to use more immediate coroutine dispatching in detectTapGestures and detectTapAndPress, true by default.
isNonComposedClickableEnabled
var isNonComposedClickableEnabled: Boolean
Flag that enables an optimized implementation for the clickable overload without an Indication parameter. This also applies to combinedClickable, androidx.compose.foundation.selection.selectable, and androidx.compose.foundation.selection.toggleable, which also use clickable. When this flag is true, clickable will no longer use androidx.compose.ui.composed, which leads to improved performance and allows for composables with a clickable modifier to skip. However, this means that only IndicationNodeFactory instances can be supported - if a non-IndicationNodeFactory instance is provided to LocalIndication, clickable will crash at runtime. To resolve this either migrate the Indication implementation used to a IndicationNodeFactory, or use the other clickable overload with an explicit Indication parameter - this flag can be disabled as a temporary migration aid.
isOnScrollChangedCallbackEnabled
var isOnScrollChangedCallbackEnabled: Boolean
Enables Compose trigger for calling androidx.compose.ui.node.DelegatableNode.dispatchOnScrollChanged callbacks during scroll events.
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.