Flutter文本格式化插件idkit_inputformatters的使用

Flutter文本格式化插件idkit_inputformatters的使用

idkit_inputformatters 是一个用于文本输入格式化的插件。该插件简单易用、功能强大、稳定且高度可定制。欢迎每位开发者使用。

现有功能简介

以下是现有功能的简要介绍。更多功能和用法请查看 example 文件夹中的 main.dart 文件。

1. 限制输入框的最大长度

   • 示例代码

     inputFormatters: [
         IDKitNumeralTextInputFormatter.length(
            maxLength: 10,
            errorStreamController: streamController,
         )
     ]
     

   • 代码解释

     上述格式器将文本输入值的最大长度限制为十个字符。

2. 限制文本输入的最大值

   • 示例代码

     inputFormatters: [
         IDKitNumeralTextInputFormatter.max(
            maxValue: 100,
            maxDecimalDigit: 2,
            decimalPoint: true,
            errorStreamController: streamController,
         ),
     ]
     

   • 代码解释

     上述代码将文本输入的最大值限制为一百，并且当输入值为小数时，最多保留两位小数。

3. 限制文本输入的最小值

   • 示例代码

     inputFormatters: [
         IDKitNumeralTextInputFormatter.min(
            minValue: 1,
            maxDecimalDigit: 2,
            decimalPoint: true,
            errorStreamController: streamController,
         )
     ]
     

   • 代码解释

     上述代码将文本输入的最小值限制为一，并且当输入值为小数时，最多保留两位小数。

4. 限制文本输入值的范围

   • 示例代码

     inputFormatters: [
         IDKitNumeralTextInputFormatter.range(
            minValue: 2,
            maxValue: 100,
            maxDecimalDigit: 2,
            decimalPoint: false,
            errorStreamController: streamController,
         ),
     ]
     

   • 代码解释

     上述代码将文本输入的最小值限制为二，最大值限制为一百。如果输入值为小数，则最多保留两位小数。

5. 自定义输入格式器

   • 示例代码

     inputFormatters: [
         IDKitNumeralTextInputFormatter(...),
     ]
     

   • 代码解释

     上述代码用于设置自定义输入格式器。

完整示例Demo

以下是一个完整的示例Demo，展示了如何在 Flutter 应用中使用 idkit_inputformatters 插件。

import 'dart:async';

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

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key}) : super(key: key);

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

class _MyHomePageState extends State<MyHomePage> {
  late StreamController<InputFormatterError> streamController = StreamController();

  [@override](/user/override)
  void initState() {
    // 处理异常输入值的广播监听事件。
    streamController.stream.listen((event) {
      print(event);
      // Your codes...
    });
    super.initState();
  }

  [@override](/user/override)
  void dispose() {
    // 销毁控制对象。
    streamController.close();
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('IDKitInputFormatters 包测试'),
      ),
      body: Container(
        child: TextField(
          controller: TextEditingController(),
          inputFormatters: [
            // 仅限制输入为数字。
            IDKitNumeralTextInputFormatter(
              minValue: 1,
            ),

            // 限制输入值的最大长度。
            // IDKitNumeralTextInputFormatter.length(
            //   maxLength: 10,
            //   errorStreamController: streamController,
            // ),

            // 限制输入值的最大值。
            IDKitNumeralTextInputFormatter.max(
              maxValue: 100,
              maxDecimalDigit: 2,
              decimalPoint: true,
              errorStreamController: streamController,
            ),

            // 限制输入值的最小值。
            IDKitNumeralTextInputFormatter.min(
              minValue: 1,
              maxDecimalDigit: 2,
              decimalPoint: true,
              errorStreamController: streamController,
            ),

            // 限制输入值的范围。
            IDKitNumeralTextInputFormatter.range(
              minValue: 2,
              maxValue: 100,
              maxDecimalDigit: 2,
              decimalPoint: false,
              errorStreamController: streamController,
            ),
          ],
        ),
      ),
    );
  }
}