Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sjwall/MaterialTapTargetPrompt
⛔️ DEPRECATED Material Design tap target for Android. https://sjwall.github.io/MaterialTapTargetPrompt/
https://github.com/sjwall/MaterialTapTargetPrompt
android deprecated material material-design onboarding tap-target
Last synced: 3 months ago
JSON representation
⛔️ DEPRECATED Material Design tap target for Android. https://sjwall.github.io/MaterialTapTargetPrompt/
- Host: GitHub
- URL: https://github.com/sjwall/MaterialTapTargetPrompt
- Owner: sjwall
- License: apache-2.0
- Created: 2016-06-05T16:24:53.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-04-12T06:06:58.000Z (almost 2 years ago)
- Last Synced: 2024-10-15T12:42:03.918Z (3 months ago)
- Topics: android, deprecated, material, material-design, onboarding, tap-target
- Language: Java
- Homepage:
- Size: 3.23 MB
- Stars: 1,520
- Watchers: 30
- Forks: 211
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- -awesome-android-ui - MaterialTapTargetPrompt - 2.0) | <img src="/art/MaterialTapTargetPrompt.jpg" width="49%"> (Index `(light-weight pages)`)
- awesome-android-ui - MaterialTapTargetPrompt - 2.0) | <img src="/art/MaterialTapTargetPrompt.jpg" width="49%"> (Index `(light-weight pages)`)
- awesome-android-ui - MaterialTapTargetPrompt - 2.0) | <img src="/art/MaterialTapTargetPrompt.jpg" width="49%"> (Index)
README
# DEPRECATED
Android is moving towards compose, for an alternative library in compose have a look at [intro-showcase-view](https://github.com/canopas/Intro-showcase-view).
Bug fix pull requests will be accepted for this library for the immediate future but there will be no active development or new features and it will eventually be archived.
Thank you to everyone who has contributed to the library over the years!
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.
sjwall.github.io/MaterialTapTargetPrompt
Quick start
·
Examples
·
Sample app
The sample app is available to download on the [Google Play Store][5]:
# Quick start
## Gradle
Add the following to `build.gradle` using Maven Central:
```groovy
dependencies {
implementation 'uk.co.samuelwall:material-tap-target-prompt:3.3.2'
}
```
Supports Android minSdkVersion 14
Version 2.15.0 works with Android Support Library
Also available from [GitHub packages](https://github.com/sjwall/MaterialTapTargetPrompt/packages/277676)
## Usage
Basic usage is shown below with more examples in the [sample app][2] and [documentation][3]:
```java
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][6] and [PromptFocal][7] classes.
Custom shapes such as a rectangle can be set by calling `setPromptBackground` and/or `setPromptFocal`.
Documentation and examples are available [here][8].
# License
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.
[2]: https://github.com/sjwall/MaterialTapTargetPrompt/tree/master/sample/src/main/java/uk/co/samuelwall/materialtaptargetprompt/sample
[3]: https://sjwall.github.io/MaterialTapTargetPrompt/examples
[5]: https://play.google.com/store/apps/details?id=uk.co.samuelwall.materialtaptargetprompt.sample&utm_source=global_co&utm_medium=prtnr&utm_content=Mar2515&utm_campaign=PartBadge&pcampaignid=MKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1
[6]: https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptBackground.java
[7]: https://github.com/sjwall/MaterialTapTargetPrompt/blob/master/library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/extras/PromptFocal.java
[8]: https://sjwall.github.io/MaterialTapTargetPrompt/shapes