Formulix documentation
Installation / Formulix 0.1.2

Tiptap 3

An extension with atomic nodes and native ProseMirror history.

Installation

npm install formulix-tiptap

Load formulix-tiptap/formulix-ui.min.js before creating the editor and import the ESM extension from formulix-tiptap. Use your application’s existing Tiptap installation. Version run: 3.32.0.

Configuration

import Formulix from 'formulix-tiptap';
// Add to your existing editor's extensions:
Formulix.configure({
  servidor: 'https://api.formulix.com.br', // PLACEHOLDER
  chave: 'YOUR_PUBLIC_KEY', // PLACEHOLDER
  idioma: 'en',
  upload: uploadPng
});
// uploadPng(blob) must upload the PNG and return a Promise for its URL.
// In your application's buttons:
editor.commands.openFormulix('formula'); // also: conta, grafico, quimica

Implement uploadPng in your application. The upload callback is required for graphs and drawings. The media server must authenticate the user and validate PNG format, size and permissions. Option names and command identifiers remain unchanged in 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

Open tabs through commands and double-click an item to edit it again. The atomic formulixInline and formulixBloco nodes store sanitized HTML. Save editor.getJSON() or editor.getHTML(), preserving MathML, tables and required data-* attributes in your server sanitizer.

Known limits

Selection is mapped through transactions while the dialog is open. If the target is removed while the service responds, the update is rejected. Read-only mode prevents changes. Remote collaboration/Yjs has not been validated.

Existing checks on 3.32.0 cover all four types, JSON/HTML, history, mapped selection, sanitization and read-only mode.

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.