gongminghbsz/smart-show

Toast & Snackbar & TopBar & Dialog

SmartShow

android studio 升至3.4（gradle5.1.1），编译报错问题，请尽快使用最新版本2.7.5

关注技术公众号，随时获知库的更新及其他优质技术文章。

模块导航：

• SmartToast
• SmartSnackbar
• SmartTopBar
• SmartDialog
• 关于实现
• 关于作者及技术交流
• 引入该库

功能总览：

1. 优雅封装，简化调用
2. 处理系统bug等，如Android 7.1系统关于Toast的BadTokenException
3. 解决已知的UI性能缺陷，提高用户体验，如Toast重复弹跳等,关闭通知权限后Toast不显示
4. 对不同系统版本及厂商设备进行适配
5. 合理的复用策略，节约内存开销的同时及时解除引用以便被垃圾回收器回收
6. 根据实际开发中的常见需求，进行功能扩展

四大模块的详细功能可查看下面各模块的介绍

效果展示

    
    

代码实现

回到模块导航

如果你对实现感兴趣，请参考我的CSDN博客：

• 2.x 版本 https://blog.csdn.net/jungle_pig/article/details/83959662
• 1.x 版本 https://blog.csdn.net/jungle_pig/article/details/78568493
  已授权郭霖微信公众号 同步发表：
• 2.x 版本 https://mp.weixin.qq.com/s/7qQdPLLfhZA_i7HjucfgWA
• 1.x 版本 https://mp.weixin.qq.com/s/l62PtbmrIOkVKfJ2r0JwEw

关于作者

回到模块导航

为使SmartShow库更加健壮，如果您在使用过程中发现任何问题，请联系我，我会立即跟进修复和维护。感谢您的支持！

作者：朱志强

微信：w361281607



邮箱：coder_zzq@163.com

技术公众号：

引入SmartShow

回到模块导航

1. 在Project的gradle文件中
   

allprojects {

    repositories {

        ...

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

    }

}

2. 在Module的gradle文件中
   
   第一种方式，引入所有模块

    implementation ('com.github.the-pig-of-jungle.smart-show:all:2.7.5'){
    
        exclude group: 'com.android.support'
        
    }
        
        //添加与你项目匹配的design依赖库的相应版本
        
        implementation 'com.android.support:design:x.y.z'
        

第二种方式，自由引入各个模块

    //smart toast

    implementation 'com.github.the-pig-of-jungle.smart-show:toast:2.7.5'

    // smart dialog
    
    implementation 'com.github.the-pig-of-jungle.smart-show:dialog:2.7.5'

    // smart topbar
    
    implementation('com.github.the-pig-of-jungle.smart-show:topbar:2.7.5') {
    
        exclude group: 'com.android.support'
        
    }
    
    //添加与你项目匹配的design依赖库的相应版本
            
    implementation 'com.android.support:design:x.y.z'

    // smart snackbar
    
    implementation('com.github.the-pig-of-jungle.smart-show:snackbar:2.7.5') {
    
        exclude group: 'com.android.support'
        
    }
    
    //添加与你项目匹配的design依赖库的相应版本
                
    implementation 'com.android.support:design:x.y.z'

3. 在Application的onCreate方法中初始化
   

        SmartShow.init(this);

SmartToast部分

回到模块导航

1. 使用application context，而不是activity，避免因activity生命周期问题引起的各种问题
2. 复用Toast实例，当Toast正在显示时，多次触发内容和位置均未改变的Toast，不会重复弹出；下一个Toast不会等到上一个Toast的Duration耗尽才弹出
3. 解决传统复用模式的功能缺陷，如正在显示一个内容为"A"的Toast，此时再弹出内容为"B"的Toast时，文本虽改变，但没有弹出效果；如果复用的Toast正在显示，改变其Gravity以改变显示位置会无效，直到消失后再次显示才生效
4. 可修改Toast默认布局的风格，如背景颜色，文字大小和颜色等
5. 可为Toast设置自定义布局
6. 完美解决Android 7.1的系统bug——Toast BadTokenException
7. 完美解决应用关闭通知权限后Toast不显示问题
8. 可配置离开当前页面（退出当前activity或进入新的activity），立即消失正在显示的Toast
9. 结合主流app消息提示的效果，提供info、success、error、warning、complete、forbid、wait、fail 8 种类型的Toast

API

调用show方法显示Toast，duration和常用的显示位置体现在方法名上，而不是传参，调用非常简易

普通 Toast

默认样式：设置背景色：

        //在默认位置显示

        SmartToast.show("我是朱志强");
        
        SmartToast.showLong("我是朱志强");



        //在屏幕顶部显示，水平居中，距离顶部距离与在默认位置显示时，距离底部的距离一致

        SmartToast.showAtTop("我是朱志强");
        
        SmartToast.showLongAtTop("我是朱志强");



        //在屏幕**显示

        SmartToast.showInCenter("我是朱志强");
        
        SmartToast.showLongInCenter("我是朱志强");



        //在左上角，x，y偏移量为10dp的位置显示

        SmartToast.showAtLocation("我是朱志强",Gravity.LEFT | Gravity.TOP,10,10);
        
        SmartToast.showLongAtLocation("我是朱志强",Gravity.LEFT | Gravity.TOP,10,10);

Type Toast

type toast 均居中显示

默认样式：设置主题色：

        //普通
        
        SmartToast.info("已在后台下载");
        
        SmartToast.infoLong("已在后台下载");
        
        
        
        //成功
        
        SmartToast.success("重置成功");
        
        SmartToast.successLong("重置成功");
        
        
        
        //错误
        
        SmartToast.error("保存失败");
        
        SmartToast.errorLong("保存失败");
        
        
        
        //警告
        
        SmartToast.warning("电量过低，请充电");
                
        SmartToast.warningLong("电量过低，请充电");
        
        
        //完成
        
        SmartToast.complete("下载完成");
        
        SmartToast.completeLong("下载完成");
        
        
        //失败
        
        SmartToast.fail("保存失败");
        
        SmartToast.failLong("保存失败");
        
        
        //禁止
        
        SmartToast.forbid("当前账户不允许汇款操作");
        
        SmartToast.forbidLong("当前账户不允许汇款操作");
        
        
        //等候
        
        SmartToast.waiting("已在后台下载，请耐心等待");
        
        SmartToast.waitingLong("已在后台下载，请耐心等待");

定制化

若自定义布局，可调用View方法传入，在布局中必须定义id为android:id="@id/custom_toast_msg"的TextView显示消息文本

          //自定义布局

          IPlainToastSetting customView(CustomViewCallback callback);

         //设置布局背景颜色

         IPlainToastSetting backgroundColor(@ColorInt int color);

         IPlainToastSetting backgroundColorRes(@ColorRes int colorRes);



         // 设置消息文本颜色

         IPlainToastSetting textColor(@ColorInt int color);

         IPlainToastSetting textColorRes(@ColorRes int color);



         //设置消息文本大小

         IPlainToastSetting textSizeSp(float sp);



         //消息文本是否为粗体

         IPlainToastSetting textBold(boolean bold);

         例子：

          SmartToast.plainSetting()

                    .backgroundColorRes(R.color.colorPrimary)

                    .textSizeSp(18)

                    .textBold(true)

                    .customView(new IPlainToastSetting.CustomViewCallback() {

                         @Override
                         public View createToastView(LayoutInflater inflater) {

                            View view = inflater.inflate(R.layout.custom_toast,null);

                            return view;
                         }
                    });

配置 Type Toast 的主题色

        ITypeToastSetting themeColor(@ColorInt int color);

        ITypeToastSetting themeColorRes(@ColorRes int colorRes);

        例子：

        SmartToast.typeSetting()

                .themeColorRes(R.color.colorPrimary);

配置离开当前activity时，是否立即隐藏正在显示的Toast（不管是普通Toast还是 Type Toast），默认false

        IGlobalSetting dismissOnLeave(boolean b);
        
        例子：
        
        SmartToast.globalSetting()

                        .dismissOnLeave(true);

判断显示和隐藏

         //是否有Toast在显示
         
         SmartToast.isShowing();

         //隐藏当前显示的Toast

         SmartToast.dismiss();

SmartSnackbar部分

回到模块导航

1. 复用Snackbar实例，当Snackbar正在显示，多次触发时，若msg和actionTex均未改变，则不会重复弹出，否则会有弹出效果
2. 可修改布局风格，如背景颜色，文字大小和颜色等
3. 可配置离开当前Activity时，立即消失正在显示的Snackbar。如，在Activity A 上显示了一个Indefinite Snackbar，并且用户没有点击响应，启动activity B，然后再返回A，原来的Snackbar已自动消失

API

传入当前界面的Activity,获取Snackbar，三种duration体现在方法名上，而不是传参，尽可能简化调用

只传入消息文本

        //short snackbar
        
        SmartSnackbar.get(this).show("我是朱志强");


        
        //long snackbar
        
        SmartSnackbar.get(this).showLong("我是朱志强");


        
       //indefinite snackbar,只传入消息文本时，会显示默认的动作文本"确定"，点击动作文本，执行默认行为——Snackbar消失
        
       SmartSnackbar.get(this).showIndefinite("我是朱志强");     

只传入消息文本和动作文本，则点击动作文本执行默认逻辑--Snackbar消失

       //short snackbar
       
       SmartSnackbar.get(this).show("为SmartShow Star 一下可以么","好的");


       
       //long snackbar
       
       SmartSnackbar.get(this).showLong("为SmartShow Star 一下可以么","好的");


       
       //indefinite snackbar
       
       SmartSnackbar.get(this).showIndefinite("为SmartShow Star 一下可以么","好的");

传入消息文本和动作文本以及动作监听器

       SmartSnackbar.get(this).show("我是朱志强", "打赏", new View.OnClickListener() {
       
           @Override
           public void onClick(View v) {
       
                //...
       
              }
           });


           
       SmartSnackbar.get(this).showLong("我是朱志强", "打赏", new View.OnClickListener() {
       
           @Override
           public void onClick(View v) {
       
                //...
       
              }
           });


           
       SmartSnackbar.get(this).showIndefinite("我是朱志强", "打赏", new View.OnClickListener() {
       
           @Override
           public void onClick(View v) {
           
                //...
                
           });              

• 以上示例获取SmartSnackbar使用的是SmartSnackbar.get(this)，this为当前界面activity，还可使用SmartSnackbar.get(CoordinatorLayout view)。
• 根据谷歌源码，我们知道创建Snackbar时需传入一个当前activity的某个View。实际上，Snackar会以该View为基点，沿着整个View Tree上溯，直到找到CoordinatorLayout容器或android.R.id.content 容器，哪个先找到，就将视图嵌入其中。以CoordinatorLayout为内嵌容器时，Snackbar会有一些特殊的行为，如可以用手指手动滑动移除，显示时会导致FloatingActionButton升高等。 为了提高效率，直接将android.R.id.content或者CoordinatorLayout传入会更好。
• SmartSnackbar对入口做了限制，如果你的页面想以某个具体CoordinatorLayout作为容器，则调用get(CoordinatorLayout view)。否则调用get(Activity activity)，内部会自动将该Activity的 android.R.id.content作为容器。

定制化

定制化SmartSnackbar，可调用setting方法获取ISnackbarSetting对象进行全局配置

在application的onCreate方法里执行配置代码

        //获取ISnackbarSetting对象
        
        SmartSnackbar.setting()

配置布局风格

        //设置背景颜色
        
        ISnackbarSetting backgroundColor(int color);
        
        ISnackbarSetting backgroundColorRes(int colorRes);


        
        //设置消息文本颜色
        
        ISnackbarSetting msgTextColor(@ColorInt int color);
        
        ISnackbarSetting msgTextColorRes(@ColorRes int colorRes);


        
        //设置消息文本大小
        
        ISnackbarSetting msgTextSizeSp(float textSizeSp);


        
        //设置动作文本颜色
        
        ISnackbarSetting actionColor(@ColorInt int color);
        
        ISnackbarSetting actionColorRes(@ColorRes int colorRes);


        
        //设置动作文本大小
        
        ISnackbarSetting actionSizeSp(float textSizeSp);


        
        //对布局进一步处理，callback中会传入布局的根View和显示消息文本的TextView以及动作文本的Button，
                 
        //callback中的处理和以上配置方法的处理有冲突时，将覆盖掉以上的配置
        
        ISnackbarSetting processView(IProcessBarCallback callback);


        
        //设置调用Indefinite Snackbar时，如果只传入消息文本，默认显示的动作文本字符串，如果不设置，即显示为"确定"
        
        ISnackbarSetting defaultActionTextForIndefinite(String actionText);


        
        //设置离开当前activity时，是否立即消失掉正在显示的Snackbar，默认false。如，在Activity A上显示了一个
        
        //Indefinite Snackbar，启动Activity B，然后按返回键回到A，原先的Snackbar依然存在，设置为true后，
        
        //在进入B之前就会消失
        
        ISnackbarSetting dismissOnLeave(boolean b);


        
        例子：
        
        SmartSnackbar.setting()
                        
        .backgroundColorRes(R.color.colorPrimary)
        
        .msgTextColorRes(R.color.white)
        
        .actionColorRes(R.color.colorAccent)
                        
        .dismissOnLeave(true);

判断显示和隐藏

         //隐藏当前显示的Snackbar

         SmartSnackbar.dismiss();


         
         //是否有Snackbar在显示
         
         SmartSnackbar.isShowing();

监听显示和隐藏

将Activity实现ISnackbarShowCallback接口，然后重写方法即可。在SmartSnackbar显示时，会检测当前activity是否实现该接口，是则进行回调。

public class SnackbarActivity extends BaseActivity implements ISnackbarShowCallback {

        @Override
        protected int contentLayout() {
    
           return R.layout.activity_smart_show;
        
        }
    
        @Override
        public void onShown(Snackbar sb) {
            
        }
    
        @Override
        public void onDismissed(Snackbar sb, int event) {
    
        }
        
}

SmartTopbar部分

回到模块导航

默认样式：设置背景色：

1. SmartTopbar在功能以及使用上很像一个顶部的Snackbar
   
2. 当Topbar正在显示，多次触发时，若msg和actionTex均未改变，则不会重复弹出，否则有弹出效果
3. 可修改布局风格，如背景颜色，文字大小和颜色等
4. 可配置离开当前Activity时，立即消失正在显示的Topbar。如，在Activity A 上显示了一个Indefinite Topbar，并且用户没有 点击响应，启动activity B，然后再返回A，原来的Topbar已自动消失
5. 可通过手势右滑隐藏Topbar

API

传入当前界面的Activity,获取Topbar，三种duration体现在方法名上，而不是传参，尽可能简化调用

只传入消息文本

        //short topbar
        
        SmartTopbar.get(this).show("我是朱志强");


        
        //long topbar
        
        SmartTopbar.get(this).showLong("我是朱志强");


        
       //indefinite topbar,只传入消息文本时，会显示默认的动作文本"确定"，点击动作文本，执行默认行为——Topbar消失
        
       SmartTopbar.get(this).showIndefinite("我是朱志强");     

只传入消息文本和动作文本，则点击动作文本，执行默认逻辑--Topbar消失

       //short topbar
       
       SmartTopbar.get(this).show("为SmartShow Star 一下可以么","好的");


       
       //long topbar
       
       SmartTopbar.get(this).showLong("为SmartShow Star 一下可以么","好的");


       
       //indefinite topbar
       
       SmartTopbar.get(this).showIndefinite("为SmartShow Star 一下可以么","好的");

传入消息文本和动作文本以及动作监听器

       SmartTopbar.get(this).show("我是朱志强", "打赏", new View.OnClickListener() {
       
           @Override
           public void onClick(View v) {
       
                //...
       
              }
           });


           
       SmartTopbar.get(this).showLong("我是朱志强", "打赏", new View.OnClickListener() {
       
           @Override
           public void onClick(View v) {
       
                //...
       
              }
           });


           
       SmartTopbar.get(this).showIndefinite("我是朱志强", "打赏", new View.OnClickListener() {
       
           @Override
           public void onClick(View v) {
           
                //...
                
           });              

定制化

定制化SmartTopbar，可调用setting方法获取ITopbarSetting对象进行全局配置

在application的onCreate方法里执行配置代码

        //获取ITopbarSetting对象
        
        SmartTopbar.setting()

配置布局风格

        //设置背景颜色
        
        ITopbarSetting backgroundColor(int color);
        
        ITopbarSetting backgroundColorRes(int colorRes);


        
        //设置消息文本颜色
        
        ITopbarSetting msgTextColor(@ColorInt int color);
        
        ITopbarSetting msgTextColorRes(@ColorRes int colorRes);


        
        //设置消息文本大小
        
        ITopbarSetting msgTextSizeSp(float textSizeSp);


        
        //设置动作文本颜色
        
        ITopbarSetting actionColor(@ColorInt int color);
        
        ITopbarSetting actionColorRes(@ColorRes int colorRes);


        
        //设置动作文本大小
        
        ITopbarSetting actionSizeSp(float textSizeSp);


        
        //对布局进一步处理，callback中会传入布局的根View和显示消息文本的TextView以及动作文本的Button，
                 
        //callback中的处理和以上配置方法的处理有冲突时，将覆盖掉以上的配置
        
        ITopbarSetting processView(IProcessBarCallback callback);

        
        //设置调用Indefinite Topbar时，如果只传入消息文本，默认显示的动作文本字符串，如果不设置，即显示为"确定"
        
        ITopbarSetting defaultActionTextForIndefinite(String actionText);


        
        //设置离开当前activity时，是否立即消失掉正在显示的Topbar，默认false。如，在Activity A上显示了一个
        
        //Indefinite Topbar，启动Activity B，然后按返回键回到A，原先的Topkbar依然存在，设置为true后，
        
        //在进入B之前就会消失
        
        ITopbarSetting dismissOnLeave(boolean b);


        
        例子：
        
        SmartTopbar.setting()
                        
        .backgroundColorRes(R.color.colorPrimary)
        
        .msgTextColorRes(R.color.white)
        
        .actionColorRes(R.color.colorAccent)
                        
        .dismissOnLeave(true);

判断显示和隐藏

         //隐藏当前显示的Topbar

         SmartTopbar.dismiss();


         
         //是否有Topbar在显示
         
         SmartTopbar.isShowing();

监听显示和隐藏

将Activity实现ITopbarShowCallback接口，然后重写方法即可。在SmartTopbar显示时，会检测当activity是否实现该接口，是则进行回调。

public class SnackbarActivity extends BaseActivity implements ITopbarShowCallback {

        @Override
        protected int contentLayout() {
    
           return R.layout.activity_smart_show;
        
        }
    
        @Override
        public void onShown(Topbar tb) {
            
        }
    
        @Override
        public void onDismissed(Topbar tb, int event) {
    
        }
        
}

SmartDialog部分

回到模块导航

1. 解决因activity、fragment生命周期导致的BadTokenException、NullPointException等问题
2. 提供主流APP中使用的message、input、list、loading等对话框
   

效果图

原理

SmartDialog并不是android.app.Dialog的子类,只是个包装器，它内部持有一个真正的Dialog，用来显示。SmartDialog负责处理当Activity、Fragment 生命周期异常时，取消创建或显示所持Dialog。

详细文档请移步 wiki

• 预定义的SmartDialog实现

  • NotificationDialog
  • EnsureDialog
  • InputTextDialog
  • ClickListDialog
  • ChooseListDialog
  • LoadingDialog

• 自定义

  • Dialog 创建
  • Dialog ContentView
  • Dialog Style
  • Dialog 宽度
  • Dialog 属性