超好用的Android高亮引导库的使用

更新时间：2021年04月22日 11:43:46 作者：OyeAndroid

这篇文章主要介绍了超好用的Android高亮引导库的使用，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

简介

HighlightPro 是Android的一个高亮引导库，同时它还可以是一个简单的popup window库

功能:

可一次显示一个或多个高亮view
通过水平约束和竖直约束来准确定位提示view
自定义提示view的出现动画
自定义高亮形状和大小
自定义高亮形状的paint
链式调用，使用简单
支持简单的pop window

效果图:

用法:

Gradle

在项目级的build.gradle文件种添加maven存储仓库Jitpack：

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

添加依赖到你的app的build.gradle 文件中：

dependencies {		
	implementation 'com.github.hyy920109:GuidePro:1.0.3'
}

代码

我们可以通过Activity Fragment ViewGroup其中一个拿到HighlightPro对象：

/**
 * 会使用activity.window.decorView 作为父view 全屏显示
 */
fun with(activity: Activity): HighlightPro {
    return HighlightPro(activity)
}

/**
 * 会使用会使用fragment依赖的activity的activity.window.decorView 作为父view 全屏显示
 */
fun with(fragment: Fragment): HighlightPro {
    return HighlightPro(fragment)
}

/**
 * 会使用传进来的viewGroup作为父view
 */
fun with(view: ViewGroup): HighlightPro {
    return HighlightPro(view)
}

简单的完整链式调用

HighlightPro.with(this)
            .setHighlightParameter {
                HighlightParameter.Builder()
                    .setHighlightViewId(R.id.btn_step_first)
                    .setTipsViewId(R.layout.guide_step_first)
                    .setHighlightShape(RectShape(4f.dp, 4f.dp, 6f))
                    .setHighlightHorizontalPadding(8f.dp)
                    .setConstraints(Constraints.StartToEndOfHighlight + Constraints.TopToTopOfHighlight)
                    .setMarginOffset(MarginOffset(start = 8.dp))
                    .build()
            }
            .setBackgroundColor("#80000000".toColorInt())
            .setOnShowCallback { index ->
                //do something
            }
            .setOnDismissCallback {
                //do something
            }
            .show()

如果你想一次展示多个高亮view可以看如下代码（区别是传入的是一个List）：

HighlightPro.with(this)
            .setHighlightParameters(
                HighlightParameter.Builder()
                    .setHighlightViewId(R.id.btn_step_first)
                    .setTipsViewId(R.layout.guide_step_first)
                    .setHighlightShape(RectShape(4f.dp, 4f.dp, 6f))
                    .setHighlightHorizontalPadding(8f.dp)
                    .setConstraints(Constraints.StartToEndOfHighlight + Constraints.TopToTopOfHighlight)
                    .setMarginOffset(MarginOffset(start = 8.dp))
                    .build()
                        +
                HighlightParameter.Builder()
                    .setHighlightViewId(R.id.btn_step_second)
                    .setTipsViewId(R.layout.guide_step_second)
                    .setHighlightShape(RectShape(4f.dp, 4f.dp, 6f))
                    .setHighlightHorizontalPadding(8f.dp)
                    .setConstraints(Constraints.StartToEndOfHighlight + Constraints.TopToTopOfHighlight)
                    .setMarginOffset(MarginOffset(start = 8.dp))
                    .build()
            )
            .setBackgroundColor("#80000000".toColorInt())
            .setOnShowCallback { index ->
                //do something
            }
            .setOnDismissCallback {
                //do something
            }
            .show()

如果我们连环展示高亮view(比如第一步、第二步。。。)，可以采用多次调用setHighlightParameter, 代码如下：

HighlightPro.with(this)
    .setHighlightParameter {
        HighlightParameter.Builder()
            .setHighlightViewId(R.id.btn_step_first)
            .setTipsViewId(R.layout.guide_step_first)
            .setHighlightShape(RectShape(4f.dp, 4f.dp, 6f))
            .setHighlightHorizontalPadding(8f.dp)
            .setConstraints(Constraints.StartToEndOfHighlight + Constraints.TopToTopOfHighlight)
            .setMarginOffset(MarginOffset(start = 8.dp))
            .build()
    }
    .setHighlightParameter {
        HighlightParameter.Builder()
            .setHighlightViewId(R.id.btn_step_second)
            .setTipsViewId(R.layout.guide_step_second)
            .setHighlightShape(CircleShape())
            .setHighlightHorizontalPadding(20f.dp)
            .setHighlightVerticalPadding(20f.dp)
            .setConstraints(Constraints.TopToBottomOfHighlight + Constraints.EndToEndOfHighlight)
            .setMarginOffset(MarginOffset(top = 8.dp))
            .build()
    }
    .setHighlightParameter {
        HighlightParameter.Builder()
            .setHighlightViewId(R.id.btn_step_third)
            .setTipsViewId(R.layout.guide_step_third)
            .setHighlightShape(OvalShape())
            .setHighlightHorizontalPadding(12f.dp)
            .setHighlightVerticalPadding(12f.dp)
            .setConstraints(Constraints.BottomToTopOfHighlight + Constraints.EndToEndOfHighlight)
            .setMarginOffset(MarginOffset(bottom = 6.dp))
            .build()
    }
    .setBackgroundColor("#80000000".toColorInt())
    .setOnShowCallback { index ->
        //do something
    }
    .setOnDismissCallback {
        //do something
    }
    .interceptBackPressed(true)
    .show()

如果我们想现实pop window, 可以通过enableHighlight来控制，传入false 就代表了不会高亮target view:

HighlightPro.with(this)
    .setHighlightParameter {
        HighlightParameter.Builder()
            .setHighlightViewId(R.id.btn_tips_bottom)
            .setTipsViewId(R.layout.pop_tips_layout_bottom)
            .setConstraints(Constraints.TopToBottomOfHighlight + Constraints.EndToEndOfHighlight)
            .setMarginOffset(MarginOffset(end = (-2).dp))
            .build()
    }
    .enableHighlight(false)//禁用highlight
    .interceptBackPressed(true)//拦截返回键，返回键会导致 popwindow消失
    .show()

API 文档

关于 HighlightParameter.Builder

方法名	方法描述
setHighlightViewId	设置高亮view的id
setHighlightView	设置高亮view
setTipsViewId	设置提示view的id
setTipsView	设置提示view
setHighlightShape	设置高亮形状
setHighlightVerticalPadding	设置高亮区域的竖直padding
setHighlightHorizontalPadding	设置高亮区域的水平padding
setConstraints	设置提示view的相关约束
setMarginOffset	设置提示view的偏移量
build	返回一个 HighlightParameter 对象

注意

setHighlightViewId & setHighlightView
setTipsViewId & setTipsView

对于上面两组方法，你只需要使用每组中其中一个方法。如果都没使用，UI 表现会不正常

关于 HighlightShape

HighlightShape	方法描述
RectShape	边缘模糊的矩形图形
CircleShape	边缘模糊的圆形
OvalShape	边缘模糊的椭圆形

注意

任何形状都是基于高亮view在屏幕中的矩形区域，我们可以通过setHighlightVerticalPadding 或 setHighlightHorizontalPadding来扩大高亮区域

关于 Constraints

这个类是决定提示view位置的核心类，类似于Android自带的约束布局，目前我们所有的约束均依赖于高亮view

Vertical Constraints	属性描述
TopToTopOfHighlight	将提示view顶部和高亮矩形顶部对齐
TopToBottomOfHighlight	将提示view顶部和高亮矩形底部对齐
BottomToBottomOfHighlight	将提示view底部和高亮矩形底部对齐
BottomToTopOfHighlight	将提示view底部和高亮矩形顶部对齐

Horizontal Constraint	属性描述
StartToStartOfHighlight	将提示view左侧和高亮矩形左侧对齐
StartToEndOfHighlight	将提示view左侧和高亮矩形右侧对齐
EndToEndOfHighlight	将提示view右侧和高亮矩形右侧对齐
EndToStartOfHighlight	将提示view右侧和高亮矩形左侧对齐

注意

通常我们就设置两个约束：一个竖直约束，一个水平约束，而且我们可以通过运算符重载+来构建约束集合：

Constraints.TopToBottomOfHighlight + Constraints.EndToEndOfHighlight

当然我们也可以设置偏移量来调整提示view的位置：

setMarginOffset(MarginOffset(start = 8.dp))

最后

上面我们基本把HighlightPro的用法介绍完了，欢迎大家使用，如果它对您有帮助，记得给个star哦。如果使用过程有啥bug，欢迎提Issues，我会及时跟进的。

到此这篇关于超好用的Android高亮引导库的使用的文章就介绍到这了,更多相关Android高亮引导库内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Android高亮引导控件的实现代码

RecyclerView滑动到指定Position的方法
这篇文章主要为大家详细介绍了RecyclerView滑动到指定Position的方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-04-04
okhttp3.4.1+retrofit2.1.0实现离线缓存的示例
本篇文章主要介绍了okhttp3.4.1+retrofit2.1.0实现离线缓存的示例，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-12-12
Android自定义控件实现雷达图效果
这篇文章主要为大家详细介绍了Android自定义控件实现雷达图效果，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-09-09
浅析Android 模拟键盘鼠标事件
本篇文章是对Android模拟键盘鼠标事件进行了详细的分析介绍，需要的朋友参考下
2013-06-06
Android WebRTC 对 AudioRecord 的使用技术分享
这篇文章主要介绍了Android WebRTC 对 AudioRecord 的使用技术分享,AudioRecord 是 Android 基于原始PCM音频数据录制的类,接下来和小编进入文章了解更详细的内容吧
2022-02-02
Android实现淘宝选中商品尺寸的按钮组实例
这篇文章介绍的是仿淘宝中的选中商品不同尺寸，比如衣服有L、M、XL等等的款式。这时候我们就需要一个button组来进行了，当时这个时候里面的尺寸可能有很多，那怎么办呢？这里我们就肯定要做个自适应的按钮组了，要不然弄出来也没用。
2016-08-08
flutter PositionedTransition实现缩放动画
这篇文章主要为大家详细介绍了flutter PositionedTransition实现缩放动画，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-07-07
camera录制视频的缩略图获取原理心得分享
camera录制的视频的缩略图如何获取，想必有很多的朋友都不会吧，下面与大家分享下获取的原理，感兴趣的你可不要错过了哈
2013-06-06
Flutter路由传递参数及解析实现
这篇文章介绍了Flutter路由传递参数及解析实现的方法，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-11-11
Android 勇闯高阶性能优化之启动优化篇
在移动端程序中，用户希望的是应用能够快速打开。启动时间过长的应用不能满足这个期望，并且可能会令用户失望。轻则鄙视你，重则直接卸载你的应用
2021-10-10

超好用的Android高亮引导库的使用

简介

用法:

代码

API 文档

最后

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具