Flutter应用更新说明插件release_notes_dialog的使用

release_notes_dialog 是一个易于使用的发布说明对话框插件。它可以自定义以适应您的应用程序设计。

该插件旨在补充现有的 AboutDialog。

安装

在您的 pubspec.yaml 文件中添加依赖：

dependencies:
  release_notes_dialog: "^2.0.0"

在您的 .dart 文件中导入插件：

import 'package:release_notes_dialog/release_notes_dialog.dart';

基本用法

ReleaseNotesDialog 需要一个 Release 列表。每个 Release 需要一个标题，并包含一个 ChangeGroup 列表。ChangeGroup 用于对您的更改进行分组，例如功能、修复、改进等。

创建一个 Release 列表：

final List<Release> releases = [
  Release(
    title: "1.1.0",
    changes: [
      ChangeGroup(
        title: "Features",
        changes: [
          "Added a new feature",
          "Added a second feature",
        ],
      ),
      ChangeGroup(
        title: "Fixes",
        changes: [
          "Fixed the first bug",
          "Fixed a happy little accident",
          "Fixed another bug",
        ],
      ),
    ],
  ),
  Release(
    title: "1.0.0",
    changes: [
      ChangeGroup(
        title: "Release!",
      ),
    ],
  ),
];

您可以以多种方式显示这些发布说明：

使用 showDialog() 函数显示 ReleaseNotesDialog

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

使用 showReleaseNotesDialog() 函数显示对话框

ElevatedButton(
  onPressed: () => showReleaseNotesDialog(
    context: context,
    releases: releases,
  ),
  child: Text("Show ReleaseNotesDialog"),
);

使用 Navigator 显示 ReleaseNotesPage

ElevatedButton(
  onPressed: () => Navigator.of(context, rootNavigator: useRootNavigator).push(
    MaterialPageRoute<void>(
      builder: (BuildContext context) {
        return ReleaseNotesPage(
          releases: releases,
        );
      },
    ),
  ),
  child: Text("Show ReleaseNotesPage"),
);

使用 showReleaseNotesPage() 函数显示页面

ElevatedButton(
  onPressed: () => showReleaseNotesPage(
    context: context,
    releases: releases,
  ),
  child: Text("Show ReleaseNotesPage"),
);

显示 ReleaseNotesListTile

ReleaseNotesListTile(releases: releases);

显示 ReleaseNotesWidget

ReleaseNotesWidget(releases: releases);

示例代码

以下是一个完整的示例代码，展示了如何在 Flutter 应用中使用 release_notes_dialog 插件：

import 'dart:io';

import 'package:flutter/material.dart';
import 'package:release_notes_dialog/release_notes_dialog.dart';

void main() {
  runApp(ExampleApp());
}

class ExampleApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'ReleaseNotesDialog Example',
      theme: ThemeData(
        useMaterial3: true,
      ),
      home: ExamplePage(),
    );
  }
}

class ExamplePage extends StatelessWidget {
  final List<Release> releases = [
    Release(
      title: "1.1.0",
      changes: [
        ChangeGroup(
          title: "Features",
          changes: [
            "Added new feature 1",
            "Added new feature 2",
            "Added a very long feature to show how multiple lines work",
          ],
        ),
        ChangeGroup(
          title: "Fixes",
          changes: [
            if (Platform.isAndroid) "Fixed bug on Android",
            if (Platform.isIOS) "Fixed bug on iOS",
            "Fixed a very long bug to show multiple lines again",
            "Fixed bug 1",
            "Fixed bug 2",
            "Fixed bug 3",
          ],
        ),
      ],
    ),
    Release(
      title: "1.0.0",
      changes: [ChangeGroup(title: "Release!")],
    ),
  ];

  @override
  Widget build(BuildContext context) {
    final ThemeData theme = Theme.of(context);

    return Scaffold(
      appBar: AppBar(
        title: Text('ReleaseNotesDialog Example'),
      ),
      body: ListView(
        padding: EdgeInsets.symmetric(vertical: 20),
        children: [
          Padding(
            padding: EdgeInsets.only(bottom: 15),
            child: Text(
              "Dialogs",
              style: theme.textTheme.headlineLarge,
              textAlign: TextAlign.center,
            ),
          ),
          Row(
            mainAxisAlignment: MainAxisAlignment.spaceEvenly,
            children: [
              ElevatedButton(
                onPressed: () => showDialog(
                  context: context,
                  builder: (BuildContext context) {
                    return ReleaseNotesDialog(releases: releases);
                  },
                ),
                child: Text("Show ReleaseNotesDialog"),
              ),
              ElevatedButton(
                onPressed: () => showDialog(
                  context: context,
                  builder: (BuildContext context) {
                    return AboutDialog(
                      applicationVersion: releases.first.title,
                    );
                  },
                ),
                child: Text("Show AboutDialog"),
              ),
            ],
          ),
          Padding(
            padding: EdgeInsets.only(top: 50, bottom: 15),
            child: Text(
              "Pages",
              style: theme.textTheme.headlineLarge,
              textAlign: TextAlign.center,
            ),
          ),
          Row(
            mainAxisAlignment: MainAxisAlignment.spaceEvenly,
            children: [
              ElevatedButton(
                onPressed: () => showReleaseNotesPage(
                  context: context,
                  releases: releases,
                ),
                child: Text("Show ReleaseNotesPage"),
              ),
              ElevatedButton(
                onPressed: () => showLicensePage(
                  context: context,
                  applicationVersion: releases.first.title,
                ),
                child: Text("Show LicensePage"),
              ),
            ],
          ),
          Padding(
            padding: EdgeInsets.only(top: 50, bottom: 15),
            child: Text(
              "ListTiles",
              style: theme.textTheme.headlineLarge,
              textAlign: TextAlign.center,
            ),
          ),
          ReleaseNotesListTile(releases: releases),
          AboutListTile(),
        ],
      ),
    );
  }
}

贡献

欢迎贡献、功能请求和错误报告！