Update documentation and remove unused parameters

pull/1522/head
Ellet 1 year ago
parent 3f47e30bc3
commit 28af566d59
No known key found for this signature in database
GPG Key ID: C488CC70BBCEF0D1
  1. 4
      CHANGELOG.md
  2. 3
      doc/CONTRIBUTING.md
  3. 11
      doc/translation.md
  4. 1
      example/pubspec.yaml
  5. 5
      lib/src/models/config/toolbar/buttons/font_family.dart
  6. 5
      lib/src/models/config/toolbar/buttons/font_size.dart
  7. 3
      lib/src/models/rules/insert.dart
  8. 2
      pubspec.yaml

@ -1,7 +1,9 @@
## [8.4.5]
## [8.5.0]
- Migrate to `flutter_localizations` for the translations
- Translate some of the untranslated localizations
- Add default Chinese fallback translation
- Remove unused parameters `items` in `QuillToolbarFontFamilyButtonOptions` and `QuillToolbarFontSizeButtonOptions`
- Update documentation
## [8.4.4]
- Update `.pubignore` to ignore unnecessary files and folders

@ -59,3 +59,6 @@ git push origin your-branch-name
```
Thank you for your time and efforts in this open-source community project!!
## Development Notes
- When update the translations or localizations in the app, please take a look at the [translation](./translation.md) page as it have important notes in order to work

@ -38,4 +38,13 @@ Currently, translations are available for these 31 locales:
#### Contributing to translations
The translation file is located at [toolbar.i18n.dart](lib/src/translations/toolbar.i18n.dart). Feel free to contribute your own translations, just copy the English translations map and replace the values with your translations. Then open a pull request so everyone can benefit from your translations!
The translation files is located at [l10n folder](../lib/src/l10n/). Feel free to contribute your own translations, just copy the [English translations](../lib/src/l10n/quill_en.arb) map and replace the values with your translations.
Run the following script in the root folder:
```
./scripts/renegerate-translations.sh
```
This will generate the new dart files from the arb files in order to take affect, otherwise you won't notice a difference
Then open a pull request so everyone can benefit from your translations!

@ -40,7 +40,6 @@ dev_dependencies:
flutter:
uses-material-design: true
generate: true
assets:
- assets/
- assets/images/

@ -50,7 +50,6 @@ class QuillToolbarFontFamilyButtonOptions extends QuillToolbarBaseButtonOptions<
this.itemPadding,
this.defaultItemColor = Colors.red,
this.renderFontFamilies = true,
@Deprecated('It is not required because of `rawItemsMap`') this.items,
this.highlightElevation = 1,
this.hoverElevation = 1,
this.fillColor,
@ -61,8 +60,6 @@ class QuillToolbarFontFamilyButtonOptions extends QuillToolbarBaseButtonOptions<
final Color? fillColor;
final double hoverElevation;
final double highlightElevation;
@Deprecated('It is not required because of `rawItemsMap`')
final List<PopupMenuEntry<String>>? items;
/// By default it will be [fontFamilyValues] from [QuillToolbarConfigurations]
/// You can override this if you want
@ -137,8 +134,6 @@ class QuillToolbarFontFamilyButtonOptions extends QuillToolbarBaseButtonOptions<
fillColor: fillColor ?? this.fillColor,
hoverElevation: hoverElevation ?? this.hoverElevation,
highlightElevation: highlightElevation ?? this.highlightElevation,
// ignore: deprecated_member_use_from_same_package
items: items ?? this.items,
);
}
}

@ -34,7 +34,6 @@ class QuillToolbarFontSizeButtonOptions extends QuillToolbarBaseButtonOptions<
this.fillColor,
this.hoverElevation = 1,
this.highlightElevation = 1,
this.items,
this.rawItemsMap,
this.onSelected,
super.iconTheme,
@ -58,8 +57,6 @@ class QuillToolbarFontSizeButtonOptions extends QuillToolbarBaseButtonOptions<
final Color? fillColor;
final double hoverElevation;
final double highlightElevation;
@Deprecated('It is not required because of `rawItemsMap`')
final List<PopupMenuEntry<String>>? items;
/// By default it will be [fontSizesValues] from [QuillToolbarConfigurations]
/// You can override this if you want
@ -104,8 +101,6 @@ class QuillToolbarFontSizeButtonOptions extends QuillToolbarBaseButtonOptions<
fillColor: fillColor ?? this.fillColor,
hoverElevation: hoverElevation ?? this.hoverElevation,
highlightElevation: highlightElevation ?? this.highlightElevation,
// ignore: deprecated_member_use_from_same_package
items: items ?? this.items,
rawItemsMap: rawItemsMap ?? this.rawItemsMap,
onSelected: onSelected ?? this.onSelected,
attribute: attribute ?? this.attribute,

@ -375,9 +375,6 @@ class AutoFormatMultipleLinksRule extends InsertRule {
_detectLinkPattern,
caseSensitive: false,
);
// @Deprecated(
// 'Please use [linkRegExp1] or [linkRegExp2]',
// )
static final linkRegExp = oneLineLinkRegExp;
@override

@ -1,6 +1,6 @@
name: flutter_quill
description: A rich text editor built for the modern Android, iOS, web and desktop platforms. It is the WYSIWYG editor and a Quill component for Flutter.
version: 8.4.3
version: 8.5.0
homepage: https://1o24bbs.com/c/bulletjournal/108
repository: https://github.com/singerdmx/flutter-quill

Loading…
Cancel
Save