Skip to main content

Welcome to AppFlowy Editor

AppFlowy Editor is a highly customizable rich-text editor built for Flutter. It provides a powerful foundation for building intuitive, feature-rich editing experiences in your Flutter applications.

Quick Start

Get your first editor running in minutes

Installation

Add AppFlowy Editor to your project

Customization

Customize themes, components, and shortcuts

API Reference

Explore the complete API documentation

What is AppFlowy Editor?

AppFlowy Editor is a Flutter package that enables you to build rich, intuitive editors with minimal setup. Whether you’re building a note-taking app, a document editor, or any application requiring text editing capabilities, AppFlowy Editor provides the tools you need.

Key Features

AppFlowy Editor offers a comprehensive set of features for building modern text editors:

Rich Text Editing

Support for bold, italic, underline, strikethrough, and more formatting options

Block Components

Extensible block system including headings, lists, quotes, code blocks, and custom components

Customizable Themes

Full control over colors, typography, spacing, and visual appearance

Shortcut Events

Built-in keyboard shortcuts with support for custom shortcut events

Selection & Toolbars

Floating toolbar, context menu, and customizable selection behavior

Import/Export

Import from and export to JSON, Markdown, and Quill Delta formats

Platform Support

AppFlowy Editor works across all Flutter platforms:
  • Android
  • iOS
  • Linux
  • macOS
  • Windows
  • Web

Community & Support

AppFlowy Editor is actively maintained by AppFlowy’s core team and a community of over 1,000 builders.

Discord Community

Join our Discord server for support and discussions

GitHub Repository

View source code, report issues, and contribute

Twitter

Follow us for updates and announcements

Test Coverage

View our comprehensive test coverage

Next Steps

Ready to get started? Choose your path:
1

Installation

Install AppFlowy Editor in your Flutter project
2

Quick Start

Follow the Quick Start guide to create your first editor
3

Customize

Learn how to customize your editor to match your app’s design

Build docs developers (and LLMs) love