UIPresenter

This android library is like a tour guide for your app's Views. It helps to explain to your user, the role of the Views in your Activity or Fragment. It supports minSdk 21 and up.

UIPresenter in action	UIPresenter in action	UIPresenter in action

How to get this library in your android app

Step 1. Add the jitpack repository to the repositories { } function, inside your project build.gradle or your settings.gradle like so:

repositories {
    google()
    mavenCentral()
    // Place the jitpack repository inside this, like so:
    maven { url 'https://jitpack.io' }
}

Step 2. Add the dependency in your module build.gradle file, like so:

dependencies {
    implementation "com.github.germainkevinbusiness:UIPresenter:2.0.0"
}

That's it!

Example with a RecyclerView & a menu item

Usage

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

UIPresenter(activity = this).set(
    viewToPresent = binding.recyclerView[2], // using view binding here
    descriptionText = "This is a row inside the RecyclerView with an animal image and name",
    presenterStateChangeListener = { _, _ -> }
)

Only the above three parameters inside the UIPresenter.set() method are required to display a Presenter on your Activity or Fragment's UI. The rest of the parameters in the UIPresenter.set() method are optional, but great for customization!

Here's the output of the above code in light and dark mode:

For more in-depth examples, check out the sample app.

Note

To create your own animation when the presenter is being added to the decorView (called revealAnimation), or when the presenter is being removed from the decorView (called removeAnimation) , you need to implement the PresenterAnimation interface, like so:

class MyCustomAnimation : PresenterAnimation {

    override fun runAnimation(
        coroutineScope: CoroutineScope, // A scope to run your animation in, if you want
        presenter: Presenter, // The Presenter is the View which presents your UI and the View that
        // your custom animation will animate.
        animationDuration: Long, // The duration of the animation in milliseconds
        afterAnim: () -> Unit // When called that means we can safely consider this animation to be done
    ) {
        // write your animation logic here
    }
}

You can apply your own animations to the UIPresenter like so:

UIPresenter(activity = this).set(
    revealAnimation = MyCustomAnimation(), // if it's a reveal animation
    removeAnimation = MyCustomAnimation() // if it's a remove animation
)

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

Licenced under the MIT Licence

Copyright (c) 2023 Kevin Germain

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.