11.5K ·GitHub
What is this?
ImmersionBar is an Android library that manages immersive (full-bleed) status bars and navigation bars, letting you tint status bar text, change navigation bar icon color, and handle things like rotation, notches, and the soft keyboard with minimal code.
ImmersionBar is an Android library that manages immersive (full-bleed) status bars and navigation bars, letting you tint status bar text, change navigation bar icon color, and handle things like rotation, notches, and the soft keyboard with minimal code.Is this a standalone app or a library I add to my project?It is a library you add as a Gradle dependency to an existing Android app; it is not a standalone application.
It is a library you add as a Gradle dependency to an existing Android app; it is not a standalone application.How do I add it to my project?Add the ImmersionBar dependency from Maven Central for versions 3.1.1 and above (or the older JCenter artifact for 3.0.0), then call its API with one line of code in your Activity, Fragment, Dialog, DialogFragment, or PopupWindow.
Add the ImmersionBar dependency from Maven Central for versions 3.1.1 and above (or the older JCenter artifact for 3.0.0), then call its API with one line of code in your Activity, Fragment, Dialog, DialogFragment, or PopupWindow.Do I need anything special to use it?Just a standard Android project targeting API 19 (Android 4.4) or above; no extra SDK or external service is required.
Just a standard Android project targeting API 19 (Android 4.4) or above; no extra SDK or external service is required.Does it work the same on every device?No — some devices can't change status bar font color to dark even over a white background, which needs a separate workaround, and one PopupWindow method can cause the navigation bar to overlap the bottom layout or block the keyboard-driven input field from rising.
No — some devices can't change status bar font color to dark even over a white background, which needs a separate workaround, and one PopupWindow method can cause the navigation bar to overlap the bottom layout or block the keyboard-driven input field from rising.What Android versions and screen types does it support?It targets Android 4.4 and newer, and explicitly adapts for landscape/portrait switching, notch screens, and gesture navigation detection.
It targets Android 4.4 and newer, and explicitly adapts for landscape/portrait switching, notch screens, and gesture navigation detection.Does it need ProGuard rules if I shrink my app?No extra ProGuard rules are needed for version 3.1.1 and above; only versions below 3.1.1 require the proguard-rules.pro entries.
No extra ProGuard rules are needed for version 3.1.1 and above; only versions below 3.1.1 require the proguard-rules.pro entries.Can I check navigation bar height or visibility programmatically?Yes, it exposes static helpers like getNavigationBarHeight(), hasNavigationBar(), isNavigationAtBottom(), and getBarProperties() for a full snapshot of status/navigation bar state.
Yes, it exposes static helpers like getNavigationBarHeight(), hasNavigationBar(), isNavigationAtBottom(), and getBarProperties() for a full snapshot of status/navigation bar state.How do I avoid the status bar overlapping my layout?The README lists six approaches, from setting a fixed dimen height to using fitsSystemWindows, ImmersionBar's own statusBarView()/titleBar()/titleBarMarginTop() methods.
The README lists six approaches, from setting a fixed dimen height to using fitsSystemWindows, ImmersionBar's own statusBarView()/titleBar()/titleBarMarginTop() methods.Does it work inside Fragments used with ViewPager2?Yes, if a Fragment's visibility is controlled by ViewPager2 with BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT, you call ImmersionBar directly in onResume(); other show/hide patterns are also documented in the demo.
Yes, if a Fragment's visibility is controlled by ViewPager2 with BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT, you call ImmersionBar directly in onResume(); other show/hide patterns are also documented in the demo.What are similar projects?MaterialDrawer, SlidingMenu, QMUI_Android, FlycoTabLayout, AndroidSwipeLayout, GSYVideoPlayer, RxTool, material-components-android
MaterialDrawer, SlidingMenu, QMUI_Android, FlycoTabLayout, AndroidSwipeLayout, GSYVideoPlayer, RxTool, material-components-androidWhich topics is it in?bar, dialog, status, statusbar, android-ui, status-bar, navigation, android-development, android-library, kotlin, customization, java
bar, dialog, status, statusbar, android-ui, status-bar, navigation, android-development, android-library, kotlin, customization, java