MaterialTapTargetPrompt

Additional

Language
Java
Version
v2.14.0 (Oct 27, 2018)
Created
Jun 5, 2016
Updated
Nov 27, 2018
Owner
Sam Wall (sjwall)
Contributors
Bernat Borrás Paronella (alorma)
Roman (drstranges)
SUPERCILEX
Sam Wall (sjwall)
jwmach1
dennisvandalen
carloshwa
rcraggs
FrangSierra
yoksnod
L3K0V
11
Activity
Badge
Generate
Download
Source code
APK file

Show card

Material Tap Target Prompt

A Tap Target implementation in Android based on Material Design Onboarding guidelines. For more information on tap targets check out the guidelines.

JavaDocs, examples and a sample 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:

repositories {
    jcenter()
}

dependencies {
    implementation 'uk.co.samuelwall:material-tap-target-prompt:2.14.0'
}

Supports Android minSdkVersion 14

Usage

Basic usage is shown below with more examples in the sample app and documentation:

new MaterialTapTargetPrompt.Builder(MainActivity.this)
        .setTarget(R.id.fab)
        .setPrimaryText("Send your first email")
        .setSecondaryText("Tap the envelope to start composing your first email")
        .setPromptStateChangeListener(new MaterialTapTargetPrompt.PromptStateChangeListener()
        {
            @Override
            public void onPromptStateChanged(MaterialTapTargetPrompt prompt, int 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 are null then builder.show and builder.create will return null.

Other shapes

The default shape is a circle but any other shape can be rendered by extending the PromptBackground and PromptFocal classes. Custom shapes such as a rectangle can be set by calling setPromptBackground and/or setPromptFocal. Documentation and examples are available here.

License

Copyright (C) 2016-2018 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.