Flutter WhatsNew #

A Flutter package to display a "What's New" or "Changelog" dialog to users. Perfect for informing users about new features, updates, or important announcements after an app update.

Features #

• Changelog Parsing: Automatically parse your CHANGELOG.md file and display the latest changes.
• Customizable UI: Fully customizable text, colors, buttons, and layout.
• Scheduled Display: Show the dialog after a delay or only when the app version changes.
• Adaptive Design: Works on Android, iOS, Web, and Desktop.
• Material 3 Ready: Modern design defaults.

Installation #

Add flutter_whatsnew to your pubspec.yaml:

dependencies:
  flutter_whatsnew: ^1.1.0

Usage #

1. Show Changelog from File #

Ensure your CHANGELOG.md is included in your pubspec.yaml assets:

flutter:
  assets:
    - CHANGELOG.md

Then, navigate to the WhatsNewPage.changelog:

import 'package:flutter_whatsnew/flutter_whatsnew.dart';

// Check documentation for method parameters
WhatsNewPage.changelog(
  title: Text("What's New"),
  buttonText: Text("Continue"),
  // path: 'assets/CHANGELOG.md', // Optional, defaults to CHANGELOG.md
);

2. Manual List of Items #

You can pass a list of widgets (e.g., ListTile) to display specific features:

WhatsNewPage(
  title: Text("What's New"),
  items: [
    ListTile(
      leading: Icon(Icons.star),
      title: Text('New Feature'),
      subtitle: Text('Description of the new feature.'),
    ),
    ListTile(
      leading: Icon(Icons.bug_report),
      title: Text('Bug Fixes'),
      subtitle: Text('Fixed various issues.'),
    ),
  ],
  buttonText: Text("Let's Go"),
  onButtonPressed: () {
    Navigator.pop(context);
  },
);

3. Scheduled / Delayed Display #

Use ScheduledWhatsNewPage to show the dialog only after a delay or based on version checks.

ScheduledWhatsNewPage(
  details: WhatsNewPage.changelog(
    title: Text("Update Available"),
    buttonText: Text("Okay"),
  ),
  delay: Duration(seconds: 3), // Show after 3 seconds
  // appVersion: '1.0.1', // Only show if the saved version differs
  child: HomeScreen(),
);

detailed Documentation #

WhatsNewPage #

WhatsNewPage.changelog #