Update README.md

pull/1467/head
Ahmed Hnewa 2 years ago
parent ce71bf97bc
commit 11ab287a99
No known key found for this signature in database
GPG Key ID: C488CC70BBCEF0D1
  1. 101
      README.md

@ -63,14 +63,7 @@ dependencies:
> >
> Using the latest version and reporting any issues you encounter on GitHub will greatly contribute to the improvement of the library. Your input and insights are valuable in shaping a stable and reliable version for all our users. Thank you for being part of the open-source community! > Using the latest version and reporting any issues you encounter on GitHub will greatly contribute to the improvement of the library. Your input and insights are valuable in shaping a stable and reliable version for all our users. Thank you for being part of the open-source community!
> >
> if you want to use a more stable release, please use the followings: > also [flutter_quill_extensions](https://pub.dev/packages/flutter_quill_extensions) will not work with the latest versions, please use [fresh_quill_extensions](https://pub.dev/packages/fresh_quill_extensions) as temporary alternative
>
> ```yaml
> flutter_quill: ^7.4.16
> flutter_quill_extensions: ^0.5.0
> ```
>
> instead of the latest version
> >
## Usage ## Usage
@ -87,20 +80,22 @@ and then embed the toolbar and the editor, within your app. For example:
QuillProvider( QuillProvider(
configurations: QuillConfigurations( configurations: QuillConfigurations(
controller: _controller, controller: _controller,
editorConfigurations: QuillEditorConfigurations( sharedConfigurations: const QuillSharedConfigurations(
readOnly: _isReadonly, locale: Locale('de'),
), ),
), ),
child: Column( child: Column(
children: [ children: [
QuillToolbar.basic(), const QuillToolbar(),
Expanded( Expanded(
child: Container( child: QuillEditor.basic(
child: QuillEditor.basic(), configurations: const QuillEditorConfigurations(
), readOnly: false,
) ),
], ),
), )
],
),
) )
``` ```
@ -210,7 +205,7 @@ To add an Icon, we should use a new QuillCustomButton class
```dart ```dart
QuillCustomButton( QuillCustomButton(
icon:Icons.ac_unit, iconData: Icons.ac_unit,
onTap: () { onTap: () {
debugPrint('snowflake'); debugPrint('snowflake');
} }
@ -220,30 +215,30 @@ To add an Icon, we should use a new QuillCustomButton class
Each `QuillCustomButton` is used as part of the `customButtons` option as follows: Each `QuillCustomButton` is used as part of the `customButtons` option as follows:
```dart ```dart
QuillToolbar.basic( QuillToolbar(
(...), configurations: QuillToolbarConfigurations(
customButtons: [ customButtons: [
QuillCustomButton( QuillCustomButton(
icon:Icons.ac_unit, iconData: Icons.ac_unit,
onTap: () { onTap: () {
debugPrint('snowflake1'); debugPrint('snowflake1');
} },
), ),
QuillCustomButton(
QuillCustomButton( iconData: Icons.ac_unit,
icon:Icons.ac_unit, onTap: () {
onTap: () { debugPrint('snowflake2');
debugPrint('snowflake2'); },
} ),
), QuillCustomButton(
iconData: Icons.ac_unit,
QuillCustomButton( onTap: () {
icon:Icons.ac_unit, debugPrint('snowflake3');
onTap: () { },
debugPrint('snowflake3'); ),
} ],
), ),
] ),
``` ```
## Embed Blocks ## Embed Blocks
@ -258,14 +253,16 @@ Provide a list of embed
import 'package:flutter_quill_extensions/flutter_quill_extensions.dart'; import 'package:flutter_quill_extensions/flutter_quill_extensions.dart';
QuillEditor.basic( QuillEditor.basic(
controller: controller, configurations: const QuillEditorConfigurations(
embedBuilders: FlutterQuillEmbeds.builders(), embedBuilders: FlutterQuillEmbeds.builders(),
); ),
)
QuillToolbar.basic(
controller: controller, QuillToolbar(
embedButtons: FlutterQuillEmbeds.buttons(), configurations: QuillToolbarConfigurations(
); embedButtons: FlutterQuillEmbeds.buttons(),
),
),
``` ```
> [!WARNING] > [!WARNING]

Loading…
Cancel
Save