Flutter一次性验证码(OTP)界面插件awesome_otp_screen的使用

Flutter一次性验证码(OTP)界面插件awesome_otp_screen的使用

特性

本包提供了预构建的优秀OTP验证屏幕,并带有自定义键盘。

开始使用

  • SDK: >=2.18.2 <3.0.0
  • Flutter: >=1.17.0

使用方法

以下是为包用户准备的简短且有用的示例。您可以将更长的示例添加到/example文件夹中。

AwesomeOtpScreen.withGradientBackground(
    topColor: Colors.green.shade200,
    bottomColor: Colors.greenAccent.shade700,
    otpLength: 4,
    validateOtp: validateOtp,
    routeCallback: moveToNextScreen,
    themeColor: Colors.white,
    titleColor: Colors.white,
    title: "Phone Number Verification",
    subTitle: "Enter the code sent to \n +880170020020",
    icon: Image.asset(
      'assets/images/phone_logo.png',
      fit: BoxFit.fill,
    ),
)

额外信息

以下是一个完整的示例演示如何使用awesome_otp_screen插件。

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

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

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

  // 验证OTP的函数
  Future<String> validateOtp(String otp) async {
    await Future.delayed(const Duration(milliseconds: 2000));
    if (otp == "123456") {
      return "Done"; // 验证成功
    } else {
      return "The entered Otp is wrong"; // 验证失败
    }
  }

  // 验证成功后的回调函数
  void moveToNextScreen(context) {
    Navigator.push(
      context,
      MaterialPageRoute(builder: (context) => const SuccessfulOtpScreen()),
    );
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      home: AwesomeOtpScreen.withGradientBackground(
        topColor: Colors.green.shade200,
        bottomColor: Colors.greenAccent.shade700,
        otpLength: 4,
        validateOtp: validateOtp,
        routeCallback: moveToNextScreen,
        themeColor: Colors.white,
        titleColor: Colors.white,
        title: "Phone Number Verification",
        subTitle: "Enter the code sent to \n +880170020020",
        icon: Image.asset(
          'assets/images/phone_logo.png',
          fit: BoxFit.fill,
        ),
      ),
    );
  }
}

// 验证成功的屏幕
class SuccessfulOtpScreen extends StatelessWidget {
  const SuccessfulOtpScreen({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Container(
      color: Colors.white,
      child: const Padding(
        padding: EdgeInsets.all(10.0),
        child: Center(
          child: Text(
            "Otp verification successful",
            textAlign: TextAlign.center,
            style: TextStyle(
                fontSize: 20, fontWeight: FontWeight.bold, color: Colors.black),
          ),
        ),
      ),
    );
  }
}

更多关于Flutter一次性验证码(OTP)界面插件awesome_otp_screen的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter一次性验证码(OTP)界面插件awesome_otp_screen的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


awesome_otp_screen 是一个用于在 Flutter 应用中实现一次性验证码(OTP)输入的插件。它提供了一个简单且可定制的界面,帮助开发者快速集成 OTP 功能。以下是如何使用 awesome_otp_screen 的步骤:

1. 添加依赖

首先,你需要在 pubspec.yaml 文件中添加 awesome_otp_screen 依赖:

dependencies:
  flutter:
    sdk: flutter
  awesome_otp_screen: ^1.0.0  # 请检查最新版本

然后运行 flutter pub get 来安装依赖。

2. 导入包

在你的 Dart 文件中导入 awesome_otp_screen 包:

import 'package:awesome_otp_screen/awesome_otp_screen.dart';

3. 使用 AwesomeOtpScreen

你可以通过 AwesomeOtpScreen 组件来创建一个 OTP 输入界面。以下是一个简单的示例:

class OtpScreen extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('OTP Verification'),
      ),
      body: AwesomeOtpScreen(
        otpLength: 6, // OTP 的长度
        onOtpSubmit: (String otp) {
          // 当用户提交 OTP 时的回调
          print('Submitted OTP: $otp');
          // 这里你可以进行 OTP 验证的逻辑处理
          if (otp == '123456') { // 假设正确的 OTP 是 '123456'
            Navigator.of(context).pushReplacement(
              MaterialPageRoute(builder: (context) => HomeScreen()),
            );
          } else {
            ScaffoldMessenger.of(context).showSnackBar(
              SnackBar(content: Text('Invalid OTP')),
            );
          }
        },
        otpStyle: TextStyle(fontSize: 24, fontWeight: FontWeight.bold),
        otpInputDecoration: InputDecoration(
          border: OutlineInputBorder(),
          labelText: 'Enter OTP',
        ),
        buttonText: 'Verify',
        buttonStyle: ElevatedButton.styleFrom(
          primary: Colors.blue,
          onPrimary: Colors.white,
        ),
      ),
    );
  }
}

4. 自定义选项

AwesomeOtpScreen 提供了多个选项来自定义 OTP 输入界面:

  • otpLength: OTP 的长度,默认为 6。
  • onOtpSubmit: 当用户提交 OTP 时的回调函数。
  • otpStyle: OTP 输入框的文本样式。
  • otpInputDecoration: OTP 输入框的装饰。
  • buttonText: 提交按钮的文本。
  • buttonStyle: 提交按钮的样式。

5. 导航到 OTP 屏幕

你可以通过导航将用户带到 OTP 屏幕:

Navigator.of(context).push(
  MaterialPageRoute(builder: (context) => OtpScreen()),
);

6. 处理 OTP 验证

onOtpSubmit 回调中,你可以处理 OTP 的验证逻辑。通常,你会将用户输入的 OTP 与服务器生成的 OTP 进行比较,或者直接调用 API 进行验证。

7. 错误处理

如果用户输入的 OTP 不正确,你可以使用 ScaffoldMessenger 显示错误消息,提示用户重新输入。

8. 完成验证

如果 OTP 验证成功,你可以将用户导航到应用的主界面或其他相关页面。

完整示例

以下是一个完整的示例代码:

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

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: OtpScreen(),
    );
  }
}

class OtpScreen extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('OTP Verification'),
      ),
      body: AwesomeOtpScreen(
        otpLength: 6,
        onOtpSubmit: (String otp) {
          print('Submitted OTP: $otp');
          if (otp == '123456') {
            Navigator.of(context).pushReplacement(
              MaterialPageRoute(builder: (context) => HomeScreen()),
            );
          } else {
            ScaffoldMessenger.of(context).showSnackBar(
              SnackBar(content: Text('Invalid OTP')),
            );
          }
        },
        otpStyle: TextStyle(fontSize: 24, fontWeight: FontWeight.bold),
        otpInputDecoration: InputDecoration(
          border: OutlineInputBorder(),
          labelText: 'Enter OTP',
        ),
        buttonText: 'Verify',
        buttonStyle: ElevatedButton.styleFrom(
          primary: Colors.blue,
          onPrimary: Colors.white,
        ),
      ),
    );
  }
}

class HomeScreen extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Home'),
      ),
      body: Center(
        child: Text('Welcome to the Home Screen!'),
      ),
    );
  }
}
回到顶部