AndroidComposeUiFlags

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() {
        AndroidComposeUiFlags.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.ui.AndroidComposeUiFlags {
    public static int isSharedComposeViewContextEnabled return false
}

Summary

Public properties
Boolean

This flag enables performance improvements in accessibility, such as caching accessibility state and deferring listener registration.
android
Boolean

This flag forces scroll capture to center the content being rendered even if it's already visible.
android
Boolean

If enabled, the creation of the container for AndroidViews is delayed until an AndroidView is added.
android
Boolean

If enabled, WindowInsetsRulers interactions will use the delayed-initialization path to improve ComposeView startup time.
android
Boolean

This flag enables the Android Framework implementation of VelocityTracker.
android
Boolean

Enables using out of frame scheduler instead of Choreographer for text input events.
android
Boolean

Enables propagation of hideFromAccessibility to children of merging parents.
android
Boolean

Enables sorting of accessibility children based on their traversal index when the parent is a traversal group and is a merging container.
android
Boolean

This flag enables using the View's handler for semantics processing instead of the Main Looper.
android

Public properties

isAccessibilityPerformanceEnabled

android 
var isAccessibilityPerformanceEnabled: Boolean

This flag enables performance improvements in accessibility, such as caching accessibility state and deferring listener registration.

isAlwaysScrollDuringScrollCaptureEnabled

android
Added in 1.12.0
var isAlwaysScrollDuringScrollCaptureEnabled: Boolean

This flag forces scroll capture to center the content being rendered even if it's already visible.

isDelayAndroidViewsHandlerCreationEnabled

android 
var isDelayAndroidViewsHandlerCreationEnabled: Boolean

If enabled, the creation of the container for AndroidViews is delayed until an AndroidView is added.

isDelayedWindowInsetsRulersEnabled

android 
var isDelayedWindowInsetsRulersEnabled: Boolean

If enabled, WindowInsetsRulers interactions will use the delayed-initialization path to improve ComposeView startup time. If disabled, the immediate-initialization path is used instead.

isFrameworkVelocityTrackerEnabled

android
Added in 1.12.0
var isFrameworkVelocityTrackerEnabled: Boolean

This flag enables the Android Framework implementation of VelocityTracker.

isOutOfFrameSchedulerForTextInputEventsEnabled

android
Added in 1.12.0
var isOutOfFrameSchedulerForTextInputEventsEnabled: Boolean

Enables using out of frame scheduler instead of Choreographer for text input events.

isPropagateHideFromAccessibilityToMergingChildrenEnabled

android 
var isPropagateHideFromAccessibilityToMergingChildrenEnabled: Boolean

Enables propagation of hideFromAccessibility to children of merging parents.

isTraversalGroupSortingEnabled

android 
var isTraversalGroupSortingEnabled: Boolean

Enables sorting of accessibility children based on their traversal index when the parent is a traversal group and is a merging container.

isViewBasedSemanticsHandlerEnabled

android
Added in 1.11.0
var isViewBasedSemanticsHandlerEnabled: Boolean

This flag enables using the View's handler for semantics processing instead of the Main Looper. This avoids crashes in environments where Compose is used on a non-main thread.