core/com.michaelflisar.composechangelog

Package-level declarations

Types

Changelog

object Changelog

ChangelogDefaults

object ChangelogDefaults

ChangelogUtil

object ChangelogUtil

Properties

DefaultTextFormatter

actual val ChangelogDefaults.DefaultTextFormatter: ChangelogTextFormatter

expect val ChangelogDefaults.DefaultTextFormatter: ChangelogTextFormatter

actual val ChangelogDefaults.DefaultTextFormatter: ChangelogTextFormatter

Functions

Changelog

@Composable

fun Changelog(releases: List<ChangelogReleaseItem>, setup: Changelog.Setup, modifier: Modifier, lazyListState: LazyListState = rememberLazyListState(), releaseContainer: @Composable (content: @Composable () -> Unit) -> Unit = { it() })

Displays the list of releases and their items. It uses the release renderer to display the release information and the item renderers to display the items.

@Composable

fun Changelog(state: ChangelogState, setup: Changelog.Setup, modifier: Modifier, lazyListState: LazyListState = rememberLazyListState(), releaseContainer: @Composable (content: @Composable () -> Unit) -> Unit = { OutlinedCard { Column( modifier = Modifier.padding(8.dp), verticalArrangement = Arrangement.spacedBy(8.dp) ) { it() } } }, loading: @Composable () -> Unit = { LinearProgressIndicator() })

Main entry point for the changelog. It will read the changelog data and display it. You can customize the release container and the loading state.

getAppVersionCode

fun Changelog.getAppVersionCode(context: Context): Long

returns the app version code

getAppVersionName

fun Changelog.getAppVersionName(context: Context): String

returns the app version name

fun Changelog.getAppVersionName(): String

returns the app version name (the packageVersion from the exe file metadata)

rememberChangelogData

@Composable

fun rememberChangelogData(state: ChangelogState, setup: Changelog.Setup, filter: (ChangelogReleaseItem) -> Boolean = { true }): MutableState<ChangelogData>

Reads the changelog data from the file and filters it based on the minimum visible release version. It returns a mutable state that contains the changelog data, which can be either loading or the actual data.

runPS

fun runPS(command: String): String

setup

fun ChangelogDefaults.setup(context: Context, changelogResourceId: Int = R.raw.changelog, textFormatter: ChangelogTextFormatter = DefaultTextFormatter, versionFormatter: ChangelogVersionFormatter = DefaultVersionFormatter(), skipUnknownTags: Boolean = false, textMore: String = "More"): Changelog.Setup

fun ChangelogDefaults.setup(file: File = File("changelog.xml"), textFormatter: ChangelogTextFormatter = DefaultTextFormatter, versionFormatter: ChangelogVersionFormatter = DefaultVersionFormatter(), skipUnknownTags: Boolean = false, textMore: String = "More"): Changelog.Setup