Repolode
toeverything

toeverything/blocksuite

Um toolkit TypeScript com componentes de UI em web components e uma camada de dados baseada em CRDT para criar editores de blocos e apps colaborativos.

Alternativa open source a:Notion

Estrelas
6,083
Forks
565
Issues abertas
196
Último commit
há 4 dias

O que é?

BlockSuite é um toolkit para criar editores e aplicações colaborativas. Ele oferece um framework headless para modelar o estado de documentos, além de componentes de edição prontos, como um editor de documentos baseado em blocos (PageEditor) e um editor de canvas no estilo gráfico (EdgelessEditor), ambos com os mesmos recursos de rich text.

A camada de dados é baseada na biblioteca CRDT Yjs, oferecendo colaboração em tempo real e suporte para voltar a estados anteriores dos documentos. Os componentes são web components nativos, então podem ser usados com React ou outros frameworks. Desenvolvedores podem definir blocos personalizados, reutilizar um documento em vários editores e converter conteúdo de e para formatos como Markdown e HTML usando snapshots e transformers.

O projeto surgiu da base de conhecimento AFFiNE e é mantido como uma biblioteca independente. Ainda está em estágio inicial, e suas APIs de componentes e extensões estão sendo refinadas.

Recursos principais

  • 01Dois editores prontos: um editor de páginas baseado em blocos e um editor de canvas sem grade.
  • 02Colaboração em tempo real e histórico de documentos com base no CRDT Yjs.
  • 03Definições personalizadas de blocos e embeds inline.
  • 04Web components nativos que podem ser usados com React e outros frameworks.
  • 05Suporte a snapshots e transformers para converter Markdown e HTML.

Casos de uso

  • Criar um editor de blocos no estilo do Notion dentro de uma aplicação web.
  • Adicionar edição colaborativa de rich text a um produto existente.
  • Criar um editor personalizado reutilizando o framework vanilla e os componentes do BlockSuite.
  • Compartilhar um documento entre várias visualizações de editor.

Início rápido

  1. 1

    Leia o guia de início rápido para instalar os pacotes do BlockSuite

  2. 2

    Comece pelos editores predefinidos do pacote presets

Antes de usar

  • O README informa que o BlockSuite ainda está em estágio inicial; por isso, os componentes e as APIs de extensão podem mudar.
  • Para compilar a partir do código-fonte, é necessário seguir um guia separado: BUILDING.md.
  • Licenciado sob a MPL 2.0, uma licença de copyleft fraco que exige o compartilhamento das alterações feitas em arquivos modificados cobertos pela MPL.

Em coleções

Tópicos

Perguntas frequentes

O que é blocksuite?
Um toolkit TypeScript com componentes de UI em web components e uma camada de dados baseada em CRDT para criar editores de blocos e apps colaborativos. BlockSuite é um toolkit para criar editores e aplicações colaborativas. Ele oferece um framework headless para modelar o estado de documentos, além de componentes de edição prontos, como um editor de documentos baseado em blocos (PageEditor) e um editor de canvas no estilo gráfico (EdgelessEditor), ambos com os mesmos recursos de rich text.
blocksuite é gratuito? Qual é a licença?
blocksuite é open source sob a licença MPL-2.0. Confira os termos da licença antes de usá-lo em produtos comerciais.
blocksuite ainda é mantido?
Manutenção ativa. O último commit de blocksuite foi em 3 de nov. de 2026.
Para que posso usar blocksuite?
Criar um editor de blocos no estilo do Notion dentro de uma aplicação web. Adicionar edição colaborativa de rich text a um produto existente. Criar um editor personalizado reutilizando o framework vanilla e os componentes do BlockSuite. Compartilhar um documento entre várias visualizações de editor.
Como instalar blocksuite?
Leia o guia de início rápido para instalar os pacotes do BlockSuite Comece pelos editores predefinidos do pacote presets
Onde consigo blocksuite?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/toeverything/blocksuite

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados