jodit 4.0.5 → 4.0.13

package/esm/plugins/spellcheck/langs/index.d.ts

@@ -8,6 +8,7 @@ import * as cs_cz from "./cs_cz.js";
 import * as de from "./de.js";
 import * as es from "./es.js";
 import * as fa from "./fa.js";
+import * as fi from "./fi.js";
 import * as fr from "./fr.js";
 import * as he from "./he.js";
 import * as hu from "./hu.js";
@@ -23,4 +24,4 @@ import * as ru from "./ru.js";
 import * as tr from "./tr.js";
 import * as zh_cn from "./zh_cn.js";
 import * as zh_tw from "./zh_tw.js";
-export { ar, cs_cz, de, es, fa, fr, he, hu, id, it, ja, ko, mn, nl, pl, pt_br, ru, tr, zh_cn, zh_tw };
+export { ar, cs_cz, de, es, fa, fi, fr, he, hu, id, it, ja, ko, mn, nl, pl, pt_br, ru, tr, zh_cn, zh_tw };

package/esm/plugins/spellcheck/langs/index.js

@@ -8,6 +8,7 @@ import * as cs_cz from "./cs_cz.js";
 import * as de from "./de.js";
 import * as es from "./es.js";
 import * as fa from "./fa.js";
+import * as fi from "./fi.js";
 import * as fr from "./fr.js";
 import * as he from "./he.js";
 import * as hu from "./hu.js";
@@ -23,4 +24,4 @@ import * as ru from "./ru.js";
 import * as tr from "./tr.js";
 import * as zh_cn from "./zh_cn.js";
 import * as zh_tw from "./zh_tw.js";
-export { ar, cs_cz, de, es, fa, fr, he, hu, id, it, ja, ko, mn, nl, pl, pt_br, ru, tr, zh_cn, zh_tw };
+export { ar, cs_cz, de, es, fa, fi, fr, he, hu, id, it, ja, ko, mn, nl, pl, pt_br, ru, tr, zh_cn, zh_tw };

package/esm/plugins/symbols/langs/fi.d.ts

@@ -0,0 +1 @@
+export let symbols: string;

package/esm/plugins/symbols/langs/fi.js

@@ -0,0 +1,9 @@
+"use strict";
+/*!
+ * Jodit Editor (https://xdsoft.net/jodit/)
+ * Released under MIT see LICENSE.txt in the project root for license information.
+ * Copyright (c) 2013-2024 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+export default {
+    symbols: 'Symbolit'
+};

package/esm/plugins/symbols/langs/index.d.ts

@@ -8,6 +8,7 @@ import * as cs_cz from "./cs_cz.js";
 import * as de from "./de.js";
 import * as es from "./es.js";
 import * as fa from "./fa.js";
+import * as fi from "./fi.js";
 import * as fr from "./fr.js";
 import * as he from "./he.js";
 import * as hu from "./hu.js";
@@ -23,4 +24,4 @@ import * as ru from "./ru.js";
 import * as tr from "./tr.js";
 import * as zh_cn from "./zh_cn.js";
 import * as zh_tw from "./zh_tw.js";
-export { ar, cs_cz, de, es, fa, fr, he, hu, id, it, ja, ko, mn, nl, pl, pt_br, ru, tr, zh_cn, zh_tw };
+export { ar, cs_cz, de, es, fa, fi, fr, he, hu, id, it, ja, ko, mn, nl, pl, pt_br, ru, tr, zh_cn, zh_tw };

package/esm/plugins/symbols/langs/index.js

@@ -8,6 +8,7 @@ import * as cs_cz from "./cs_cz.js";
 import * as de from "./de.js";
 import * as es from "./es.js";
 import * as fa from "./fa.js";
+import * as fi from "./fi.js";
 import * as fr from "./fr.js";
 import * as he from "./he.js";
 import * as hu from "./hu.js";
@@ -23,4 +24,4 @@ import * as ru from "./ru.js";
 import * as tr from "./tr.js";
 import * as zh_cn from "./zh_cn.js";
 import * as zh_tw from "./zh_tw.js";
-export { ar, cs_cz, de, es, fa, fr, he, hu, id, it, ja, ko, mn, nl, pl, pt_br, ru, tr, zh_cn, zh_tw };
+export { ar, cs_cz, de, es, fa, fi, fr, he, hu, id, it, ja, ko, mn, nl, pl, pt_br, ru, tr, zh_cn, zh_tw };

package/esm/plugins/table-keyboard-navigation/table-keyboard-navigation.d.ts

@@ -10,6 +10,6 @@
  */
 import type { IJodit } from "jodit/esm/types";
 /**
- * Process navigate keypressing in table cell
+ * Process navigates key pressing in table cell
  */
 export declare function tableKeyboardNavigation(editor: IJodit): void;

package/esm/plugins/table-keyboard-navigation/table-keyboard-navigation.js

@@ -7,111 +7,108 @@ import * as consts from "jodit/esm/core/constants.js";
 import { Dom } from "jodit/esm/core/dom/dom.js";
 import { Table } from "jodit/esm/modules/table/table.js";
 import { pluginSystem } from "jodit/esm/core/global.js";
+import { call } from "jodit/esm/core/helpers/index.js";
+const WORK_KEYS = new Set([
+    consts.KEY_TAB,
+    consts.KEY_LEFT,
+    consts.KEY_RIGHT,
+    consts.KEY_UP,
+    consts.KEY_DOWN
+]);
 /**
- * Process navigate keypressing in table cell
+ * Process navigates key pressing in table cell
  */
 export function tableKeyboardNavigation(editor) {
     editor.e
         .off('.tableKeyboardNavigation')
         .on('keydown.tableKeyboardNavigation', (event) => {
-        let current, block;
-        if (event.key === consts.KEY_TAB ||
-            event.key === consts.KEY_LEFT ||
-            event.key === consts.KEY_RIGHT ||
-            event.key === consts.KEY_UP ||
-            event.key === consts.KEY_DOWN) {
-            current = editor.s.current();
-            block = Dom.up(current, Dom.isCell, editor.editor);
-            if (!block) {
-                return;
-            }
-            const range = editor.s.range;
-            if (event.key !== consts.KEY_TAB && current !== block) {
-                if (((event.key === consts.KEY_LEFT ||
-                    event.key === consts.KEY_UP) &&
-                    (Dom.prev(current, (elm) => event.key === consts.KEY_UP
-                        ? Dom.isTag(elm, 'br')
-                        : Boolean(elm), block) ||
-                        (event.key !== consts.KEY_UP &&
-                            Dom.isText(current) &&
-                            range.startOffset !== 0))) ||
-                    ((event.key === consts.KEY_RIGHT ||
-                        event.key === consts.KEY_DOWN) &&
-                        (Dom.next(current, (elm) => event.key === consts.KEY_DOWN
-                            ? Dom.isTag(elm, 'br')
-                            : Boolean(elm), block) ||
-                            (event.key !== consts.KEY_DOWN &&
-                                Dom.isText(current) &&
-                                current.nodeValue &&
-                                range.startOffset !==
-                                    current.nodeValue.length)))) {
-                    return;
-                }
-            }
+        const { key } = event;
+        if (!WORK_KEYS.has(key)) {
+            return;
         }
-        else {
+        const current = editor.s.current();
+        if (!current) {
             return;
         }
-        const tableModule = editor.getInstance('Table', editor.o);
-        const table = Dom.up(block, (elm) => elm && /^table$/i.test(elm.nodeName), editor.editor);
+        const cell = Dom.up(current, Dom.isCell, editor.editor);
+        if (!cell) {
+            return;
+        }
+        const { range } = editor.s;
+        if (key !== consts.KEY_TAB && current !== cell) {
+            const isNextDirection = key === consts.KEY_RIGHT || key === consts.KEY_DOWN;
+            const hasNext = call(!isNextDirection ? Dom.prev : Dom.next, current, elm => key === consts.KEY_UP || key === consts.KEY_DOWN
+                ? Dom.isTag(elm, 'br')
+                : Boolean(elm), cell);
+            if ((!isNextDirection &&
+                (hasNext ||
+                    (key !== consts.KEY_UP &&
+                        Dom.isText(current) &&
+                        range.startOffset !== 0))) ||
+                (isNextDirection &&
+                    (hasNext ||
+                        (key !== consts.KEY_DOWN &&
+                            Dom.isText(current) &&
+                            current.nodeValue &&
+                            range.startOffset !==
+                                current.nodeValue.length)))) {
+                return;
+            }
+        }
+        const tableModule = editor.getInstance(Table, editor.o);
+        const table = Dom.closest(cell, 'table', editor.editor);
         let next = null;
-        switch (event.key) {
+        const isPrev = key === consts.KEY_LEFT || event.shiftKey;
+        const getNextCell = () => call(isPrev ? Dom.prev : Dom.next, cell, Dom.isCell, table);
+        switch (key) {
             case consts.KEY_TAB:
-            // case consts.KEY_RIGHT:
             case consts.KEY_LEFT: {
-                const sibling = event.key === consts.KEY_LEFT || event.shiftKey
-                    ? 'prev'
-                    : 'next';
-                next = Dom[sibling](block, (elm) => elm &&
-                    /^td|th$/i.test(elm.tagName), table);
+                next = getNextCell();
                 if (!next) {
-                    tableModule.appendRow(table, sibling === 'next'
+                    tableModule.appendRow(table, !isPrev
                         ? false
-                        : table.querySelector('tr'), sibling === 'next');
-                    next = Dom[sibling](block, Dom.isCell, table);
+                        : table.querySelector('tr'), !isPrev);
+                    next = getNextCell();
                 }
                 break;
             }
             case consts.KEY_UP:
             case consts.KEY_DOWN:
                 {
-                    let i = 0, j = 0;
-                    const matrix = tableModule.formalMatrix(table, (elm, _i, _j) => {
-                        if (elm === block) {
-                            i = _i;
-                            j = _j;
-                        }
-                    });
-                    if (event.key === consts.KEY_UP) {
-                        if (matrix[i - 1] !== undefined) {
-                            next = matrix[i - 1][j];
+                    const matrix = tableModule.formalMatrix(table);
+                    const [row, column] = tableModule.formalCoordinate(table, cell);
+                    if (key === consts.KEY_UP) {
+                        if (matrix[row - 1] !== undefined) {
+                            next = matrix[row - 1][column];
                         }
                     }
                     else {
-                        if (matrix[i + 1] !== undefined) {
-                            next = matrix[i + 1][j];
+                        if (matrix[row + 1] !== undefined) {
+                            next = matrix[row + 1][column];
                         }
                     }
                 }
                 break;
         }
-        if (next) {
-            if (!next.firstChild) {
-                const first = editor.createInside.element('br');
-                next.appendChild(first);
-                editor.s.setCursorBefore(first);
+        if (!next) {
+            return;
+        }
+        editor.e.fire('hidePopup hideResizer');
+        if (!next.firstChild) {
+            const first = editor.createInside.element('br');
+            next.appendChild(first);
+            editor.s.setCursorBefore(first);
+        }
+        else {
+            if (key === consts.KEY_TAB) {
+                editor.s.select(next, true);
             }
             else {
-                if (event.key === consts.KEY_TAB) {
-                    editor.s.select(next, true);
-                }
-                else {
-                    editor.s.setCursorIn(next, event.key === consts.KEY_RIGHT ||
-                        event.key === consts.KEY_DOWN);
-                }
+                editor.s.setCursorIn(next, key === consts.KEY_RIGHT || key === consts.KEY_DOWN);
             }
-            return false;
         }
+        editor.synchronizeValues();
+        return false;
     });
 }
 pluginSystem.add('tableKeyboardNavigation', tableKeyboardNavigation);

package/esm/tsconfig.json

@@ -35,7 +35,7 @@
 
 		"importHelpers": true,
 
-		"lib": ["es5", "esnext", "dom", "scripthost", "es2015.iterable"],
+		"lib": ["es5", "esnext", "DOM", "scripthost", "es2015.iterable"],
 
 		"baseUrl": ".",
 		"paths": {

package/esm/types/create.d.ts

@@ -41,7 +41,7 @@ interface ICreate {
     /**
      * Create DOM element from HTML text
      */
-    fromHTML(html: string, refs?: IDictionary<boolean>): HTMLElement;
+    fromHTML<T extends HTMLElement>(html: string, refs?: IDictionary<boolean>): T;
     /**
      * Apply to element `createAttributes` options
      */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "jodit",
-	"version": "4.0.5",
+	"version": "4.0.13",
 	"description": "Jodit is awesome and usefully wysiwyg editor with filebrowser",
 	"main": "esm/index.js",
 	"types": "types/index.d.ts",

package/types/core/async/async.d.ts

@@ -56,7 +56,7 @@ export declare class Async implements IAsync {
     private requestsIdle;
     private requestsRaf;
     private requestIdleCallbackNative;
-    private cancelIdleCallbackNative;
+    private __cancelIdleCallbackNative;
     requestIdleCallback(callback: IdleRequestCallback, options?: {
         timeout: number;
     }): number;

package/types/core/create/create.d.ts

@@ -53,7 +53,7 @@ export declare class Create implements ICreate {
      * });
      * ```
      */
-    fromHTML(html: string | number, refsToggleElement?: IDictionary<boolean | void>): HTMLElement;
+    fromHTML<T extends HTMLElement>(html: string | number, refsToggleElement?: IDictionary<boolean | void>): T;
     /**
      * Apply to element `createAttributes` options
      */

package/types/core/helpers/utils/append-script.d.ts

@@ -12,10 +12,6 @@ export interface CallbackAndElement {
     callback: EventListener;
     element: HTMLElement;
 }
-/**
- * Append script in document and call callback function after download
- */
-export declare const appendScript: (jodit: IViewBased, url: string, callback: (this: HTMLElement, e?: Event) => any) => CallbackAndElement;
 /**
  * Load script and return promise
  */
@@ -24,5 +20,5 @@ export declare const appendScriptAsync: Loader;
  * Download CSS style script
  */
 export declare const appendStyleAsync: Loader;
-export declare const loadNext: (jodit: IViewBased, urls: string[], i?: number) => Promise<void>;
+export declare function loadNext(jodit: IViewBased, urls: string[], i?: number): Promise<void>;
 export declare function loadNextStyle(jodit: IViewBased, urls: string[], i?: number): Promise<void>;

package/types/core/plugin/helpers/load.d.ts

@@ -14,4 +14,4 @@ export declare function loadStyle(jodit: IJodit, pluginName: string): Promise<vo
 /**
  * @private
  */
-export declare function loadExtras(items: Map<string, PluginType>, jodit: IJodit, extrasList: IExtraPlugin[], callback: () => void): void;
+export declare function loadExtras(items: Map<string, PluginType>, jodit: IJodit, extraList: IExtraPlugin[], callback: () => void): void;

package/types/langs/fi.d.ts

@@ -0,0 +1,218 @@
+declare const _exports: {
+    'Type something': string;
+    Advanced: string;
+    'About Jodit': string;
+    'Jodit Editor': string;
+    "Jodit User's Guide": string;
+    'contains detailed help for using': string;
+    'For information about the license, please go to our website:': string;
+    'Buy full version': string;
+    'Copyright \u00A9 XDSoft.net - Chupurnov Valeriy. All rights reserved.': string;
+    Anchor: string;
+    'Open in new tab': string;
+    'Open in fullsize': string;
+    'Clear Formatting': string;
+    'Fill color or set the text color': string;
+    Redo: string;
+    Undo: string;
+    Bold: string;
+    Italic: string;
+    'Insert Unordered List': string;
+    'Insert Ordered List': string;
+    'Align Center': string;
+    'Align Justify': string;
+    'Align Left': string;
+    'Align Right': string;
+    'Insert Horizontal Line': string;
+    'Insert Image': string;
+    'Insert file': string;
+    'Insert youtube/vimeo video': string;
+    'Insert link': string;
+    'Font size': string;
+    'Font family': string;
+    'Insert format block': string;
+    Normal: string;
+    'Heading 1': string;
+    'Heading 2': string;
+    'Heading 3': string;
+    'Heading 4': string;
+    Quote: string;
+    Code: string;
+    Insert: string;
+    'Insert table': string;
+    'Decrease Indent': string;
+    'Increase Indent': string;
+    'Select Special Character': string;
+    'Insert Special Character': string;
+    'Paint format': string;
+    'Change mode': string;
+    Margins: string;
+    top: string;
+    right: string;
+    bottom: string;
+    left: string;
+    Styles: string;
+    Classes: string;
+    Align: string;
+    Right: string;
+    Center: string;
+    Left: string;
+    '--Not Set--': string;
+    Src: string;
+    Title: string;
+    Alternative: string;
+    Filter: string;
+    Link: string;
+    'Open link in new tab': string;
+    Image: string;
+    file: string;
+    'Image properties': string;
+    Cancel: string;
+    Ok: string;
+    'Your code is similar to HTML. Keep as HTML?': string;
+    'Paste as HTML': string;
+    Keep: string;
+    Clean: string;
+    'Insert as Text': string;
+    'Word Paste Detected': string;
+    'The pasted content is coming from a Microsoft Word/Excel document. Do you want to keep the format or clean it up?': string;
+    'Insert only Text': string;
+    'File Browser': string;
+    'Error on load list': string;
+    'Error on load folders': string;
+    'Are you sure?': string;
+    'Enter Directory name': string;
+    'Create directory': string;
+    'type name': string;
+    'Drop image': string;
+    'Drop file': string;
+    'or click': string;
+    'Alternative text': string;
+    Browse: string;
+    Upload: string;
+    Background: string;
+    Text: string;
+    Top: string;
+    Middle: string;
+    Bottom: string;
+    'Insert column before': string;
+    'Insert column after': string;
+    'Insert row above': string;
+    'Insert row below': string;
+    'Delete table': string;
+    'Delete row': string;
+    'Delete column': string;
+    'Empty cell': string;
+    Delete: string;
+    'Strike through': string;
+    Underline: string;
+    Break: string;
+    'Search for': string;
+    'Replace with': string;
+    Replace: string;
+    Edit: string;
+    'Vertical align': string;
+    'Horizontal align': string;
+    'Sort by changed': string;
+    'Sort by name': string;
+    'Sort by size': string;
+    'Add folder': string;
+    Split: string;
+    'Split vertical': string;
+    'Split horizontal': string;
+    Merge: string;
+    'Add column': string;
+    'Add row': string;
+    Border: string;
+    'Embed code': string;
+    Update: string;
+    superscript: string;
+    subscript: string;
+    'Cut selection': string;
+    Paste: string;
+    'Choose Content to Paste': string;
+    'Chars: %d': string;
+    'Words: %d': string;
+    All: string;
+    'Select %s': string;
+    'Select all': string;
+    source: string;
+    bold: string;
+    italic: string;
+    brush: string;
+    link: string;
+    undo: string;
+    redo: string;
+    table: string;
+    image: string;
+    eraser: string;
+    paragraph: string;
+    fontsize: string;
+    video: string;
+    font: string;
+    about: string;
+    print: string;
+    underline: string;
+    strikethrough: string;
+    indent: string;
+    outdent: string;
+    fullsize: string;
+    shrink: string;
+    hr: string;
+    ul: string;
+    ol: string;
+    cut: string;
+    selectall: string;
+    'Open link': string;
+    'Edit link': string;
+    'No follow': string;
+    Unlink: string;
+    Eye: string;
+    pencil: string;
+    ' URL': string;
+    Reset: string;
+    Save: string;
+    'Save as ...': string;
+    Resize: string;
+    Crop: string;
+    Width: string;
+    Height: string;
+    'Keep Aspect Ratio': string;
+    Yes: string;
+    No: string;
+    Remove: string;
+    Select: string;
+    'You can only edit your own images. Download this image on the host?': string;
+    'The image has been successfully uploaded to the host!': string;
+    palette: string;
+    'There are no files': string;
+    Rename: string;
+    'Enter new name': string;
+    preview: string;
+    download: string;
+    'Paste from clipboard': string;
+    "Your browser doesn't support direct access to the clipboard.": string;
+    'Copy selection': string;
+    copy: string;
+    'Border radius': string;
+    'Show all': string;
+    Apply: string;
+    'Please fill out this field': string;
+    'Please enter a web address': string;
+    Default: string;
+    Circle: string;
+    Dot: string;
+    Quadrate: string;
+    'Lower Alpha': string;
+    'Lower Greek': string;
+    'Lower Roman': string;
+    'Upper Alpha': string;
+    'Upper Roman': string;
+    Find: string;
+    'Find Previous': string;
+    'Find Next': string;
+    'Insert className': string;
+    'Press Alt for custom resizing': string;
+    'Class name': string;
+};
+export = _exports;

package/types/plugins/add-new-line/add-new-line.d.ts

@@ -16,23 +16,23 @@ import "./config";
  * Create helper for adding new paragraph(Jodit.defaultOptions.enter tag) before iframe, table or image
  */
 export declare class addNewLine extends Plugin {
-    private line;
-    private isMatchedTag;
-    private timeout;
-    private preview;
-    private current;
-    private lineInFocus;
-    private isShown;
-    private show;
-    private hideForce;
+    private __line;
+    private __isMatchedTag;
+    private __timeout;
+    private __isBeforeContent;
+    private __current;
+    private __lineInFocus;
+    private __isShown;
+    private __show;
+    private __hideForce;
     protected onLock(isLocked: true): void;
-    private hide;
-    private canGetFocus;
+    private __hide;
+    private __canGetFocus;
     protected afterInit(editor: IJodit): void;
-    private addEventListeners;
-    private onClickLine;
+    private __addEventListeners;
+    private __onClickLine;
     protected onDblClickEditor(e: MouseEvent): void;
-    private onMouseMove;
+    private __onMouseMove;
     /** @override */
     protected beforeDestruct(): void;
 }

package/types/plugins/copy-format/langs/fi.d.ts

@@ -0,0 +1,4 @@
+declare const _exports: {
+    'copy-format': string;
+};
+export = _exports;

package/types/plugins/copy-format/langs/index.d.ts

@@ -8,6 +8,7 @@ import cs_cz from "./cs_cz.js";
 import de from "./de.js";
 import es from "./es.js";
 import fa from "./fa.js";
+import fi from "./fi.js";
 import fr from "./fr.js";
 import he from "./he.js";
 import hu from "./hu.js";
@@ -23,4 +24,4 @@ import ru from "./ru.js";
 import tr from "./tr.js";
 import zh_cn from "./zh_cn.js";
 import zh_tw from "./zh_tw.js";
-export { ar, cs_cz, de, es, fa, fr, he, hu, id, it, ja, ko, mn, nl, pl, pt_br, ru, tr, zh_cn, zh_tw };
+export { ar, cs_cz, de, es, fa, fi, fr, he, hu, id, it, ja, ko, mn, nl, pl, pt_br, ru, tr, zh_cn, zh_tw };

package/types/plugins/line-height/langs/fi.d.ts

@@ -0,0 +1,4 @@
+declare const _exports: {
+    'Line height': string;
+};
+export = _exports;

package/types/plugins/line-height/langs/index.d.ts

@@ -8,6 +8,7 @@ import * as cs_cz from "./cs_cz.js";
 import * as de from "./de.js";
 import * as es from "./es.js";
 import * as fa from "./fa.js";
+import * as fi from "./fi.js";
 import * as fr from "./fr.js";
 import * as he from "./he.js";
 import * as hu from "./hu.js";
@@ -23,4 +24,4 @@ import * as ru from "./ru.js";
 import * as tr from "./tr.js";
 import * as zh_cn from "./zh_cn.js";
 import * as zh_tw from "./zh_tw.js";
-export { ar, cs_cz, de, es, fa, fr, he, hu, id, it, ja, ko, mn, nl, pl, pt_br, ru, tr, zh_cn, zh_tw };
+export { ar, cs_cz, de, es, fa, fi, fr, he, hu, id, it, ja, ko, mn, nl, pl, pt_br, ru, tr, zh_cn, zh_tw };

package/types/plugins/resizer/resizer.d.ts

@@ -47,12 +47,12 @@ export declare class resizer extends Plugin {
     private getWorkplacePosition;
     private applySize;
     private onDelete;
-    private onChangeEditor;
+    private __onChangeEditor;
     /**
      * Bind an edit element to element
      * @param element - The element that you want to add a function to resize
      */
-    private bind;
+    private __bind;
     private onClickElement;
     private updateSize;
     private showSizeViewer;

package/types/plugins/search/config.d.ts

@@ -17,6 +17,11 @@ declare module 'jodit/config' {
         useSearch: boolean;
         search: {
             lazyIdleTimeout: number;
+            /**
+             * Use custom highlight API https://developer.mozilla.org/en-US/docs/Web/API/CSS_Custom_Highlight_API
+             * or use default implementation (wrap text in span and attribute jd-tmp-selection)
+             */
+            useCustomHighlightAPI: boolean;
             /**
              * Function to search for a string within a substring. The default implementation is [[fuzzySearchIndex]]
              * But you can write your own. It must implement the [[FuzzySearch]] interface.