Buscar pacotes, repositórios e categorias de apps

Capa de appflowy_editor
Detalhes do pacotev6.2.0

appflowy_editor

Um editor de texto rico altamente personalizável para Flutter. O projeto AppFlowy Editor para o AppFlowy e além.

AndroidiOSWebmacOSWindowsLinux
Downloads em 30 dias
15,6 mil
Curtidas
517
Pontos Pub
60

Instalar pacote

flutter pub add appflowy_editor

Visão geral do pacote

Orientação gerada a partir de informações públicas. Apenas para referência.

O AppFlowy Editor é um editor de texto rico altamente personalizável construído para o Flutter, projetado para oferecer recursos avançados de edição de texto em múltiplas plataformas. Ele permite a integração sem problemas de markdown, HTML e conteúdo estruturado, com foco em extensibilidade e desempenho. Ideal para aplicações que exigem edição dinâmica de documentos, ele impulsiona as funcionalidades centrais do AppFlowy, permanecendo adaptável para casos de uso mais amplos. O editor suporta recursos de colaboração em tempo real e oferece uma arquitetura modular para que desenvolvedores possam estender comportamento e aparência.

Casos de uso

  • Criação e edição de documentos
  • Renderização de conteúdo rico em Markdown
  • aplicativos de anotação colaborativa
  • sistemas personalizáveis de gerenciamento de conteúdo
  • Componentes de interface do usuário extensíveis para fluxos de trabalho de texto

Principais recursos

  • Design e comportamento altamente personalizáveis
  • Suporte multiplataforma (Android, iOS, Web, macOS, Windows, Linux)
  • Análise integrada de Markdown e HTML
  • Arquitetura modular de plugin
  • Pronto para colaboração em tempo real
  • Sistema de eventos extensível

Indicado para

  • Desenvolvedores construindo editores de texto rico
  • Equipes criando ferramentas colaborativas de produtividade
  • Aplicativos que exigem tratamento de documentos estruturados
  • Projetos que precisam de consistência entre plataformas
  • Componentes de interface personalizáveis em aplicativos com muitos conteúdos

Considerações

  • Requer compreensão da árvore de widgets do Flutter
  • Curva de aprendizado mais acentuada devido à modularidade
  • Pode ser necessário configuração adicional para sincronização em tempo real
  • O desempenho depende da complexidade dos plugins personalizados
  • Documentação limitada além do uso básico

README original

Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.

AppFlowy Editor

A highly customizable rich-text editor for Flutter

Discord • Twitter

Key Features

  • Build rich, intuitive editors
  • Design and modify an ever-expanding list of customizable features including
    • block components (such as form input controls, numbered lists, and rich text widgets)
    • shortcut events
    • themes
    • selection menu
    • toolbar menu
  • Test Coverage and ongoing maintenance by AppFlowy's core team and community of more than 1,000 builders
Preview Customize your own theme
Preview Customize your own theme
Change the color of your text Format your text
Color Format

Getting Started

Add the AppFlowy editor Flutter package to your environment.

flutter pub add appflowy_editor
flutter pub get

Creating Your First Editor

Start by creating a new empty AppFlowyEditor object.

final editorState = EditorState.blank(withInitialText: true); // with an empty paragraph
final editor = AppFlowyEditor(
  editorState: editorState,
);

You can also create an editor from a JSON object in order to configure your initial state. Or you can create an editor from Markdown or Quill Delta.

final json = jsonDecode('YOUR INPUT JSON STRING');
final editorState = EditorState(document: Document.fromJson(json));
final editor = AppFlowyEditor(
  editorState: editorState,
);

Note: The parameters localizationsDelegates need to be assigned in MaterialApp widget

MaterialApp(
  localizationsDelegates: const [
    AppFlowyEditorLocalizations.delegate,
  ],
);

To get a sense of how the AppFlowy Editor works, run our example:

git clone https://github.com/AppFlowy-IO/appflowy-editor.git
flutter pub get
flutter run

Customizing Your Editor

Customizing theme

Please refer to our documentation on customizing AppFlowy for a detailed discussion about customizing theme.

Customizing Block Components

Please refer to our documentation on customizing AppFlowy for a detailed discussion about customizing components.

Below are some examples of component customizations:

Customizing Shortcut Events

Please refer to our documentation on customizing AppFlowy for a detailed discussion about customizing shortcut events.

Below are some examples of shortcut event customizations:

  • BIUS demonstrates how to make text bold/italic/underline/strikethrough through shortcut keys
  • Need more examples? Check out shortcuts

Migration Guide

Please refer to the migration documentation.

Glossary

Please refer to the API documentation.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Please look at CONTRIBUTING.md for details.

License

All code contributed to the AppFlowy Editor project is dual-licensed, and released under both of the following licenses:

  1. The GNU Affero General Public License Version 3
  2. The Mozilla Public License, Version 2.0 (the “MPL”)

See LICENSE for more information.

Categorias

Dependências

Lista de dependências 20 itens

Repositório-fonte

Projetos que usam este pacote