android 一个非常好用的页面引导工具guideView

先看图,我就放一张,其实有各种各样的式样,下面详细解释一下。


6.png

使用方法

使用起来非常简单,代码如下:

Guide.with(this).addGuideParameter(
            GuideParamter.Builder(this.context!!)
//            .addHighLightView(textView)//直接加view
            .addHighLightViewById(R.id.message)//添加id
            .setHighLightShap(Shape.RoundRect)
            .setHighLightViewPadding(PaddingOffset(0, 0, 0, 0))
//            .addTipContentViewById(R.layout.guide_layout)
            .addTipContentView(tipView)//也可以直接添加view,因为这个页面可能多次使用
            .setTipViewOrientation(TipOrientation.BOTTOM)
            .setTipViewMargin(10)
            .setTipHintListener { loge(mTAG, "第一步") }
            .setDialogDimAmount(0.5f)
            .build()
        ).addGuideParameter(
            GuideParamter.Builder(this.context!!)
//            .addHighLightView(textView1)
            .addHighLightViewById(R.id.message1)
            .setHighLightShap(Shape.Oval)
            .setHighLightViewPadding(PaddingOffset(0, 0, 0, 0))
//            .addTipContentViewById(R.layout.guide_layout)
            .addTipContentView(tipView)//也可以直接添加view,因为这个页面可能多次使用
            .setTipViewOrientation(TipOrientation.LEFT)
            .setTipViewMargin(15)
            .setTipHintListener { loge(mTAG, "第二步") }
            .setDialogDimAmount(0.5f)
            .build()
        ).setGuideDimAmount(0.5f)
        .setLastStepListener {
            loge(mTAG, "最后一步")
        }.show()

或者是

Guide.with(this).setGuideParameters(
            GuideParamter.Builder(this.context!!)
//            .addHighLightView(textView)//直接加view
            .addHighLightViewById(R.id.message)//添加id
            .setHighLightShap(Shape.RoundRect)
            .setHighLightViewPadding(PaddingOffset(0, 0, 0, 0))
//            .addTipContentViewById(R.layout.guide_layout)
            .addTipContentView(tipView)//也可以直接添加view,因为这个页面可能多次使用
            .setTipViewOrientation(TipOrientation.BOTTOM)
            .setTipViewMargin(10)
            .setTipHintListener { loge(mTAG, "第一步") }
            .setDialogDimAmount(0.5f)
            .build()
                +
            GuideParamter.Builder(this.context!!)
//            .addHighLightView(textView1)
            .addHighLightViewById(R.id.message1)
            .setHighLightShap(Shape.Oval)
            .setHighLightViewPadding(PaddingOffset(0, 0, 0, 0))
//            .addTipContentViewById(R.layout.guide_layout)
            .addTipContentView(tipView)//也可以直接添加view,因为这个页面可能多次使用
            .setTipViewOrientation(TipOrientation.LEFT)
            .setTipViewMargin(15)
            .setTipHintListener { loge(mTAG, "第二步") }
            .setDialogDimAmount(0.5f)
            .build()
        ).setGuideDimAmount(0.5f)
        .setLastStepListener {
            loge(mTAG, "最后一步")
        }.show()

可以看出使用起来是超级简单的,你想在那里用就直接放入就好,而且有现成的库。
1.5版本新增一项功能,可以设置返回按钮的模式。

代码说明

Guide.with(this)这个with(this)支持activity、fragment、view都可以。show()就是显示了。

外部Guide的方法说明

方法名 含义
addGuideParameter(paramter: GuideParamter) 添加需要引导的步骤(单个,可多次添加)
setGuideParameters(guideParamters: MutableList<GuideParamter>) 添加需要引导的步骤(多个,它支持plus操作符)
setGuideDimAmount(amount:Float) 设置那个需要引导的view那里的透明度(范围0~1)
setLastStepListener(lastStepListener: () -> Unit) 可以设置最后一步的监听事件
setKeyBackStatus(status: KeyBackEnum) 可以返回按钮的效果,这个需要使用1.5版本

Shap的形状支持如下几种,是枚举类型

Shap 说明
Rect 矩形
RoundRect 圆角矩形
Circle 圆形
Oval 椭圆形

内部GuideParamter引导步骤的方法说明

GuideParamter.Builder(this.context!!)这个Builder(this.context!!)需要传入Context对象

方法名 含义
addHighLightView(view: View) 添加需要引导的的view
addHighLightViewById(@IdRes viewId: Int) 添加需要引导的的view的id
setHighLightShap(shape: Shape) 设置需要引导的view外部的高亮框的样式
setHighLightViewPadding(paddingOffset: PaddingOffset) 设置需要引导的view外部的高亮框与view的间隔
addTipContentView(view: View) 添加对于引导步骤的指示view,直接添加view
addTipContentViewById(@LayoutRes viewId: Int) 添加对于引导步骤的指示view,可以直接添加layout
setTipViewOrientation(orientation: TipOrientation) 设置指示view的方位,是对于高亮view来说的
setTipViewMargin(margin: Int) 设置指示view的方位距离高亮view的间隔
setTipHintListener(tipHintListener: () -> Unit) 设置单步的监听事件
setDialogDimAmount(amount:Float) 设置单步的高亮部分的透明度(范围0~1)
build() 创建步骤的对象

你可以选择自己需要的形式来实现

PaddingOffset传入四个参数,分别是左、上、右、下,单位是像素

TipOrientation提示框在高亮框的哪个方位,也是枚举

TipOrientation 说明
LEFT 左边
TOP 上面
RIGHT 右边
BOTTOM 下面

引入库的方法

第一步,在项目所在的build.gradle中加入maven { url 'https://jitpack.io'}
allprojects {
    repositories {
       ...
        maven { url 'https://jitpack.io'}
    }
}
第二步,在app所在的build.gradle下的dependencies中依赖implementation 'com.github.tangqipeng:guideView:1.4'就好。

记得1.5可以设置返回按钮的效果

KeyBackEnum 说明
DEFAULT 默认状态(点击返回按钮之后guide直接消失)
INVALID 无效状态(点击返回按钮没有效果)
EFFECTIVE 有效状态(点击返回按钮的效果和提示窗口一样)

是不是很简单,有兴趣的同学可以试一试。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,284评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,115评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,614评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,671评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,699评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,562评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,309评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,223评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,668评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,859评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,981评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,705评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,310评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,904评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,023评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,146评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,933评论 2 355

推荐阅读更多精彩内容