Formulix documentation← Back to the site
Installation / Formulix 0.1.0

Tiptap 3

An extension with atomic nodes and native ProseMirror history.

Installation

Run npm run build:integrations. Load dist/integrations/tiptap/formulix-ui.min.js before creating the editor and import the ESM extension from dist/integrations/tiptap/index.js. For sources and licences, use npm run package:integrations. Use your application’s existing Tiptap installation. Version run: 3.32.0.

Configuration

import Formulix from './formulix/index.js';
// Add to your existing editor's extensions:
Formulix.configure({
  servidor: 'https://api.formulix.example', // 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

Use the HTTPS API URL supplied by your operator and your account’s public key. Register the editor’s domain in the dashboard; registration also covers its subdomains. Example URLs and keys are placeholders, not available services.

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 draft.

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. Feature parity in alpha adapters, simultaneous use of different languages, Firefox/WebKit and mobile use still need validation.