Formulix दस्तावेज़
Installation / Formulix 0.1.2

CKEditor 5

Editor model की transactions और widgets वाला plugin।

Installation

npm install formulix-ckeditor5

Editor बनाने से पहले formulix-ckeditor5/formulix-ui.min.js load करें और formulix-ckeditor5 को ESM के रूप में import करें।

Application की उसी ckeditor5 installation का उपयोग करें; दूसरी editor copy bundle न करें। Tested version और घोषित peer dependency: CKEditor 49।

Configuration

import Formulix from 'formulix-ckeditor5';
// ClassicEditor की मौजूदा configuration में मिलाएँ।
const config = {
  plugins: [ /* application plugins, */ Formulix ],
  toolbar: ['formulixFormula', 'formulixConta', 'formulixGrafico', 'formulixQuimica'],
  formulix: {
    servidor: 'https://api.formulix.com.br',
    chave: 'YOUR_PUBLIC_KEY',
    idioma: 'hi'
  }
};

upload callback न होने पर FileRepository और पहले से configured upload adapter इस्तेमाल होते हैं। Custom upload के लिए formulix में upload: async blob => { /* upload PNG; return URL */ } दें। यह केवल contract है; server पर authenticated upload, PNG और size validation लागू करें।

API और public key

Default URL आधिकारिक सेवा की है, https://api.formulix.com.br। Key वैकल्पिक है: इसके बिना editor का domain Free plan पर चलता है; limit पूरी होने पर dialog में sign-up link दिखता है। Dashboard में domain दर्ज करें और plan चुनें; registration subdomains को भी कवर करता है और site बिना key के भी चलती रहती है।

Preview और insertion का content API को जाता है। Browser में केवल domain से जुड़ी public key रखें; admin, SMTP या Mercado Pago credentials कभी न रखें। Authentication, errors और limits तथा गोपनीयता नीति देखें।

उपयोग और saving

चार buttons से item डालें; double-click से फिर edit करें। editor.getData() save करें। Server sanitizer में data-formulix wrappers, MathML, tables और data-* attributes बचाएँ। Changes और history model transactions इस्तेमाल करते हैं।

ज्ञात सीमाएँ

CKEditor 49 पर चारों types, save/reload, re-edit, undo, sanitization और read-only mode जाँचे गए। Host editor का license अलग review करें; adapter GPL-3.0-or-later है।

Word का OMML/RTF clipboard मार्ग TinyMCE के लिए विशिष्ट है। दूसरे platforms पर Word paste और एक साथ अलग भाषाएँ अभी supported नहीं हैं।