@leanix/components 0.4.76 → 0.4.78

package/index.d.ts

@@ -39,6 +39,7 @@ export * from './lib/core-ui/tooltip/tooltip.directive';
 export * from './lib/core-ui/linkify/linkify.pipe';
 export * from './lib/core-ui/linkify/unlinkify.pipe';
 export * from './lib/core-ui/functions/core-css.helpers';
+export * from './lib/core-ui/functions/highlight-text.function';
 export * from './lib/core-ui/services/resize-observer.service';
 export * from './lib/forms-ui/forms-ui.module';
 export * from './lib/forms-ui/components/basic-dropdown-item/basic-dropdown-item.component';

package/lib/core-ui/functions/highlight-text.function.d.ts

@@ -0,0 +1,29 @@
+export interface HighlightTextSettings {
+    /**
+     * Whether to match case sensitively
+     */
+    caseSensitive?: boolean;
+    /**
+     * Whether to match whole words only
+     */
+    wordsOnly?: boolean;
+    /**
+     * The element to wrap highlighted terms in
+     */
+    element?: string;
+    /**
+     * The class name to apply to highlighted terms
+     */
+    className?: string;
+}
+/**
+ * Highlights all occurrences of search terms in a given element.
+ * This function will recursively traverse all child nodes of the given element,
+ * and apply the highlight to text nodes only.
+ *
+ * Replaces the 'jquery-highlight' plugin: https://github.com/knownasilya/jquery-highlight/blob/master/jquery.highlight.js
+ * @param elem The element to highlight
+ * @param terms The search terms to highlight - string or array of strings
+ * @param settings Optional settings, @see HighlightTextSettings
+ */
+export declare function highlightText(elem: HTMLElement, terms: string | string[], settings?: HighlightTextSettings): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leanix/components",
-  "version": "0.4.76",
+  "version": "0.4.78",
   "license": "Apache-2.0",
   "author": "LeanIX GmbH",
   "repository": {