easynotificationview

This small kotlin library helps you to show fully customizable notifications in any part of your app without the need to write any boilerplate code.

EasyNotificationView.create(this, R.layout.layout_for_notification).show()

In this case you will see smth like this:

Adding to the project

Add to the dependencies section:

implementation 'com.netfantazii:EasyNotificationView:0.5'

Make sure, that the project's build.gradle file has the following repositoriy specified (it is included in new android studio projects by default):

jcenter()

How to customize the notification layout?

Just pass what layout you like to the create function.

How to customize the animation?

I've created a couple of basic animations. You can add them this way:

        EasyNotificationView.create(
            this,
            R.layout.layout_for_notification,
            appearAnimator = FadeInAppearAnimator(),
            disappearAnimator = BottomSlideDisappearAnimator()
        ).show()     

You can easily create your animation and animate any parameters you want. Just inherit from basic Appear or Disappear animator class and implement required functions. You can see the example in created animations.

Changing the default container for the notification.

By default, the container used for the notification is the root view of the activity (android.R.layout.content) or the root of the fragment (which is returned from onCreateView()). If you want to change this behavior, you can pass a container to the show() function explicitly.

        val container = findViewById<FrameLayout>(R.id.container)
        EasyNotificationView.create(this, R.layout.layout_for_notification).show(container)

Listeners

The notification supports up to 9 buttons plus background click behavior. The buttons in your layout file must have following ids: env_button1, env_button2, ...env_button9.

        <TextView
            android:id="@+id/env_button1"
            android:text="Sample button 1" />
        
        <TextView
            android:id="@+id/env_button2"
            android:text="Sample button 2" />
        
        <TextView
            android:id="@+id/env_button9"
            android:text="Sample button 9" />

After defining ids, use the appropriate setter to attach the listener:

EasyNotificationView.create(this, R.layout.layout_for_notification).apply {
            onButton3ClickListener = {
                greatFunction()
                hide()
            }

            onButton7ClickListener = {
                anotherGreatFunction()
                hide()
            }
        }.show()

By default all the buttons except the background overlay have hide() behavior. Clicking on them will start disappear animation and finally close the notification.

Changing the overlay color and behavior

Just pass the color as the third argument and apply the onOverlayClickListener.

        val overlayColor = ContextCompat.getColor(this, R.color.colorPrimary)
        EasyNotificationView.create(this, R.layout.layout_for_notification, overlayColor).apply {
            onOverlayClickListener = {
                onOverlayClickFunction()
            }
        }.show()

By default, the overlay swallows all clicks, but you can make it to propagate them to the underlying views. To do that, define isOverlayClickable property as 'false' and do not apply any listeners to the overlay.

        EasyNotificationView.create(this, R.layout.layout_for_notification).apply {
            isOverlayClickable = false
        }.show()

Passing the transparent color and disabling overlay clickability will make the overlay disappear.

        EasyNotificationView.create(this, R.layout.layout_for_notification, Color.TRANSPARENT).apply {
            isOverlayClickable = false
        }.show()

Showing auto-closing notification with a timer

Invoke showAutoHide() method and pass time in milliseconds as an argument (it defines how much time the notification will stay on the screen before starting disappearing animation)

        EasyNotificationView.create(this, R.layout.layout_for_notification, Color.TRANSPARENT).apply {
                isOverlayClickable = false
            }.showAutoHide(1000)

Overriding back button behavior

By default, the back button is overriden while the notification is on the screen. It will hide() the notification. If you want to disable it or change the behavior, use setOnBackPressAction() method.

        EasyNotificationView.create(this, R.layout.layout_for_notification, Color.TRANSPARENT)
            .apply {
                isOverlayClickable = false
                setOnBackPressAction { /*your code*/ }
            }.show()

Or

        EasyNotificationView.create(this, R.layout.layout_for_notification, Color.TRANSPARENT)
            .apply {
                isOverlayClickable = false
                setOnBackPressAction(null)
            }.show()

Under the hood behavior

The notification view attaches itself to the container when you call the show() method. After the disappear animation finishes, the notification view automatically detaches itself from the root view.

Known issues

For some reason, if a view is added to a constraint layout with match parent parameters, it remains in the memory after detaching until a new view is added. It's not a significant memory leak, but anyway... Also, this is not the issue for this particular library, any view suffers from this. I've created the question here. If anyone knows smth about it, share your thoughts, please.