超好用的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子控件超出父控件的范围显示出来方法,希望这篇文章能够帮助到各位朋友,有碰到此问题的朋友可以进来看看哦。 <RelativeLayout xmlns:an...2016-10-02
Android开发中findViewById()函数用法与简化
findViewById方法在android开发中是获取页面控件的值了,有没有发现我们一个页面控件多了会反复研究写findViewById呢,下面我们一起来看它的简化方法。 Android中Fin...2016-09-20- 如果我们的项目需要做来电及短信的功能,那么我们就得在Android模拟器开发这些功能,本来就来告诉我们如何在Android模拟器上模拟来电及来短信的功能。 在Android模拟...2016-09-20
- 夜神android模拟器如何设置代理呢?对于这个问题其实操作起来是非常的简单,下面小编来为各位详细介绍夜神android模拟器设置代理的方法,希望例子能够帮助到各位。 app...2016-09-20
- 为了增强android应用的用户体验,我们可以在一些Button按钮上自定义动态的设置一些样式,比如交互时改变字体、颜色、背景图等。 今天来看一个通过重写Button来动态实...2016-09-20
- 如果我们要在Android应用APP中加载html5页面,我们可以使用WebView,本文我们分享两个WebView加载html5页面实例应用。 实例一:WebView加载html5实现炫酷引导页面大多...2016-09-20
- 深入理解Android中View和ViewGroup从组成架构上看,似乎ViewGroup在View之上,View需要继承ViewGroup,但实际上不是这样的。View是基类,ViewGroup是它的子类。本教程我们深...2016-09-20
- 下面我们来看一篇关于Android自定义WebView网络视频播放控件开发例子,这个文章写得非常的不错下面给各位共享一下吧。 因为业务需要,以下代码均以Youtube网站在线视...2016-10-02
- java开发的Android应用,性能一直是一个大问题,,或许是Java语言本身比较消耗内存。本文我们来谈谈Android 性能优化之MemoryFile文件读写。 Android匿名共享内存对外A...2016-09-20
- TextView默认是横着显示了,今天我们一起来看看Android设置TextView竖着显示如何来实现吧,今天我们就一起来看看操作细节,具体的如下所示。 在开发Android程序的时候,...2016-10-02
android.os.BinderProxy cannot be cast to com解决办法
本文章来给大家介绍关于android.os.BinderProxy cannot be cast to com解决办法,希望此文章对各位有帮助呀。 Android在绑定服务的时候出现java.lang.ClassCastExc...2016-09-20- 这篇文章主要介绍了Android 实现钉钉自动打卡功能的步骤,帮助大家更好的理解和学习使用Android,感兴趣的朋友可以了解下...2021-03-15
- 下面我们来看一篇关于Android 开发之布局细节对比:RTL模式 ,希望这篇文章对各位同学会带来帮助,具体的细节如下介绍。 前言 讲真,好久没写博客了,2016都过了一半了,赶紧...2016-10-02
- 首先如果要在程序中使用sdcard进行存储,我们必须要在AndroidManifset.xml文件进行下面的权限设置: 在AndroidManifest.xml中加入访问SDCard的权限如下: <!--...2016-09-20
- 下面来给各位简单的介绍一下关于Android开发之PhoneGap打包及错误解决办法,希望碰到此类问题的同学可进入参考一下哦。 在我安装、配置好PhoneGap项目的所有依赖...2016-09-20
用Intel HAXM给Android模拟器Emulator加速
Android 模拟器 Emulator 速度真心不给力,, 现在我们来介绍使用 Intel HAXM 技术为 Android 模拟器加速,使模拟器运行度与真机比肩。 周末试玩了一下在Eclipse中使...2016-09-20- 在安卓开发时我碰到一个问题就是需要实现全屏,但又需要我们来判断出用户是使用了全屏或非全屏了,下面我分别找了两段代码,大家可参考。 先来看一个android屏幕全屏实...2016-09-20
Android开发中布局中的onClick简单完成多控件时的监听的利与弊
本文章来为各位介绍一篇关于Android开发中布局中的onClick简单完成多控件时的监听的利与弊的例子,希望这个例子能够帮助到各位朋友. 首先在一个控件加上这么一句:and...2016-09-20Ubuntu 系统下安装Android开发环境 Android Studio 1.0 步骤
Android Studio 是一个Android开发环境,基于IntelliJ IDEA. 类似 Eclipse ADT,Android Studio 提供了集成的 Android 开发工具用于开发和调试,可以在Linux,Mac OS X,Window...2016-09-20- 这篇文章主要为大家详细介绍了Android实现简单用户注册案例,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2020-05-26