Skip to content

Latest commit

 

History

History
203 lines (173 loc) · 7.36 KB

README.md

File metadata and controls

203 lines (173 loc) · 7.36 KB
Raw

UltimateBarX

一款方便的设置状态栏和导航栏的各种效果的框架

github 地址：UltimateBarX

gitee 地址：UltimateBarX

详细介绍：这就是 github 上最好用的 Android 状态栏导航栏库

  • 可以设置各种效果，透明、半透明、固定颜色、布局是否侵入等
  • 状态栏和导航栏分开设置，互不影响
  • 支持 Android 4.4 以上，各系统版本的现实效果高度统一
  • 支持低版本（不支持变灰）重新设置状态栏导航栏的背景
  • 支持 Activity 和 Fragment
  • 同一个 Activity 或 Fragment 可以多次设置不同的效果
  • 适配刘海屏、滴水屏、挖孔屏、全面屏
  • 适配 miui、emui、funtouch 等 rom
  • 适配横屏、竖屏

同类型框架对比

UltimateBarX StatusBarCompat StatusBarUtil ImmersionBar
状态栏修改 ✅ ✅ ✅ ✅
导航栏修改 ✅ ❌ ❌ ✅
状态栏和导航栏
独立设置互不影响		 ✅ ❌ ❌ ❌
light 模式 ✅ ✅ ✅ ✅
light 模式兼容低版本 ✅ ❌ ❌ ✅
支持 Fragment ✅ ❌ ❌ ✅
布局侵入 ✅ ✅ ✅ ✅
布局不侵入 ✅ ✅ ✅ ✅
侵入和不侵入无缝切换 ✅ ❌ ❌ ❌
多次设置 ✅ ✅ ✅ ✅
适配全面屏 ✅ ❌ ❌ ✅
国产 rom 导航栏适配 ✅ ❌ ❌ ⭕️
BottomNavigationView 兼容 ✅ ❌ ❌ ❌
软键盘 adjustResize 兼容 ✅ ❌ ❌ ❌

使用方法

在根目录的 build.gradle 里面添加

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

在子目录的 build.gradle 中添加

dependencies {
    // release 版本
    // 将 $lastVersion 替换成上图中的版本号
    implementation 'com.gitee.zackratos:UltimateBarX:$lastVersion'
    
    // snapshot 版本
    implementation 'com.gitee.zackratos:UltimateBarX:dev-SNAPSHOT'
}

UltimateBarX 中提供了三个方法，分别是

// 只需要设置状态栏，不需要设置导航栏
statusBarOnly {
    // 布局是否侵入状态栏（true 不侵入，false 侵入）
    fitWindow = true
    // 状态栏背景颜色（色值）
    color = Color.RED
    // 状态栏背景颜色（资源 id）
    colorRes = R.color.deepSkyBlue
    // 状态栏背景 drawable
    drawableRes = R.drawable.bg_common
    // 以上三个设置背景的方法用一个即可，如多次设置，后面的会把前面的覆盖掉
    // light模式：状态栏字体 true: 灰色，false: 白色 Android 6.0+
    light = true
    // 低版本 light 模式不生效，重新设置状态栏背景
    // 防止状态栏背景色跟字体颜色一致导致字体看不见
    // lvl 系列方法仅在低版本（不支持 light 模式的版本）下开启 light 模式生效
    lvlColor = Color.BLACK
    lvlColorRes = R.color.cyan
    lvlDrawableRes = R.drawable.bg_lvl
    // 以上三个 lvl 方法用一个即可，如多次设置，后面的会把前面的覆盖掉
}

// 设置状态栏
statusBar {
    fitWindow = true
    // ...
}

// 设置导航栏
navigationBar {
    fitWindow = true
    // ...
}

这三个方法都可以在 Activity 和 Fragment 中使用
如果当前 Activity 或 Fragment 只需要设置状态栏不需要设置导航栏建议使用 statusBarOnly 方法（使用 statusBar 方法也可以，但是在某些极端的情况下可能会出现异常效果）
其实国内的大部分（99%）需求都不需要设置导航栏，所以一般情况下，可以直接使用 statusBarOnly 方法
statusBarOnly 方法不可与 statusBar 方法同时使用，也不可与 navigationBar 方法同时使用，切记！！！ 同时使用会出现异常效果（statusBar 方法和 navigationBar 方法可以同时使用）
也就是说，如果只需要设置状态栏，直接使用 statusBarOnly 方法， 如果需要同时设置状态栏和导航栏，使用 statusBar 方法和 navigationBar 方法组合实现需要的效果（如果只需要设置导航栏，那就使用 navigationBar 方法，不过这种需求几乎不存在）
使用 statusBarOnly 方法可以解决一切导航栏异常的问题，可以查看 issues44 里面的解释

使用 transparent 方法可以快速设置透明效果

statusBarOnly {
    transparent()
}

跟下面的写法效果是一样的

statusBarOnly {
    fitWindow = false
    color = Color.TRANSLUCENT
}

使用 get 系列方法可以在上一次的基础上修改

例如，先用下面的代码实现状态栏变红色，不侵入，非 light 模式

statusBarOnly {
    color = Color.RED
    fitWindow = true
    light = false
}

然后需要设置 light 模式，其他效果保持不变，直接用下面的方法即可

getStatusBarOnly {
    light = true
}

get 系列方法包括 getStatusBarOnly、getStatusBar、getNavigationBar

当布局可侵入状态栏或导航栏时，如果需要给某个 View 增加状态栏或者导航栏的高度，可以

targetView.addStatusBarTopPadding()
targetView.addNavigationBarBottomPadding()

java 中使用

UltimateBarX.statusBarOnly(this)
        .fitWindow(true)
        .colorRes(R.color.deepSkyBlue)
        .light(true)
        .lvlColorRes(R.color.cyan)
        .apply();

如果项目中引入了 kotlin，也可以直接调用 kotlin 的扩展方法

UltimateBarXKt.statusBarOnly(this, barConfig -> {
    barConfig.setFitWindow(true);
    barConfig.setColorRes(R.color.deepSkyBlue);
    barConfig.setLight(true);
    barConfig.setLvlColorRes(R.color.cyan);
    return null;
});

0.7.0 以下版本的使用方法见 INSTRUCTION.old

ProGuard

-keep class com.zackratos.ultimatebarx.ultimatebarx.** { *; }
-keep public class * extends androidx.fragment.app.Fragment { *; }

截图

　

　

　

Change Log

CHANGELOG

联系我

在使用中遇到任何问题，欢迎加我微信交流

License

Copyright 2020 Zackratos

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.