Search packages, repositories and app categories

rich_editor cover
Package detailsv0.5.0

rich_editor

WYSIWYG editor for Flutter with a rich set of supported formatting options.

AndroidiOSmacOSWindows
30-day downloads
1K
Likes
93
Pub points
150

Install package

flutter pub add rich_editor

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

A WYSIWYG editor for Flutter that enables rich text formatting with support for bold, italic, lists, links, and more. Designed for seamless integration into apps requiring advanced text input, it offers a clean, intuitive interface for composing formatted content. Built with extensibility in mind, it supports custom styling and plugins. The package is actively maintained and compatible across Android, iOS, macOS, and Windows platforms.

Use cases

  • Creating rich text content in note-taking apps
  • Building blog or article editors
  • Implementing user-generated content forms
  • Developing collaborative document tools
  • Enabling formatted messaging interfaces

Key features

  • Real-time WYSIWYG editing
  • Extensive formatting options (bold, italic, underline, etc.)
  • Support for links, images, and lists
  • Customizable toolbar and themes
  • Cross-platform compatibility

Suitable for

  • Developers building content-rich Flutter applications
  • Apps requiring user-friendly text editing
  • Projects needing Markdown or HTML output
  • Teams working on multi-platform text editors

Considerations

  • May require additional configuration for complex styling
  • Performance can vary with large documents
  • Limited built-in image upload handling
  • Requires understanding of Flutter's rendering model

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

✨ rich_editor

pub package pub points

WYSIWYG editor for Flutter with a rich set of supported formatting options.

Based on https://github.com/dankito/RichTextEditor, but for Flutter.

✨ Features

  • [x] Bold, Italic, Underline, Strike through, Subscript, Superscript
  • [x] Heading 1 - 6, Text body, Preformatted, Block quote
  • [x] Font (reads all system fonts) (Android only)
  • [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
  • [ ] Search
  • [ ] Icon indicators

📸 Screenshots

Usage

      // Insert widget into tree
      RichEditor(
        key: keyEditor,
        value: 'initial html here',
        editorOptions: RichEditorOptions(
          placeholder: 'Start typing',
          // backgroundColor: Colors.blueGrey, // Editor's bg color
          // baseTextColor: Colors.white,
          // editor padding
          padding: EdgeInsets.symmetric(horizontal: 5.0),
          // font name
          baseFontFamily: 'sans-serif',
          // Position of the editing bar (BarPosition.TOP or BarPosition.BOTTOM)
          barPosition: BarPosition.TOP,
        ),
        // 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;
        },
      )

Get current HTML from editor

String? html = await keyEditor.currentState?.getHtml();
print(html);

Set Focus and Unfocus

await keyEditor.currentState?.focus();
await keyEditor.currentState?.unFocus();

Clear Editor content

await keyEditor.currentState?.clear();
Custom Toolbar

If you're interested in creating your own toolbar check the custom_toolbar_demo.dart in the example

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.

Categories

Dependencies

Dependency list 4 items

Source repository

Projects using this package