ComposeChangelog

4.0.0indexed

Simplifies changelog management by providing tools to display changelogs in applications, enhancing user experience with customizable layouts and seamless integration.

AndroidJVMNativeWasm·MFlisar/ComposeChangelog

Stars

Used by

dependents

—

Health

/ 100

ComposeChangelog

This library provides following main features:

filtering

Screenshots

:camera: Screenshots

core

:computer: Supported Platforms

:arrow_right: Versions

Dependency	Version
Kotlin	`2.4.0`
Jetbrains Compose	`1.11.1`

:wrench: Setup

Direct Dependency Notation

:rocket: Usage

Define your changelog as xml file

[!NOTE] the header tag only works if you add the renderer-header module! supported icons for the header tag must be defined by yourself (the icon is optional though)

Show the changelog


// 1) define a version formatter that can convert between a version number and a version string
val changelogFormatter = DefaultVersionFormatter(DefaultVersionFormatter.Format.MajorMinorPatchCandidate)

// 2) optional - here you can apply some customisations like changelog resource id, localized texts, styles, filter, sorter, renderer...
val setup = ChangelogDefaults.setup(context = context) // context must only be provided on android!

// 3) show the changelog dialog
if (changelogState.visible) {
    Dialog(
        onDismissRequest = { changelogState.hide() }
    ) {
        Surface {
            Changelog(changelogState, setup, Modifier.fillMaxWidth())
        }
    }
}


Button(
    onClick = {
        changelogState.show() 
    }
) {
    Text()
}

Show the interesting parts of the changelog on app start

In addition to the previous code, you can also show the changelog on app start if there are new versions that the user did not see yet. This is optional of course but it is a nice way to inform your users about new features and changes in your app.

[!NOTE] This will automatically only show new changelogs that the user did not see yet.

Header renderer

If you want to use the header renderer, add the module and register the renderer like following:

// in this example we define a renderer that can render 3 icons for the header - this optional
Changelog.registerRenderer(
    ChangelogHeaderRenderer {
        val icon = when (it?.lowercase()) {
            "info" -> Icons.Default.Info
            "new" -> Icons.Default.NewReleases
            "warning" -> Icons.Default.Warning
            else -> null
        }
        if (icon != null) {
            Icon(imageVector = icon, contentDescription = null)
        }
    }
)

:file_folder: Modules

:sparkles: Demo

A full demo is included inside the demo module, it shows nearly every usage with working examples.

:information_source: More

Advanced
- Custom Renderer
- Gradle Plugin

:books: API

Check out the API documentation.

:bulb: Other Libraries

You can find more libraries (all multiplatform) of mine that all do work together nicely here.

Related libraries

Surfaced from shared tags and platforms — no rankings paid for.

ComposeDialogs★ 91

MFlisarEnhances user interfaces with customizable dialogs, offering flexible configurations and seamless integration for simplified dialog management and user interaction.Shared: material3, compose

ComposeDebugDrawer★ 44

MFlisarEnhances UI development with a customizable debug drawer, allowing easy integration of debugging features into applications to streamline testing and troubleshooting processes.Shared: material3, compose

compose★ 6.0k

androidxDeclarative UI toolkit enabling programmatic UI via composable functions, offering animations, Material (including Material 3), foundation building blocks, compiler optimizations, runtime state management, and core UI primitives.Shared: material3, compose

material3-windowsizeclass-multiplatform★ 361

chrisbanesFacilitates responsive UI design by implementing Material 3 window size classes across multiple platforms, ensuring layouts adapt to various screen sizes. Supports Android, iOS, desktop, and web environments.Shared: material3, compose

czan★ 79

TweenerDesign system library inspired by Paul Cezanne, tailored for apps with a specific look and feel for targeted platforms like Material 3 for Android and Cupertino for iOS, following Atomic Design methodology.Shared: material3, compose

halogen★ 34

himattmTurns natural-language prompts into full Material 3 themes at runtime — generating colors, typography, and shapes from LLM seeds, expanding via HCT, with per-key caching and presets.Shared: material3, compose

Dependency

Version

Kotlin

2.4.0

Jetbrains Compose

1.11.1

:rocket: Usage

Define your changelog as xml file

[!NOTE] the header tag only works if you add the renderer-header module! supported icons for the header tag must be defined by yourself (the icon is optional though)

Show the changelog

// 1) define a version formatter that can convert between a version number and a version string val changelogFormatter = DefaultVersionFormatter(DefaultVersionFormatter.Format.MajorMinorPatchCandidate) // 2) optional - here you can apply some customisations like changelog resource id, localized texts, styles, filter, sorter, renderer... val setup = ChangelogDefaults.setup(context = context) // context must only be provided on android! // 3) show the changelog dialog if (changelogState.visible) { Dialog( onDismissRequest = { changelogState.hide() } ) { Surface { Changelog(changelogState, setup, Modifier.fillMaxWidth()) } } } Button( onClick = { changelogState.show() } ) { Text() }

Show the interesting parts of the changelog on app start

[!NOTE] This will automatically only show new changelogs that the user did not see yet.

Header renderer

If you want to use the header renderer, add the module and register the renderer like following:

// in this example we define a renderer that can render 3 icons for the header - this optional Changelog.registerRenderer( ChangelogHeaderRenderer { val icon = when (it?.lowercase()) { "info" -> Icons.Default.Info "new" -> Icons.Default.NewReleases "warning" -> Icons.Default.Warning else -> null } if (icon != null) { Icon(imageVector = icon, contentDescription = null) } } )

core	✅	✅	✅	✅	✅	provides all the basic classes and composables to show a changelog
renderer-header	✅	✅	✅	✅	✅	implements rendering of a tag
statesaver-kotpreferences	✅	✅	✅	✅	✅	provides a simple state saver based on KotPreferences
statesaver-preferences	✅	✅	✅	✅	❌	provides a simple state saver based on jetpack preferences
gradle-plugin	-	-	-	-	-	This is a gradle plugin that offers functions to generate version numbers from a version string
shared	✅	✅	✅	✅	✅	shared classes between the gradle plugin and the library - no need to include this manually!

ComposeChangelog

ComposeChangelog

Table of Contents

:camera: Screenshots

core

:computer: Supported Platforms

:arrow_right: Versions

:wrench: Setup

:rocket: Usage

Define your changelog as xml file

Show the changelog

Show the interesting parts of the changelog on app start

Header renderer

:file_folder: Modules

:sparkles: Demo

:information_source: More

:books: API

:bulb: Other Libraries

Related libraries

ComposeChangelog

Table of Contents

:camera: Screenshots

core

:computer: Supported Platforms

:arrow_right: Versions

:wrench: Setup

:rocket: Usage

Define your changelog as xml file

Show the changelog

Show the interesting parts of the changelog on app start

Header renderer

:file_folder: Modules

:sparkles: Demo

:information_source: More

:books: API

:bulb: Other Libraries

Related libraries