2 Star 0 Fork 0

Archermind-TI / ShowCaseView

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
README.md 4.79 KB
一键复制 编辑 原始数据 按行查看 历史

Show Case View

###项目简介

一个轻量级向导/引导式遮罩实现,在此库中,提供了基本的遮罩,指向[被解释对象/界面元素],解释文本区域实现。

功能演示


集成说明

  1. 下载ShowCaseView的har包ShowCaseView.har(位于output文件夹下)。
  2. 启动DevEco Studio,将下载的har包,导入工程目录“entry->libs”下。
  3. 在moudle级别下的build.gradle文件中添加依赖,在dependences标签中增加对libs目录下har包的应用。
dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar', '*.har'])
      implementation project(':ShowCaseView')
	……
}

4.在导入的har包上点击右键,选择“Add as Library”对包进行引用,选择需要引用的模块,并点击“OK”即引用成功。

方式二

  1. 在module的build.gradle中添加对ShowCaseView的依赖

    dependencies {
        implementation fileTree(dir: 'libs', include: ['*.jar', '*.har'])
     
        ……
        implementation 'com.gitee.archermind-ti:ShowCaseView:1.0.0-beta'
    }
  2. 在project的build.gradle中添加mavenCentral()的引用

    allprojects {
        repositories {
            ……
            mavenCentral()
        }
    }

使用说明:

Ability中的使用示例

new GuideView.Builder(this)
    .setTitle("Guide Title Text")
    .setContentText("Guide Description Text\n .....Guide Description Text\n .....Guide Description Text .....")
    .setGravity(Gravity.auto) //optional
    .setDismissType(DismissType.anywhere) //optional - default DismissType.targetView
    .setTargetView(component1)
    .setContentTextSize(12)//optional
    .setTitleTextSize(14)//optional
    .build()
    .show();

改变字体

new GuideView.Builder(this)
    .setTitle("Guide Title Text")
    .setContentText("Guide Description Text\n .....Guide Description Text\n .....Guide Description Text .....")
    .setTargetView(component1)
    .setContentFont(font)//optional
    .setTitleFont(font)//optional
    .setDismissType(DismissType.outside) //optional - default dismissible by TargetView
    .build()
    .show();

更改标题和内容文本大小

new GuideView.Builder(this)
    .setTitle("Guide Title Text")
    .setContentText("Guide Description Text\n .....Guide Description Text\n .....Guide Description Text .....")
    .setTargetView(component1)
    .setContentTextSize(12)//optional
    .setTitleTextSize(14)//optional
    .setDismissType(DismissType.outside) //optional - default dismissible by TargetView
    .build()
    .show();

改变位置

new GuideView.Builder(this)
    .setTitle("Guide Title Text")
    .setContentText("Guide Description Text\n .....Guide Description Text\n .....Guide Description Text .....")
    .setGravity(Gravity.center)//optional
    .setTargetView(component1) 
    .setDismissType(DismissType.outside) //optional - default dismissible by TargetView
    .build()
    .show();

设置监听

new GuideView.Builder(this)
    .setTitle("Guide Title Text")
    .setContentText("Guide Description Text\n .....Guide Description Text\n .....Guide Description Text .....")
    .setGravity(Gravity.center)
    .setTargetView(view1)
    .setDismissType(DismissType.outside) //optional - default dismissible by TargetView
    .setGuideListener(new GuideListener() {
        @Override
        public void onDismiss(Component component) {
           //TODO ...
        }
     })
    .build()
    .show();

功能说明

DismissType 属性

类型 描述
outside 在MessageView外点击即可解除
anywhere 在任意位置点击即可解除
targetView 通过点击targetView来解除(targetView是通过setTargetView方法分配的)

PointerType 属性

类型 描述
circle 显示指向targetView的圆指针
arrow 显示指向targetView的箭头
none 不显示指向targetView的指针和线条

版本迭代

  • v1.0.0

License

Copyright 2018 Mohammad Reza Eram

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/archermind-ti/showcaseview.git
git@gitee.com:archermind-ti/showcaseview.git
archermind-ti
showcaseview
ShowCaseView
master

搜索帮助

344bd9b3 5694891 D2dac590 5694891