Documentation

SwiftUI Changelog View

A SwiftUI View for reporting application features and bug fixes to users.

ChangelogView with a light color scheme. A SwiftUI Starter Kit Component.
ChangelogView with a light color scheme.
ChangelogView with a dark color scheme. A SwiftUI Starter Kit Component.
ChangelogView with a dark color scheme.

Usage

let config = VersionController.latest.1

ChangelogView(
    configuration: config
)

// Wrapper view for modal presentation at app launch
ChangelogLaunchView(
    interactor: .init(
        didSelectContinue: {
        }
    ),
    configuration: config
)

Features

  • Built-in versioning system via ChangelogView.Configuration, which allows for cataloguing version changes, to promote transparency to users.
  • Supports light and dark device color schemes by default.
  • Supports font scaling via Dynamic Type.
  • Supports offline usage in SwiftUI Previews for easy debugging and testing.

Notes

  • Recommended to use ChangelogLaunchView, which wraps ChangelogView for use in a modal display context.
  • Append new version notes in VersionController, which consolidates documented version changes.
  • Get the latest internal version notes using VersionController.latest.