SystemUiMode enum

Describes different display configurations for both Android and iOS.

These modes mimic Android-specific display setups.

Used by SystemChrome.setEnabledSystemUIMode.

Flutter apps use SystemUiMode.edgeToEdge by default and setting any of the other SystemUiModes will NOT work unless you perform the migration detailed in https://docs.flutter.dev/release/breaking-changes/default-systemuimode-edge-to-edge.

Inheritance
Available extensions

Values

leanBack → const SystemUiMode

Fullscreen display with status and navigation bars presentable by tapping anywhere on the display.

Available starting at Android SDK 4.1 (API 16). Earlier versions of Android will not be affected by this setting. However, if your app targets Android SDK 15 (API 35) or later (Flutter does this by default), then you must migrate using the instructions in https://docs.flutter.dev/release/breaking-changes/default-systemuimode-edge-to-edge to use this mode.

For applications running on iOS, the status bar and home indicator will be hidden for a similar fullscreen experience.

Tapping on the screen displays overlays, this gesture is not received by the application.

See also:

immersive → const SystemUiMode

Fullscreen display with status and navigation bars presentable through a swipe gesture at the edges of the display.

Available starting at Android SDK 4.4 (API 19). Earlier versions of Android will not be affected by this setting. However, if your app targets Android SDK 15 (API 35) or later (Flutter does this by default), then you must migrate using the instructions in https://docs.flutter.dev/release/breaking-changes/default-systemuimode-edge-to-edge to use this mode.

For applications running on iOS, the status bar and home indicator will be hidden for a similar fullscreen experience.

A swipe gesture from the edge of the screen displays overlays. In contrast to SystemUiMode.immersiveSticky, this gesture is not received by the application.

See also:

immersiveSticky → const SystemUiMode

Fullscreen display with status and navigation bars presentable through a swipe gesture at the edges of the display.

Available starting at Android SDK 4.4 (API 19). Earlier versions of Android will not be affected by this setting. However, if your app targets Android SDK 15 (API 35) or later (Flutter does this by default), then you must migrate using the instructions in https://docs.flutter.dev/release/breaking-changes/default-systemuimode-edge-to-edge to use this mode.

For applications running on iOS, the status bar and home indicator will be hidden for a similar fullscreen experience.

A swipe gesture from the edge of the screen displays overlays. In contrast to SystemUiMode.immersive, this gesture is received by the application.

See also:

edgeToEdge → const SystemUiMode

Fullscreen display with status and navigation elements rendered over the application.

Available starting at Android SDK 10 (API 29). Earlier versions of Android will not be affected by this setting.

If your app targets Android SDK 15 (API 35) or later (Flutter does this by default), then this mode is used by default on Android. This mode is also used by default on iOS.

For applications running on iOS, the status bar and home indicator will be visible.

The system overlays will not disappear or reappear in this mode as they are permanently displayed on top of the application.

See also:

  • SystemUiOverlayStyle, can be used to configure transparent status and navigation bars with or without a contrast scrim.
manual → const SystemUiMode

Declares manually configured SystemUiOverlays.

When using this mode with SystemChrome.setEnabledSystemUIMode, the preferred overlays must be set by the developer.

When SystemUiOverlay.top is enabled, the status bar will remain visible on all platforms. Omitting this overlay will hide the status bar on iOS & Android.

When SystemUiOverlay.bottom is enabled, the navigation bar and home indicator of Android and iOS applications will remain visible. Omitting this overlay will hide them.

Omitting both overlays will result in the same configuration as SystemUiMode.leanBack.

If your app targets Android SDK 15 (API 35) or later, then you must migrate using the instructions in https://docs.flutter.dev/release/breaking-changes/default-systemuimode-edge-to-edge to use this mode.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<SystemUiMode>
A constant List of the values in this enum, in order of their declaration.