Flutter提示框插件ag_prompter_cli的使用

ag_prompter_cli 是一个用于在 Flutter 应用程序中轻松创建命令行向导（CLI Wizard）的包。以下是其安装和使用的详细说明。

安装

1. 在您的 pubspec.yaml 文件中添加该包：

   dependencies:
       ag_prompter_cli: <最新版本>

2. 运行以下命令以获取该包：

   flutter pub get

3. 在您的 Dart 文件中导入该包：

   import 'package:ag_prompter_cli/ag_prompter_cli.dart';

4. 开始在您的 Flutter 应用程序中使用 ag_prompter_cli 小部件。

示例代码

以下是一个完整的示例，展示如何在 Flutter 中使用 ag_prompter_cli 创建一个简单的提示框向导。

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

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('ag_prompter_cli 示例'),
        ),
        body: Center(
          child: ElevatedButton(
            onPressed: () {
              // 显示提示框向导
              showPrompter(context);
            },
            child: Text('开始提示框向导'),
          ),
        ),
      ),
    );
  }
}

// 显示提示框向导的函数
void showPrompter(BuildContext context) {
  final prompter = Prompter(
    steps: [
      Step(
        title: '第一步',
        description: '请输入您的名字：',
        inputType: InputType.text,
        onSubmit: (value) {
          print('输入的名字是: $value');
          return true;
        },
      ),
      Step(
        title: '第二步',
        description: '请选择您的年龄：',
        inputType: InputType.number,
        onSubmit: (value) {
          print('选择的年龄是: $value');
          return true;
        },
      ),
      Step(
        title: '第三步',
        description: '是否同意条款？',
        inputType: InputType.confirm,
        onSubmit: (value) {
          print('是否同意: $value');
          return true;
        },
      ),
    ],
  );

  // 显示提示框向导
  prompter.show(context);
}

代码说明

1. 导入包：首先导入 ag_prompter_cli 包。

   import 'package:ag_prompter_cli/ag_prompter_cli.dart';

2. 定义主应用：创建一个简单的 Flutter 应用程序，并在按钮点击时调用 showPrompter 函数。

   void main() {
     runApp(MyApp());
   }
   
   class MyApp extends StatelessWidget {
     @override
     Widget build(BuildContext context) {
       return MaterialApp(
         home: Scaffold(
           appBar: AppBar(
             title: Text('ag_prompter_cli 示例'),
           ),
           body: Center(
             child: ElevatedButton(
               onPressed: () {
                 showPrompter(context);
               },
               child: Text('开始提示框向导'),
             ),
           ),
         ),
       );
     }
   }

3. 创建提示框向导：使用 Prompter 类定义一系列步骤，并设置每一步的标题、描述、输入类型和提交逻辑。

   void showPrompter(BuildContext context) {
     final prompter = Prompter(
       steps: [
         Step(
           title: '第一步',
           description: '请输入您的名字：',
           inputType: InputType.text,
           onSubmit: (value) {
             print('输入的名字是: $value');
             return true;
           },
         ),
         Step(
           title: '第二步',
           description: '请选择您的年龄：',
           inputType: InputType.number,
           onSubmit: (value) {
             print('选择的年龄是: $value');
             return true;
           },
         ),
         Step(
           title: '第三步',
           description: '是否同意条款？',
           inputType: InputType.confirm,
           onSubmit: (value) {
             print('是否同意: $value');
             return true;
           },
         ),
       ],
     );
   
     // 显示提示框向导
     prompter.show(context);
   }

4. 运行效果：点击按钮后，会依次弹出三个提示框，分别要求用户输入名字、选择年龄并确认条款。

贡献指南

如果您希望为 ag_prompter_cli 做出贡献，请遵循以下步骤：

1. 克隆仓库并创建新分支：

   git clone <repository-url>
   git checkout -b feature/your-feature-name

2. 编写代码并确保测试通过：

   flutter test