Material Tap Target Prompt GitHubFollow thequick start guide below to get started.
JavaDocs,examples and asample app with examples implemented are available.The sample app is available to download on the Google Play Store:
Quick start
Gradle
Add the following to build.gradle using Maven Central:
dependencies{ implementation'uk.co.samuelwall:material-tap-target-prompt:3.3.2'}Supports Android minSdkVersion 14
Usage
Tap target prompts are created with abuilder class much like the Android AlertDialog builder:
builder=newMaterialTapTargetPrompt.Builder(MainActivity.this)builder=MaterialTapTargetPrompt.Builder(this@MainActivity)Set the view to focus the prompt on:
builder.setTarget(R.id.target_view_id)builder.target=R.id.target_view_idSet the text to display on the first line:
builder.setPrimaryText("This text is displayed on the first line");builder.primaryText="This text is displayed on the first line"Optionally set the text to display on the second line. If the primary text is not set the secondary text must be set
builder.setSecondaryText("Text to display on the second line")builder.secondaryText="Text to display on the second line"To listen in to the prompt events set a PromptStateChangeListener.Possible states are:
- STATE_NOT_SHOWN - Prompt has yet to be shown
- STATE_REVEALING - Prompt reveal animation is running
- STATE_REVEALED - Prompt reveal animation has finished and the prompt is displayed
- STATE_FOCAL_PRESSED - Prompt target has been pressed
- STATE_NON_FOCAL_PRESSED - Prompt has been pressed outside the focal area
- STATE_DISMISSING - Prompt dismiss method has been called and the prompt is being removed from view
- STATE_DISMISSED - Prompt has been removed from view after the prompt has either been pressed somewhere other than the prompt target or the system back button has been pressed
- STATE_FINISHING - Prompt finish method has been called and the prompt is being removed from view
- STATE_FINISHED - Prompt has been removed from view after the prompt has been pressed in the focal area
builder.setPromptStateChangeListener(newMaterialTapTargetPrompt.PromptStateChangeListener(){@OverridepublicvoidonPromptStateChanged(MaterialTapTargetPromptprompt,intstate){if(state==MaterialTapTargetPrompt.STATE_FOCAL_PRESSED){// User has pressed the prompt target}}})builder.setPromptStateChangeListener{prompt,state->if(state==MaterialTapTargetPrompt.STATE_FOCAL_PRESSED){// User has pressed the prompt target}}The Builder extends abstract classPromptOptions which contains more customisation options.
Finally show the tap target:
builder.show()builder.show()All combined together:
importuk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt;newMaterialTapTargetPrompt.Builder(MainActivity.this).setTarget(R.id.target_view_id).setPrimaryText("This text is displayed on the first line").setSecondaryText("Text to display on the second line").setPromptStateChangeListener(newMaterialTapTargetPrompt.PromptStateChangeListener(){@OverridepublicvoidonPromptStateChanged(MaterialTapTargetPromptprompt,intstate){if(state==MaterialTapTargetPrompt.STATE_FOCAL_PRESSED){// User has pressed the prompt target}}}).show();importuk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt;MaterialTapTargetPrompt.Builder(this@MainActivity).setTarget(R.id.target_view_id).setPrimaryText("This text is displayed on the first line").setSecondaryText("Text to display on the second line").setPromptStateChangeListener{prompt,state->if(state==MaterialTapTargetPrompt.STATE_FOCAL_PRESSED){// User has pressed the prompt target}}.show()Note
If a target is not set or the target view could not be found or both the primary and secondary text arenull thenbuilder.show andbuilder.create will returnnull.
Customisation
The library is designed with extendable classes to allow for maximum customisation. More details and examples are availablehere.
License
Copyright (C) 2016-2018 Samuel WallLicensed 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 athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.