changelog_flutter_kit 1.1.1
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
WhatsNewControllerseparating pure business state from Flutter UI widgets. - Pluggable Persistence (
WhatsNewStorage):- Automatically defaults to
SharedPrefsWhatsNewStorageif no custom storage is supplied (zero-configuration out of the box). - Included
InMemoryWhatsNewStoragefor testing and ephemeral use cases. - Interface allows custom backing with SQLite, Hive, Isar, Drift, or remote database.
- Automatically defaults to
- SemVer 2.0.0 Parser & Comparator:
- Full adherence to semantic version precedence including prereleases (
-beta.1), build metadata (+build.42), andvprefix tolerance.
- Full adherence to semantic version precedence including prereleases (
- Declarative Headless Widgets:
WhatsNewBuilder: Reactive builder exposingWhatsNewState(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.
- Apple Human Interface Guidelines bottom sheet modal with squircle icon badges, SF-style typography, drag handle, and
- Android Material 3 Presentation:
- Material 3 bottom sheet modal with tonal elevation, pill badges, and
FilledButton.
- Material 3 bottom sheet modal with tonal elevation, pill badges, and
- Desktop, Web & Tablet Modal Dialog:
WhatsNewPresentationStyle.dialogcentered modal popup with constrained dimensions.
- Monetization & Pro Hooks:
isProchangelog flags, dimmed visual opacity, lock badges, andonProTapcallbacks for gating premium announcements.
- Version History View:
- Dedicated multi-version scrollable screen (
WhatsNewSheet.showHistoryandWhatsNew.showHistory).
- Dedicated multi-version scrollable screen (
๐ First-Class Localization (i18n) #
WhatsNewLocalizationEngine:- Built-in localized presets for
spanish,french,german, andarabic(with RTL support). - Direct compatibility with
flutter_localizations,.arbfiles, andeasy_localization.
- Built-in localized presets for
- Multi-Language Changelog Content:
- Added
translationsmap toChangelogEntryandlocalizedTitlestoVersionChangelog. - Automatically resolves localized descriptions and titles matching user device locale (
Localizations.maybeLocaleOf(context)).
- Added
๐ 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.
WhatsNewStatic 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) anddart pub publish --dry-runcompliant.
1.0.0 - 2026-01-01 #
- Initial release of
changelog_flutter_kit. - Basic changelog presentation sheet and entry models.