@highcharts/grid-pro 2.0.0

package/es-modules/Grid/Pro/CellRendering/Renderers/SparklineRenderer.js

@@ -0,0 +1,89 @@
+/* *
+ *
+ *  Sparkline Cell Renderer class
+ *
+ *  (c) 2020-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Dawid Dragula
+ *  - Sebastian Bochan
+ *
+ * */
+'use strict';
+import CellRenderer from '../CellRenderer.js';
+import CellRendererRegistry from '../CellRendererRegistry.js';
+import SparklineContent from '../ContentTypes/SparklineContent.js';
+import U from '../../../../Core/Utilities.js';
+const { merge } = U;
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Renderer for the Text in a column..
+ */
+class SparklineRenderer extends CellRenderer {
+    /* *
+     *
+     *  Constructor
+     *
+     * */
+    constructor(column) {
+        super(column);
+        if (!SparklineContent.H) {
+            throw new Error('Sparkline Renderer: Highcharts is not loaded. Please ensure ' +
+                'that Highcharts namespace is registered before the Sparkline' +
+                ' Renderer is used.');
+        }
+        this.options = merge(SparklineRenderer.defaultOptions, this.column.options.cells?.renderer || {});
+    }
+    /* *
+     *
+     *  Methods
+     *
+     * */
+    render(cell) {
+        return new SparklineContent(cell, this);
+    }
+}
+/**
+ * The default edit mode renderer type names for this view renderer.
+ */
+SparklineRenderer.defaultEditingRenderer = 'textInput';
+/**
+ * Default options for the sparkline renderer.
+ */
+SparklineRenderer.defaultOptions = {
+    type: 'sparkline'
+};
+/* *
+ *
+ *  Namespace
+ *
+ * */
+(function (SparklineRenderer) {
+    /**
+     * Imports the Highcharts namespace to be used by the Sparkline Renderer.
+     *
+     * @param H
+     * Highcharts namespace.
+     */
+    function useHighcharts(H) {
+        if (H && !SparklineContent.H) {
+            SparklineContent.H = H;
+        }
+    }
+    SparklineRenderer.useHighcharts = useHighcharts;
+})(SparklineRenderer || (SparklineRenderer = {}));
+CellRendererRegistry.registerRenderer('sparkline', SparklineRenderer);
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default SparklineRenderer;

package/es-modules/Grid/Pro/CellRendering/Renderers/TextInputRenderer.d.ts

@@ -0,0 +1,54 @@
+import type Column from '../../../Core/Table/Column';
+import type TableCell from '../../../Core/Table/Body/TableCell';
+import { EditModeRenderer } from '../../CellEditing/CellEditMode';
+import type { EditModeRendererTypeName } from '../../CellEditing/CellEditingComposition';
+import CellRenderer from '../CellRenderer.js';
+import TextInputContent from '../ContentTypes/TextInputContent.js';
+/**
+ * Renderer for the Select in a column..
+ */
+declare class TextInputRenderer extends CellRenderer implements EditModeRenderer {
+    /**
+     * The default edit mode renderer type names for this view renderer.
+     */
+    static defaultEditingRenderer: EditModeRendererTypeName;
+    /**
+     * Default options for the text input renderer.
+     */
+    static defaultOptions: TextInputRenderer.Options;
+    options: TextInputRenderer.Options;
+    constructor(column: Column, options: Partial<CellRenderer.Options>);
+    render(cell: TableCell, parentElement?: HTMLElement): TextInputContent;
+}
+declare namespace TextInputRenderer {
+    /**
+     * Options to control the text input renderer content.
+     */
+    interface Options extends CellRenderer.Options {
+        type: 'textInput';
+        /**
+         * Whether the text input is disabled.
+         */
+        disabled?: boolean;
+        /**
+         * Attributes to control the text input.
+         */
+        attributes?: TextInputAttributes;
+    }
+    /**
+     * Attributes to control the text input.
+     */
+    interface TextInputAttributes {
+        minlength?: number;
+        maxlength?: number;
+        pattern?: string;
+        placeholder?: string;
+        size?: number;
+    }
+}
+declare module '../CellRendererType' {
+    interface CellRendererTypeRegistry {
+        textInput: typeof TextInputRenderer;
+    }
+}
+export default TextInputRenderer;

package/es-modules/Grid/Pro/CellRendering/Renderers/TextInputRenderer.js

@@ -0,0 +1,65 @@
+/* *
+ *
+ *  Text Input Cell Renderer class
+ *
+ *  (c) 2020-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Dawid Dragula
+ *  - Sebastian Bochan
+ *
+ * */
+'use strict';
+import CellRenderer from '../CellRenderer.js';
+import CellRendererRegistry from '../CellRendererRegistry.js';
+import TextInputContent from '../ContentTypes/TextInputContent.js';
+import U from '../../../../Core/Utilities.js';
+const { merge } = U;
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Renderer for the Select in a column..
+ */
+class TextInputRenderer extends CellRenderer {
+    /* *
+     *
+     *  Constructor
+     *
+     * */
+    constructor(column, options) {
+        super(column);
+        this.options = merge(TextInputRenderer.defaultOptions, options);
+    }
+    /* *
+     *
+     *  Methods
+     *
+     * */
+    render(cell, parentElement) {
+        return new TextInputContent(cell, this, parentElement);
+    }
+}
+/**
+ * The default edit mode renderer type names for this view renderer.
+ */
+TextInputRenderer.defaultEditingRenderer = 'textInput';
+/**
+ * Default options for the text input renderer.
+ */
+TextInputRenderer.defaultOptions = {
+    type: 'textInput'
+};
+CellRendererRegistry.registerRenderer('textInput', TextInputRenderer);
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default TextInputRenderer;

package/es-modules/Grid/Pro/CellRendering/Renderers/TextRenderer.d.ts

@@ -0,0 +1,43 @@
+import type Column from '../../../Core/Table/Column';
+import type TableCell from '../../../Core/Table/Body/TableCell';
+import type { EditModeRendererTypeName } from '../../CellEditing/CellEditingComposition';
+import CellRenderer from '../CellRenderer.js';
+import TextContent from '../../../Core/Table/CellContent/TextContent.js';
+/**
+ * Renderer for the Text in a column..
+ */
+declare class TextRenderer extends CellRenderer {
+    /**
+     * The default edit mode renderer type names for this view renderer.
+     */
+    static defaultEditingRenderer: Record<Column.DataType, EditModeRendererTypeName>;
+    /**
+     * Default options for the text renderer.
+     */
+    static defaultOptions: TextRenderer.Options;
+    options: TextRenderer.Options;
+    /**
+     * The format to use for the text content.
+     */
+    format?: string;
+    /**
+     * Formatter function for the text content.
+     */
+    formatter?: (this: TableCell) => string;
+    constructor(column: Column);
+    render(cell: TableCell): TextContent;
+}
+declare namespace TextRenderer {
+    /**
+     * Options to control the text renderer content.
+     */
+    interface Options extends CellRenderer.Options {
+        type: 'text';
+    }
+}
+declare module '../CellRendererType' {
+    interface CellRendererTypeRegistry {
+        text: typeof TextRenderer;
+    }
+}
+export default TextRenderer;

package/es-modules/Grid/Pro/CellRendering/Renderers/TextRenderer.js

@@ -0,0 +1,74 @@
+/* *
+ *
+ *  Text Cell Renderer class
+ *
+ *  (c) 2020-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Dawid Dragula
+ *
+ * */
+'use strict';
+import CellRenderer from '../CellRenderer.js';
+import CellRendererRegistry from '../CellRendererRegistry.js';
+import TextContent from '../../../Core/Table/CellContent/TextContent.js';
+import U from '../../../../Core/Utilities.js';
+const { merge } = U;
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Renderer for the Text in a column..
+ */
+class TextRenderer extends CellRenderer {
+    /* *
+     *
+     *  Constructor
+     *
+     * */
+    constructor(column) {
+        super(column);
+        this.options = merge(TextRenderer.defaultOptions, this.column.options.cells?.renderer || {});
+        const cellOptions = column.options.cells;
+        this.format =
+            cellOptions?.format ??
+                TextContent.defaultFormatsForDataTypes[column.dataType];
+        this.formatter = cellOptions?.formatter;
+    }
+    /* *
+     *
+     *  Methods
+     *
+     * */
+    render(cell) {
+        return new TextContent(cell);
+    }
+}
+/**
+ * The default edit mode renderer type names for this view renderer.
+ */
+TextRenderer.defaultEditingRenderer = {
+    string: 'textInput',
+    number: 'numberInput',
+    'boolean': 'checkbox',
+    datetime: 'dateInput'
+};
+/**
+ * Default options for the text renderer.
+ */
+TextRenderer.defaultOptions = {
+    type: 'text'
+};
+CellRendererRegistry.registerRenderer('text', TextRenderer);
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default TextRenderer;

package/es-modules/Grid/Pro/CellRendering/Renderers/TimeInputRenderer.d.ts

@@ -0,0 +1,37 @@
+import type Column from '../../../Core/Table/Column';
+import type TimeInputRendererBase from './DateInputRendererBase';
+import type TableCell from '../../../Core/Table/Body/TableCell';
+import type { EditModeRenderer } from '../../CellEditing/CellEditMode';
+import type { EditModeRendererTypeName } from '../../CellEditing/CellEditingComposition';
+import CellRenderer from '../CellRenderer.js';
+import TimeInputContent from '../ContentTypes/TimeInputContent.js';
+/**
+ * Renderer for the Select in a column..
+ */
+declare class TimeInputRenderer extends CellRenderer implements EditModeRenderer {
+    /**
+     * The default edit mode renderer type name for this view renderer.
+     */
+    static defaultEditingRenderer: EditModeRendererTypeName;
+    /**
+     * Default options for the time input renderer.
+     */
+    static defaultOptions: TimeInputRenderer.Options;
+    options: TimeInputRenderer.Options;
+    constructor(column: Column, options: Partial<CellRenderer.Options>);
+    render(cell: TableCell, parentElement?: HTMLElement): TimeInputContent;
+}
+declare namespace TimeInputRenderer {
+    /**
+     * Options to control the time input renderer content.
+     */
+    interface Options extends TimeInputRendererBase.Options {
+        type: 'timeInput';
+    }
+}
+declare module '../CellRendererType' {
+    interface CellRendererTypeRegistry {
+        timeInput: typeof TimeInputRenderer;
+    }
+}
+export default TimeInputRenderer;

package/es-modules/Grid/Pro/CellRendering/Renderers/TimeInputRenderer.js

@@ -0,0 +1,64 @@
+/* *
+ *
+ *  Time Input Cell Renderer class
+ *
+ *  (c) 2020-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Dawid Dragula
+ *
+ * */
+'use strict';
+import CellRenderer from '../CellRenderer.js';
+import CellRendererRegistry from '../CellRendererRegistry.js';
+import TimeInputContent from '../ContentTypes/TimeInputContent.js';
+import U from '../../../../Core/Utilities.js';
+const { merge } = U;
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Renderer for the Select in a column..
+ */
+class TimeInputRenderer extends CellRenderer {
+    /* *
+     *
+     *  Constructor
+     *
+     * */
+    constructor(column, options) {
+        super(column);
+        this.options = merge(TimeInputRenderer.defaultOptions, options);
+    }
+    /* *
+     *
+     *  Methods
+     *
+     * */
+    render(cell, parentElement) {
+        return new TimeInputContent(cell, this, parentElement);
+    }
+}
+/**
+ * The default edit mode renderer type name for this view renderer.
+ */
+TimeInputRenderer.defaultEditingRenderer = 'timeInput';
+/**
+ * Default options for the time input renderer.
+ */
+TimeInputRenderer.defaultOptions = {
+    type: 'timeInput'
+};
+CellRendererRegistry.registerRenderer('timeInput', TimeInputRenderer);
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default TimeInputRenderer;

package/es-modules/Grid/Pro/ColumnTypes/ColumnDataType.d.ts

@@ -0,0 +1,29 @@
+/* *
+ *
+ *  (c) 2010-2024 Torstein Honsi
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ * */
+
+/* *
+ *
+ *  Declarations
+ *
+ * */
+
+/**
+ * Data types of the column cells.
+ */
+
+export type ColumnDataType = 'string' | 'number' | 'boolean' | 'datetime';
+
+/* *
+*
+*  Export
+*
+* */
+
+export default ColumnDataType;

package/es-modules/Grid/Pro/ColumnTypes/Validator.d.ts

@@ -0,0 +1,118 @@
+import type Column from '../../Core/Table/Column';
+import type { EditModeContent } from '../CellEditing/CellEditMode';
+import type Table from '../../Core/Table/Table';
+import type TableCell from '../../Core/Table/Body/TableCell';
+import Cell from '../../Core/Table/Cell.js';
+/**
+ * Class for validating cell content.
+ */
+declare class Validator {
+    viewport: Table;
+    /**
+     * The cell that has an error.
+     */
+    errorCell?: Cell;
+    /**
+     * HTML Element for the errors.
+     */
+    notifContainer: HTMLElement;
+    constructor(viewport: Table);
+    /**
+     * Validates the cell content.
+     *
+     * @param cell
+     * Edited cell.
+     *
+     * @param errors
+     * An output array for error messages.
+     *
+     * @returns
+     * Returns true if the value is valid, false otherwise.
+     */
+    validate(cell: TableCell, errors?: string[]): boolean;
+    /**
+     * Set content of notification and adjust the position.
+     *
+     * @param cell
+     * Cell that is currently edited and is not valid.
+     *
+     * @param errors
+     * An array of error messages.
+     *
+     */
+    initErrorBox(cell: TableCell, errors: string[]): void;
+    /**
+     * Highlight the non-valid cell and display error in the notification box.
+     */
+    show(): void;
+    /**
+     * Hide the notification, error and unset highlight on cell.
+     *
+     * @param hideErrorBox
+     * The flag that hides the error on edited cell.
+     *
+     */
+    hide(hideErrorBox?: boolean): void;
+    /**
+     * Set the position of the error box.
+     */
+    reflow(): void;
+    /**
+     * Destroy validator.
+     */
+    destroy(): void;
+}
+/**
+ * Namespace for Validation functionality.
+ */
+declare namespace Validator {
+    /**
+     * The class names used by the validator functionality.
+     */
+    const classNames: {
+        readonly notifContainer: string;
+        readonly notifError: string;
+        readonly notifAnimation: string;
+        readonly editedCellError: string;
+    };
+    /**
+     * Callback function that checks if field is valid.
+     */
+    type ValidateFunction = (this: TableCell, content: EditModeContent) => boolean;
+    /**
+     * Callback function that returns a error message.
+     */
+    type ValidationErrorFunction = (this: TableCell, content?: EditModeContent) => string;
+    /**
+     * Definition of the validation rule that should container validate method
+     * and error message displayed in notification.
+     */
+    interface RuleDefinition {
+        validate: RulesRegistryType | ValidateFunction;
+        notification: string | ValidationErrorFunction;
+    }
+    /**
+     *  Definition of default validation rules.
+     */
+    interface RulesRegistryType {
+        boolean: RuleDefinition;
+        datetime: RuleDefinition;
+        notEmpty: RuleDefinition;
+        number: RuleDefinition;
+        ignoreCaseUnique: RuleDefinition;
+        unique: RuleDefinition;
+    }
+    /**
+     * Type of rule: `notEmpty`, `number` or `boolean`.
+     */
+    type RuleKey = keyof RulesRegistryType;
+    /**
+     * Definition of default validation rules.
+     */
+    const rulesRegistry: RulesRegistryType;
+    /**
+     * Default validation rules for each dataType.
+     */
+    const predefinedRules: Record<Column.DataType, RuleKey[]>;
+}
+export default Validator;