Flutter步进器插件cool_stepper_plus的使用

Flutter步进器插件cool_stepper_plus的使用

Cool Stepper Plus 是一个用于展示步骤序列的操作组件。它对于表单向导或引导页面非常有用。

该项目是从 Cool Stepper 派生出来的，因为我需要一个支持空安全的包，并且希望对这个伟大的组件进行持续开发。感谢 emrade 和所有帮助构建这个令人惊叹组件的开发者们。

截图

Header 启用并带有默认按钮

Header 禁用并带有自定义按钮（Ripple Button）

示例

CoolStepper(
  showErrorSnackbar: false,   // 如果为true，则如果表单验证失败，会显示snackbar。如果为false，则不会显示snackbar
  isHeaderEnabled: false,     // 如果为true，则显示header。如果为false，则禁用header
  onCompleted: () => {        // 提交信息到服务器
    // 提交逻辑
  },
  steps: [
    CoolStep(
      title: "基本信息",
      subtitle: "请填写一些基本信息以开始",
      content:  // 在这里添加获取基本信息的widget
    ),
    CoolStep(
      title: "添加地址",
      subtitle: "请填写您的地址",
      content: // 在这里添加获取地址信息的widget
    ),
    CoolStep(
      title: "添加个人照片",
      subtitle: "如果您愿意，请添加一张个人照片",
      content: // 在这里添加获取个人照片的widget
    ),
  ],
);

这是一个验证的例子。验证期望一个函数来验证整个表单。如果一切正常，返回null；否则返回错误字符串。

validation: () {
  if (!_formKey.currentState!.validate()) {
    return '请正确填写表单';   // 显示的错误消息
  }
  return null;
},

CoolStepper 类

CoolStepperConfig 属性

待办事项

• 已添加 TextStyle 参数以自定义下一步按钮（2.2.0）
• 已添加 TextStyle 参数以自定义后退按钮（2.2.0）
• 未添加 TextStyle 参数以自定义步骤x of N
• 未添加选项以更改下一步按钮的背景颜色

如果有任何问题或不清楚的地方，请打开一个问题。

许可证

请参阅 LICENSE.md

完整示例代码

import 'package:cool_stepper_plus/cool_stepper_plus.dart';
import 'package:flutter/material.dart';
import 'package:another_flushbar/flushbar.dart';
import 'package:ripple_button/ripple_button.dart';

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Cool Stepper',
      theme: ThemeData(
        primarySwatch: Colors.pink,
        visualDensity: VisualDensity.adaptivePlatformDensity,
      ),
      debugShowCheckedModeBanner: false,
      home: MyHomePage(title: 'Cool Stepper'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key? key, this.title}) : super(key: key);

  final String? title;

  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final _formKey = GlobalKey<FormState>();
  String? selectedRole = 'Writer';
  final TextEditingController _nameCtrl = TextEditingController();
  final TextEditingController _emailCtrl = TextEditingController();

  [@override](/user/override)
  Widget build(BuildContext context) {
    final steps = [
      CoolStep(
        title: '基本信息',
        subtitle: '请填写一些基本信息以开始',
        alignment: Alignment.center,
        content: Form(
          key: _formKey,
          child: Column(
            children: [
              _buildTextField(
                labelText: '姓名',
                validator: (value) {
                  if (value!.isEmpty) {
                    return '姓名是必填项';
                  }
                  return null;
                },
                controller: _nameCtrl,
              ),
              _buildTextField(
                labelText: '电子邮件地址',
                validator: (value) {
                  if (value!.isEmpty) {
                    return '电子邮件地址是必填项';
                  }
                  return null;
                },
                controller: _emailCtrl,
              ),
            ],
          ),
        ),
        validation: () {
          if (!_formKey.currentState!.validate()) {
            return '请正确填写表单';
          }
          return null;
        },
      ),
      CoolStep(
        title: '选择您的角色',
        subtitle: '选择一个能更好地定义您的角色',
        alignment: Alignment.center,
        content: Container(
          child: Row(
            children: [
              _buildSelector(
                context: context,
                name: '作家',
              ),
              SizedBox(width: 5.0),
              _buildSelector(
                context: context,
                name: '编辑者',
              ),
            ],
          ),
        ),
      ),
    ];

    void _onFinish() {
      final flush = Flushbar(
        message: '步骤完成！',
        flushbarStyle: FlushbarStyle.FLOATING,
        margin: EdgeInsets.all(8.0),
        borderRadius: BorderRadius.all(Radius.circular(8.0)),
        icon: Icon(
          Icons.check_circle_outline_outlined,
          size: 28.0,
          color: Colors.green,
        ),
        duration: Duration(seconds: 2),
        leftBarIndicatorColor: Colors.green,
      );
      flush.show(context);
    }

    final stepper = CoolStepper(
      showErrorSnackbar: true,
      hasRoundedCorner: true,
      onCompleted: _onFinish,
      contentPadding: EdgeInsets.only(left: 40, right: 40),
      config: CoolStepperConfig(
        finishButton: Container(
          child: RippleButton(
            text: '完成',
            type: RippleButtonType.AMBER,
            padding: EdgeInsets.only(right: 16, bottom: 6),
            style: RippleButtonStyle(
              width: 20,
            ),
            onPressed: () {},
          ),
        ),
        backButton: RippleButton(
          text: '后退',
          type: RippleButtonType.BLUE_TRANSLUCENT,
          padding: EdgeInsets.only(left: 16, bottom: 6),
          style: RippleButtonStyle(
            width: 24,
          ),
          onPressed: () {},
        ),
        nextButton: RippleButton(
          text: '下一步',
          type: RippleButtonType.AMBER,
          padding: EdgeInsets.only(right: 16, bottom: 6),
          style: RippleButtonStyle(
            width: 20,
          ),
          onPressed: () {},
        ),
      ),
      steps: steps,
    );

    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title!),
      ),
      body: Container(
        child: stepper,
      ),
    );
  }

  Widget _buildTextField({
    String? labelText,
    FormFieldValidator<String>? validator,
    TextEditingController? controller,
  }) {
    return Padding(
      padding: const EdgeInsets.only(bottom: 20.0),
      child: TextFormField(
        decoration: InputDecoration(
          labelText: labelText,
        ),
        validator: validator,
        controller: controller,
      ),
    );
  }

  Widget _buildSelector({
    BuildContext? context,
    required String name,
  }) {
    final isActive = name == selectedRole;

    return Expanded(
      child: AnimatedContainer(
        duration: Duration(milliseconds: 200),
        curve: Curves.easeInOut,
        decoration: BoxDecoration(
          color: isActive ? Theme.of(context!).primaryColor : null,
          border: Border.all(
            width: 0,
          ),
          borderRadius: BorderRadius.circular(8.0),
        ),
        child: RadioListTile(
          value: name,
          activeColor: Colors.white,
          groupValue: selectedRole,
          onChanged: (String? v) {
            setState(() {
              selectedRole = v;
            });
          },
          title: Text(
            name,
            style: TextStyle(
              color: isActive ? Colors.white : null,
            ),
          ),
        ),
      ),
    );
  }
}