Flutter文本自动校正与自动补全插件 autocorrect_and_autocomplete_engine 的使用

Features

autocorrect_and_autocomplete_engine 是一个基于Tries构建的简单高效的自动纠错和自动补全引擎，主要功能包括：

• 自动补全给定字符串
• 生成给定字符串的自动补全建议列表
• 自动纠正给定字符串
• 生成给定字符串的自动纠正建议列表
• 对给定列表进行字母排序

Getting Started

添加依赖

在你的 pubspec.yaml 文件中添加该包：

dependencies:
    autocorrect_and_autocomplete_engine: ^版本号

请确保替换 ^版本号 为最新版本号。

导入包

在你的 Dart 文件中导入该包：

import 'package:autocorrect_and_autocomplete_engine/autocorrect_and_autocomplete_engine.dart';

Usage

初始化

TrieEngine 需要一个字符串列表来处理自动补全和自动纠错。以下是初始化 TrieEngine 的方法：

使用字符串列表初始化

List<String> testData = ["compete","ability","baker","abilities","able"];
TrieEngine trieEngine = TrieEngine(src : testData);

使用文件中的单词列表初始化

你可以从文件中读取单词列表并初始化 TrieEngine：

TrieEngine trieEngine = TrieEngine(src : File('PATH_TO_FILE').readAsLinesSync());

插入新字符串

你可以通过以下方式插入新的字符串到 TrieEngine 中：

trieEngine.insertWord('awesome');

使用自动补全

自动补全给定字符串

使用 autoComplete() 方法可以基于字母顺序自动补全给定字符串：

String result = trieEngine.autoComplete('marv');
print(result); // marvel

生成自动补全建议列表

使用 autoCompleteSuggestions() 方法可以生成给定字符串的自动补全建议列表：

List<String> result = trieEngine.autoCompleteSuggestions('marv');
print(result); // [mar, marathon, marble, marc, march, ...]

使用自动纠错

自动纠错给定字符串

使用 autoCorrect() 方法可以自动纠正给定字符串：

String result = trieEngine.autoCorrect('marxvl');
print(result); // marvel

生成自动纠错建议列表

使用 autoCorrectSuggestions() 方法可以生成给定字符串的自动纠错建议列表：

List<String> result = trieEngine.autoCorrectSuggestions('marxvl');
print(result); // [marvel, mar, max, ma, mail, male, mali, mall, marble, marc]

对列表进行字母排序

使用 toSortedList() 方法可以对给定的测试数据列表进行字母排序：

List<String> listToSort = ["compete","ability","baker","abilities","able"];

TrieEngine trieEngine = TrieEngine(src : listToSort);

List<String> sortedList = trieEngine.toSortedList();

print(sortedList); // [abilities, ability, able, baker, compete]

示例 Demo

下面是一个完整的示例代码，展示了如何使用 autocorrect_and_autocomplete_engine 包实现自动补全和自动纠错功能：

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

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

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

class MyHomePage extends StatefulWidget {
  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final TextEditingController _controller = TextEditingController();
  List<String> suggestions = [];
  String correctedText = '';
  TrieEngine _trieEngine;

  [@override](/user/override)
  void initState() {
    super.initState();
    List<String> testData = ["compete", "ability", "baker", "abilities", "able"];
    _trieEngine = TrieEngine(src: testData);
  }

  void _onTextChanged(String text) {
    setState(() {
      suggestions = _trieEngine.autoCompleteSuggestions(text);
      correctedText = _trieEngine.autoCorrect(text);
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Autocorrect and Autocomplete Demo'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          children: [
            TextField(
              controller: _controller,
              onChanged: _onTextChanged,
              decoration: InputDecoration(
                labelText: 'Type here...',
              ),
            ),
            SizedBox(height: 20),
            Text('Corrected Text: $correctedText'),
            SizedBox(height: 20),
            Expanded(
              child: ListView.builder(
                itemCount: suggestions.length,
                itemBuilder: (context, index) {
                  return ListTile(
                    title: Text(suggestions[index]),
                  );
                },
              ),
            ),
          ],
        ),
      ),
    );
  }
}