GT2/Ejectable/node_modules/expo-status-bar/README.md

36 lines
1.6 KiB
Markdown
Raw Normal View History

2021-08-16 00:14:59 +00:00
# expo-status-bar
Provides the same interface as the React Native [StatusBar API](https://reactnative.dev/docs/statusbar), but with slightly different defaults to work great in Expo environments.
- Default to `translucent={true}` on Android.
- The `style="auto"` maps to a dark status bar when in light mode and a light status bar when in dark moded. `style="inverted"` inverts this behavior.
# API documentation
- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/status-bar.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/status-bar/)
# Installation in managed Expo projects
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/image/). If you follow the link and there is no documentation available then this library is not yet usable within managed projects — it is likely to be included in an upcoming Expo SDK release.
Please refer to the [React Native StatusBar API documentation](https://reactnative.dev/docs/statusbar).
# Installation in bare React Native projects
```
npm install expo-status-bar
```
### Configure for iOS
Run `npx pod-install` after installing the npm package.
### Configure for Android
No additional setup necessary.
# Contributing
Contributions are very welcome! Please refer to guidelines described in the [contributing guide](https://github.com/expo/expo#contributing).