Skip to content

Commit 0c537f2

Browse files
committed
docs(readme): minor changes in README.md, indicating shortcut events in unsupported on mobile devices, fix outdated font family link
1 parent 8107c19 commit 0c537f2

File tree

3 files changed

+12
-19
lines changed

3 files changed

+12
-19
lines changed

README.md

+8-18
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,6 @@ You can join our [Slack Group] for discussion.
6060
- [📦 Embed Blocks](#-embed-blocks)
6161
- [🔄 Delta Conversion](#-delta-conversion)
6262
- [📝 Rich Text Paste](#-rich-text-paste)
63-
- [✂️ Shortcut events](#-shortcut-events)
6463
- [🌐 Translation](#-translation)
6564
- [🧪 Testing](#-testing)
6665
- [🤝 Contributing](#-contributing)
@@ -244,16 +243,17 @@ The `QuillSimpleToolbar` and `QuillEditor` widgets are both customizable.
244243

245244
### 🔗 Links
246245

247-
- [Using Custom App Widget](./doc/configurations/using_custom_app_widget.md)
248-
- [Localizations Setup](./doc/configurations/localizations_setup.md)
249-
- [Font Size](./doc/configurations/font_size.md)
250-
- [Font Family](#font-family)
251-
- [Custom Toolbar buttons](./doc/configurations/custom_buttons.md)
252-
- [Search](./doc/configurations/search.md)
246+
- [🛠️ Using Custom App Widget](./doc/configurations/using_custom_app_widget.md)
247+
- [🌍 Localizations Setup](./doc/configurations/localizations_setup.md)
248+
- [🔠 Font Size](./doc/configurations/font_size.md)
249+
- [🖋 Font Family](#-font-family)
250+
- [🔘 Custom Toolbar buttons](./doc/configurations/custom_buttons.md)
251+
- [🔍 Search](./doc/configurations/search.md)
252+
- [✂️ Shortcut events](./doc/customizing_shortcuts.md)
253253

254254
### 🖋 Font Family
255255

256-
To use your own fonts, update your [Assets](./example/assets/fonts) folder and pass in `fontFamilyValues`.
256+
To use your own fonts, update your [Assets](./example/assets/fonts) directory and pass in `items` to `QuillToolbarFontFamilyButton`'s options.
257257
More details
258258
on [this commit](https://github.com/singerdmx/flutter-quill/commit/71d06f6b7be1b7b6dba2ea48e09fed0d7ff8bbaa),
259259
[this article](https://stackoverflow.com/questions/55075834/fontfamily-property-not-working-properly-in-flutter)
@@ -323,16 +323,6 @@ The plugin [`quill_native_bridge`](https://pub.dev/packages/quill_native_bridge)
323323
> See [issue #1998](https://github.com/singerdmx/flutter-quill/issues/1998) and [issue #2220](https://github.com/singerdmx/flutter-quill/issues/2220)
324324
for more details.
325325

326-
## ✂️ Shortcut events
327-
328-
We can customize some Shorcut events, using the parameters `characterShortcutEvents` or `spaceShortcutEvents` from `QuillEditorConfig` to add more functionality to the editor.
329-
330-
> [!NOTE]
331-
>
332-
> You can get all standard shortcuts using `standardCharactersShortcutEvents` or `standardSpaceShorcutEvents`.
333-
334-
To see an example of this, refer to [shortcut events](./doc/customizing_shortcuts.md) page.
335-
336326
## 🌐 Translation
337327

338328
The package offers translations for the toolbar and editor widgets, it will follow the system locale unless you set your

doc/configurations/custom_buttons.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Custom `QuillSimpleToolbar` Buttons
1+
# 🔘 Custom `QuillSimpleToolbar` Buttons
22

33
You may add custom buttons to the _end_ of the toolbar, via the `customButtons` option, which is a `List`
44
of `QuillToolbarCustomButtonOptions`.

doc/customizing_shortcuts.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Shortcut events
22

3+
> [!NOTE]
4+
> This feature is supported **only on desktop devices**.
5+
36
We will use a simple example to illustrate how to quickly add a `CharacterShortcutEvent` event.
47

58
In this example, text that starts and ends with an asterisk ( * ) character will be rendered in italics for emphasis. So typing `*xxx*` will automatically be converted into _`xxx`_.

0 commit comments

Comments
 (0)