@highcharts/grid-pro 2.0.0

package/es-modules/Grid/Core/GridUtils.d.ts

@@ -0,0 +1,110 @@
+/**
+ * The event object for the grid.
+ */
+export interface GridEvent<T, E extends Event = Event> {
+    /**
+     * The original browser event.
+     */
+    originalEvent?: E;
+    /**
+     * The target of the event.
+     */
+    target: T;
+}
+/**
+ * The event listener for the grid.
+ */
+export interface GridEventListener {
+    eventName: keyof HTMLElementEventMap;
+    listener: EventListener;
+}
+declare namespace GridUtils {
+    /**
+     * Parameters for the makeHTMLElement utils function.
+     */
+    interface MakeHTMLElementParameters {
+        className?: string;
+        id?: string;
+        innerText?: string;
+        innerHTML?: string;
+        style?: Partial<CSSStyleDeclaration>;
+    }
+    /**
+     * Creates a HTML element with the provided options.
+     *
+     * @param tagName
+     * The tag name of the element.
+     *
+     * @param params
+     * The parameters of the element.
+     *
+     * @param parent
+     * The parent element.
+     */
+    function makeHTMLElement<T extends HTMLElement>(tagName: string, params?: MakeHTMLElementParameters, parent?: HTMLElement): T;
+    /**
+     * Creates a div element with the provided class name and id.
+     *
+     * @param className
+     * The class name of the div.
+     *
+     * @param id
+     * The id of the element.
+     */
+    function makeDiv(className: string, id?: string): HTMLElement;
+    /**
+     * Check if there's a possibility that the given string is an HTML
+     * (contains '<').
+     *
+     * @param str
+     * Text to verify.
+     */
+    function isHTML(str: string): boolean;
+    /**
+     * Returns a string containing plain text format by removing HTML tags
+     *
+     * @param text
+     * String to be sanitized
+     *
+     * @returns
+     * Sanitized plain text string
+     */
+    function sanitizeText(text: string): string;
+    /**
+     * Sets an element's content, checking whether it is HTML or plain text.
+     * Should be used instead of element.innerText when the content can be HTML.
+     *
+     * @param element
+     * Parent element where the content should be.
+     *
+     * @param content
+     * Content to render.
+     */
+    function setHTMLContent(element: HTMLElement, content: string): void;
+    /**
+     * Creates a proxy that, when reading a property, first returns the value
+     * from the original options of a given entity; if it is not defined, it
+     * falls back to the value from the defaults (default options), recursively
+     * for nested objects. Setting values on the proxy will change the original
+     * options object (1st argument), not the defaults (2nd argument).
+     *
+     * @param options
+     * The specific options object.
+     *
+     * @param defaultOptions
+     * The default options to fall back to.
+     *
+     * @returns
+     * A proxy that provides merged access to options and defaults.
+     */
+    function createOptionsProxy<T extends object>(options: T, defaultOptions?: Partial<T>): T;
+    /**
+     * Format text with placeholders. Used for lang texts.
+     *
+     * @param template The text template with placeholders
+     * @param values Object containing values to replace placeholders
+     * @returns Formatted text
+     */
+    function formatText(template: string, values: Record<string, string | number>): string;
+}
+export default GridUtils;

package/es-modules/Grid/Core/GridUtils.js

@@ -0,0 +1,191 @@
+/* *
+ *
+ *  Grid utilities
+ *
+ *  (c) 2009-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Dawid Dragula
+ *
+ * */
+import AST from '../../Core/Renderer/HTML/AST.js';
+import U from '../../Core/Utilities.js';
+const { isObject } = U;
+AST.allowedAttributes.push('srcset', 'media');
+AST.allowedTags.push('picture', 'source');
+/* *
+ *
+ *  Namespace
+ *
+ * */
+var GridUtils;
+(function (GridUtils) {
+    /* *
+     *
+     *  Declarations
+     *
+     * */
+    /* *
+     *
+     *  Functions
+     *
+     * */
+    /**
+     * Creates a HTML element with the provided options.
+     *
+     * @param tagName
+     * The tag name of the element.
+     *
+     * @param params
+     * The parameters of the element.
+     *
+     * @param parent
+     * The parent element.
+     */
+    function makeHTMLElement(tagName, params, parent) {
+        const element = document.createElement(tagName);
+        if (params) {
+            const paramsKeys = Object.keys(params);
+            for (let i = 0; i < paramsKeys.length; i++) {
+                const key = paramsKeys[i];
+                const value = params[key];
+                if (value !== void 0) {
+                    if (key === 'style') {
+                        Object.assign(element.style, value);
+                    }
+                    else {
+                        element[key] = value;
+                    }
+                }
+            }
+        }
+        if (parent) {
+            parent.appendChild(element);
+        }
+        return element;
+    }
+    GridUtils.makeHTMLElement = makeHTMLElement;
+    /**
+     * Creates a div element with the provided class name and id.
+     *
+     * @param className
+     * The class name of the div.
+     *
+     * @param id
+     * The id of the element.
+     */
+    function makeDiv(className, id) {
+        return makeHTMLElement('div', { className, id });
+    }
+    GridUtils.makeDiv = makeDiv;
+    /**
+     * Check if there's a possibility that the given string is an HTML
+     * (contains '<').
+     *
+     * @param str
+     * Text to verify.
+     */
+    function isHTML(str) {
+        return str.indexOf('<') !== -1;
+    }
+    GridUtils.isHTML = isHTML;
+    /**
+     * Returns a string containing plain text format by removing HTML tags
+     *
+     * @param text
+     * String to be sanitized
+     *
+     * @returns
+     * Sanitized plain text string
+     */
+    function sanitizeText(text) {
+        try {
+            return new DOMParser().parseFromString(text, 'text/html')
+                .body.textContent || '';
+        }
+        catch {
+            return '';
+        }
+    }
+    GridUtils.sanitizeText = sanitizeText;
+    /**
+     * Sets an element's content, checking whether it is HTML or plain text.
+     * Should be used instead of element.innerText when the content can be HTML.
+     *
+     * @param element
+     * Parent element where the content should be.
+     *
+     * @param content
+     * Content to render.
+     */
+    function setHTMLContent(element, content) {
+        if (isHTML(content)) {
+            element.innerHTML = AST.emptyHTML;
+            const formattedNodes = new AST(content);
+            formattedNodes.addToDOM(element);
+        }
+        else {
+            element.innerText = content;
+        }
+    }
+    GridUtils.setHTMLContent = setHTMLContent;
+    /**
+     * Creates a proxy that, when reading a property, first returns the value
+     * from the original options of a given entity; if it is not defined, it
+     * falls back to the value from the defaults (default options), recursively
+     * for nested objects. Setting values on the proxy will change the original
+     * options object (1st argument), not the defaults (2nd argument).
+     *
+     * @param options
+     * The specific options object.
+     *
+     * @param defaultOptions
+     * The default options to fall back to.
+     *
+     * @returns
+     * A proxy that provides merged access to options and defaults.
+     */
+    function createOptionsProxy(options, defaultOptions = {}) {
+        const handler = (defaults = {}) => ({
+            get(target, prop) {
+                const targetValue = target[prop];
+                const defaultValue = defaults[prop];
+                if (isObject(targetValue, true)) {
+                    return new Proxy(targetValue, handler(defaultValue ?? {}));
+                }
+                return targetValue ?? defaultValue;
+            },
+            set(target, prop, value) {
+                target[prop] = value;
+                return true;
+            },
+            deleteProperty(target, prop) {
+                delete target[prop];
+                return true;
+            }
+        });
+        return new Proxy(options, handler(defaultOptions));
+    }
+    GridUtils.createOptionsProxy = createOptionsProxy;
+    /**
+     * Format text with placeholders. Used for lang texts.
+     *
+     * @param template The text template with placeholders
+     * @param values Object containing values to replace placeholders
+     * @returns Formatted text
+     */
+    function formatText(template, values) {
+        return template.replace(/\{(\w+)\}/g, (match, key) => (values[key] !== void 0 ? String(values[key]) : match));
+    }
+    GridUtils.formatText = formatText;
+})(GridUtils || (GridUtils = {}));
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default GridUtils;