Gathering detailed insights and metrics for @aladdinstudios/react-native-immersive-bars
Gathering detailed insights and metrics for @aladdinstudios/react-native-immersive-bars
React Native component to change bottom bar/navigation bar to be transparent on Android
Installations
npm install @aladdinstudios/react-native-immersive-barsDeveloper
aladdinstudios
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
Typescript Support
Yes
Node Version
16.13.0
NPM Version
8.1.0
Statistics
29 Commits
2 Branches
2 Contributors
Updated on 11 Feb 2023
Bundle Size
226.00 B
Minified
178.00 B
Minified + Gzipped
Languages
Java (93.7%)
JavaScript (6.3%)
Total Downloads
Cumulative downloads
Total Downloads
24,147
Last day
76.2%
111
Compared to previous day
Last week
23.6%
675
Compared to previous week
Last month
10.5%
2,826
Compared to previous month
Last year
5,166%
23,697
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
1
Versions
React Native Immersive Bars
Do you like the button slider that changes from light to dark mode? That's another package that I've built:
react-native-button-toggle-group
Google officially suggests apps that target Q or higher to render content under the statusbar and navbar. However, doing so previously was difficult to do and required some customization and tweaking. Not to mention the variant support for other APIs.
Well, this package enables you to easily do so across various Android APIs levels. It also mocks out usage with iOS and other platforms, so you're able to use it in cross-platform apps.
⚠ This package only supports Android 5.0 and higher ⚠
This package is meant to be used alongside the
react-native-safe-area-contextpackage in order to provide proper padding and margins in order to keep scrollviews and others from being stuck forever under the navbar.Please refer to that package's README for more information on how to use it.
Install
npm i --save @aladdinstudios/react-native-immersive-bars
Or
yarn add @aladdinstudios/react-native-immersive-bars
Android
If you're targeting API 29+ in your React Native app, you need to do one more step to enable the fully transparent bars. Add:
1<item name="android:enforceNavigationBarContrast">false</item>
To:
android\app\src\main\res\values\styles.xml
Usage
Usage in JavaScript
1import { changeBarColors } from "@aladdinstudios/react-native-immersive-bars"; 2 3// ... 4 5React.useEffect(() => { 6 changeBarColors(isDarkMode, "#50000000", "transparent"); 7 // or changeBarColors(isDarkMode); 8}, [isDarkMode]);
The changeBarColors function has a single required parameter and two optional ones.
isDarkMode(Required): If the app is in dark mode or not - will apply proper styling to icons and statusbar/navbar backgroundtranslucentLightStr(Optional): When a translucent bar must be drawn (due to API restrictions), what color it should be drawn in light modetranslucentDarkStr(Optional): When a translucent bar must be drawn (due to API restrictions), what color it should be drawn in dark mode
Both translucentLightStr and translucentDarkStr accept and color that Color.parseColor is able to handle as well as the string 'transparent'.
THIS MEANS THAT THREE DIGIT HEX SHORTHAND LIKE
#FFFWILL CAUSE YOUR APP TO CRASH
Adding to onCreate (Optional)
If you only use the JavaScript code, your app will flash the navbar once the App.tsx code finally renders. If you want to avoid a jump like that, you can edit your code in:
android > app > src > main > java > yourpackagepath > MainActivity.java
And change the code to reflect this:
1import com.facebook.react.ReactActivity; 2import com.rnimmersivebars.ImmersiveBars; // here 3 4public class MainActivity extends ReactActivity { 5 @Override 6 protected void onCreate(Bundle savedInstanceState) { 7 boolean isDarkMode = false; // Customize this to match your app's default theme 8 ImmersiveBars.changeBarColors(this, isDarkMode); // here 9 super.onCreate(savedInstanceState); 10 } 11 // ...other code 12}
Notice about Fork
This package is a fork of react-native-immersive-bars. Initially this just made the package work after the jcenter was shut down. I have a PR open to merge this into the original package, but I'm not sure if it will be merged.
I also plan to add TurboModules support to this package, but I'm not sure when I'll get around to it. If I do, I'll make a PR to the original package as well.
Alternatives
If you don't need to use a fullscreen navbar, then you can simply change the color of the navbar itself with this package:
Note that this package does not play nice with react-native-safe-area-context's edge detection.
Otherwise, if you want to hide the navbar and the statusbar in their entirety, I'd suggest taking a look at the following package:
No vulnerabilities found.
No security vulnerabilities found.