diff --git a/doc/configurations/custom_buttons.md b/doc/configurations/custom_buttons.md index 0639ee37..d1f050f8 100644 --- a/doc/configurations/custom_buttons.md +++ b/doc/configurations/custom_buttons.md @@ -1,8 +1,10 @@ -# Custom `QuillToolbar` Buttons +# Custom QuillToolbar Buttons ✨ You may add custom buttons to the _end_ of the toolbar, via the `customButtons` option, which is a `List` of `QuillToolbarCustomButtonOptions`. +## Adding an Icon 🖌️ + To add an Icon, we should use a new `QuillToolbarCustomButtonOptions` class ```dart @@ -14,6 +16,8 @@ To add an Icon, we should use a new `QuillToolbarCustomButtonOptions` class ), ``` +## Example Usage 📚 + Each `QuillCustomButton` is used as part of the `customButtons` option as follows: ```dart diff --git a/doc/configurations/font_size.md b/doc/configurations/font_size.md index a4e25825..2eb3d8e9 100644 --- a/doc/configurations/font_size.md +++ b/doc/configurations/font_size.md @@ -1,4 +1,4 @@ -# Font Size +# 🔠 Font Size Within the editor toolbar, a drop-down with font-sizing capabilities is available. This can be enabled or disabled diff --git a/doc/configurations/localizations_setup.md b/doc/configurations/localizations_setup.md index cf5c12f9..fa7efa16 100644 --- a/doc/configurations/localizations_setup.md +++ b/doc/configurations/localizations_setup.md @@ -1,8 +1,6 @@ -# Localizations Setup +# 🌍 Localizations Setup -in addition to the required delegates mentioned above in [Using custom app widget](./using_custom_app_widget.md) - -which are: +In addition to the required delegates mentioned above in [Using custom app widget](./using_custom_app_widget.md), which are: ```dart localizationsDelegates: const [ @@ -12,21 +10,15 @@ localizationsDelegates: const [ ], ``` -which are used by official Flutter widgets +Which are used by Flutter widgets. -The library also needs the `FlutterQuillLocalizations.delegate` +📌 Note: The library also needs the `FlutterQuillLocalizations.delegate`: ```dart // Required localizations delegates ... FlutterQuillLocalizations.delegate ``` -To offer the default localizations. - -But **you don't have to** since we have wrapped the `QuillEditor` and `QuillToolbar` -with `FlutterQuillLocalizationsWidget` which will check if it sets then it will go, if not, then it will be provided -only for them, so it's not really required, but if you are overriding the `localizationsDelegates` you could also add -the `FlutterQuillLocalizations.delegate` -which won't change anything +**You don't have to add this explicitly** because we have wrapped the `QuillEditor` and `QuillToolbar` with `FlutterQuillLocalizationsWidget`. This widget will check if the necessary localizations are set; if not, it will provide them only for these widgets. Therefore, it's not strictly required. However, if you are overriding the `localizationsDelegates`, you can also add the `FlutterQuillLocalizations.delegate`. -There are additional notes in the [Translation](../translation.md) section +📄 For additional notes, refer to the [Translation](../translation.md) section. diff --git a/doc/configurations/using_custom_app_widget.md b/doc/configurations/using_custom_app_widget.md index 1b41bc2e..f498db58 100644 --- a/doc/configurations/using_custom_app_widget.md +++ b/doc/configurations/using_custom_app_widget.md @@ -1,14 +1,12 @@ -# Using Custom App Widget +# 🛠️ Using Custom App Widget -This project uses some adaptive widgets like `AdaptiveTextSelectionToolbar` which require the following delegates: +The project uses some adaptive widgets like `AdaptiveTextSelectionToolbar` which require the following delegates: 1. Default Material Localizations delegate 2. Default Cupertino Localizations delegate 3. Default Widgets Localizations delegate -You don't need to include those since they are defined by default -but if you are using a Custom app or you are overriding the `localizationsDelegates` in the App widget -then please make sure it includes those: +You don't need to include these since they are defined by default. However, if you are using a custom app or overriding the `localizationsDelegates` in the App widget, ensure it includes the following: ```dart localizationsDelegates: const [ @@ -18,9 +16,8 @@ localizationsDelegates: const [ ], ``` -You might need more depending on your use case, for example, if you are using custom localizations for your app, using a -custom app widget like `FluentApp` from [FluentUI] -which will also need + +You might need more depending on your use case. For example, if you are using custom localizations for your app with a custom app widget like `FluentApp` from [FluentUI], you will also need: ```dart localizationsDelegates: const [ @@ -30,9 +27,8 @@ localizationsDelegates: const [ ], ``` -Note: In the latest versions of `FluentApp` you no longer need to add the `localizationsDelegates` but this is just an -example, for more [info](https://github.com/bdlukaa/fluent_ui/pull/946) +📌 Note: In recent versions of `FluentApp`, you no longer need to add the `localizationsDelegates`. This is just an example. For more information, refer to the [#946](https://github.com/bdlukaa/fluent_ui/pull/946). -There are additional notes on the [Localizations](./localizations_setup.md) page +📄 For additional notes, see the [Localizations](./localizations_setup.md) page. [FluentUI]: https://pub.dev/packages/fluent_ui