@drghaliasri/butex 5.3.2 → 5.4.0

package/dist/react.d.ts

@@ -1,7 +1,7 @@
 import * as react from 'react';
 
 type EditorSide = 'english' | 'arabic';
-type EditorNodeKind = 'char' | 'number' | 'operator' | 'delimiter' | 'frac' | 'sqrt' | 'env' | 'atomicCommand' | 'atomicOperatorCommand';
+type EditorNodeKind = 'char' | 'number' | 'operator' | 'delimiter' | 'frac' | 'sqrt' | 'overset' | 'underset' | 'accent' | 'env' | 'atomicCommand' | 'atomicOperatorCommand';
 type MatrixEnvStyle = 'matrix' | 'pmatrix' | 'bmatrix' | 'Bmatrix' | 'vmatrix' | 'Vmatrix';
 type GridEnvName = MatrixEnvStyle | 'array' | 'aligned';
 type EnvColumnAlignment = 'l' | 'c' | 'r';
@@ -26,6 +26,9 @@ type EditorNode = {
     denominator: EditorChain | null;
     radicand: EditorChain | null;
     rootIndex: EditorChain | null;
+    overExpr: EditorChain | null;
+    underExpr: EditorChain | null;
+    baseExpr: EditorChain | null;
     envName: GridEnvName | null;
     matrixStyle: MatrixEnvStyle | null;
     matrixRows: EditorChain[][] | null;
@@ -76,6 +79,138 @@ type EditorSession = {
     debugLog: EditorDebugEntry[];
 };
 
+declare const ACCENT_COMMANDS: {
+    readonly vec: {
+        readonly id: "vec";
+        readonly englishTex: "\\vec";
+        readonly arabicTex: "\\arabvec";
+        readonly placement: "over";
+        readonly label: "⃗";
+        readonly title: "سهم فوق";
+    };
+    readonly hat: {
+        readonly id: "hat";
+        readonly englishTex: "\\hat";
+        readonly arabicTex: "\\hat";
+        readonly placement: "over";
+        readonly label: "ˆ";
+        readonly title: "قبعة";
+    };
+    readonly tilde: {
+        readonly id: "tilde";
+        readonly englishTex: "\\tilde";
+        readonly arabicTex: "\\tilde";
+        readonly placement: "over";
+        readonly label: "˜";
+        readonly title: "مدة";
+    };
+    readonly dot: {
+        readonly id: "dot";
+        readonly englishTex: "\\dot";
+        readonly arabicTex: "\\dot";
+        readonly placement: "over";
+        readonly label: "˙";
+        readonly title: "نقطة فوق";
+    };
+    readonly ddot: {
+        readonly id: "ddot";
+        readonly englishTex: "\\ddot";
+        readonly arabicTex: "\\ddot";
+        readonly placement: "over";
+        readonly label: "¨";
+        readonly title: "نقطتان فوق";
+    };
+    readonly dddot: {
+        readonly id: "dddot";
+        readonly englishTex: "\\dddot";
+        readonly arabicTex: "\\dddot";
+        readonly placement: "over";
+        readonly label: "⃛";
+        readonly title: "ثلاث نقاط فوق";
+    };
+    readonly bar: {
+        readonly id: "bar";
+        readonly englishTex: "\\bar";
+        readonly arabicTex: "\\bar";
+        readonly placement: "over";
+        readonly label: "¯";
+        readonly title: "خط فوق";
+    };
+    readonly check: {
+        readonly id: "check";
+        readonly englishTex: "\\check";
+        readonly arabicTex: "\\check";
+        readonly placement: "over";
+        readonly label: "ˇ";
+        readonly title: "علامة تحقق";
+    };
+    readonly breve: {
+        readonly id: "breve";
+        readonly englishTex: "\\breve";
+        readonly arabicTex: "\\breve";
+        readonly placement: "over";
+        readonly label: "˘";
+        readonly title: "قوس قصير";
+    };
+    readonly acute: {
+        readonly id: "acute";
+        readonly englishTex: "\\acute";
+        readonly arabicTex: "\\grave";
+        readonly placement: "over";
+        readonly label: "´";
+        readonly title: "نبرة حادة";
+    };
+    readonly grave: {
+        readonly id: "grave";
+        readonly englishTex: "\\grave";
+        readonly arabicTex: "\\acute";
+        readonly placement: "over";
+        readonly label: "`";
+        readonly title: "نبرة ثقيلة";
+    };
+    readonly overline: {
+        readonly id: "overline";
+        readonly englishTex: "\\overline";
+        readonly arabicTex: "\\overline";
+        readonly placement: "over";
+        readonly label: "‾";
+        readonly title: "خط علوي ممتد";
+    };
+    readonly underline: {
+        readonly id: "underline";
+        readonly englishTex: "\\underline";
+        readonly arabicTex: "\\underline";
+        readonly placement: "under";
+        readonly label: "_";
+        readonly title: "خط سفلي";
+    };
+    readonly overleftarrow: {
+        readonly id: "overleftarrow";
+        readonly englishTex: "\\overleftarrow";
+        readonly arabicTex: "\\overrightarrow";
+        readonly placement: "over";
+        readonly label: "←";
+        readonly title: "سهم علوي إلى اليسار";
+    };
+    readonly overrightarrow: {
+        readonly id: "overrightarrow";
+        readonly englishTex: "\\overrightarrow";
+        readonly arabicTex: "\\overleftarrow";
+        readonly placement: "over";
+        readonly label: "→";
+        readonly title: "سهم علوي إلى اليمين";
+    };
+    readonly overleftrightarrow: {
+        readonly id: "overleftrightarrow";
+        readonly englishTex: "\\overleftrightarrow";
+        readonly arabicTex: "\\overleftrightarrow";
+        readonly placement: "over";
+        readonly label: "↔";
+        readonly title: "سهم علوي مزدوج الاتجاه";
+    };
+};
+type AccentCommandId = keyof typeof ACCENT_COMMANDS;
+
 declare const ATOMIC_COMMANDS: {
     readonly cos: {
         readonly id: "cos";
@@ -472,7 +607,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly id: "neq";
         readonly category: "operators1";
         readonly Tex: "\\neq";
-        readonly mirror: false;
+        readonly mirror: true;
         readonly Label: "≠";
         readonly title: "لا يساوي";
         readonly svg_path: null;
@@ -482,6 +617,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "operators1";
         readonly Tex: "\\approx";
         readonly mirror: false;
+        readonly displayMirror: true;
         readonly Label: "≈";
         readonly title: "تقريبا يساوي";
         readonly svg_path: null;
@@ -491,6 +627,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "operators1";
         readonly Tex: "\\sim";
         readonly mirror: false;
+        readonly displayMirror: true;
         readonly Label: "∼";
         readonly title: "مشابه";
         readonly svg_path: null;
@@ -509,6 +646,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "operators1";
         readonly Tex: "\\leq";
         readonly mirror: true;
+        readonly displayMirror: false;
         readonly Label: "≤";
         readonly title: "أصغر من أو يساوي";
         readonly svg_path: null;
@@ -518,6 +656,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "operators1";
         readonly Tex: "\\geq";
         readonly mirror: true;
+        readonly displayMirror: false;
         readonly Label: "≥";
         readonly title: "أكبر من أو يساوي";
         readonly svg_path: null;
@@ -527,6 +666,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "operators1";
         readonly Tex: "\\coloneqq";
         readonly mirror: true;
+        readonly displayMirror: false;
         readonly Label: "≔";
         readonly title: "يعرف بأنه يساوي";
         readonly svg_path: null;
@@ -536,6 +676,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "operators1";
         readonly Tex: "\\eqqcolon";
         readonly mirror: true;
+        readonly displayMirror: false;
         readonly Label: "≕";
         readonly title: "يساوي بالتعريف";
         readonly svg_path: null;
@@ -545,6 +686,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "operators2";
         readonly Tex: "\\propto";
         readonly mirror: true;
+        readonly displayMirror: false;
         readonly Label: "∝";
         readonly title: "يتناسب مع";
         readonly svg_path: null;
@@ -554,6 +696,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "operators2";
         readonly Tex: "\\in";
         readonly mirror: true;
+        readonly displayMirror: false;
         readonly Label: "∈";
         readonly title: "ينتمي إلى";
         readonly svg_path: null;
@@ -563,6 +706,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "operators2";
         readonly Tex: "\\notin";
         readonly mirror: false;
+        readonly displayMirror: true;
         readonly Label: "∉";
         readonly title: "لا ينتمي إلى";
         readonly svg_path: null;
@@ -572,6 +716,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "operators2";
         readonly Tex: "\\subset";
         readonly mirror: true;
+        readonly displayMirror: false;
         readonly Label: "⊂";
         readonly title: "مجموعة جزئية من";
         readonly svg_path: null;
@@ -581,6 +726,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "operators2";
         readonly Tex: "\\supset";
         readonly mirror: true;
+        readonly displayMirror: false;
         readonly Label: "⊃";
         readonly title: "مجموعة شاملة لـ";
         readonly svg_path: null;
@@ -590,6 +736,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "operators2";
         readonly Tex: "\\subseteq";
         readonly mirror: true;
+        readonly displayMirror: false;
         readonly Label: "⊆";
         readonly title: "مجموعة جزئية أو تساوي";
         readonly svg_path: null;
@@ -599,6 +746,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "operators2";
         readonly Tex: "\\supseteq";
         readonly mirror: true;
+        readonly displayMirror: false;
         readonly Label: "⊇";
         readonly title: "مجموعة شاملة أو تساوي";
         readonly svg_path: null;
@@ -608,6 +756,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "operators2";
         readonly Tex: "\\cap";
         readonly mirror: false;
+        readonly displayMirror: true;
         readonly Label: "∩";
         readonly title: "تقاطع";
         readonly svg_path: null;
@@ -617,6 +766,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "operators2";
         readonly Tex: "\\cup";
         readonly mirror: false;
+        readonly displayMirror: true;
         readonly Label: "∪";
         readonly title: "اتحاد";
         readonly svg_path: null;
@@ -626,6 +776,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "operators2";
         readonly Tex: "\\emptyset";
         readonly mirror: false;
+        readonly displayMirror: true;
         readonly Label: "∅";
         readonly title: "المجموعة الخالية";
         readonly svg_path: null;
@@ -635,6 +786,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "operators2";
         readonly Tex: "\\nsubseteq";
         readonly mirror: true;
+        readonly displayMirror: false;
         readonly Label: "⊈";
         readonly title: "ليست مجموعة جزئية أو تساوي";
         readonly svg_path: null;
@@ -644,6 +796,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "operators2";
         readonly Tex: "\\nsupseteq";
         readonly mirror: true;
+        readonly displayMirror: false;
         readonly Label: "⊉";
         readonly title: "ليست مجموعة شاملة أو تساوي";
         readonly svg_path: null;
@@ -852,6 +1005,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "integrals";
         readonly Tex: "\\iint";
         readonly mirror: true;
+        readonly displayMirror: false;
         readonly Label: "∬";
         readonly title: "تكامل مزدوج";
         readonly svg_path: null;
@@ -861,6 +1015,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "integrals";
         readonly Tex: "\\iiint";
         readonly mirror: true;
+        readonly displayMirror: false;
         readonly Label: "∭";
         readonly title: "تكامل ثلاثي";
         readonly svg_path: null;
@@ -870,6 +1025,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "integrals";
         readonly Tex: "\\iiiint";
         readonly mirror: true;
+        readonly displayMirror: false;
         readonly Label: "⨌";
         readonly title: "تكامل رباعي";
         readonly svg_path: null;
@@ -879,6 +1035,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "integrals";
         readonly Tex: "\\oint";
         readonly mirror: true;
+        readonly displayMirror: false;
         readonly Label: "∮";
         readonly title: "تكامل مغلق";
         readonly svg_path: null;
@@ -888,6 +1045,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "integrals";
         readonly Tex: "\\oiint";
         readonly mirror: true;
+        readonly displayMirror: false;
         readonly Label: "∯";
         readonly title: "تكامل سطحي مغلق";
         readonly svg_path: null;
@@ -897,6 +1055,7 @@ declare const ATOMIC_OPERATOR_COMMANDS: {
         readonly category: "integrals";
         readonly Tex: "\\oiiint";
         readonly mirror: true;
+        readonly displayMirror: false;
         readonly Label: "∰";
         readonly title: "تكامل حجمي مغلق";
         readonly svg_path: null;
@@ -931,6 +1090,11 @@ type EditorRuntimeApi = {
     insertArrayEnv: (rows: number, columns: number) => void;
     insertAlignedEnv: (rows: number, columns: number) => void;
     insertSqrt: () => void;
+    insertOverset: () => void;
+    insertUnderset: () => void;
+    insertLimitsSeriesTemplate: (commandId: AtomicCommandId) => void;
+    insertAccentPair: () => void;
+    insertAccent: (accentId: AccentCommandId) => void;
     insertAtomicCommand: (commandId: AtomicCommandId) => void;
     insertAtomicOperatorCommand: (commandId: AtomicOperatorCommandId) => void;
     addSup: () => void;