一行代码简单实现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.gitee.arcns.arc-fast:immersive:1.18.2'
// 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
https://gitee.com/arcns/arc-fast
作者：
Arcns