cubetiq/rich_editor
5
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Restyled by prettier-markdown

Browse Source
This commit is contained in:
Restyled.io 2021-06-04 12:58:16 +00:00
parent 7677e120cc
commit 48bd174142
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,4 +1,5 @@
# ✨ rich_editor # ✨ rich_editor
[![pub package](https://img.shields.io/pub/v/rich_editor.svg)](https://pub.dartlang.org/packages/rich_editor) [![pub package](https://img.shields.io/pub/v/rich_editor.svg)](https://pub.dartlang.org/packages/rich_editor)
[![pub points](https://badges.bar/rich_editor/pub%20points)](https://pub.dev/packages/rich_editor/score) [![pub points](https://badges.bar/rich_editor/pub%20points)](https://pub.dev/packages/rich_editor/score)
@ -7,6 +8,7 @@ WYSIWYG editor for Flutter with a rich set of supported formatting options.
Based on https://github.com/dankito/RichTextEditor, but for Flutter. Based on https://github.com/dankito/RichTextEditor, but for Flutter.
## ✨ Features ## ✨ Features
- [x] Bold, Italic, Underline, Strike through, Subscript, Superscript - [x] Bold, Italic, Underline, Strike through, Subscript, Superscript
- [x] Heading 1 - 6, Text body, Preformatted, Block quote - [x] Heading 1 - 6, Text body, Preformatted, Block quote
- [x] Font (reads all system fonts) (Android only) - [x] Font (reads all system fonts) (Android only)
@ -26,9 +28,12 @@ Based on https://github.com/dankito/RichTextEditor, but for Flutter.
- [ ] Icon indicators - [ ] Icon indicators
## 📸 Screenshots ## 📸 Screenshots
<img src="https://github.com/JideGuru/rich_editor/raw/master/res/1.png" width="400"> <img src="https://github.com/JideGuru/rich_editor/raw/master/res/2.png" width="400">
<img src="https://github.com/JideGuru/rich_editor/raw/master/res/1.png" width="400">
<img src="https://github.com/JideGuru/rich_editor/raw/master/res/2.png" width="400">
## Usage ## Usage
```dart ```dart
// Insert widget into tree // Insert widget into tree
RichEditor( RichEditor(
@ -57,24 +62,29 @@ Based on https://github.com/dankito/RichTextEditor, but for Flutter.
``` ```
Get current HTML from editor Get current HTML from editor
```dart ```dart
String? html = await keyEditor.currentState?.getHtml(); String? html = await keyEditor.currentState?.getHtml();
print(html); print(html);
``` ```
Set Focus and Unfocus Set Focus and Unfocus
```dart ```dart
await keyEditor.currentState?.focus(); await keyEditor.currentState?.focus();
await keyEditor.currentState?.unFocus(); await keyEditor.currentState?.unFocus();
``` ```
Clear Editor content Clear Editor content
```dart ```dart
await keyEditor.currentState?.clear(); await keyEditor.currentState?.clear();
``` ```
### Custom Toolbar ### Custom Toolbar
If you're interested in creating your own toolbar check the custom_toolbar_demo.dart in the example
If you're interested in creating your own toolbar check the
custom_toolbar_demo.dart in the example
## License ## License
@ -90,4 +100,4 @@ If you're interested in creating your own toolbar check the custom_toolbar_demo.
distributed under the License is distributed on an "AS IS" BASIS, distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.