aboutsummaryrefslogtreecommitdiff
path: root/about/README.md
blob: ccde4e6b1ca857366d72541a2cc10b1f6cb45d26 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# KAU :about

Most apps could not be possible without the collective efforts of other developers and their libraries.
It's always nice to give credit where credit is due, but it's not always at the top of ones agenda.
About Activity aims to fix that by preparing a beautiful overlay activity that does just that.

![About Activity Gif](https://raw.githubusercontent.com/AllanWang/Storage-Hub/master/kau/kau_about_activity.gif)

The overlay is heavily based off of the about section in [Plaid](https://github.com/nickbutcher/plaid),
and adds on the power of [About Libraries](https://github.com/mikepenz/AboutLibraries) to automatically find the dependencies.

This activity can be easily added by extending `AboutActivityBase`.
Everything is already prepared, but you can modify the theme or other components through the config DSL or through the open functions.

If you wish to add custom panels, you will need to implement `AboutPanelContract`. 
The most common usage is with a recyclerview, so there is a simplified class `AboutPanelRecycler` that you may extend as well.
Note that the viewpager by default will keep all panels in memory, so it's best to not have too many pages with expensive interactions.

You may easily launch the activity through the binder:
```
Activity.kauLaunchAbout<T>()
```
where `T` extends `AboutActivityBase`

Be sure to include the activity in your Manifest and have it extend `Kau.About`, or any other style that achieves the same look.

## Proguard

Without auto detection, KAU about will retain the classes containing the lib strings by default.
If you use proguard with auto detect, make sure to retain all R classes to make it possible

```
-keep class .R
-keep class **.R$* {
    <fields>;
}
```