MaterialTapTargetPrompt

Additional

Language
Java
Version
v2.6.1 (Feb 17, 2018)
Created
Jun 5, 2016
Updated
Feb 17, 2018
Owner
Sam Wall (sjwall)
Contributors
Bernat Borrás Paronella (alorma)
Roman (drstranges)
SUPERCILEX
Sam Wall (sjwall)
jwmach1
KSeyffarth
dennisvandalen
carloshwa
8
Activity
Badge
Generate
Download
Source code
APK file

Commercial

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.

Sample App

The sample app in the repository is available on Google Play:

Gradle

To use the gradle dependency, add this to build.gradle:

repositories {
    jcenter()
}

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

Supports minSdkVersion 14

Usage

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

new MaterialTapTargetPrompt.Builder(MainActivity.this)
        .setTarget(findViewById(R.id.fab))
        .setPrimaryText("Send your first email")
        .setSecondaryText("Tap the envelop 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();

If a target is not set or both the primary and secondary text are null then builder.show and builder.create will return null.

Different shapes

The default shape is a circle but any other shape can be rendered by extending the PromptBackground and PromptFocal classes. A rectangle implementation is provided through the RectanglePromptBackground and RectanglePromptFocal implementations.

new MaterialTapTargetPrompt.Builder(this)
                .setTarget(view)
                .setPrimaryText("Different shapes")
                .setSecondaryText("Extend PromptFocal or PromptBackground to change the shapes")
                .setPromptBackground(new RectanglePromptBackground())
                .setPromptFocal(new RectanglePromptFocal())
                .show();

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.