GuideView:一分鐘實(shí)現(xiàn)Android遮罩引導(dǎo)視圖

先看一下效果圖

image

主角GuideView登場!

GuideView是一種基于DialogFragment實(shí)現(xiàn)的引導(dǎo)遮罩浮層視圖的輕量級解決方案,它具備以下的特性:

  • 響應(yīng)導(dǎo)航按鈕的動作(因?yàn)橐龑?dǎo)浮層本質(zhì)是一個dialog);
  • 鏈?zhǔn)揭龑?dǎo)層,支持設(shè)定一組的引導(dǎo)遮罩視圖,通過點(diǎn)擊切換下一個試圖,快讀與業(yè)務(wù)進(jìn)行解藕;
  • 自動繪制半透明浮層、透明核心區(qū)以及確保目標(biāo)視圖和引導(dǎo)視圖的位置。

實(shí)現(xiàn)說明

頁面的結(jié)構(gòu)如下圖所示:

image

核心類

GuideViewBundle

引導(dǎo)視圖的配置項(xiàng)類,每一頁引導(dǎo)視圖對應(yīng)一個配置項(xiàng)。在GuideView內(nèi)部通過這個配置項(xiàng)去構(gòu)造GuideView的實(shí)例,并通過GuideViewFragment顯示在界面上。

其中的屬性都通過構(gòu)造器的模式,通過靜態(tài)內(nèi)部類Builder進(jìn)行構(gòu)建,屬性說明如下:

  • targetView

    引導(dǎo)視圖需要顯示附著的目標(biāo)視圖

  • hintView

    引導(dǎo)視圖(不包含半透明浮層以及透明焦點(diǎn)區(qū))

  • transparentSpaceXXX

    默認(rèn)的情況下,透明焦點(diǎn)區(qū)的大小跟目標(biāo)視圖的大小保持一致,如果需要加大透明區(qū)域的大小,可以通過設(shè)置這組屬性,指定上下左右的額外的空白區(qū)域

  • hintViewMarginXXX

    引導(dǎo)視圖(hintView)相對于目標(biāo)視圖(targetView)的邊距

  • hasTransparentLayer

    是否顯示透明焦點(diǎn)區(qū)域,默認(rèn)顯示。可以選擇不繪制透明焦點(diǎn)區(qū)域而只有半透明的浮層

  • hintViewDirection

    引導(dǎo)視圖(hintView)相對于目標(biāo)視圖(targetView)的位置方向,目前可以定義上(上方左對齊)、下(下方左對齊)、左(左方上對齊)、右(右方上對齊)四個方向。如果需要在位置之余有不一樣的對齊效果,可以使用hintViewMarginXXX屬性

  • outlineType

    透明焦點(diǎn)區(qū)的輪廓類型,有圓形(橢圓)輪廓和方形輪廓兩種

  • maskColor

    半透明遮罩浮層的顏色

  • isDismissOnClicked

    全局點(diǎn)擊可以關(guān)閉引導(dǎo)視圖,默認(rèn)為true。如果設(shè)置false,則需要手動設(shè)置點(diǎn)擊hintView的特定位置關(guān)閉視圖

GuideView

界面實(shí)際展示的視圖對象,根據(jù)GuideViewBundle設(shè)置的屬性,由GuideViewFragment創(chuàng)建并添加到齊視圖容器中,對外部業(yè)務(wù)完全透明無感知到一個類

GuideViewFragment

實(shí)際顯示引導(dǎo)視圖的彈窗。其內(nèi)部加載了一個FrameLayout容器,通過在容器中添加GuideView的實(shí)例實(shí)現(xiàn)顯示引導(dǎo)視圖層。一個GuideViewFragment可以設(shè)定一組引導(dǎo)視圖,完成一組引導(dǎo)序列。請使用其靜態(tài)內(nèi)部類Builder構(gòu)建其實(shí)例,并使用Builder#addGuidViewBundle(bundle)方法添加引導(dǎo)視圖的配置項(xiàng)。

如果需要自定義點(diǎn)擊關(guān)閉的動作(GuideViewBundle.Builder#setDismissOnClicked(false)的情況下),可以使用下面的方法

void onNext()

如果還存在沒有顯示的引導(dǎo)視圖,這個方法會繼續(xù)顯示下一張,否則會關(guān)閉彈窗

添加依賴

  1. 在根目錄的build.gradle文件中添加jitpack倉庫

    allprojects {
           repositories {
              ...
              maven { url 'https://jitpack.io' }
           }
    }
    
  2. 添加GuideView依賴

    dependencies {
        compile 'com.github.easilycoder:GuideView:0.0.1'
    }
    

使用示例

GuideViewFragment.Builder()
                    .addGuidViewBundle(GuideViewBundle.Builder()
                            .setTargetView(tvContent)
                            .setHintView(hintViewLeft)
                            .setDismissOnClicked(false)
                            .setHintViewMargin(0, -160, 0, 0)
                            .setTransparentSpace(space, space, space, space)
                            .setOutlineType(TYPE_RECT)
                            .setHintViewParams(params)
                            .setHintViewDirection(LEFT).build())
                    .addGuidViewBundle(GuideViewBundle.Builder()
                            .setTargetView(tvContent)
                            .setOutlineType(TYPE_OVAL)
                            .setHintView(hintViewTop)
                            .setDismissOnClicked(false)
                            .setHintViewParams(params)
                            .setHintViewMargin(-dp2px(this, 55f), 0, 0, 0)
                            .setTransparentSpace(space, space, space, space)
                            .setHintViewDirection(TOP)
                            .build())
                    .addGuidViewBundle(GuideViewBundle.Builder()
                            .setTargetView(tvContent)
                            .setOutlineType(TYPE_OVAL)
                            .setHintView(hintViewRight)
                            .setDismissOnClicked(false)
                            .setHintViewParams(params)
                            .setHintViewMargin(0, -160, 0, 0)
                            .setTransparentSpace(space, space, space, space)
                            .setHintViewDirection(RIGHT)
                            .build())
                    .addGuidViewBundle(GuideViewBundle.Builder()
                            .setTargetView(tvContent)
                            .setOutlineType(TYPE_OVAL)
                            .setHintViewParams(params)
                            .setHintViewMargin(-dp2px(this, 55f), 0, 0, 0)
                            .setHintView(hintViewBottom)
                            .setTransparentSpace(space, space, space, space)
                            .setHintViewDirection(BOTTOM)
                            .build())
                    .setCancelable(false)
                    .build().show(supportFragmentManager, "hit")

具體實(shí)例以及設(shè)計實(shí)現(xiàn)可以參考我的GitHub倉庫:GuideView

如果你對我的項(xiàng)目感興趣,歡迎star,歡迎提issue。還有更多有趣的項(xiàng)目歡迎使用。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容