rich_editor/README.md

60 lines
2.1 KiB
Markdown
Raw Normal View History

2021-05-30 02:38:29 +07:00
# ✨ rich_editor
2021-05-31 22:52:29 +07:00
[![pub package](https://img.shields.io/pub/v/rich_editor.svg)](https://pub.dartlang.org/packages/rich_editor)
2021-05-30 02:40:07 +07:00
[![pub points](https://badges.bar/rich_editor/pub%20points)](https://pub.dev/packages/rich_editor/score)
2021-05-27 05:42:34 +07:00
2021-05-30 02:38:29 +07:00
WYSIWYG editor for Android and JavaFX with a rich set of supported formatting options.
2021-05-27 05:42:34 +07:00
2021-05-31 19:53:10 +07:00
Based on https://github.com/dankito/RichTextEditor, but for Flutter.
2021-05-27 05:42:34 +07:00
2021-05-30 02:38:29 +07:00
## ✨ Features
- [x] Bold, Italic, Underline, Strike through, Subscript, Superscript
- [x] Heading 1 - 6, Text body, Preformatted, Block quote
2021-05-30 02:40:07 +07:00
- [ ] Font (reads all system fonts)
2021-05-30 02:38:29 +07:00
- [x] Font Size
- [x] Text Color
- [x] Text Background Color
- [x] Highlight text
- [x] Justify Left, Center, Right, Blockquote
- [x] Indent, Outdent
- [x] Undo, Redo
- [x] Unordered List (Bullets)
- [x] Ordered List (Numbers)
- [x] Insert local or remote Image
- [x] Insert Link
- [x] Insert Checkbox
2021-05-30 02:40:07 +07:00
- [ ] Search
2021-05-27 05:42:34 +07:00
2021-05-30 02:38:29 +07:00
## 📸 Screenshots
2021-05-31 22:53:15 +07:00
<img src="res/1.png" width="400"> <img src="res/2.png" width="400">
2021-05-31 22:52:29 +07:00
## Usage
```dart
RichEditor(
key: keyEditor,
value: 'initial html here',
// You can return a Link (maybe you need to upload the image to your
// storage before displaying in the editor or you can also use base64
getImageUrl: (image) {
String link = 'https://avatars.githubusercontent.com/u/24323581?v=4';
String base64 = base64Encode(image.readAsBytesSync());
String base64String = 'data:image/png;base64, $base64';
return base64String;
},
)
```
2021-05-30 02:38:29 +07:00
## License
Copyright 2021 JideGuru
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.