Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pranavpandey/dynamic-toasts
Custom toasts with color and icon on Android.
https://github.com/pranavpandey/dynamic-toasts
android custom error hint icon library material-design text toast warning
Last synced: 7 days ago
JSON representation
Custom toasts with color and icon on Android.
- Host: GitHub
- URL: https://github.com/pranavpandey/dynamic-toasts
- Owner: pranavpandey
- License: apache-2.0
- Created: 2017-06-23T08:06:59.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-07T14:23:46.000Z (11 months ago)
- Last Synced: 2024-04-14T05:42:56.363Z (7 months ago)
- Topics: android, custom, error, hint, icon, library, material-design, text, toast, warning
- Language: Java
- Homepage: https://dynamic.pranavpandey.com
- Size: 2.98 MB
- Stars: 158
- Watchers: 10
- Forks: 25
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Dynamic Toasts
[](https://www.apache.org/licenses/LICENSE-2.0.html)
[](https://travis-ci.org/pranavpandey/dynamic-toasts)
[](https://search.maven.org/artifact/com.pranavpandey.android/dynamic-toasts)
A simple library to display themed toasts with icon and text on Android 2.3 (API 9) and above.
> Since v0.4.0, it uses [26.x.x support libraries][android-support] so, minimum SDK will be
Android 4.0 (API 14).
Since v2.0.0, it uses [AndroidX][androidx] so, first [migrate][androidx-migrate] your
project to AndroidX.
Since v4.1.0, it is dependent on Java 8 due to the dependency on
[Dynamic Utils][dynamic-utils].
Since v4.2.0, it is targeting Java 17 to provide maximum compatibility.
Since v4.3.0, the minimum SDK is Android 4.4 (API 19) to comply with the latest policies.
---
## Contents
- [Installation](#installation)
- [Usage](#usage)
- [Configuration](#configuration)
- [Default toast](#default-toast)
- [Default toast with duration](#default-toast-with-duration)
- [Default toast with icon](#default-toast-with-icon)
- [Default toast with icon and duration](#default-toast-with-icon-and-duration)
- [Error toast](#error-toast)
- [Error toast with duration](#error-toast-with-duration)
- [Success toast](#success-toast)
- [Success toast with duration](#success-toast-with-duration)
- [Warning toast](#warning-toast)
- [Warning toast with duration](#warning-toast-with-duration)
- [Custom toast](#custom-toast)
- [Custom toast with duration](#custom-toast-with-duration)
- [Custom toast with icon](#custom-toast-with-icon)
- [Custom toast with icon and duration](#custom-toast-with-icon-and-duration)
- [Cheat sheets](#cheat-sheets)
- [Dependency](#dependency)
- [License](#license)
---
## Installation
It can be installed by adding the following dependency to your `build.gradle` file:
```groovy
dependencies {
// For AndroidX enabled projects.
implementation 'com.pranavpandey.android:dynamic-toasts:4.3.0'
// For legacy projects.
implementation 'com.pranavpandey.android:dynamic-toasts:1.3.0'
}
```
---
## Usage
It has several method to display toasts based on the requirement. Each method returns a `Toast`
object which can be customised further.
Please call `show()` method to display the toast.
> For a complete reference, please read the [documentation][documentation].
### Configuration
Optional configuration to customise the toasts further like custom background color or drawable,
custom text size, typeface or icon size, etc.
Various methods can be called anywhere in the app to do customisations.
```java
DynamicToast.Config.getInstance()
// Background color for default toast.
.setDefaultBackgroundColor(@ColorInt int defaultBackgroundColor)
// Tint color for default toast.
.setDefaultTintColor(@ColorInt int defaultTintColor)
// Background color for error toast.
.setErrorBackgroundColor(@ColorInt int errorBackgroundColor)
// Background color for success toast.
.setSuccessBackgroundColor(@ColorInt int successBackgroundColor)
// Background color for warning toast.
.setWarningBackgroundColor(@ColorInt int warningBackgroundColor)
// Custom icon for error toast. Pass `null` to use default icon.
.setErrorIcon(@Nullable Drawable errorIcon)
// Custom icon for success toast. Pass `null` to use default icon.
.setSuccessIcon(@Nullable Drawable successIcon)
// Custom icon for warning toast. Pass `null` to use default icon.
.setWarningIcon(@Nullable Drawable warningIcon)
// Disable icon for all the toasts.
.setDisableIcon(boolean disableIcon)
// Custom icon size in `pixels` for all the toasts.
.setIconSize(int iconSize)
// Custom text size in `SP` for all the toasts.
.setTextSize(int textSize)
// Custom text typeface for all the toasts. Pass `null` to use system typeface.
.setTextTypeface(@Nullable Typeface textTypeface)
// Custom background drawable for all the toasts. Pass `null` to use default background.
.setToastBackground(@Nullable Drawable toastBackground)
// Apply customisations.
.apply();
```
Call `reset()` method to reset all the customisations.
```java
// Reset customisations.
DynamicToast.Config.getInstance().reset();
```
### Default toast
Simple toast based on the vanilla Android theme for `Toast.LENGTH_SHORT` duration.
```java
DynamicToast.make(context, "Default toast").show();
```
### Default toast with duration
Simple toast based on the vanilla Android theme for supplied duration.
```java
DynamicToast.make(context, "Default toast with duration", duration).show();
```
### Default toast with icon
Simple toast based on the vanilla Android theme with a icon for `Toast.LENGTH_SHORT` duration.
```java
DynamicToast.make(context, "Default toast with icon", drawable).show();
```
### Default toast with icon and duration
Simple toast based on the vanilla Android theme with a icon for supplied duration.
```java
DynamicToast.make(context, "Default toast with icon and duration", drawable, duration).show();
```
### Error toast
Error toast with `#F44336` background for `Toast.LENGTH_SHORT` duration.
```java
DynamicToast.makeError(context, "Error toast").show();
```
### Error toast with duration
Error toast with `#F44336` background for supplied duration.
```java
DynamicToast.makeError(context, "Error toast with duration", duration).show();
```
### Success toast
Success toast with `#4CAF50` background for `Toast.LENGTH_SHORT` duration.
```java
DynamicToast.makeSuccess(context, "Success toast").show();
```
### Success toast with duration
Success toast with `#4CAF50` background for supplied duration.
```java
DynamicToast.makeSuccess(context, "Success toast with duration", duration).show();
```
### Warning toast
Warning toast with `#FFEB3B` background for `Toast.LENGTH_SHORT` duration.
```java
DynamicToast.makeWarning(context, "Warning toast").show();
```
### Warning toast with duration
Warning toast with `#FFEB3B` background for supplied duration.
```java
DynamicToast.makeWarning(context, "Warning toast with duration", duration).show();
```
### Custom toast
Custom toast based on the supplied background and tint color for `Toast.LENGTH_SHORT` duration.
```java
DynamicToast.make(context, "Custom toast", tintColor, backgroundColor).show();
```
### Custom toast with duration
Custom toast based on the supplied background and tint color for supplied duration.
```java
DynamicToast.make(context, "Custom toast with duration", tintColor, backgroundColor, duration).show();
```
### Custom toast with icon
Custom toast based on the supplied icon, background and tint color theme for `Toast.LENGTH_SHORT`
duration.
```java
DynamicToast.make(context, "Custom toast with icon", drawable, tintColor, backgroundColor).show();
```
### Custom toast with icon and duration
Custom toast based on the supplied icon, background and tint color theme for supplied duration.
```java
DynamicToast.make(context, "Custom toast with icon and duration", drawable,
tintColor, backgroundColor, duration).show();
```
### Cheat sheets
Use dynamic hint to display cheat sheets for any `view`. All the methods are same as explained
above, just replace `DynamicToast` with `DynamicHint` to create a cheat sheet.
> Use `DynamicHint.show(view, toast)` method to display it according to the anchor view position.
### Dependency
It depends on the [dynamic-utils][dynamic-utils] to perform various internal operations.
So, its functions can also be used to perform other useful operations.
---
## Author
Pranav Pandey
[](https://github.com/pranavpandey)
[](https://twitter.com/intent/follow?screen_name=pranavpandeydev)
[](https://paypal.me/pranavpandeydev)
---
## License
Copyright 2017-2024 Pranav Pandey
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.
[android-support]: https://developer.android.com/topic/libraries/support-library/revisions.html#26-0-0
[androidx]: https://developer.android.com/jetpack/androidx
[androidx core]: https://developer.android.com/jetpack/androidx/releases/core
[androidx-migrate]: https://developer.android.com/jetpack/androidx/migrate
[documentation]: https://pranavpandey.github.io/dynamic-toasts
[dynamic-utils]: https://github.com/pranavpandey/dynamic-utils