Release Notes Dialog #

An easy to use release notes dialog. Customizable to fit your apps design.

Installation #

In your pubspec.yaml:

dependencies:
    release_notes_dialog: "^1.2.0"

In your .dart file:

import 'package:release_notes_dialog/release_notes_dialog.dart';

Basic Usage #

The ReleaseNotesDialog requires a list of releases. A release needs a version number and contains a list of sublists. Sublists are used to group your changes, for example features, bug fixes, improvements, other.

Create a list of releases:

final List<Release> releases = [
  Release(
    "1.1.0",
    [
      ReleaseSublist(
        name: "Features",
        changes: [
          "Added new feature 1",
          "Added new feature 2",
        ],
      ),
      ReleaseSublist(
        name: "Fixes",
        changes: [
          "Fixed bug 1",
          "Fixed bug 2",
          "Fixed bug 3",
        ],
      ),
    ],
  ),
  Release(
    "1.0.0",
    [
      ReleaseSublist(
        name: "Release!",
      ),
    ],
  ),
];

Show the dialog:

ElevatedButton(
    onPressed: () => showDialog(
        context: context,
        builder: (BuildContext context) {
          return ReleaseNotesDialog(releases: releases);
        }),
    child: Text("Show Dialog"),
);

API #

Release Notes Dialog #

Release #

ReleaseSublist #

Contributions #

Contributions, feature requests and bug reports are welcomed!