Skip to main content

changelog_flutter_kit 1.1.1 copy "changelog_flutter_kit: ^1.1.1" to clipboard
changelog_flutter_kit: ^1.1.1 copied to clipboard

A headless and platform-adaptive 'What's New' and release notes kit for Flutter apps with native iOS Cupertino, Material 3, SemVer comparison, and persistence.

CHANGELOG #

All notable changes to the changelog_flutter_kit package will be documented in this file. The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.


1.1.1 - 2026-10-04 #

๐Ÿ“š Documentation & Metadata #

  • Updated repository and issue tracker URLs to official GitHub project (andronasef/changelog_flutter_kit).
  • Updated README feature banner graphic with absolute fallback URL hosted on GitHub raw CDN for seamless rendering on pub.dev.

1.1.0 - 2026-10-04 #

โœจ Core & Headless Engine #

  • Decoupled Controller Architecture: Introduced WhatsNewController separating pure business state from Flutter UI widgets.
  • Pluggable Persistence (WhatsNewStorage):
    • Automatically defaults to SharedPrefsWhatsNewStorage if no custom storage is supplied (zero-configuration out of the box).
    • Included InMemoryWhatsNewStorage for testing and ephemeral use cases.
    • Interface allows custom backing with SQLite, Hive, Isar, Drift, or remote database.
  • SemVer 2.0.0 Parser & Comparator:
    • Full adherence to semantic version precedence including prereleases (-beta.1), build metadata (+build.42), and v prefix tolerance.
  • Declarative Headless Widgets:
    • WhatsNewBuilder: Reactive builder exposing WhatsNewState (hasUpdate, currentChangelog, unseenChangelogs, markCurrentSeen).
    • WhatsNewGate: Conditional renderer displaying child or fallback based on update availability.

๐ŸŽจ Headful Platform-Adaptive UI Layer #

  • iOS & macOS Cupertino Presentation:
    • Apple Human Interface Guidelines bottom sheet modal with squircle icon badges, SF-style typography, drag handle, and CupertinoButton.filled.
  • Android Material 3 Presentation:
    • Material 3 bottom sheet modal with tonal elevation, pill badges, and FilledButton.
  • Desktop, Web & Tablet Modal Dialog:
    • WhatsNewPresentationStyle.dialog centered modal popup with constrained dimensions.
  • Monetization & Pro Hooks:
    • isPro changelog flags, dimmed visual opacity, lock badges, and onProTap callbacks for gating premium announcements.
  • Version History View:
    • Dedicated multi-version scrollable screen (WhatsNewSheet.showHistory and WhatsNew.showHistory).

๐ŸŒ First-Class Localization (i18n) #

  • WhatsNewLocalization Engine:
    • Built-in localized presets for spanish, french, german, and arabic (with RTL support).
    • Direct compatibility with flutter_localizations, .arb files, and easy_localization.
  • Multi-Language Changelog Content:
    • Added translations map to ChangelogEntry and localizedTitles to VersionChangelog.
    • Automatically resolves localized descriptions and titles matching user device locale (Localizations.maybeLocaleOf(context)).

๐ŸŒ JSON Schema & Dynamic Loaders #

  • WhatsNewLoader:
    • fromJsonString(): Parses JSON array or wrapped object payloads.
    • fromAsset(): Loads bundled changelog files from Flutter asset bundles.
    • fromLocalizedAsset(): Dynamically loads locale-keyed asset files (changelog_es.json).
    • fromNetwork(): Fetches remote changelogs over HTTP/HTTPS with custom headers, configurable timeouts, and automatic asset fallback when offline.
  • WhatsNew Static Facade Methods:
    • WhatsNew.checkAndShowFromAsset()
    • WhatsNew.checkAndShowFromNetwork()
    • WhatsNew.initializeFromAsset()
    • WhatsNew.initializeFromNetwork()

๐Ÿงช Quality, Tests & Showcase #

  • 29 Automated Tests: Comprehensive unit and widget tests covering SemVer comparisons, storage persistence, state controller logic, widget rendering, and JSON parsing.
  • Interactive Showcase App: Multi-platform example app with headless banners, Cupertino sheets, Material 3 sheets, dialogs, full history, and debug storage reset.
  • Static Analysis: Verified with flutter analyze (0 issues found) and dart pub publish --dry-run compliant.

1.0.0 - 2026-01-01 #

  • Initial release of changelog_flutter_kit.
  • Basic changelog presentation sheet and entry models.
2
likes
160
points
417
downloads

Documentation

API reference

Publisher

unverified uploader

Weekly Downloads

A headless and platform-adaptive 'What's New' and release notes kit for Flutter apps with native iOS Cupertino, Material 3, SemVer comparison, and persistence.

Repository (GitHub)
View/report issues

Topics

#changelog #release-notes #whats-new #bottom-sheet #cupertino

License

MIT (license)

Dependencies

flutter, package_info_plus, shared_preferences

More

Packages that depend on changelog_flutter_kit