# MaterialTapTargetPrompt

**Repository Path**: chinasoft4_ohos/MaterialTapTargetPrompt

## Basic Information

- **Project Name**: MaterialTapTargetPrompt
- **Description**: Material Design tap target for Ohos.
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2021-06-28
- **Last Updated**: 2021-09-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MaterialTapTargetPrompt

#### 项目介绍
- 项目名称：MaterialTapTargetPrompt
- 所属系列：openharmony的第三方组件适配移植
- 功能：基于Material Design风格涉及的Tap Target组件
- 项目移植状态：主功能完成
- 调用差异：无
- 开发版本：sdk6，DevEco Studio 2.2 Beta1
- 基线版本：Release v3.2.0

#### 效果演示
<img src="gif/show.gif"></img>

#### 安装教程
                                
1.在项目根目录下的build.gradle文件中，
 ```gradle

	allprojects {
	    repositories {
	        maven {
	            url 'https://s01.oss.sonatype.org/content/repositories/releases/'
	        }
	    }
	}
 ```
2.在entry模块的build.gradle文件中，
 ```gradle
	dependencies {
	   implementation('com.gitee.chinasoft_ohos:material-tap-target-prompt:1.0.1')
	   ......  
	}
 ```

在sdk6，DevEco Studio 2.2 Beta1下项目可直接运行
如无法运行，删除项目.gradle,.idea,build,gradle,build.gradle文件，
并依据自己的版本创建新项目，将新项目的对应文件复制到根目录下

#### 使用说明
1. 在Ability里对某控件使用:
	```java
    final MaterialTapTargetPrompt.Builder tapTargetPromptBuilder;
        try {
            tapTargetPromptBuilder = new MaterialTapTargetPrompt.Builder(this,mRootView)
                    .setPrimaryText(ResourceTable.String_menu_prompt_title)
                    .setSecondaryText(ResourceTable.String_menu_prompt_description)
                    .setContentDescription(ResourceTable.String_menu_prompt_content_description)
                    .setFocalPadding(ResourceTable.Float_dp40)
                    .setAnimationCurveType(Animator.CurveType.ACCELERATE_DECELERATE)
                    .setMaxTextWidth(ResourceTable.Float_tap_target_menu_max_width)
                    .setTarget(findComponentById(ResourceTable.Id_ig_left))
                    .setIcon(new VectorElement(this,ResourceTable.Graphic_ic_menu));
            tapTargetPromptBuilder.show();
        } catch (NotExistException | IOException | WrongTypeException e) {
            e.printStackTrace();
        }
	```

2. 在Dialog里对某控件使用:
	```java
    new MaterialTapTargetPrompt.Builder(mAbility,mRootView)
                .setTarget(getContentCustomComponent().findComponentById(ResourceTable.Id_fab))
                .setAnimationCurveType(Animator.CurveType.ACCELERATE_DECELERATE)
                .setPrimaryText("Clipped to ability bounds")
                .setSecondaryText("The prompt does not draw outside the ability")
                .setClipToView(mRootView)
                .show();
	```

3. 在Fraction里对某控件使用:
	```java
    new MaterialTapTargetPrompt.Builder(this,mRootView)
            .setTarget(ResourceTable.Id_fraction_fab)
            .setAnimationCurveType(Animator.CurveType.ACCELERATE_DECELERATE)
            .setPrimaryText("Clipped to dialog bounds")
            .setSecondaryText("The prompt does not draw outside the dialog")
            .setClipToView(mRootView)
            .show();
	```
4. 注意事项：
	```
	1.mRootView为动画的父布局，必须为DependentLayout
	2.不支持SpannableStringBuilder原因，Text文本内容多样式未实现
	3.openharmony暂不支持使用Style定义自定义属性的值，故使用自定义StyleBean替代
	4.openharmony无DialogFragment控件，暂时使用Fraction替代
	5.openharmony无替代View.draw(Canvas)，将指定view绘制到动画的Cnavas上的Api，故使用在指定component的位置在动画Cnavas上做透明处理，无法完全替代
	```


#### 测试信息

CodeCheck代码测试无异常

CloudTest代码测试无异常

病毒安全检测通过

当前版本demo功能与原组件基本无差异

#### 版本迭代

1.0.1

#### 版权和许可信息

    Copyright (C) 2016-2021 Samuel Wall

    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.