Remove usages of deprecated setSystemUiVisibility() #29493
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,6 +20,8 @@ | |
| import androidx.annotation.NonNull; | ||
| import androidx.annotation.Nullable; | ||
| import androidx.annotation.VisibleForTesting; | ||
| import androidx.core.view.WindowCompat; | ||
| import androidx.core.view.WindowInsetsCompat; | ||
| import androidx.core.view.WindowInsetsControllerCompat; | ||
| import io.flutter.Log; | ||
| import io.flutter.embedding.engine.systemchannels.PlatformChannel; | ||
|
|
@@ -28,14 +30,13 @@ | |
|
|
||
| /** Android implementation of the platform plugin. */ | ||
| public class PlatformPlugin { | ||
|
|
||
| private final Activity activity; | ||
| private final PlatformChannel platformChannel; | ||
| private final PlatformPluginDelegate platformPluginDelegate; | ||
| private PlatformChannel.SystemChromeStyle currentTheme; | ||
| private PlatformChannel.SystemUiMode currentSystemUiMode; | ||
| private List<PlatformChannel.SystemUiOverlay> currentOverlays; | ||
| private static final String TAG = "PlatformPlugin"; | ||
|
|
||
| /** | ||
|
|
@@ -141,7 +142,7 @@ public PlatformPlugin( | |
| this.platformChannel.setPlatformMessageHandler(mPlatformMessageHandler); | ||
| this.platformPluginDelegate = delegate; | ||
|
|
||
| currentSystemUiMode = PlatformChannel.SystemUiMode.EDGE_TO_EDGE; | ||
|
Contributor
Author
There was a problem hiding this comment. The only difference between this mode and the |
||
| } | ||
|
|
||
| /** | ||
|
|
@@ -240,105 +241,98 @@ public void onSystemUiVisibilityChange(int visibility) { | |
| private void setSystemChromeEnabledSystemUIMode(PlatformChannel.SystemUiMode systemUiMode) { | ||
| int enabledOverlays; | ||
|
|
||
| Window window = activity.getWindow(); | ||
| View view = window.getDecorView(); | ||
| WindowInsetsControllerCompat windowInsetsControllerCompat = | ||
| new WindowInsetsControllerCompat(window, view); | ||
|
|
||
| if (systemUiMode == PlatformChannel.SystemUiMode.LEAN_BACK) { | ||
|
Contributor
There was a problem hiding this comment. Why don't we check for the build version here anymore?
Contributor
Author
There was a problem hiding this comment. A CI failure indicated that the minimum version is 16 (Jelly Bean) so this was unneeded. Do we need to keep the check in case someone bumps it down?
Contributor
There was a problem hiding this comment. Oh ok, that makes sense!
Now that you mention it, that would probably be a situation we would want to have covered by it. I'll defer to @blasten though :) |
||
| // LEAN BACK | ||
| // Available starting at SDK 20, due to the backwards compatibility provided by the | ||
|
Contributor
There was a problem hiding this comment. It would be great if we can eventually migrate from the deprecated APIs to use AndroidX's compat libraries, but according to https://docs.flutter.dev/development/tools/sdk/release-notes/supported-platforms we are also supporting API 19. Seems like everything here and below will require API 20+. We might need to rethink a bit on the supported modes and the default mode (especially if edge-to-edge, which works best on API 29+, is going to be the new default). |
||
| // WindowInsetsControllerCompat class for setting the behavior of system bars. | ||
| // Should not show overlays, tap to reveal overlays, needs onChange callback | ||
| // When the overlays come in on tap, the app does not receive the gesture and does not know | ||
| // the system overlay has changed. The overlays cannot be dismissed, so adding the callback | ||
| // support will allow users to restore the system ui and dismiss the overlays. | ||
| // Not compatible with top/bottom overlays enabled. | ||
| windowInsetsControllerCompat.setSystemBarsBehavior( | ||
| WindowInsetsControllerCompat.BEHAVIOR_SHOW_BARS_BY_TOUCH); | ||
| windowInsetsControllerCompat.hide(WindowInsetsCompat.Type.systemBars()); | ||
| WindowCompat.setDecorFitsSystemWindows(window, false); | ||
|
There was a problem hiding this comment.
Are all the values in https://github.com/flutter/flutter/blob/61a0add2865c51bfee33939c1820709d1115c77d/packages/flutter/lib/src/services/system_chrome.dart#L90 equivalent edge-to-edge? @Piinks
Contributor
There was a problem hiding this comment. I am not sure I understand the question, are all the values in >what< equivalent to edge to edge?
Contributor
There was a problem hiding this comment. No, only one is edge to edge, the rest are different? There was a problem hiding this comment. Thanks. It sounds like only the case
Contributor
Author
There was a problem hiding this comment. That call replaces the flag SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN which is also a part of other modes There was a problem hiding this comment. Thanks for the videos. It does seem like all the modes that Flutter supports are edge-to-edge in Android terminology. https://developer.android.com/training/gestures/edge-to-edge - I didn't see any example where the opposite to that definition is true.
Contributor
Author
There was a problem hiding this comment. It seems like to implement edge to edge mode like that shown in the guide, you have to do some further style customization besides using this method (like to get the transparent bars). |
||
| } else if (systemUiMode == PlatformChannel.SystemUiMode.IMMERSIVE) { | ||
| // IMMERSIVE | ||
| // Available starting at SDK 20, due to the backwards compatibility provided by the | ||
| // WindowInsetsControllerCompat class for setting the behavior of system bars. | ||
| // Should not show overlays, swipe from edges to reveal overlays, needs onChange callback | ||
| // When the overlays come in on swipe, the app does not receive the gesture and does not know | ||
| // the system overlay has changed. The overlays cannot be dismissed, so adding callback | ||
| // support will allow users to restore the system ui and dismiss the overlays. | ||
| // Not compatible with top/bottom overlays enabled. | ||
| windowInsetsControllerCompat.setSystemBarsBehavior( | ||
| WindowInsetsControllerCompat.BEHAVIOR_SHOW_BARS_BY_SWIPE); | ||
| windowInsetsControllerCompat.hide(WindowInsetsCompat.Type.systemBars()); | ||
| WindowCompat.setDecorFitsSystemWindows(window, false); | ||
| } else if (systemUiMode == PlatformChannel.SystemUiMode.IMMERSIVE_STICKY) { | ||
| // STICKY IMMERSIVE | ||
| // Available starting at SDK 20, due to the backwards compatibility provided by the | ||
| // WindowInsetsControllerCompat class for setting the behavior of system bars. | ||
| // Should not show overlays, swipe from edges to reveal overlays. The app will also receive | ||
| // the swipe gesture. The overlays cannot be dismissed, so adding callback support will | ||
| // allow users to restore the system ui and dismiss the overlays. | ||
| // Not compatible with top/bottom overlays enabled. | ||
| windowInsetsControllerCompat.setSystemBarsBehavior( | ||
| WindowInsetsControllerCompat.BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE); | ||
| windowInsetsControllerCompat.hide(WindowInsetsCompat.Type.systemBars()); | ||
| WindowCompat.setDecorFitsSystemWindows(window, false); | ||
| } else if (systemUiMode == PlatformChannel.SystemUiMode.EDGE_TO_EDGE | ||
| && Build.VERSION.SDK_INT >= 29) { | ||
|
There was a problem hiding this comment. This version check can probably be removed now
Contributor
Author
There was a problem hiding this comment. Actually, it seems like there's a test that ensures this is not enabled for versions below this. @Piinks any insight on this?
Contributor
There was a problem hiding this comment. This is restricted on purpose, see flutter/flutter#89774 for context. There was a problem hiding this comment. @Piinks For the comment below, "SDK 29 and up will apply..." are these things set somewhere else? I'm trying to understand where the differences are between the Flutter implementation and the internal Android implementation.
Contributor
Author
There was a problem hiding this comment. Sorry for budding in here, but I did ask @Piinks about this yesterday, and it's my understanding that this comment is a bit misleading. The call made when the edge to edge mode is set in Flutter is just to lay out the app behind the system bars, same for Android. The remaining steps to achieve edge to edge mode like in Android (shown in the guide) in Flutter are done beyond a call to |
||
| // EDGE TO EDGE | ||
| // Available starting at SDK 29. See issue for context: | ||
| // https://github.com/flutter/flutter/issues/89774. | ||
| // Will apply a translucent body scrim behind 2/3 button navigation bars | ||
| // to ensure contrast with buttons on the nav and status bars, unless the contrast is not | ||
| // enforced in the overlay styling. | ||
| WindowCompat.setDecorFitsSystemWindows(window, false); | ||
| } else { | ||
| // When none of the conditions are matched, return without updating the system UI overlays. | ||
| return; | ||
| } | ||
| currentSystemUiMode = systemUiMode; | ||
| } | ||
|
|
||
| private void setSystemChromeEnabledSystemUIOverlays( | ||
|
Contributor
Author
There was a problem hiding this comment. Note that this method is deprecated now. |
||
| List<PlatformChannel.SystemUiOverlay> overlaysToShow) { | ||
| Window window = activity.getWindow(); | ||
| View view = window.getDecorView(); | ||
| WindowInsetsControllerCompat windowInsetsControllerCompat = | ||
| new WindowInsetsControllerCompat(window, view); | ||
|
|
||
| // Start by assuming we want to hide all system overlays (like an immersive | ||
| // game). | ||
| windowInsetsControllerCompat.hide(WindowInsetsCompat.Type.systemBars()); | ||
| WindowCompat.setDecorFitsSystemWindows(window, false); | ||
|
|
||
| // We apply sticky immersive mode if desired. Available starting at SDK 20. | ||
| if (overlaysToShow.size() == 0) { | ||
| currentSystemUiMode = PlatformChannel.SystemUiMode.IMMERSIVE_STICKY; | ||
|
|
||
| windowInsetsControllerCompat.setSystemBarsBehavior( | ||
| WindowInsetsControllerCompat.BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE); | ||
| } | ||
|
|
||
| // Re-add any desired system overlays. | ||
| for (int i = 0; i < overlaysToShow.size(); ++i) { | ||
| PlatformChannel.SystemUiOverlay overlayToShow = overlaysToShow.get(i); | ||
| switch (overlayToShow) { | ||
| case TOP_OVERLAYS: | ||
| windowInsetsControllerCompat.show(WindowInsetsCompat.Type.statusBars()); | ||
| break; | ||
| case BOTTOM_OVERLAYS: | ||
| windowInsetsControllerCompat.show(WindowInsetsCompat.Type.navigationBars()); | ||
| break; | ||
| } | ||
| } | ||
| currentOverlays = overlaysToShow; | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -350,8 +344,11 @@ private void setSystemChromeEnabledSystemUIOverlays( | |
| * PlatformPlugin}. | ||
| */ | ||
| public void updateSystemUiOverlays() { | ||
| setSystemChromeEnabledSystemUIMode(currentSystemUiMode); | ||
|
|
||
| if (currentOverlays != null) { | ||
| setSystemChromeEnabledSystemUIOverlays(currentOverlays); | ||
|
There was a problem hiding this comment.
Is what situation
Contributor
Author
There was a problem hiding this comment. If someone decides to make a call to There was a problem hiding this comment. right, but wouldn't an external call to
Contributor
Author
There was a problem hiding this comment. Oh, I see what you mean. In that case, if |
||
| } else if (currentTheme != null) { | ||
| setSystemChromeSystemUIOverlayStyle(currentTheme); | ||
| } | ||
| } | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line means edge-to-edge mode will become the default mode (related to flutter/flutter#86248 ?). It would be great if we can eventually land this, but do note that it will be a breaking change for apps that don't handle paddings/safe area properly. My team had to manually apply non-trivial fixes (e.g. cl/397106186 and cl/397283284) before enabling this.