Package detailsv0.2.7

super_editor

Configurable, composable, extensible text editor and document renderer for Flutter.

AndroidiOS

pub.dev API documentation Source code

30-day downloads: 16.6K
Likes: 782
Pub points: 60

Install package

flutter pub add super_editor

Package Overview

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

Super Editor is a highly configurable, composable, and extensible text editor and document renderer for Flutter. It enables developers to build rich text editing experiences with support for custom formatting, plugins, and dynamic content rendering. Designed for flexibility, it allows deep customization of editing behavior, styling, and interaction patterns. Ideal for applications requiring advanced document handling, such as note-taking apps, collaborative editors, or content management systems. Built with performance and scalability in mind, it supports both Android and iOS platforms.

Use cases

Rich text editing in note-taking apps
Collaborative document editing
Custom markdown or HTML rendering
Dynamic content composition
Extensible UI components for text input
Document-based application interfaces

Key features

Highly composable architecture
Support for custom plugins and extensions
Configurable text formatting and styling
Cross-platform compatibility (Android, iOS)
Built-in support for rich text and document rendering
Extensible event and action system

Suitable for

Developers building advanced text editors
Teams needing customizable document workflows
Applications requiring rich text and media integration
Projects with complex content modeling needs
Flutter developers seeking modular editor solutions

Considerations

Steeper learning curve due to composability
Requires careful state management for complex use cases
May need additional setup for advanced features like collaboration
Performance depends on implementation complexity
Limited out-of-the-box templates for specific use cases

Original README

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

Open source, configurable, extensible text editor and document renderer for Flutter.

Super Editor works with any backend. Plug yours in and go!

Super Editor was initiated by Superlist and is implemented and maintained by the Flutter Bounty Hunters, Superlist, and the contributors.

A Note on Releases (June, 2024):
We've been busy at work on core editor improvements like undo/redo, a stable editor pipeline, and useful editor reactions. These APIs have evolved a lot, so we haven't cut a standard release in a long time. We're still evolving those APIs right now.

Rest assured, Super Editor and the other projects in this repo are under regular development. We're still here and working hard.

We're now starting to publish developer releases of Super Editor so that the community can see what we've been working on.

As a reminder, your project doesn't need to use Pub to use Super Editor. You can depend directly on this GitHub repository to keep up with the latest changes. Please check the section below about our Git branches.

A Note on Branches:
Do you use Flutter's stable branch? Be sure to checkout super_editor's stable branch, for compatibility.
Do you use Flutter's master branch? Be sure to checkout super_editor's main branch, for compabitility.

Super Editor & Super Text Field

Please see the SuperEditor README about how to use the packages, or run the sample editor.

A web demo is accessible at https://superlist.com/SuperEditor.

We're building an entire toolkit!

You might notice that this is a mono-repo, which includes multiple projects. That's because we're not just building an editor. We're building a document editing toolkit. In fact, we're revolutionizing all text layout and editing with Flutter! Check out some of our supporting projects.

Mono-repo Versioning

If you have compilation errors when using the GitHub version of super_editor, try overriding dependencies for the other packages in this mono-repo, e.g., super_editor_markdown, super_text_layout, and attributed_text. This project often makes changes to multiple packages within the mono-repo, which requires that you use the latest main or stable version of every package.

You can override your dependencies as follows:

dependency_overrides:
  super_editor:
    git:
      url: https://github.com/superlistapp/super_editor
      path: super_editor
      ref: stable # or "main"
  super_editor_markdown:
    git:
      url: https://github.com/superlistapp/super_editor
      path: super_editor_markdown
      ref: stable
  super_text_layout:
    git:
      url: https://github.com/superlistapp/super_editor
      path: super_text_layout
      ref: stable
  attributed_text:
    git:
      url: https://github.com/superlistapp/super_editor
      path: attributed_text
      ref: stable