NoviceGuide

Introduction: Android 无侵入式引导提示
More: Author   ReportBugs   
Tags:

优点

代码无侵入式,不需要处理原来的布局以及逻辑,只要在需要显示的地方像显示一个 dialog 一样配置好然后调用 show 方法即可

依赖方法

allprojects {
        repositories {
            ...
            maven { url 'https://jitpack.io' }
        }
    }
dependencies {
            implementation 'com.github.ZhangJian96:NoviceGuide:1.0.0'
    }

api

NoviceGuide.Builder 的 api 方法说明
focusView 出现引导高亮显示的 View(一般是引导描述的按钮等)
setPadding 设置高亮区域在 View 周边 padding
setRadius 设置高亮部分的圆角(默认 0,就是矩形),当设置超过 View 半径就会是圆(类比 drawable 的 Radius)
setRelyActivity 当前引导所依附的 Activity(因为原理是拿到 Activity 的 android.R.id.content。所以目前只支持对属于 Activity 的 View 做处理,这也是后期优化点)
setLayout(int layout,DecorateInflate decorateInflate) 设置引导显示提示的布局,内部处理好 inflate 的过程,同时提供 DecorateInflate 回调装饰 inflate 后的 View,不需要可以传 null
setPassId 设置上方法提供的不居中“跳过”的按钮 id,可不设置,不设置的时候需要自己在 DecorateInflate 回调中自己处理好调用 dismiss()的逻辑。注意:在使用NoviceGuideSet构建一条链的引导时,请设置该方法,交给NoviceGuideSet内部自己去处理链的跳转步骤
build 返回 NoviceGuide 对象
NoviceGuide 方法说明
show 将设置好的NoviceGuide显示出来
dismiss 关闭引导,一般情况无需使用者调用,由内部处理好
NoviceGuideSet 方法说明
addGuide(NoviceGuide NoviceGuide) 添加引导链其中的一个步骤
show 显示引导,点击 PassView 后按添加顺序依次展示

范例

创建一个引导:

 new NoviceGuide.Builder(MainActivity.this)
                        .focusView(binding.btnGuide)
                        .setRadius(1000)    //显示出圆形
                        .setRelyActivity(MainActivity.this)
                        .setLayout(R.layout.layout_btn_guide, new DecorateInflate() {
                            @Override
                            public void onInflate(final NoviceGuide noviceGuide, View inflaterView) {
                                inflaterView.setOnClickListener(new View.OnClickListener() {
                                    @Override
                                    public void onClick(View v) {
                                        noviceGuide.dismiss();
                                    }
                                });
                            }
                        })
                        .build()
                        .show();

如果是一系列的步骤引导,你可以使用NoviceGuideSet

NoviceGuide noviceGuide1 = new NoviceGuide.Builder(MainActivity.this)
                .focusView(binding.tvBtn1)
                .setPadding(5, 5, 5, 5)
                .setRadius(15)
                .setRelyActivity(MainActivity.this)
                .setLayout(R.layout.layout_guide, null)
                .setPassId(R.id.iv_know)
                .build();

NoviceGuide noviceGuide2 = new NoviceGuide.Builder(MainActivity.this)
                .focusView(binding.tvBtn2)
                .setPadding(5, 5, 5, 5)
                .setRadius(15)
                .setRelyActivity(MainActivity.this)
                .setLayout(R.layout.layout_guide, null)
                .setPassId(R.id.iv_know)
                .build();

NoviceGuideSet noviceGuideSet = new NoviceGuideSet();
noviceGuideSet.addGuide(noviceGuide1);
noviceGuideSet.addGuide(noviceGuide1);
noviceGuideSet.show();

效果

提示引导 多步骤第一步 多步骤第二步

Apps
About Me
Google+: Trinea trinea
GitHub: Trinea