Flutter功能未知插件patch_pal的介绍与使用

PatchPal

patch_pal 是一个 Flutter 插件，它使您能够通过使用 JSON 配置文件轻松启用或禁用应用程序中的功能。您可以使用 Gist 或原始 Git JSON 文件。

目录

• 开始
• JSON 结构
• 使用方法
• 待办事项列表

开始

在开始之前，请确保您已准备好 JSON 配置文件。JSON 结构应如下所示：

{
  "packageName": "com.yeasin50.patch_pal",
  "version": "1.0.0",
  "items": [
    {
      "name": "number of mango",
      "value": 3,
      "message": "added 3 mangos"
    },
    {
      "name": "rain",
      "value": true,
      "message": "enabled rain based on weather"
    }
  ],
  "updates": ["looking for updates..."]
}

使用方法

按照以下步骤将 patch_pal 集成到您的 Flutter 项目中：

第一步：添加依赖项

在 pubspec.yaml 文件中添加 patch_pal 作为依赖项：

dependencies:
  patch_pal: ^1.0.0 # 最新版本

或者，如果您想使用存储库中的最新版本，请使用：

patch_pal:
  git:
    url: https://github.com/yeasin50/patch_pal.git
    ref: master

第二步：导入包

在 Dart 代码中导入包：

import 'package:patch_pal/patch_pal.dart';

第三步：初始化配置

使用 PatchPal.init(yourJsonConfigFilePath); 初始化您的 JSON 配置文件路径。可以使用 FutureBuilder 异步设置路径。yourJsonConfigFilePath 应返回有效的 JSON 文件。

第四步：访问值

可以使用 PatchItemName 访问值。以下是一些常见用例：

• 要显示对话框，使用 PatchPal.dialog。
• 使用 PatchPal.view 替换带有补丁视图的小部件。
• 使用 PatchPal.overlay 显示覆盖层或基于值堆叠小部件。
• 使用 PatchPal.switcher 根据值切换小部件。

待办事项列表

• ❌ 配置（JSON）生成器
• ✅ 警报小部件和视图
• ❌ 流或 ValueListenable 支持

许可证

该项目根据 MIT 许可证进行许可 - 请参阅 LICENSE.md 文件以获取详细信息。

完整示例 Demo

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

void main() {
  runApp(const MainApp());
}

class MainApp extends StatelessWidget {
  const MainApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: Center(
          child: FutureBuilder<void>(
            // 初始化 JSON 配置文件路径
            future: PatchPal.init(
              'https://raw.githubusercontent.com/yeasin50/AssetsFor_/master/apps/patch_pal/test.json',
            ),
            builder: (context, snapshot) {
              if (snapshot.connectionState == ConnectionState.done) {
                if (snapshot.hasError) {
                  return const Center(
                    child: Text('Error'),
                  );
                } else {
                  return Column(
                    children: [
                      buildPatchPalWidget(context),
                    ],
                  );
                }
              } else {
                return const Center(
                  child: CircularProgressIndicator(),
                );
              }
            },
          ),
        ),
      ),
    );
  }

  Column buildPatchPalWidget(BuildContext context) {
    return Column(
      mainAxisSize: MainAxisSize.max,
      children: [
        // 根据 'rain' 的值切换小部件
        PatchPal.switcher(
          patchItemName: 'rain',
          onPatch: const Text('It is raining'),
          onNoPatch: const Text('This is a text'),
        ),
        PatchPal.switcher(
          patchItemName: 'rain',
          onNoPatch: const Text('This is a text'),
        ),
        PatchPal.switcher(
          patchItemName: 'unknown',
          onNoPatch: const Text('This is a text'),
          tristate: true,
        ),
        const Divider(),
        const Text("Overlay"),
        Container(
          height: 200,
          width: 200,
          color: Colors.red,
          child: PatchPal.overlay(
            patchItemName: 'rain',
            alignment: Alignment.bottomCenter,
            child: const Text('Beta test,raining'),
          ),
        ),
        const Divider(),
        const Text("Dialog"),
        Builder(builder: (ctx) {
          PatchPal.dialog(
            context: context,
            patchItemName: 'rain',
            title: 'Rain',
            message: 'It is raining',
            positiveText: 'Ok',
            negativeText: 'Cancel',
            onPositive: () {
              Navigator.pop(context);
            },
            onNegative: () {
              Navigator.pop(context);
            },
          );

          return const Text('auto show dialog');
        }),
        const Divider(),
        const Text("View"),
        PatchPal.view(
          patchItemName: 'rain',
          onPositive: const Text('It is raining'),
          child: const Text('This is a text'),
        ),
        PatchPal.view(
          patchItemName: 'rain',
          child: const Text('This is a text'),
        ),
        PatchPal.view(
          patchItemName: 'unknown',
          child: const Text('This is a text'),
        ),
      ],
    );
  }
}