Flutter应用致谢信息展示插件credits_builder的使用

Flutter应用致谢信息展示插件credits_builder的使用

credits_builder 是一个简单的包，用于生成你的依赖项的致谢页面。这是感谢和欣赏第三方库工作的最佳方式。

配置

在 pubspec.yaml 文件中设置依赖：

dependencies:
  credits_builder: ^0.0.3                 # android   ios   linux   macos   web   windows

credits_builder:
  outputFile: "assets/dependencies.json"  # 默认值

使用

生成依赖文件

运行以下命令会在 assets 文件夹中创建或更新依赖文件（路径为 assets/dependencies.json）：

dart run credits_builder:start

运行时获取依赖

以下是基本的方法，在运行时获取依赖项：

Future<List<Dependency>> getDependencies(BuildContext context) =>
      CreditsBuilder().config().get(context);

如果你定义了一个与默认不同的依赖文件名，可以这样获取信息：

 Future<List<Dependency>> getDependencies(BuildContext context) =>
    CreditsBuilder()
        .config(
          path: 'assets/other_file_name.json', // 自定义路径
        )
        .get(context);

如果你想在使用前对文件信息进行预处理（例如使用 Stringcare 去除混淆），可以这样做：

 Future<List<Dependency>> getDependencies(BuildContext context) =>
    CreditsBuilder()
        .config(
          process: (data) async => Stringcare().revealData(data) ?? data, // 预处理数据
        )
        .get(context);

更多关于Flutter应用致谢信息展示插件credits_builder的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter应用致谢信息展示插件credits_builder的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


credits_builder 是一个用于在 Flutter 应用中展示致谢信息的插件。它可以帮助你轻松地列出并展示你在项目中使用的第三方库、依赖项或其他贡献者。以下是如何使用 credits_builder 插件的步骤：

1. 添加依赖

首先，在 pubspec.yaml 文件中添加 credits_builder 插件的依赖：

dependencies:
  flutter:
    sdk: flutter
  credits_builder: ^1.0.0  # 请使用最新版本

然后运行 flutter pub get 来获取依赖。

2. 配置 credits_builder

在项目的根目录下创建一个 credits.yaml 文件，用于定义你想要展示的致谢信息。例如：

credits:
  - name: "Flutter"
    description: "Google's UI toolkit for building natively compiled applications for mobile, web, and desktop from a single codebase."
    link: "https://flutter.dev"

  - name: "Provider"
    description: "A wrapper around InheritedWidget to make them easier to use and more reusable."
    link: "https://pub.dev/packages/provider"

  - name: "http"
    description: "A composable, Future-based library for making HTTP requests."
    link: "https://pub.dev/packages/http"

3. 生成致谢信息

运行以下命令来生成致谢信息：

flutter pub run credits_builder

这将会生成一个 credits.dart 文件，其中包含了你在 credits.yaml 中定义的所有致谢信息。

4. 在应用中使用致谢信息

在生成的 credits.dart 文件中，你会看到一个 credits 列表。你可以在你的 Flutter 应用中使用这个列表来展示致谢信息。

例如，你可以创建一个简单的页面来展示这些信息：

import 'package:flutter/material.dart';
import 'credits.dart';  // 导入生成的credits.dart文件

class CreditsPage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Credits'),
      ),
      body: ListView.builder(
        itemCount: credits.length,
        itemBuilder: (context, index) {
          final credit = credits[index];
          return ListTile(
            title: Text(credit.name),
            subtitle: Text(credit.description),
            onTap: () {
              if (credit.link != null) {
                // 打开链接
              }
            },
          );
        },
      ),
    );
  }
}

5. 导航到致谢页面

你可以在应用的某个地方添加一个按钮或菜单项，用于导航到 CreditsPage：

Navigator.push(
  context,
  MaterialPageRoute(builder: (context) => CreditsPage()),
);
回到顶部