Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/niorgai/StatusBarCompat
Status Bar Utils ---- Change Status Bar Mode Simply
https://github.com/niorgai/StatusBarCompat
Last synced: 1 day ago
JSON representation
Status Bar Utils ---- Change Status Bar Mode Simply
- Host: GitHub
- URL: https://github.com/niorgai/StatusBarCompat
- Owner: niorgai
- License: mit
- Created: 2016-03-21T03:06:13.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-06-25T03:51:22.000Z (almost 5 years ago)
- Last Synced: 2024-02-29T03:38:19.512Z (4 months ago)
- Language: Java
- Homepage: http://niorgai.github.io/2016/03/20/Android-transulcent-status-bar/
- Size: 4.54 MB
- Stars: 2,166
- Watchers: 58
- Forks: 356
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: License.md
Lists
- awesome-github-android-ui - StatusBarCompat - Android 沉浸式状态栏 (状态栏)
- awesome-github-android-ui - StatusBarCompat - Android 沉浸式状态栏 (状态栏)
README
# StatusBarCompat
[](https://android-arsenal.com/details/1/3349)
**Only work for SDK >= 19.**
[Demo Download](https://www.pgyer.com/IZjM)
# Usage
Add it in your root build.gradle at the end of repositories:
```groovy
allprojects {
repositories {
...
maven { url "https://jitpack.io" }
}
}
```
Add the dependency
```groovy
dependencies {
// After AndroidX
implementation ('com.github.niorgai:StatusBarCompat:2.3.3', {
exclude group: 'androidx.appcompat:appcompat'
exclude group: 'com.google.android.material:material'
})
// Before AndroidX
compile ('com.github.niorgai:StatusBarCompat:2.1.4', {
exclude group: 'com.android.support'
})
}
```
KITKAT(19) | LOLLIPOP(21)
--- | ---
| 
TranslucentStatusBar | SetStatusBarColor
--- | ---
| 
---
This is a utils for status bar, And you **do not need to** change your `style.xml` file.
The most important feature is **you can toggle `setStatusBarColor` and `translucentStatusBar` without recreate activity**.
```java
//set color for status bar
StatusBarCompat.setStatusBarColor(Activity activity, int color)
//add alpha to color
StatusBarCompat.setStatusBarColor(Activity activity, int statusColor, int alpha)
//translucent status bar
StatusBarCompat.translucentStatusBar(activity);
//should hide status bar background (default black background) when SDK >= 21
StatusBarCompat.translucentStatusBar(Activity activity, boolean hideStatusBarBackground);
//set color for CollapsingToolbarLayout
setStatusBarColorForCollapsingToolbar(Activity activity, AppBarLayout appBarLayout, CollapsingToolbarLayout collapsingToolbarLayout,
Toolbar toolbar, int statusColor)
//Change to Light status bar (convert icon and text color to dark, SDK >= 23)
changeToLightStatusBar(Activity activity)
//Cancel Light status bar (convert icon and text color to light)
cancelLightStatusBar(Activity activity)
```
# How to use
1. Use it after call `setContentView`
2. If use FullScreen Activity, must call `StatusBarCompat.translucentStatusBar(activity);`
3. If you want to set light status bar, Remember call `changeToLightStatusBar()` at last.
# About Demo:
Demo shows One Activity with four Fragments.
1. CommonFragment call `setStatusBarColor` method, SeekBar can change statusBar's alpha.
2. TranslucentFragment call `translucentStatusBar` method, when sdk >= 21, button can toggle hide/show statusBar's shadow.
3. DrawerFragment call `setStatusBarColor` method, show how to compat for DrawerLayout and CoordinatorLayout.
4. CollapsingFragment call `setStatusBarColorForCollapsingToolbar` method, compat for CollapsingToolbarLayout.
5. Each Fragment can toggle Light status bar with Checkbox.
## Issues:
These problem only show in SDK between 19 and 21:
1. If work with `TabActivity`, It will show a black line in contentView, so you can call `StatusBarCompat.setStatusBarColor(Activity activity, int statusColor, int alpha)` and the suggest alpha is 112.
2. If first view is `DrawerLayout`, let its child view set `fitsSystemWindow` to false.
3. When use `translucentStatusBar`, the method set `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN` to Window, so there will be [AndroidBug5497](https://issuetracker.google.com/issues/36911528) if work with softInputKeyboard, try [Workaround](https://github.com/madebycm/AndroidBug5497Workaround) to get help.
# Link:
1. Blog [Android-translucent-status-bar](http://niorgai.github.io/2016/03/20/Android-transulcent-status-bar/).
中文版
---
透明状态栏只有在 SDK >= 19 (Android 4.4) 才会生效.
透明状态栏 | 设置状态栏的颜色
--- | ---
|
这是一个为了兼容处理状态栏的工具类,可以不需要设置不同的`style.xml`文件,最重要的特性就是可以在**不重启 Activity 的情况下切换 `setStatusBarColor` 和 `translucentStatusBar` **. 提供以下 API :
```java
//设置状态栏的颜色
StatusBarCompat.setStatusBarColor(Activity activity, int color)
//添加alpha值
StatusBarCompat.setStatusBarColor(Activity activity, int statusColor, int alpha)
//透明状态栏
StatusBarCompat.translucentStatusBar(activity);
//SDK >= 21时, 取消状态栏的阴影
StatusBarCompat.translucentStatusBar(Activity activity, boolean hideStatusBarBackground);
//为 CollapsingToolbarLayout 设置颜色
setStatusBarColorForCollapsingToolbar(Activity activity, AppBarLayout appBarLayout, CollapsingToolbarLayout collapsingToolbarLayout, Toolbar toolbar, int statusColor)
//SDK >= 23, 将状态栏改为浅色模式(状态栏 icon 和字体会变成深色)
changeToLightStatusBar(Activity activity)
//将状态栏改为深色模式(状态栏 icon 和字体会变成浅色, 即默认模式)
cancelLightStatusBar(Activity activity)
```
# 怎么使用
1. 在 `setContentView` 方法调用后再设置.
2. 如果要使用全屏 Activity , 调用 `StatusBarCompat.translucentStatusBar(activity)` .
3. 如果想让状态栏图标变成深色, 记得**最后**调用 `changeToLightStatusBar(activity)` .
# Demo 说明:
Demo 只有一个 Activity , 分四个 Tab.
1. CommonFragment 为正常布局, 可以通过 SeekBar 来调整状态栏颜色的 alpha 值. 调用方法为: `setStatusBarColor`.
2. TranslucentFragment 为图片布局, 展示透明状态栏效果, SDK >= 21时, 可以通过按钮显示\隐藏 statusBar 的 shadow, 调用方法为: `translucentStatusBar`.
3. DrawerFragment 展示 DrawerLayout + CoordinatorLayout, 调用方法为: `setStatusBarColor`.
4. CollapsingFragment 展示 CollapsingLayout 的适配效果, 调用方法为: `setStatusBarColorForCollapsingToolbar`.
5. 每个 Fragment 下都可以通过 Checkbox 切换浅色/深色状态栏.
## 已知问题
这些问题仅仅出现在 4.4 上
1. 如果用在 TabActivity 上, 会有一条黑线在状态栏下面, 推荐使用 `StatusBarCompat.setStatusBarColor(Activity activity, int statusColor, int alpha)` 方法, 推荐的透明值为 112.
2. 如果 layout 中第一个 View 为 DrawerLayout, 那么它的子 View 的 fitsSystemWindow 需要设置为 false.
3. 调用 `translucentStatusBar` 方法时, 会给 Window 设置 `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`, 这个 Flag 和软键盘一起使用的时候可能会导致 [AndroidBug5497](https://issuetracker.google.com/issues/36911528), 可以尝试使用 [这个方法](https://github.com/madebycm/AndroidBug5497Workaround) 解决.
# 更多
在我的博客 [Android-translucent-status-bar](http://niorgai.github.io/2016/03/20/Android-transulcent-status-bar/) 中可以查看更多细节.
# License
The MIT License (MIT)
Copyright (c) 2016 JQ
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.