Skip to content

Soft and gentle rich text editing for Flutter applications.

License

Notifications You must be signed in to change notification settings

yzxh24/fleather

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Fleather & Parchment codecov pub package

Fleather

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

👉 Live demo here.

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.19.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.

Credits

About

Soft and gentle rich text editing for Flutter applications.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Dart 96.2%
  • C++ 1.8%
  • CMake 1.5%
  • Ruby 0.2%
  • C 0.1%
  • Swift 0.1%
  • Other 0.1%