ComposeChangelog
This library offers you a a changelog dialog for compose including the ability to show new logs on app start only as well as filtering and customisation.
Features#
- filtering
- useful to filter out uninteresting old changelog entries on app start
- useful for filtering changelog based on build flavour
- also supports automatic handling of showing changelogs on app start (uses preference to save last seen changelog version and handles everything for you automatically to only show new changelogs and only show those once)
- customise look
- you can provide custom composables for every item type if desired
- you can provide custom version name formatter
- you can provide a custom sorter
- supports raw and xml resources, default resource name is
changelog.xmlin raw folder - supports summaries with a "show more" button
- optional provides a
gradle pluginthat allows you to convert version names automatically to version numbers
Info
All features are splitted into separate modules, just include the modules you want to use!
Screenshots#
| core | |
|---|---|
 |
Supported Platforms#
This is a KMP (kotlin multiplatform) library and the provided modules do support following platforms.
| Module | JVM | ANDROID | Info |
|---|---|---|---|
| Core | |||
core | ✔ | ✔ | |
| Modules | |||
statesaver-kotpreferences | ✔ | ✔ | |
statesaver-preferences | ✔ | ✔ | |
| Gradle Plugin | |||
gradle-plugin | - | - | this is a gradle plugin only |
gradle-plugin-shared | ✔ | ✔ | no need to include this manually |
Info
iOS support is missing currently. If you want to help simply create a PR! If you need help, contact me by creating a new issue. You just need to write a simple xml parser (I've written one for android and jvm already - especially the one for jvm can probably be easily converted to an iOS version)
Demo#
A full demo is included inside the demo module, it shows nearly every usage with working examples.