Skip to content

Commit

Permalink
Release 1.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
CatHood0 committed Aug 20, 2024
1 parent 0fce2ec commit 7c2a406
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 18 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
## 1.1.3

* Chore: deprecated `removeEmptyWordsOnTokenize` and `removeAllEmptyWords` since are useless
* Chore: deprecated `LanguageDicPriorityOrder` and it was replaced by `StrategyLanguageSearchOrder`
* Fix: `italian` contains not used english words
* Feat: added more words for `Deutsch` and `Spanish` dictionaries

## 1.1.2

* Fix: bad state after close controllers
Expand Down
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@
- **Customizable Error Handling**: Optionally use custom gesture recognizers for wrong words, enabling custom interactions.
- **Stream-based State Management**: Provides a stream of updates for spell-checking states, allowing reactive UI updates.

## Current languages supported by default (more will be added in future releases)
## Current languages supported (more languages will be added in future releases)

The package already have a default list of words for these languages:

* German - de
* English - en
* Spanish - es
* French - fr
* Italian - it
* Norwegian - no
* Portuguese - pt
* Swedish - sv
* German - `de`
* English - `en`
* Spanish - `es`
* French - `fr`
* Italian - `it`
* Norwegian - `no`
* Portuguese - `pt`
* Swedish - `sv`

## Getting Started

Expand Down Expand Up @@ -55,7 +55,6 @@ Use the `check()` method to analyze a `String` for spelling errors:
```dart
List<TextSpan>? result = spellChecker.check(
'Your text here',
removeEmptyWordsOnTokenize: true,
);
```

Expand Down Expand Up @@ -130,6 +129,7 @@ When you add a custom language you will need to call `registerLanguage()` and pa
### Customization Options

* **checkBuilder**: Use the checkBuilder() method for a custom widget-based approach to handling spelling errors.
* **setNewStrategy**: Use the setNewStrategy() method to modify the current value to change the behvarior if the dictionary is reloaded.
* **customLongPressRecognizerOnWrongSpan**: Attach custom gesture recognizers to wrong words for tailored interactions.

### Caching
Expand All @@ -151,7 +151,7 @@ _Note: this functions let us dispose the controllers using `disposeControllers()

```dart
late StreamSubscription subscription;
subscription = SimpleSpellChecker(language: '')
subscription = spellChecker
.checkStream(
'Your text here',
removeEmptyWordsOnTokenize: true,
Expand All @@ -166,12 +166,12 @@ or

```dart
late StreamSubscription subscription;
subscription = SimpleSpellChecker(language: '').checkBuilderStream<Widget>(
'Your text here',
builder: (word, isWrong) {
return Text(word, style: TextStyle(color: isWrong ? Colors.red : null));
},
removeEmptyWordsOnTokenize: true,
subscription = spellChecker
.checkBuilderStream<Widget>(
'Your text here',
builder: (word, isWrong) {
return Text(word, style: TextStyle(color: isWrong ? Colors.red : null));
},
).listen(
(List<Widget> data) {},
);
Expand Down
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: simple_spell_checker
description: "A simple and powerful spell checker, allowing developers to detect and highlight spelling errors in text"
version: 1.1.2
version: 1.1.3
homepage: https://github.com/CatHood0/simple_spell_checker/
issue_tracker: https://github.com/CatHood0/simple_spell_checker/issues
documentation: https://github.com/CatHood0/simple_spell_checker
Expand Down

0 comments on commit 7c2a406

Please sign in to comment.