CKEditor 5

A plugin using widgets and editor model transactions.

Installation

npm install formulix-ckeditor5

Load formulix-ckeditor5/formulix-ui.min.js before creating the editor and import formulix-ckeditor5 as ESM.

Use your application’s existing ckeditor5 installation; do not bundle another editor copy. The tested version and declared peer dependency is CKEditor 49.

Configuration

import Formulix from 'formulix-ckeditor5';
// Merge into your existing ClassicEditor configuration.
const configuration = {
  plugins: [ /* application's plugins, */ Formulix ],
  toolbar: ['formulixFormula', 'formulixConta', 'formulixGrafico', 'formulixQuimica'],
  formulix: {
    servidor: 'https://api.formulix.com.br', // PLACEHOLDER
    chave: 'YOUR_PUBLIC_KEY', // PLACEHOLDER
    idioma: 'en'
  }
};

Without an upload callback, the plugin uses FileRepository and your configured upload adapter. For custom uploads, pass upload: async blob => { /* upload PNG and return URL */ } in formulix. This describes the contract: implement authenticated upload and server-side PNG/size validation. Keep the API option names unchanged; idioma: 'en' selects English.

API and public key

The default URL is the official service, https://api.formulix.com.br. The key is optional: without one, the editor’s domain uses the Free plan; when it runs out, the dialog shows a sign-up link. Register the domain in the dashboard and choose a plan; registration covers its subdomains and the site keeps working without a key.

Preview and insertion content is sent to the API. Use only the domain-bound public key in the browser, never administrator, SMTP or Mercado Pago credentials. See authentication, errors and limits and the privacy policy.

Use and persistence

Use the four buttons and double-click an item to edit it again. Save editor.getData(). Preserve data-formulix wrappers, MathML, tables and required data-* attributes in the server sanitizer. Changes and history use model transactions.

Known limits

Tested with CKEditor 49: all four types, save/reload, editing again, undo, sanitization and read-only mode. Review the host editor’s licence separately; this adapter is GPL-3.0-or-later.

The Word OMML/RTF clipboard path remains specific to TinyMCE. Word paste on the other platforms and using different languages at the same time are not supported yet.