一行代码简单实现Android沉浸式Dialog

因为随着全面屏时代的来临,沉浸式的体验对于APP变得越来越重要,Dialog作为APP一种重要的交互方式,如果不实现沉浸式的话,那么Dialog显示时便会在状态栏/系统导航栏/小白条上会出现丑陋的黑边,或出现上下一边有黑边一边没有黑边的情况,影响体验。

Dialog显示时状态栏/系统导航栏/底部小白条上出现黑边

但是,想要在Android中实现理想的沉浸式Dialog,并不是一件容易的事情,不仅Android不同版本的系统实现方式不同,而且Android提供的设置API也并不友好,大多数情况下,若我们想要达到理想的沉浸式Dialog,往往需要花费大量的时间。
由于每个项目都会或多或少遇到这个问题,解决起来也较为繁琐,存在着大量样板代码,所以我做了一个开源Library项目,不仅能够方便大家快速实现Android沉浸式Dialog,也能够大大简化Dialog的配置,让大家聚焦于业务功能代码。

1、Library实现的功能

1、对复杂的Dialog Style和Window进行封装,开发者仅需简单配置即可完成绝多数多配置
2、支持自定义背景颜色、系统栏图标颜色、底部导航栏/小白条背景色等沉浸式配置

2、集成方式

allprojects {
    repositories {
        ...
        maven { url 'https://www.jitpack.io' }
    }
}
// 注意,本项目基于androidx
 implementation 'com.github.Arcns.arc-fast:immersive:1.23.1'
// Library中使用了Constraintlayout,如果你的项目中未引入,那么你还需要
implementation 'androidx.constraintlayout:constraintlayout:yourversion'

3、使用方式

第一步:Dialog改为继承ImmersiveDialog
第二步:实现layoutId(Dialog的布局文件)和immersiveDialogConfig(沉浸式配置)
第三步:在onViewCreated实现您自己的业务逻辑

/**
 * 第一步:Dialog改为继承ImmersiveDialog
 */
class TestDialog : ImmersiveDialog() {

    /**
     * 第二步:实现layoutId(Dialog的布局文件)
     * 注意:您不需要再自行实现onCreateView方法
     */
    override val layoutId: Int get() = R.layout.dialog_test

    /**
     * 第二步:实现immersiveDialogConfig(沉浸式配置),为简化配置,我们内置了三种常用配置:
     * 1. createFullScreenDialogConfig 全屏弹窗配置
     * 2. createBottomDialogConfig 底部弹窗配置
     * 3. createSoftInputAdjustResizeDialogConfig 带输入框的弹窗配置
     * 如果您有更多自定义需求,您可以自行创建自己的ImmersiveDialogConfig
     * 注意:您不需要再自行配置Dialog和Window,通过ImmersiveDialogConfig即可简单完成配置
     */
    override val immersiveDialogConfig: ImmersiveDialogConfig
        get() = ImmersiveDialogConfig.createFullScreenDialogConfig()

    /**
     * 第三步:在onViewCreated实现您自己的业务逻辑
     */
    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)
        ... ...
    }
}

常用案例一:全屏弹窗

override val immersiveDialogConfig
        get() = ImmersiveDialogConfig.createFullScreenDialogConfig().apply {
            height = 500 // 可选:设置弹窗宽度
            width = 500 // 可选:设置弹窗高度
            backgroundDimEnabled = false // 可选:禁用默认弹窗背景
            backgroundColor = 0x99000000.toInt() // 可选:设置弹窗背景的颜色
        }

常用案例二:底部弹窗

override val immersiveDialogConfig
        get() = ImmersiveDialogConfig.createFullScreenDialogConfig().apply {
            height = 500 // 可选:设置弹窗高度
            navigationColor = Color.BLACK  //可选:设置底部导航栏背景为黑色
            isLightNavigationBarForegroundColor = true //可选:设置设置底部导航栏上的图标为白色
        }

常用案例三:带输入框同时需要弹出键盘时自动更改布局的弹窗

override val immersiveDialogConfig
        get() = ImmersiveDialogConfig.createSoftInputAdjustResizeDialogConfig().apply {
            backgroundDimEnabled = false // 可选:该配置下除非禁用backgroundDimEnabled否则navigationColor会无效
            backgroundColor = 0x99000000.toInt() // 可选:设置弹窗背景的颜色
            animations = 0
        }

override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)
        // SoftInputAdjustResizeDialogConfig需要与applyWindowInsetIMEAnimation配合使用
        binding.clContent.applyWindowInsetIMEAnimation(
            dispatchMode = WindowInsetsAnimationCompat.Callback.DISPATCH_MODE_CONTINUE_ON_SUBTREE,
            rootView = view
        )
    }
三种沉浸式效果:createFullScreenDialogConfig、createBottomDialogConfig、createSoftInputAdjustResizeDialogConfig

4、ImmersiveDialogConfig支持的配置参数

配置参数 类型 说明
width Int Dialog的宽度,支持MATCH_PARENT、WRAP_CONTENT或具体数值
height Int Dialog的高度,支持MATCH_PARENT、WRAP_CONTENT或具体数值
gravity Int 弹窗的位置,支持Gravity.CENTER、Gravity.BOTTOM等位置
backgroundDimEnabled Boolean 启用系统自带的弹窗半透明黑色背景
backgroundDimAmount Float 系统自带背景的透明值,范围为0[完全透明]-1[不透明]
backgroundColor Int 自定义的弹窗背景颜色,只有backgroundDimEnabled为false时才有效果
navigationColor Int 弹窗系统导航栏处/底部小白条的颜色
animations Int 弹窗动画的资源文件,为0时表示无动画
canceledOnTouchOutside Boolean 触摸弹窗之外的地方是否关闭弹窗
cancelable Boolean 点击返回按键是否关闭弹窗
isLightStatusBarForegroundColor Boolean 系统状态栏上的图标与文字是否显示为白色
isLightNavigationBarForegroundColor Boolean 系统导航栏上的图标是否显示为白色
enableWrapDialogContentView Boolean 启用弹窗内容根视图包裹。注意如果不启用,则由背景实现视图包裹功能(navigationColor由背景包裹控制,而且除非禁用backgroundDimEnabled否则navigationColor无效)
enableSoftInputAdjustResize Boolean 启用打开键盘时自动重置弹窗布局大小,避免布局被键盘遮挡。注意启用后,内容无法扩展到全屏,通常R版本以下带输入框同时需要弹出键盘时自动更改布局的弹窗需设置该项为true,否则键盘打开后无法重置布局
updateCustomDialogConfig (dialog, window) -> Unit 更新dialog更多自定义配置

项目地址:
https://github.com/Arcns/arc-fast

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,186评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,858评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,620评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,888评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,009评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,149评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,204评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,956评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,385评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,698评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,863评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,544评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,185评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,899评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,141评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,684评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,750评论 2 351

推荐阅读更多精彩内容