Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

fleather-editor/fleather

Open more actions menu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Fleather & Parchment codecov pub package

Fleather

screenshot

Soft and gentle rich text editing for Flutter applications based on Zefyr. It uses a document model named Parchment based on Notus.

Features

  • Works on Android, iOS, Web, macOS, Linux and Windows
  • Inline attributes like bold, italic, strikethrough and etc.
  • Line attributes like direction, alignment, heading, number and bullet list and etc.
  • Block attributes like code, quote and etc.
  • Supports inline and block embeds
  • Markdown-inspired semantics
  • Supports markdown shortcuts
  • Using Quill.js Delta as underlying data format by Parchment, Fleather is ready for collaborative editing using OT (Not provided as a built-in functionality)

Full documentation can be found here.

Get started

Add Fleather to your dependencies.

dependencies:
  flutter:
    sdk: flutter
  fleather: ^1.26.0

Usage

For a complete working project using Fleather, check our example.

  1. Create a FleatherController
document = ParchmentDocument.fromJson(json);
controller = FleatherController(document);
  1. Add FleatherEditor or FleatherField with a FleatherToolbar to your widgets.
Column(
  children: [
    FleatherToolbar.basic(controller: controller),
    Expanded(
      child: FleatherEditor(controller: controller),
    ),
    //or
    FleatherField(controller: controller)
  ],
),

Migration

For migration guides check out MIGRATION.md.

Morty Proxy This is a proxified and sanitized view of the page, visit original site.