FloatingToast-Android

An android library to make customisable floating animated toasts

Getting Started

In your build.gradle

dependencies {
    implementation 'hari.floatingtoast:floatingtoast:0.1.1'
}

Usage

Create Floating Toasts

First, instantiate a FloatingToast object with one of the makeToast() methods. This method takes three parameters: the view which calls the toast (recommended) or the activity context, the text message, and the duration for the toast. It returns a properly initialized FloatingToast object. You can display the toast notification with show(), as shown in the following example:

    Button button = findViewById(R.id.button);
    String text = "Hello toast!";
    int duration = FloatingToast.LENGTH_MEDIUM;

    button.setOnClickListener(new View.OnClickListener() {
        @Override
        public void onClick(View v) {

            FloatingToast toast = FloatingToast.makeToast(button, text, FloatingToast.LENGTH_MEDIUM);
            toast.show();
        }
    });

You can also chain your methods and avoid holding on to the Toast object, like this:

    FloatingToast.makeToast(button, text, FloatingToast.LENGTH_MEDIUM).show();

You can use the activity context to instantiate the FloatingToast object, like this:

    FloatingToast.makeToast(MainActivity.this, text, FloatingToast.LENGTH_MEDIUM).show();

    NOTE: Always use the view (which was used to call the toast) to
    create the FloatingToast object wherever possible rather than
    using the activity context.

An example with all the customisations:

    Typeface customFont = Typeface.createFromAsset(getContext().getAssets(), "fonts/custom_font.ttf");

    //Duration of 1250 millis
    //Gravity - Mid Top                 (Default is Center)
    //Fade out duration of 1000 millis  (Default is 750 millis)
    //Text size - 12dp                  (Default is 16dp)
    //Background blur - On              (Default is On)
    //Float distance - 30px             (Default is 40px)
    //Text color - White
    //Text shadow - On                  (Default is Off)
    //Custom font                       (No custom font is provided by default)
    FloatingToast.makeToast(button, text, FloatingToast.LENGTH_LONG)
            .setGravity(FloatingToast.GRAVITY_MID_TOP)
            .setFadeOutDuration(FloatingToast.FADE_DURATION_LONG)
            .setTextSizeInDp(12)
            .setBackgroundBlur(true)
            .setFloatDistance(FloatingToast.DISTANCE_SHORT)
            .setTextColor(Color.parseColor("#ffffff"))
            .setShadowLayer(5, 1, 1, Color.parseColor("#000000"))
            .setTextTypeface(customFont)
            .show();    //Show toast at the specified fixed position

You can also set the toast's position as dynamic(i.e. show the toast at the touch position) like this:

    FloatingToast.makeToast(button, text, FloatingToast.LENGTH_MEDIUM)
            .showAtTouchPosition();

Summary

Public methods

makeToast

    makeToast (View view, String text, int duration)

Make a standard toast that just contains a text view.
(Recommended method over makeToast(Activity, String, int)

makeToast

    makeToast (View view, int resId, int duration)

Make a standard toast that just contains a text view with the text from a resource.
@throws Resources.NotFoundException if the resource can't be found.
(Recommended method over makeToast(Activity, int, int)

makeToast

    makeToast (Activity activity, String text, int duration)

Make a standard toast that just contains a text view.
(Only use this method if not calling from a view)

makeToast

    makeToast (Activity activity, int resId, int duration)

Make a standard toast that just contains a text view with the text from a resource.
@throws Resources.NotFoundException if the resource can't be found.
(Only use this method if not calling from a view)

setGravity

    setGravity (int gravity)

Set the location at which the notification should appear on the screen.

setGravity

    setGravity (int gravity, int xOffset, int yOffset)

Set the location at which the notification should appear on the screen.

setFadeOutDuration

    setFadeOutDuration (int fadeOutDuration)

Set the fade out duration of the toast. Total animation time of the toast - duration + fadeOutDuration

setTextColor

    setTextColor (int color)

Sets the text color for all the states (normal, selected, focused) to be this color.

setTextTypeface

    setTextTypeface (Typeface typeface)

Sets the typeface and style in which the text should be displayed. Note that not all Typeface families actually have bold and italic variants, so you may need to use setTextStyle(int) to get the appearance that you actually want.

setTextStyle

    setTextStyle (int style)

Sets the style in which the text should be displayed, and turns on the fake bold and italic bits in the Paint if the Typeface that you provided does not have all the bits in the style that you specified.

setTextSizeInSp

    setTextSizeInSp (float sizeInSp)

Set the default text size to the given value, interpreted as "scaled pixel" units. This size is adjusted based on the current density and user font size preference.

setTextSizeInDp

    setTextSizeInDp (int sizeInDp)

Set the default text size to the given value, interpreted as "independent pixel" units. This size is adjusted based on the current density.

setTextSizeCustomUnit

    setTextSizeCustomUnit (int unit, float size)

Set the default text size to a given unit and value. See android.util.TypedValue for the possible dimension units.

setFloatDistance

    setFloatDistance (float floatDistance)

Sets the distance of the toast till which it floats.

setShadowLayer

    setShadowLayer (float shadowRadius, float shadowDx, float shadowDy, int shadowColor)

Gives the text a shadow of the specified blur radius and color, the specified distance from its drawn position. The text shadow produced does not interact with the properties on view that are responsible for real time shadows, elevation and translationZ.

setBackgroundBlur

    setBackgroundBlur (boolean bool)

Sets the blur background for the text in the toast.

showAtTouchPosition

    showAtTouchPosition (View view)

Show the view for the specified duration at the touch position.

show

    show()

Show the view for the specified duration.

Show your support

Give a ⭐️ if this project helped you!

License

Copyright ©️ 2018 Hariprasanth S

This project is licensed under the Apache License, Version 2.0
You may also obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0