WhatsNew

KO | EN

gitlite — search

#javascript #docker #php #android #macos #java #python #typescript #discord #linux #macosx #library

★ 48 Open GitHub ↗

Beautiful way to showcase new features of your app.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-WhatsNew-brightgreen.svg?style=flat)](https://android-arsenal.com/details/1/7164)
[![](https://jitpack.io/v/anderscheow/WhatsNew.svg)](https://jitpack.io/#anderscheow/WhatsNew)
[![Build Status](https://travis-ci.org/anderscheow/WhatsNew.svg?branch=master)](https://travis-ci.org/anderscheow/WhatsNew)
[![PayPal](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://www.paypal.me/anderscheow/5)

# What's New
Beautiful way to showcase new features of your app.

![](https://media.giphy.com/media/WgPaFtXbnYhr22UAaG/giphy.gif)

## 💻 Installation

```groovy
dependencies {
  implementation 'io.github.anderscheow:whatsnew:1.0.1'
}
```

## ❓ Usage
Setup features
````kotlin
val features = ArrayList<Feature>().apply {

// Recommended: Use builder (Support more configurations)
    this.add(Feature.Builder()
            .setIconRes(R.drawable.access_point)
            .setIconColor(Color.RED)
            .setTitleRes(R.string.title_one)
            .setTitleTextColor(Color.BLACK)
            .setDescriptionRes(R.string.description_one)
            .setDescriptionTextColor(Color.BLACK)
            .build())

// or use constructor
    this.add(Feature(R.drawable.account, Color.RED, R.string.title_two, Color.BLACK, R.string.description_two, Color.BLACK))
}
````

Setup and show What's New
````kotlin
// Only show partial configurations, please refer WhatsNew.Builder to view more configurations
WhatsNew.Builder(this)
        .setTitleRes(R.string.app_name)
        .setTitleColor(Color.BLACK)
        .setBackgroundRes(android.R.color.white)
        .setPrimaryButtonBackgroundColor(Color.RED)
        .setPrimaryButtonTextColor(Color.WHITE)
        .setPrimaryButtonTextRes(R.string.lets_go)
        .enablePrimaryButtonAllCaps(false)
        .setSecondaryButtonTextColor(Color.RED)
        .setSecondaryButtonTextRes(R.string.learn_more)
        .enableSecondaryButtonAllCaps(false)
        .enableFadeAnimation(true)
        .setFadeAnimationDuration(500L)
        .setFeatureItemAnimator(FeatureItemAnimator.FADE_IN_UP)
        .setFeatureItemAnimatorDuration(500L)
        .setFeatures(features)
        .setListener(object : WhatsNewListener {
            override fun onWhatsNewShowed(whatsNew: WhatsNew) {
                Log.d(TAG, "onWhatsNewShowed")
            }

override fun onWhatsNewDismissed() {
                Log.d(TAG, "onWhatsNewDismissed")
            }

override fun onPrimaryButtonClicked(whatsNew: WhatsNew) {
                Log.d(TAG, "onPrimaryButtonClicked")
            }

override fun onSecondaryButtonClicked(whatsNew: WhatsNew) {
                Log.d(TAG, "onSecondaryButtonClicked")
            }
        })
        .build()
````

### Support different animation when display features. 
Thanks to [RecyclerView Animators by wasabeef](https://github.com/wasabeef/recyclerview-animators)

* NONE
* SCALE_IN
* SCALE_IN_TOP
* SCALE_IN_BOTTOM
* SCALE_IN_LEFT
* SCALE_IN_RIGHT
* FADE_IN
* FADE_IN_UP
* FADE_IN_DOWN
* FADE_IN_LEFT
* FADE_IN_RIGHT
* SLIDE_IN_UP
* SLIDE_IN_DOWN
* SLIDE_IN_LEFT
* SLIDE_IN_RIGHT
* OVERSHOOT_IN_LEFT
* OVERSHOOT_IN_RIGHT

## Changelog

**1.1.0**

* Updated Gradle and Kotlin version
* Changed Android Support artifacts to AndroidX
* Removed some install dependencies from README

**1.0.1**

* Add support for AndroidX

**1.0.0**

* Introduce What's New library

## Contributions
Any contribution is more than welcome! You can contribute through pull requests and issues on GitHub.

## License
What's New is released under the [MIT License](https://github.com/anderscheow/Validator/blob/master/LICENSE)

WhatsNew

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README