Formulix documentação
Instalação / Formulix 0.1.2

CKEditor 5

Plugin com widgets e transações do modelo do editor.

Instalação

npm install formulix-ckeditor5

Carregue formulix-ckeditor5/formulix-ui.min.js antes de criar o editor e importe formulix-ckeditor5 como ESM.

Use a mesma instalação ckeditor5 da aplicação; não inclua outra cópia do editor. Versão testada e declarada como peer dependency: CKEditor 49.

Configuração

import Formulix from 'formulix-ckeditor5';
// Mescle com a configuração existente do ClassicEditor.
const configuracao = {
  plugins: [ /* plugins da aplicação, */ Formulix ],
  toolbar: ['formulixFormula', 'formulixConta', 'formulixGrafico', 'formulixQuimica'],
  formulix: {
    servidor: 'https://api.formulix.com.br',
    chave: 'CHAVE_PUBLICA_DO_CLIENTE',
    idioma: 'pt-BR'
  }
};

Sem callback upload, usa FileRepository e o upload adapter já configurado. Para upload próprio, passe upload: async blob => { /* enviar PNG e retornar URL */ } em formulix. Esse trecho descreve o contrato; implemente envio autenticado e validação de PNG/tamanho no servidor.

API e chave

A URL padrão é a do serviço oficial, https://api.formulix.com.br. A chave é opcional: sem ela, o domínio do editor usa o plano Grátis; quando o limite acaba, o diálogo mostra o link de cadastro. Cadastre o domínio no painel e escolha um plano; o domínio cadastrado cobre seus subdomínios e o site segue funcionando sem chave.

O conteúdo de prévias e inserções é enviado à API. Use somente a chave pública por domínio: nunca coloque credenciais administrativas, SMTP ou Mercado Pago no navegador. Consulte autenticação, erros e limites e privacidade.

Uso e persistência

Use os quatro botões e clique duas vezes no item para reeditar. Salve editor.getData(). Preserve wrappers data-formulix, MathML, tabelas e atributos data-* no sanitizador do servidor. Alterações e histórico usam transações do modelo.

Limites conhecidos

Testado com CKEditor 49: quatro tipos, salvar/recarregar, reedição, desfazer, sanitização e somente leitura. Revise separadamente a licença do editor anfitrião; o adaptador é GPL-3.0-or-later.

O clipboard OMML/RTF do Word continua específico do TinyMCE. A colagem do Word nas outras plataformas e o uso de idiomas diferentes ao mesmo tempo ainda não são suportados.