Flutter文本语言检查插件languagetool_textfield的使用

LanguageTool TextField

提供强大的拼写检查和语法纠正功能。

图片展示

Features

LanguageTool TextField 包是一个为Flutter应用程序设计的拼写检查器。它与LanguageTool API集成，以提供实时拼写检查能力。这个包通过自动检测并高亮显示用户输入时的拼写错误来增强文本输入准确性。

它特别适用于需要精确文本输入的应用程序，如聊天或笔记应用程序。通过使用LanguageTool TextField包，开发人员可以通过提供直观且可靠的拼写检查功能来改善用户体验。

Getting started

1. 添加依赖

在pubspec.yaml文件中添加以下依赖：

dependencies:
  languagetool_textfield: ^最新版本号

然后运行命令安装依赖：

flutter pub add languagetool_textfield

2. 导入包

在Dart文件中导入包：

import 'package:languagetool_textfield/languagetool_textfield.dart';

Quick Start

要开始使用此插件，请复制以下代码或参考示例项目中的实现：

// 创建一个文本控制器
final _controller = LanguageToolController();

// 在布局中使用TextField组件
child: LanguageToolTextField(
  controller: _controller,
  
  // 可选参数：指定语言代码（如'en-US'），默认值为'auto'
  language: 'en-US',
);

// 不要忘记释放控制器资源
_controller.dispose();

使用Debounce和Throttle

为了将防抖(debounce)或节流(throttle)功能加入到LanguageTool TextField中，您可以按照以下方式创建LanguageToolController并设置延迟时间和类型：

final _controller = LanguageToolController(
  // 如果延迟时间为Duration.zero，则不应用任何延迟
  delay: Duration(milliseconds: 500), // 设置防抖/节流的延迟时间
  delayType: DelayType.debouncing, // 选择DelayType.debouncing或DelayType.throttling
);

• DelayType.debouncing: 当用户在特定时间内未执行事件时调用函数。
• DelayType.throttling: 在用户执行事件期间以指定的时间间隔调用函数。

完整示例Demo

下面是一个完整的示例应用程序，展示了如何使用languagetool_textfield包以及如何结合DropdownMenu更改对齐方式：

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

void main() {
  runApp(
    const MaterialApp(
      home: App(),
    ),
  );
}

class App extends StatefulWidget {
  const App({super.key});

  @override
  State<App> createState() => _AppState();
}

class _AppState extends State<App> {
  final LanguageToolController _controller = LanguageToolController();

  static const List<MainAxisAlignment> alignments = [
    MainAxisAlignment.center,
    MainAxisAlignment.start,
    MainAxisAlignment.end,
  ];
  int currentAlignmentIndex = 0;

  @override
  Widget build(BuildContext context) {
    return Material(
      child: Scaffold(
        body: Column(
          mainAxisAlignment: alignments[currentAlignmentIndex],
          children: [
            LanguageToolTextField(
              controller: _controller,
              language: 'en-US',
            ),
            DropdownMenu<int>(
              hintText: "Select alignment...",
              onSelected: (value) => setState(() {
                currentAlignmentIndex = value ?? 0;
              }),
              dropdownMenuEntries: const [
                DropdownMenuEntry(value: 0, label: "Center alignment"),
                DropdownMenuEntry(value: 1, label: "Top alignment"),
                DropdownMenuEntry(value: 2, label: "Bottom alignment"),
              ],
            ),
          ],
        ),
      ),
    );
  }

  @override
  void dispose() {
    _controller.dispose();
    super.dispose();
  }
}

以上就是关于languagetool_textfield插件的基本介绍和使用方法。如果您有任何问题或者遇到bug，欢迎前往GitHub Issues页面提交反馈。