ComposeUiFlags

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() {
        ComposeUiFlags.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.ComposeUiFlags {
    public static int isRectTrackingEnabled return false
}

Summary

Public properties
Boolean

This property is deprecated. Use ComposeView.disableWindowInsetsRulers()
Cmn
Boolean

This flag enables support for walking up nested scrolling in response to android.R.id.accessibilityActionShowOnScreen from Accessibility.
Cmn
Boolean

This flag enables an alternate approach to fixing the issues addressed by the isViewFocusFixEnabled flag.
Cmn
Boolean

This flag enables setting the shape semantics property in the graphicsLayer modifiers.
Cmn
Boolean

This flag enables a fix for b/388590015.
Cmn
Boolean

Flag for enabling indirect pointer event navigation gestures in Compose.
Cmn
Boolean

Enable initial focus when a focusable is added to a screen with no focusable content.
Cmn
Boolean

Flag enables optimized focus change dispatching logic.
Cmn
Boolean

Enable performance optimization where coordinates calculations like androidx.compose.ui.layout.LayoutCoordinates.localToRoot are using the cached offsets we already have in RectManager, instead of traversing the whole tree on each call.
Cmn
Boolean

Enable fix to scroll target rect to the center when performing scroll capture, thus generally avoiding floating content at the top and bottom of the UI.
Cmn
Boolean

Enables support of trackpad gesture events.
Cmn
Boolean

Enables a fix where TraversableNode traversal method findNearestAncestor will take into consideration any delegates that might also be traversable.
Cmn
Boolean

This enables fixes for View focus.
Cmn

Public properties

areWindowInsetsRulersEnabled

Cmn
Added in 1.9.0
Deprecated in 1.11.0-alpha05
var areWindowInsetsRulersEnabled: Boolean

Enable WindowInsets rulers:

  • SystemBarsRulers

  • ImeRulers

  • StatusBarsRulers

  • NavigationBarsRulers

  • CaptionBarRulers

  • MandatorySystemGesturesRulers

  • TappableElementRulers

  • WaterfallRulers

  • SafeDrawingRulers

  • SafeGesturesRulers

  • SafeContentRulers

isAccessibilityShowOnScreenNestedScrollingEnabled

Cmn 
var isAccessibilityShowOnScreenNestedScrollingEnabled: Boolean

This flag enables support for walking up nested scrolling in response to android.R.id.accessibilityActionShowOnScreen from Accessibility.

Enabled is correct nested scrolling behavior and it should be enabled in all apps.

isBypassUnfocusableComposeViewEnabled

Cmn
Added in 1.10.0
var isBypassUnfocusableComposeViewEnabled: Boolean

This flag enables an alternate approach to fixing the issues addressed by the isViewFocusFixEnabled flag.

isGraphicsLayerShapeSemanticsEnabled

Cmn
Added in 1.10.0
var isGraphicsLayerShapeSemanticsEnabled: Boolean

This flag enables setting the shape semantics property in the graphicsLayer modifiers.

isIgnoreInvalidPrevFocusRectEnabled

Cmn
Added in 1.10.0
var isIgnoreInvalidPrevFocusRectEnabled: Boolean

This flag enables a fix for b/388590015. The view system ignores an invalid prevFocusRect when requestFocus is called, so we support this behavior in Compose too.

isIndirectPointerNavigationGestureDetectorEnabled

Cmn
Added in 1.10.0
var isIndirectPointerNavigationGestureDetectorEnabled: Boolean

Flag for enabling indirect pointer event navigation gestures in Compose.

isInitialFocusOnFocusableAvailable

Cmn
Added in 1.10.0
var isInitialFocusOnFocusableAvailable: Boolean

Enable initial focus when a focusable is added to a screen with no focusable content.

isOptimizedFocusEventDispatchEnabled

Cmn
Added in 1.10.0
var isOptimizedFocusEventDispatchEnabled: Boolean

Flag enables optimized focus change dispatching logic.

isRectManagerOffsetUsageFromLayoutCoordinatesEnabled

Cmn
Added in 1.10.0
var isRectManagerOffsetUsageFromLayoutCoordinatesEnabled: Boolean

Enable performance optimization where coordinates calculations like androidx.compose.ui.layout.LayoutCoordinates.localToRoot are using the cached offsets we already have in RectManager, instead of traversing the whole tree on each call.

isScrollCaptureCenteringEnabled

Cmn
Added in 1.10.0
var isScrollCaptureCenteringEnabled: Boolean

Enable fix to scroll target rect to the center when performing scroll capture, thus generally avoiding floating content at the top and bottom of the UI.

isTrackpadGestureHandlingEnabled

Cmn 
var isTrackpadGestureHandlingEnabled: Boolean

Enables support of trackpad gesture events.

If enabled, androidx.compose.ui.input.pointer.PointerEvents can have type of androidx.compose.ui.input.pointer.PointerEventType.Pan and androidx.compose.ui.input.pointer.PointerEventType.Scale, corresponding to gestures on a trackpad.

These trackpad gestures will also generally be treated as mouse, with the exact behavior depending on platform specifics.

isTraversableDelegatesFixEnabled

Cmn 
var isTraversableDelegatesFixEnabled: Boolean

Enables a fix where TraversableNode traversal method findNearestAncestor will take into consideration any delegates that might also be traversable.

isViewFocusFixEnabled

Cmn
Added in 1.8.0
var isViewFocusFixEnabled: Boolean

This enables fixes for View focus. The changes are large enough to require a flag to allow disabling them.