Flutter自定义格式化插件custom_formatter的使用

Custom Formatter

自定义格式化插件用于在TextFormField或任何数字中格式化输入值。

Getting started

首先，在您的项目pubspec.yaml文件中添加以下依赖项：

dependencies:
  custom_formatter: ^0.0.2

然后运行flutter pub get以安装该插件。

Usage

接下来，您需要通过以下方式导入包：

import 'package:custom_formatter/custom_formatter.dart';

在TextFormField中使用CustomNumberFormatter

以下是一个简单的示例，展示如何在TextFormField中使用CustomNumberFormatter来格式化输入值：

Widget build(BuildContext context) {
  return TextFormField(
    inputFormatters: [
      CustomNumberFormatter(),
    ],
  );
}

格式化数字

您还可以直接对数字进行格式化。例如：

Widget build(BuildContext context) {
  return Text(
    int.parse("123456").format,
  );
}

Additional information

欢迎提交拉取请求。如果您想要进行重大更改，请先打开一个问题讨论您希望进行的更改。

完整示例代码

以下是一个完整的示例，展示如何在Flutter应用中使用custom_formatter插件：

文件路径：example/lib/main.dart

import "package:custom_formatter/custom_formatter.dart"; // 导入自定义格式化包
import 'package:custom_formatter/number.extensions.dart'; // 导入扩展方法
import 'package:flutter/material.dart'; // 导入Flutter核心库

void main() {
  runApp(const MyApp()); // 启动应用
}

// 定义主应用类
class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Input Formatter Demo', // 设置应用标题
      theme: ThemeData(
        primarySwatch: Colors.blue, // 设置主题颜色
      ),
      home: const MyHomePage(), // 设置主页
    );
  }
}

// 主页面类
class MyHomePage extends StatelessWidget {
  final input = 1250; // 定义一个初始数字

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      body: Padding( // 使用Padding设置内边距
        padding: const EdgeInsets.symmetric(horizontal: 50), // 水平内边距为50
        child: Column( // 垂直方向布局
          crossAxisAlignment: CrossAxisAlignment.start, // 子元素左对齐
          mainAxisAlignment: MainAxisAlignment.center, // 子元素垂直居中
          children: [
            TextFormField( // 文本输入框
              inputFormatters: [ // 配置输入格式化器
                CustomNumberFormatter(), // 使用自定义格式化器
              ],
            ),
            const SizedBox(height: 30), // 添加间距
            const Text("Number before formatting :"), // 显示原始数字
            Text(input.toString()), // 显示未格式化的数字
            const SizedBox(height: 30), // 添加间距
            const Text("After formatting :"), // 显示格式化后的数字
            Text(input.format), // 使用.format方法格式化数字
          ],
        ),
      ),
    );
  }
}