@meistrari/docx-editor
v1.0.4
Published
Editor de documentos DOCX para aplicações web. Carregue um arquivo, permita edição, sugestão ou leitura, automatize o conteúdo por uma API tipada e exporte o resultado novamente como `.docx`.
Maintainers
Keywords
Readme
@meistrari/docx-editor
Editor de documentos DOCX para aplicações web. Carregue um arquivo, permita edição, sugestão ou leitura, automatize o conteúdo por uma API tipada e exporte o resultado novamente como .docx.
Demo
Vídeo de demonstração em breve
Este espaço receberá um vídeo curto com o fluxo completo: carregar, editar e exportar um documento.
Instalação
pnpm add @meistrari/docx-editorUso rápido
Crie um elemento para receber o editor:
<div id="document-editor"></div>Instancie o editor no navegador e importe os estilos:
import { DocxEditor } from '@meistrari/docx-editor';
import '@meistrari/docx-editor/style.css';
const editor = new DocxEditor({
selector: '#document-editor',
document: '/contrato.docx',
documentMode: 'editing',
onReady: ({ docxEditor }) => {
console.log('Documento pronto', docxEditor.state.documents);
},
onContentError: ({ error }) => {
console.error('Não foi possível abrir o documento', error);
},
});
export function destroyEditor() {
editor.destroy();
}O processo de abertura é assíncrono. Use as APIs que dependem do documento dentro de onReady e sempre chame destroy() ao desmontar a tela.
O que a biblioteca oferece
- Entrada por URL,
FileouBlob. - Modos
editing,viewingesuggesting. - Exportação e download de DOCX no navegador.
- Document API para leitura e mutações estruturadas.
- Controller reativo para toolbars, comentários, alterações rastreadas e outras UIs customizadas.
- Bindings oficiais para React no subpath
@meistrari/docx-editor/ui/react.
Guias
- Primeiros passos: ciclo de vida, entradas, modos e exportação.
- Document API: leitura, busca e mutação programática.
- UI customizada: comandos reativos sem acoplar a interface ao editor interno.
Entrypoints públicos recomendados
| Import | Finalidade |
|---|---|
| @meistrari/docx-editor | Instância principal, tipos e Document API |
| @meistrari/docx-editor/style.css | Estilos necessários para o editor |
| @meistrari/docx-editor/ui | Controller framework-agnostic para UI customizada |
| @meistrari/docx-editor/ui/react | Provider e hooks para React |
Os subpaths headless-toolbar, editor, converter, docx-zipper e file-zipper existem por compatibilidade. Para integrações novas, prefira os entrypoints da tabela.
Repositório e licença
Código-fonte, issues e documentação estão no repositório meistrari/docx-editor.
Distribuído sob AGPL-3.0. O histórico de origem e as licenças de terceiros estão descritos em PROVENANCE.md, NOTICE e THIRD_PARTY_LICENSES.md.
