lsp-grid 1.0.0

package/dist/collection/plugins/rtl/rtl.plugin.js

@@ -0,0 +1,110 @@
+/*!
+ * Built by LevelSkill.Pro
+ */
+import { BasePlugin } from "../base.plugin";
+/**
+ * RTL (Right-to-Left) Plugin for RevoGrid
+ *
+ * This plugin handles RTL transformation by subscribing to the beforecolumnsset event
+ * and applying column order reversal when RTL mode is enabled.
+ */
+export class RTLPlugin extends BasePlugin {
+    constructor(revogrid, providers) {
+        super(revogrid, providers);
+        this.isRTLEnabled = false;
+        this.init();
+    }
+    init() {
+        // Subscribe to beforecolumnsset event to apply RTL transformation
+        this.addEventListener('beforecolumnsset', (event) => {
+            this.handleBeforeColumnsSet(event);
+        });
+        // Listen for RTL property changes
+        this.addEventListener('aftergridinit', () => {
+            this.updateRTLState();
+        });
+        // Watch for RTL property changes
+        this.watch('rtl', (value) => {
+            this.isRTLEnabled = value;
+            this.emit('rtlstatechanged', { rtl: this.isRTLEnabled });
+        }, { immediate: true });
+    }
+    /**
+     * Handle the beforecolumnsset event to apply RTL transformation
+     */
+    handleBeforeColumnsSet(event) {
+        if (!this.isRTLEnabled) {
+            return; // No transformation needed if RTL is disabled
+        }
+        const columnCollection = event.detail;
+        // Apply RTL transformation to all column types
+        const transformedColumns = this.applyRTLTransformationToCollection(columnCollection);
+        // Update the event detail with transformed columns
+        event.detail.columns = transformedColumns.columns;
+        event.detail.columnByProp = transformedColumns.columnByProp;
+        event.detail.columnGrouping = transformedColumns.columnGrouping;
+    }
+    /**
+     * Apply RTL transformation to the entire column collection
+     */
+    applyRTLTransformationToCollection(collection) {
+        const transformedCollection = {
+            columns: {
+                rgCol: [],
+                colPinStart: [],
+                colPinEnd: [],
+            },
+            columnByProp: Object.assign({}, collection.columnByProp),
+            columnGrouping: {
+                rgCol: [],
+                colPinStart: [],
+                colPinEnd: [],
+            },
+            maxLevel: collection.maxLevel,
+            sort: Object.assign({}, collection.sort),
+        };
+        // Transform each column type
+        Object.keys(collection.columns).forEach((type) => {
+            const columnType = type;
+            const columns = collection.columns[columnType];
+            // Apply RTL transformation to columns - create new reversed array
+            const reversedColumns = [...columns].reverse();
+            transformedCollection.columns[columnType] = reversedColumns;
+            // Transform column grouping for this type
+            transformedCollection.columnGrouping[columnType] = this.applyRTLTransformationToGroups(collection.columnGrouping[columnType], columns.length);
+        });
+        return transformedCollection;
+    }
+    /**
+     * Apply RTL transformation to column groups
+     */
+    applyRTLTransformationToGroups(groups, totalColumns) {
+        return groups.map(group => {
+            // Reverse the indexes for RTL
+            const reversedIndexes = group.indexes.map((index) => totalColumns - 1 - index).reverse();
+            return Object.assign(Object.assign({}, group), { indexes: reversedIndexes });
+        }).reverse(); // Reverse the group order
+    }
+    /**
+     * Update RTL state based on the grid's rtl property
+     */
+    updateRTLState() {
+        const grid = this.revogrid;
+        if (grid && typeof grid.rtl === 'boolean') {
+            this.isRTLEnabled = grid.rtl;
+        }
+    }
+    /**
+     * Get current RTL state
+     */
+    getRTLState() {
+        return this.isRTLEnabled;
+    }
+    /**
+     * Clean up the plugin
+     */
+    destroy() {
+        super.destroy();
+    }
+}
+//# sourceMappingURL=rtl.plugin.js.map

package/dist/collection/plugins/rtl/rtl.plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rtl.plugin.js","sourceRoot":"","sources":["../../../src/plugins/rtl/rtl.plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAI5C;;;;;GAKG;AACH,MAAM,OAAO,SAAU,SAAQ,UAAU;IAGvC,YACE,QAA6B,EAC7B,SAA0B;QAE1B,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QANrB,iBAAY,GAAG,KAAK,CAAC;QAO3B,IAAI,CAAC,IAAI,EAAE,CAAC;IACd,CAAC;IAEO,IAAI;QACV,kEAAkE;QAClE,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,CAAC,KAAK,EAAE,EAAE;YAClD,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,kCAAkC;QAClC,IAAI,CAAC,gBAAgB,CAAC,eAAe,EAAE,GAAG,EAAE;YAC1C,IAAI,CAAC,cAAc,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,iCAAiC;QACjC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,KAAc,EAAE,EAAE;YACnC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;YAC1B,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QAC3D,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1B,CAAC;IAED;;OAEG;IACK,sBAAsB,CAAC,KAAoC;QACjE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,OAAO,CAAC,8CAA8C;QACxD,CAAC;QAED,MAAM,gBAAgB,GAAG,KAAK,CAAC,MAAM,CAAC;QAEtC,+CAA+C;QAC/C,MAAM,kBAAkB,GAAG,IAAI,CAAC,kCAAkC,CAAC,gBAAgB,CAAC,CAAC;QAErF,mDAAmD;QACnD,KAAK,CAAC,MAAM,CAAC,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC;QAClD,KAAK,CAAC,MAAM,CAAC,YAAY,GAAG,kBAAkB,CAAC,YAAY,CAAC;QAC5D,KAAK,CAAC,MAAM,CAAC,cAAc,GAAG,kBAAkB,CAAC,cAAc,CAAC;IAClE,CAAC;IAED;;OAEG;IACK,kCAAkC,CAAC,UAA4B;QACrE,MAAM,qBAAqB,GAAqB;YAC9C,OAAO,EAAE;gBACP,KAAK,EAAE,EAAE;gBACT,WAAW,EAAE,EAAE;gBACf,SAAS,EAAE,EAAE;aACd;YACD,YAAY,oBAAO,UAAU,CAAC,YAAY,CAAE;YAC5C,cAAc,EAAE;gBACd,KAAK,EAAE,EAAE;gBACT,WAAW,EAAE,EAAE;gBACf,SAAS,EAAE,EAAE;aACd;YACD,QAAQ,EAAE,UAAU,CAAC,QAAQ;YAC7B,IAAI,oBAAO,UAAU,CAAC,IAAI,CAAE;SAC7B,CAAC;QAEF,6BAA6B;QAC7B,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC/C,MAAM,UAAU,GAAG,IAAuC,CAAC;YAC3D,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAE/C,kEAAkE;YAClE,MAAM,eAAe,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;YAC/C,qBAAqB,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,eAAe,CAAC;YAE5D,0CAA0C;YAC1C,qBAAqB,CAAC,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,8BAA8B,CACpF,UAAU,CAAC,cAAc,CAAC,UAAU,CAAC,EACrC,OAAO,CAAC,MAAM,CACf,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,qBAAqB,CAAC;IAC/B,CAAC;IAED;;OAEG;IACK,8BAA8B,CAAC,MAAa,EAAE,YAAoB;QACxE,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;YACxB,8BAA8B;YAC9B,MAAM,eAAe,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAa,EAAE,EAAE,CAC1D,YAAY,GAAG,CAAC,GAAG,KAAK,CACzB,CAAC,OAAO,EAAE,CAAC;YAEZ,uCACK,KAAK,KACR,OAAO,EAAE,eAAe,IACxB;QACJ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,0BAA0B;IAC1C,CAAC;IAED;;OAEG;IACK,cAAc;QACpB,MAAM,IAAI,GAAG,IAAI,CAAC,QAAe,CAAC;QAClC,IAAI,IAAI,IAAI,OAAO,IAAI,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YAC1C,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC;QAC/B,CAAC;IACH,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAGD;;OAEG;IACI,OAAO;QACZ,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;CACF","sourcesContent":["import { BasePlugin } from '../base.plugin';\r\nimport type { PluginProviders } from '@type';\r\nimport { type ColumnCollection } from '../../utils/column.utils';\r\n\r\n/**\r\n * RTL (Right-to-Left) Plugin for RevoGrid\r\n * \r\n * This plugin handles RTL transformation by subscribing to the beforecolumnsset event\r\n * and applying column order reversal when RTL mode is enabled.\r\n */\r\nexport class RTLPlugin extends BasePlugin {\r\n  private isRTLEnabled = false;\r\n\r\n  constructor(\r\n    revogrid: HTMLRevoGridElement,\r\n    providers: PluginProviders,\r\n  ) {\r\n    super(revogrid, providers);\r\n    this.init();\r\n  }\r\n\r\n  private init() {\r\n    // Subscribe to beforecolumnsset event to apply RTL transformation\r\n    this.addEventListener('beforecolumnsset', (event) => {\r\n      this.handleBeforeColumnsSet(event);\r\n    });\r\n\r\n    // Listen for RTL property changes\r\n    this.addEventListener('aftergridinit', () => {\r\n      this.updateRTLState();\r\n    });\r\n\r\n    // Watch for RTL property changes\r\n    this.watch('rtl', (value: boolean) => {\r\n      this.isRTLEnabled = value;\r\n      this.emit('rtlstatechanged', { rtl: this.isRTLEnabled });\r\n    }, { immediate: true });\r\n  }\r\n\r\n  /**\r\n   * Handle the beforecolumnsset event to apply RTL transformation\r\n   */\r\n  private handleBeforeColumnsSet(event: CustomEvent<ColumnCollection>) {\r\n    if (!this.isRTLEnabled) {\r\n      return; // No transformation needed if RTL is disabled\r\n    }\r\n\r\n    const columnCollection = event.detail;\r\n    \r\n    // Apply RTL transformation to all column types\r\n    const transformedColumns = this.applyRTLTransformationToCollection(columnCollection);\r\n    \r\n    // Update the event detail with transformed columns\r\n    event.detail.columns = transformedColumns.columns;\r\n    event.detail.columnByProp = transformedColumns.columnByProp;\r\n    event.detail.columnGrouping = transformedColumns.columnGrouping;\r\n  }\r\n\r\n  /**\r\n   * Apply RTL transformation to the entire column collection\r\n   */\r\n  private applyRTLTransformationToCollection(collection: ColumnCollection): ColumnCollection {\r\n    const transformedCollection: ColumnCollection = {\r\n      columns: {\r\n        rgCol: [],\r\n        colPinStart: [],\r\n        colPinEnd: [],\r\n      },\r\n      columnByProp: { ...collection.columnByProp },\r\n      columnGrouping: {\r\n        rgCol: [],\r\n        colPinStart: [],\r\n        colPinEnd: [],\r\n      },\r\n      maxLevel: collection.maxLevel,\r\n      sort: { ...collection.sort },\r\n    };\r\n\r\n    // Transform each column type\r\n    Object.keys(collection.columns).forEach((type) => {\r\n      const columnType = type as keyof typeof collection.columns;\r\n      const columns = collection.columns[columnType];\r\n      \r\n      // Apply RTL transformation to columns - create new reversed array\r\n      const reversedColumns = [...columns].reverse();\r\n      transformedCollection.columns[columnType] = reversedColumns;\r\n      \r\n      // Transform column grouping for this type\r\n      transformedCollection.columnGrouping[columnType] = this.applyRTLTransformationToGroups(\r\n        collection.columnGrouping[columnType],\r\n        columns.length\r\n      );\r\n    });\r\n\r\n    return transformedCollection;\r\n  }\r\n\r\n  /**\r\n   * Apply RTL transformation to column groups\r\n   */\r\n  private applyRTLTransformationToGroups(groups: any[], totalColumns: number): any[] {\r\n    return groups.map(group => {\r\n      // Reverse the indexes for RTL\r\n      const reversedIndexes = group.indexes.map((index: number) => \r\n        totalColumns - 1 - index\r\n      ).reverse();\r\n      \r\n      return {\r\n        ...group,\r\n        indexes: reversedIndexes\r\n      };\r\n    }).reverse(); // Reverse the group order\r\n  }\r\n\r\n  /**\r\n   * Update RTL state based on the grid's rtl property\r\n   */\r\n  private updateRTLState() {\r\n    const grid = this.revogrid as any;\r\n    if (grid && typeof grid.rtl === 'boolean') {\r\n      this.isRTLEnabled = grid.rtl;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Get current RTL state\r\n   */\r\n  public getRTLState(): boolean {\r\n    return this.isRTLEnabled;\r\n  }\r\n\r\n\r\n  /**\r\n   * Clean up the plugin\r\n   */\r\n  public destroy() {\r\n    super.destroy();\r\n  }\r\n} "]}

package/dist/collection/plugins/sorting/sorting.func.js

@@ -0,0 +1,82 @@
+/*!
+ * Built by LevelSkill.Pro
+ */
+import { isGrouping } from "../groupingRow/grouping.service";
+import { getCellRaw } from "../../utils/column.utils";
+export function sortIndexByItems(indexes, source, sortingFunc = {}) {
+    // if no sorting - return unsorted indexes
+    if (Object.entries(sortingFunc).length === 0) {
+        // Unsorted indexes
+        return [...Array(indexes.length).keys()];
+    }
+    //
+    /**
+     * go through all indexes and align in new order
+     * performs a multi-level sorting by applying multiple comparison functions to determine the order of the items based on different properties.
+     */
+    return indexes.sort((a, b) => {
+        const itemA = source[a];
+        const itemB = source[b];
+        for (const [prop, cmp] of Object.entries(sortingFunc)) {
+            if (isGrouping(itemA)) {
+                if (itemA['__rvgr-prop'] !== prop) {
+                    return 0;
+                }
+            }
+            if (isGrouping(itemB)) {
+                if (itemB['__rvgr-prop'] !== prop) {
+                    return 0;
+                }
+            }
+            /**
+             * If the comparison function returns a non-zero value (sorted), it means that the items should be sorted based on the given property. In such a case, the function immediately returns the sorted value, indicating the order in which the items should be arranged.
+             * If none of the comparison functions result in a non-zero value, indicating that the items are equal or should remain in the same order, the function eventually returns 0.
+             */
+            const sorted = cmp === null || cmp === void 0 ? void 0 : cmp(prop, itemA, itemB);
+            if (sorted) {
+                return sorted;
+            }
+        }
+        return 0;
+    });
+}
+export function defaultCellCompare(prop, a, b) {
+    const aRaw = this.column ? getCellRaw(a, this.column) : a === null || a === void 0 ? void 0 : a[prop];
+    const bRaw = this.column ? getCellRaw(b, this.column) : b === null || b === void 0 ? void 0 : b[prop];
+    const av = typeof aRaw === 'number' ? aRaw : aRaw === null || aRaw === void 0 ? void 0 : aRaw.toString().toLowerCase();
+    const bv = typeof bRaw === 'number' ? bRaw : bRaw === null || bRaw === void 0 ? void 0 : bRaw.toString().toLowerCase();
+    if (av === bv) {
+        return 0;
+    }
+    if (av > bv) {
+        return 1;
+    }
+    return -1;
+}
+export function descCellCompare(cmp) {
+    return (prop, a, b) => {
+        return -1 * cmp(prop, a, b);
+    };
+}
+export function getNextOrder(currentOrder) {
+    switch (currentOrder) {
+        case undefined:
+            return 'asc';
+        case 'asc':
+            return 'desc';
+        case 'desc':
+            return undefined;
+    }
+}
+export function getComparer(column, order) {
+    var _a;
+    const cellCmp = ((_a = column === null || column === void 0 ? void 0 : column.cellCompare) === null || _a === void 0 ? void 0 : _a.bind({ order })) || (defaultCellCompare === null || defaultCellCompare === void 0 ? void 0 : defaultCellCompare.bind({ column, order }));
+    if (order == 'asc') {
+        return cellCmp;
+    }
+    if (order == 'desc') {
+        return descCellCompare(cellCmp);
+    }
+    return undefined;
+}
+//# sourceMappingURL=sorting.func.js.map

package/dist/collection/plugins/sorting/sorting.func.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sorting.func.js","sourceRoot":"","sources":["../../../src/plugins/sorting/sorting.func.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAEtD,MAAM,UAAU,gBAAgB,CAC9B,OAAiB,EACjB,MAAkB,EAClB,cAAoC,EAAE;IAEtC,0CAA0C;IAC1C,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7C,mBAAmB;QACnB,OAAO,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAC3C,CAAC;IACD,EAAE;IACF;;;OAGG;IACH,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QAC3B,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QACxB,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QACxB,KAAK,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YACtD,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;gBACtB,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,IAAI,EAAE,CAAC;oBAClC,OAAO,CAAC,CAAC;gBACX,CAAC;YACH,CAAC;YACD,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;gBACtB,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,IAAI,EAAE,CAAC;oBAClC,OAAO,CAAC,CAAC;gBACX,CAAC;YACH,CAAC;YACD;;;eAGG;YACH,MAAM,MAAM,GAAG,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAG,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;YACzC,IAAI,MAAM,EAAE,CAAC;gBACX,OAAO,MAAM,CAAC;YAChB,CAAC;QACH,CAAC;QACD,OAAO,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAmC,IAAgB,EAAE,CAAW,EAAE,CAAW;IAC7G,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAG,IAAI,CAAC,CAAC;IAClE,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAG,IAAI,CAAC,CAAC;IAClE,MAAM,EAAE,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC5E,MAAM,EAAE,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,GAAG,WAAW,EAAE,CAAC;IAE5E,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACd,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC;QACZ,OAAO,CAAC,CAAC;IACX,CAAC;IACD,OAAO,CAAC,CAAC,CAAC;AACZ,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,GAAoB;IAClD,OAAO,CAAC,IAAgB,EAAE,CAAW,EAAE,CAAW,EAAU,EAAE;QAC5D,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9B,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,YAAmB;IAC9C,QAAQ,YAAY,EAAE,CAAC;QACrB,KAAK,SAAS;YACZ,OAAO,KAAK,CAAC;QACf,KAAK,KAAK;YACR,OAAO,MAAM,CAAC;QAChB,KAAK,MAAM;YACT,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC;AAGD,MAAM,UAAU,WAAW,CAAC,MAA0C,EAAE,KAAY;;IAClF,MAAM,OAAO,GACX,CAAA,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,0CAAE,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,MAAI,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAA,CAAC;IACtF,IAAI,KAAK,IAAI,KAAK,EAAE,CAAC;QACnB,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC;QACpB,OAAO,eAAe,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC","sourcesContent":["import type { CellCompareFunc, ColumnProp, ColumnRegular, DataType, Order } from '@type';\r\nimport type { SortingOrderFunction } from './sorting.types';\r\nimport { isGrouping } from '../groupingRow/grouping.service';\r\nimport { getCellRaw } from '../../utils/column.utils';\r\n\r\nexport function sortIndexByItems(\r\n  indexes: number[],\r\n  source: DataType[],\r\n  sortingFunc: SortingOrderFunction = {},\r\n): number[] {\r\n  // if no sorting - return unsorted indexes\r\n  if (Object.entries(sortingFunc).length === 0) {\r\n    // Unsorted indexes\r\n    return [...Array(indexes.length).keys()];\r\n  }\r\n  //\r\n  /**\r\n   * go through all indexes and align in new order\r\n   * performs a multi-level sorting by applying multiple comparison functions to determine the order of the items based on different properties.\r\n   */\r\n  return indexes.sort((a, b) => {\r\n    const itemA = source[a];\r\n    const itemB = source[b];\r\n    for (const [prop, cmp] of Object.entries(sortingFunc)) {\r\n      if (isGrouping(itemA)) {\r\n        if (itemA['__rvgr-prop'] !== prop) {\r\n          return 0;\r\n        }\r\n      }\r\n      if (isGrouping(itemB)) {\r\n        if (itemB['__rvgr-prop'] !== prop) {\r\n          return 0;\r\n        }\r\n      }\r\n      /**\r\n       * If the comparison function returns a non-zero value (sorted), it means that the items should be sorted based on the given property. In such a case, the function immediately returns the sorted value, indicating the order in which the items should be arranged.\r\n       * If none of the comparison functions result in a non-zero value, indicating that the items are equal or should remain in the same order, the function eventually returns 0.\r\n       */\r\n      const sorted = cmp?.(prop, itemA, itemB);\r\n      if (sorted) {\r\n        return sorted;\r\n      }\r\n    }\r\n    return 0;\r\n  });\r\n}\r\n\r\nexport function defaultCellCompare(this: { column?: ColumnRegular }, prop: ColumnProp, a: DataType, b: DataType) {\r\n  const aRaw = this.column ? getCellRaw(a, this.column) : a?.[prop];\r\n  const bRaw = this.column ? getCellRaw(b, this.column) : b?.[prop];\r\n  const av = typeof aRaw === 'number' ? aRaw : aRaw?.toString().toLowerCase();\r\n  const bv = typeof bRaw === 'number' ? bRaw : bRaw?.toString().toLowerCase();\r\n\r\n  if (av === bv) {\r\n    return 0;\r\n  }\r\n  if (av > bv) {\r\n    return 1;\r\n  }\r\n  return -1;\r\n}\r\n\r\nexport function descCellCompare(cmp: CellCompareFunc) {\r\n  return (prop: ColumnProp, a: DataType, b: DataType): number => {\r\n    return -1 * cmp(prop, a, b);\r\n  };\r\n}\r\n\r\nexport function getNextOrder(currentOrder: Order): Order {\r\n  switch (currentOrder) {\r\n    case undefined:\r\n      return 'asc';\r\n    case 'asc':\r\n      return 'desc';\r\n    case 'desc':\r\n      return undefined;\r\n  }\r\n}\r\n\r\n\r\nexport function getComparer(column: Partial<ColumnRegular> | undefined, order: Order): CellCompareFunc | undefined {\r\n  const cellCmp: CellCompareFunc =\r\n    column?.cellCompare?.bind({ order }) || defaultCellCompare?.bind({ column, order });\r\n  if (order == 'asc') {\r\n    return cellCmp;\r\n  }\r\n  if (order == 'desc') {\r\n    return descCellCompare(cellCmp);\r\n  }\r\n  return undefined;\r\n}\r\n"]}

package/dist/collection/plugins/sorting/sorting.plugin.js

@@ -0,0 +1,224 @@
+/*!
+ * Built by LevelSkill.Pro
+ */
+import size from "lodash/size";
+import debounce from "lodash/debounce";
+import { BasePlugin } from "../base.plugin";
+import { getColumnByProp } from "../../utils/column.utils";
+import { columnTypes, rowTypes } from "../../store/index";
+import { getComparer, getNextOrder, sortIndexByItems } from "./sorting.func";
+export * from './sorting.types';
+export * from './sorting.func';
+export * from './sorting.sign';
+/**
+ * Lifecycle
+ * 1. @event `beforesorting` - Triggered when sorting just starts. Nothing has happened yet. This can be triggered from a column or from the source. If the type is from rows, the column will be undefined.
+ * 2. @event `beforesourcesortingapply` - Triggered before the sorting data is applied to the data source. You can prevent this event, and the data will not be sorted.
+ * 3. @event `beforesortingapply` - Triggered before the sorting data is applied to the data source. You can prevent this event, and the data will not be sorted. This event is only called from a column sorting click.
+ * 4. @event `aftersortingapply` - Triggered after sorting has been applied and completed. This event occurs for both row and column sorting.
+ *
+ * Note: If you prevent an event, it will not proceed to the subsequent steps.
+ */
+export class SortingPlugin extends BasePlugin {
+    constructor(revogrid, providers, config) {
+        super(revogrid, providers);
+        this.revogrid = revogrid;
+        /**
+         * Delayed sorting promise
+         */
+        this.sortingPromise = null;
+        /**
+         * We need to sort only so often
+         */
+        this.postponeSort = debounce((order, comparison, ignoreViewportUpdate) => this.runSorting(order, comparison, ignoreViewportUpdate), 50);
+        const setConfig = (cfg) => {
+            var _a;
+            if (cfg) {
+                const sortingFunc = {};
+                const order = {};
+                (_a = cfg.columns) === null || _a === void 0 ? void 0 : _a.forEach(col => {
+                    sortingFunc[col.prop] = getComparer(col, col.order);
+                    order[col.prop] = col.order;
+                });
+                if (cfg.additive) {
+                    this.sorting = Object.assign(Object.assign({}, this.sorting), order);
+                    this.sortingFunc = Object.assign(Object.assign({}, this.sortingFunc), sortingFunc);
+                }
+                else {
+                    // // set sorting
+                    this.sorting = order;
+                    this.sortingFunc = sortingFunc;
+                }
+            }
+        };
+        setConfig(config);
+        this.addEventListener('sortingconfigchanged', ({ detail }) => {
+            config = detail;
+            setConfig(detail);
+            this.startSorting(this.sorting, this.sortingFunc);
+        });
+        this.addEventListener('beforeheaderrender', ({ detail, }) => {
+            var _a;
+            const { data: column } = detail;
+            if (column.sortable) {
+                detail.data = Object.assign(Object.assign({}, column), { order: (_a = this.sorting) === null || _a === void 0 ? void 0 : _a[column.prop] });
+            }
+        });
+        this.addEventListener('beforeanysource', ({ detail: { type }, }) => {
+            // if sorting was provided - sort data
+            if (!!this.sorting && this.sortingFunc) {
+                const event = this.emit('beforesourcesortingapply', { type, sorting: this.sorting });
+                if (event.defaultPrevented) {
+                    return;
+                }
+                this.startSorting(this.sorting, this.sortingFunc);
+            }
+        });
+        this.addEventListener('aftercolumnsset', ({ detail: { order }, }) => {
+            // if config provided - do nothing, read from config
+            if (config) {
+                return;
+            }
+            const columns = this.providers.column.getColumns();
+            const sortingFunc = {};
+            for (let prop in order) {
+                const cmp = getComparer(getColumnByProp(columns, prop), order[prop]);
+                sortingFunc[prop] = cmp;
+            }
+            // set sorting
+            this.sorting = order;
+            this.sortingFunc = order && sortingFunc;
+        });
+        this.addEventListener('beforeheaderclick', (e) => {
+            var _a, _b, _c, _d;
+            if (e.defaultPrevented) {
+                return;
+            }
+            if (!((_b = (_a = e.detail) === null || _a === void 0 ? void 0 : _a.column) === null || _b === void 0 ? void 0 : _b.sortable)) {
+                return;
+            }
+            this.headerclick(e.detail.column, (_d = (_c = e.detail) === null || _c === void 0 ? void 0 : _c.originalEvent) === null || _d === void 0 ? void 0 : _d.shiftKey);
+        });
+    }
+    /**
+     * Entry point for sorting, waits for all delayes, registers jobs
+     */
+    startSorting(order, sortingFunc, ignoreViewportUpdate) {
+        if (!this.sortingPromise) {
+            // add job before render
+            this.revogrid.jobsBeforeRender.push(new Promise(resolve => {
+                this.sortingPromise = resolve;
+            }));
+        }
+        this.postponeSort(order, sortingFunc, ignoreViewportUpdate);
+    }
+    /**
+     * Apply sorting to data on header click
+     * If additive - add to existing sorting, multiple columns can be sorted
+     */
+    headerclick(column, additive) {
+        var _a, _b, _c;
+        const columnProp = column.prop;
+        let order = getNextOrder((_a = this.sorting) === null || _a === void 0 ? void 0 : _a[columnProp]);
+        const beforeEvent = this.emit('beforesorting', { column, order, additive });
+        if (beforeEvent.defaultPrevented) {
+            return;
+        }
+        order = beforeEvent.detail.order;
+        // apply sort data
+        const beforeApplyEvent = this.emit('beforesortingapply', {
+            column: beforeEvent.detail.column,
+            order,
+            additive,
+        });
+        if (beforeApplyEvent.defaultPrevented) {
+            return;
+        }
+        const cmp = getComparer(beforeApplyEvent.detail.column, beforeApplyEvent.detail.order);
+        if (beforeApplyEvent.detail.additive && this.sorting) {
+            const sorting = {};
+            const sortingFunc = {};
+            if (columnProp in sorting && size(sorting) > 1 && order === undefined) {
+                delete sorting[columnProp];
+                delete sortingFunc[columnProp];
+            }
+            else {
+                sorting[columnProp] = order;
+                sortingFunc[columnProp] = cmp;
+            }
+            this.sorting = Object.assign(Object.assign({}, this.sorting), sorting);
+            // extend sorting function with new sorting for multiple columns sorting
+            this.sortingFunc = Object.assign(Object.assign({}, this.sortingFunc), sortingFunc);
+        }
+        else {
+            if (order) {
+                // reset sorting
+                this.sorting = { [columnProp]: order };
+                this.sortingFunc = { [columnProp]: cmp };
+            }
+            else {
+                (_b = this.sorting) === null || _b === void 0 ? true : delete _b[columnProp];
+                (_c = this.sortingFunc) === null || _c === void 0 ? true : delete _c[columnProp];
+            }
+        }
+        this.startSorting(this.sorting, this.sortingFunc);
+    }
+    runSorting(order, comparison, ignoreViewportUpdate) {
+        var _a;
+        this.sort(order, comparison, undefined, ignoreViewportUpdate);
+        (_a = this.sortingPromise) === null || _a === void 0 ? void 0 : _a.call(this);
+        this.sortingPromise = null;
+    }
+    /**
+     * Sort items by sorting function
+     * @requires proxyItems applied to row store
+     * @requires source applied to row store
+     *
+     * @param sorting - per column sorting
+     * @param data - this.stores['rgRow'].store.get('source')
+     */
+    sort(sorting, sortingFunc, types = rowTypes, ignoreViewportUpdate = false) {
+        // if no sorting - reset
+        if (!Object.keys(sorting || {}).length) {
+            for (let type of types) {
+                const storeService = this.providers.data.stores[type];
+                // row data
+                const source = storeService.store.get('source');
+                // row indexes
+                const proxyItems = storeService.store.get('proxyItems');
+                // row indexes
+                const newItemsOrder = Array.from({ length: source.length }, (_, i) => i); // recover indexes range(0, source.length)
+                this.providers.dimension.updateSizesPositionByNewDataIndexes(type, newItemsOrder, proxyItems);
+                storeService.setData({ proxyItems: newItemsOrder, source: [...source], });
+            }
+        }
+        else {
+            for (let type of types) {
+                const storeService = this.providers.data.stores[type];
+                // row data
+                const source = storeService.store.get('source');
+                // row indexes
+                const proxyItems = storeService.store.get('proxyItems');
+                const newItemsOrder = sortIndexByItems([...proxyItems], source, sortingFunc);
+                // take row indexes before trim applied and proxy items
+                const prevItems = storeService.store.get('items');
+                storeService.setData({
+                    proxyItems: newItemsOrder,
+                    source: [...source],
+                });
+                // take currently visible row indexes
+                const newItems = storeService.store.get('items');
+                if (!ignoreViewportUpdate) {
+                    this.providers.dimension
+                        .updateSizesPositionByNewDataIndexes(type, newItems, prevItems);
+                }
+            }
+        }
+        // refresh columns to redraw column headers and show correct icon
+        columnTypes.forEach((type) => {
+            this.providers.column.dataSources[type].refresh();
+        });
+        this.emit('aftersortingapply');
+    }
+}
+//# sourceMappingURL=sorting.plugin.js.map

package/dist/collection/plugins/sorting/sorting.plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sorting.plugin.js","sourceRoot":"","sources":["../../../src/plugins/sorting/sorting.plugin.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,aAAa,CAAC;AAC/B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAEvC,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAQ5C,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAE7E,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAE/B;;;;;;;;GAQG;AAEH,MAAM,OAAO,aAAc,SAAQ,UAAU;IAoB3C,YACS,QAA6B,EACpC,SAA0B,EAC1B,MAAsB;QAEtB,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAJpB,aAAQ,GAAR,QAAQ,CAAqB;QAftC;;WAEG;QACH,mBAAc,GAAwB,IAAI,CAAC;QAE3C;;WAEG;QACH,iBAAY,GAAG,QAAQ,CACrB,CAAC,KAAoB,EAAE,UAAiC,EAAE,oBAA8B,EAAE,EAAE,CAC1F,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,EAAE,oBAAoB,CAAC,EAC1D,EAAE,CACH,CAAC;QASA,MAAM,SAAS,GAAG,CAAC,GAAmB,EAAE,EAAE;;YACxC,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,WAAW,GAAyB,EAAE,CAAC;gBAC7C,MAAM,KAAK,GAAiB,EAAE,CAAC;gBAC/B,MAAA,GAAG,CAAC,OAAO,0CAAE,OAAO,CAAC,GAAG,CAAC,EAAE;oBACzB,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;oBACpD,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC;gBAC9B,CAAC,CAAC,CAAC;gBAEH,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;oBACjB,IAAI,CAAC,OAAO,mCACP,IAAI,CAAC,OAAO,GACZ,KAAK,CACT,CAAC;oBACF,IAAI,CAAC,WAAW,mCACX,IAAI,CAAC,WAAW,GAChB,WAAW,CACf,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,iBAAiB;oBACjB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;oBACrB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;gBACjC,CAAC;YACH,CAAC;QACH,CAAC,CAAA;QAED,SAAS,CAAC,MAAM,CAAC,CAAC;QAElB,IAAI,CAAC,gBAAgB,CAAC,sBAAsB,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;YAC3D,MAAM,GAAG,MAAM,CAAC;YAChB,SAAS,CAAC,MAAM,CAAC,CAAC;YAClB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,EAAE,CAAC,EAC3C,MAAM,GACP,EAAE,EAAE;;YACH,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;YAChC,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;gBACpB,MAAM,CAAC,IAAI,mCACN,MAAM,KACT,KAAK,EAAE,MAAA,IAAI,CAAC,OAAO,0CAAG,MAAM,CAAC,IAAI,CAAC,GACnC,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,CAAC,EACxC,MAAM,EAAE,EAAE,IAAI,EAAE,GACjB,EAAE,EAAE;YACH,sCAAsC;YACtC,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACvC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;gBACrF,IAAI,KAAK,CAAC,gBAAgB,EAAE,CAAC;oBAC3B,OAAO;gBACT,CAAC;gBACD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACpD,CAAC;QACH,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,CAAC,EACxC,MAAM,EAAE,EAAE,KAAK,EAAE,GAClB,EAAE,EAAE;YACH,oDAAoD;YACpD,IAAI,MAAM,EAAE,CAAC;gBACX,OAAO;YACT,CAAC;YAED,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YACnD,MAAM,WAAW,GAAyB,EAAE,CAAC;YAE7C,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC;gBACvB,MAAM,GAAG,GAAG,WAAW,CACrB,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,EAC9B,KAAK,CAAC,IAAI,CAAC,CACZ,CAAC;gBACF,WAAW,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;YAC1B,CAAC;YAED,cAAc;YACd,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;YACrB,IAAI,CAAC,WAAW,GAAG,KAAK,IAAI,WAAW,CAAC;QAC1C,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,CAAC,mBAAmB,EAAE,CAAC,CAAC,EAAE,EAAE;;YAC/C,IAAI,CAAC,CAAC,gBAAgB,EAAE,CAAC;gBACvB,OAAO;YACT,CAAC;YAED,IAAI,CAAC,CAAA,MAAA,MAAA,CAAC,CAAC,MAAM,0CAAE,MAAM,0CAAE,QAAQ,CAAA,EAAE,CAAC;gBAChC,OAAO;YACT,CAAC;YAED,IAAI,CAAC,WAAW,CACd,CAAC,CAAC,MAAM,CAAC,MAAM,EACf,MAAA,MAAA,CAAC,CAAC,MAAM,0CAAE,aAAa,0CAAE,QAAQ,CAClC,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,KAAoB,EAAE,WAAkC,EAAE,oBAA8B;QACnG,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACzB,wBAAwB;YACxB,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CACjC,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE;gBAC1B,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC;YAChC,CAAC,CAAC,CACH,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,WAAW,EAAE,oBAAoB,CAAC,CAAC;IAC9D,CAAC;IAGD;;;OAGG;IACH,WAAW,CAAC,MAAqB,EAAE,QAAiB;;QAClD,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC;QAC/B,IAAI,KAAK,GAAU,YAAY,CAAC,MAAA,IAAI,CAAC,OAAO,0CAAG,UAAU,CAAC,CAAC,CAAC;QAC5D,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC5E,IAAI,WAAW,CAAC,gBAAgB,EAAE,CAAC;YACjC,OAAO;QACT,CAAC;QACD,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC;QAEjC,kBAAkB;QAClB,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE;YACvD,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,MAAM;YACjC,KAAK;YACL,QAAQ;SACT,CAAC,CAAC;QACH,IAAI,gBAAgB,CAAC,gBAAgB,EAAE,CAAC;YACtC,OAAO;QACT,CAAC;QACD,MAAM,GAAG,GAAG,WAAW,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAEvF,IAAI,gBAAgB,CAAC,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACrD,MAAM,OAAO,GAAiB,EAAE,CAAC;YACjC,MAAM,WAAW,GAAyB,EAAE,CAAC;YAE7C,IAAI,UAAU,IAAI,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACtE,OAAO,OAAO,CAAC,UAAU,CAAC,CAAC;gBAC3B,OAAO,WAAW,CAAC,UAAU,CAAC,CAAC;YACjC,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC;gBAC5B,WAAW,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC;YAChC,CAAC;YAED,IAAI,CAAC,OAAO,mCACP,IAAI,CAAC,OAAO,GACZ,OAAO,CACX,CAAC;YAEF,wEAAwE;YACxE,IAAI,CAAC,WAAW,mCACX,IAAI,CAAC,WAAW,GAChB,WAAW,CACf,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,KAAK,EAAE,CAAC;gBACV,gBAAgB;gBAChB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,CAAC;gBACvC,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACC,MAAA,IAAI,CAAC,OAAO,+CAAG,UAAU,CAAC,CAAC;gBAC3B,MAAA,IAAI,CAAC,WAAW,+CAAG,UAAU,CAAC,CAAC;YACxC,CAAC;QACH,CAAC;QAED,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACpD,CAAC;IAED,UAAU,CACR,KAAoB,EACpB,UAAiC,EACjC,oBAA8B;;QAE9B,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,oBAAoB,CAAC,CAAC;QAC9D,MAAA,IAAI,CAAC,cAAc,oDAAI,CAAC;QACxB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;IAC7B,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,OAAsB,EACtB,WAAkC,EAClC,QAAyB,QAAQ,EACjC,oBAAoB,GAAG,KAAK;QAE5B,wBAAwB;QACxB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;YACvC,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC;gBACvB,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBACtD,WAAW;gBACX,MAAM,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBAChD,cAAc;gBACd,MAAM,UAAU,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;gBACxD,cAAc;gBACd,MAAM,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,0CAA0C;gBACpH,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,mCAAmC,CAAC,IAAI,EAAE,aAAa,EAAE,UAAU,CAAC,CAAC;gBAC9F,YAAY,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC;aAAM,CAAC;YACN,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC;gBACvB,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBACtD,WAAW;gBACX,MAAM,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBAChD,cAAc;gBACd,MAAM,UAAU,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;gBAExD,MAAM,aAAa,GAAG,gBAAgB,CACpC,CAAC,GAAG,UAAU,CAAC,EACf,MAAM,EACN,WAAW,CACZ,CAAC;gBAEF,uDAAuD;gBACvD,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAClD,YAAY,CAAC,OAAO,CAAC;oBACnB,UAAU,EAAE,aAAa;oBACzB,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC;iBACpB,CAAC,CAAC;gBACH,qCAAqC;gBACrC,MAAM,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBACjD,IAAI,CAAC,oBAAoB,EAAE,CAAC;oBAC1B,IAAI,CAAC,SAAS,CAAC,SAAS;yBACrB,mCAAmC,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;gBACpE,CAAC;YACH,CAAC;QACH,CAAC;QACD,iEAAiE;QACjE,WAAW,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC3B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;QACpD,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IACjC,CAAC;CACF","sourcesContent":["import size from 'lodash/size';\r\nimport debounce from 'lodash/debounce';\r\n\r\nimport { BasePlugin } from '../base.plugin';\r\nimport type {\r\n  Order,\r\n  ColumnRegular,\r\n  DimensionRows,\r\n  PluginProviders,\r\n} from '@type';\r\nimport type { SortingConfig, SortingOrder, SortingOrderFunction } from './sorting.types';\r\nimport { getColumnByProp } from '../../utils/column.utils';\r\nimport { columnTypes, rowTypes } from '@store';\r\nimport { getComparer, getNextOrder, sortIndexByItems } from './sorting.func';\r\n\r\nexport * from './sorting.types';\r\nexport * from './sorting.func';\r\nexport * from './sorting.sign';\r\n\r\n/**\r\n * Lifecycle\r\n * 1. @event `beforesorting` - Triggered when sorting just starts. Nothing has happened yet. This can be triggered from a column or from the source. If the type is from rows, the column will be undefined.\r\n * 2. @event `beforesourcesortingapply` - Triggered before the sorting data is applied to the data source. You can prevent this event, and the data will not be sorted.\r\n * 3. @event `beforesortingapply` - Triggered before the sorting data is applied to the data source. You can prevent this event, and the data will not be sorted. This event is only called from a column sorting click.\r\n * 4. @event `aftersortingapply` - Triggered after sorting has been applied and completed. This event occurs for both row and column sorting.\r\n *\r\n * Note: If you prevent an event, it will not proceed to the subsequent steps.\r\n */\r\n\r\nexport class SortingPlugin extends BasePlugin {\r\n  // Current sorting order per column prop\r\n  sorting?: SortingOrder;\r\n\r\n  // Each column sorting function, multiple columns sorting supported\r\n  sortingFunc?: SortingOrderFunction;\r\n  /**\r\n   * Delayed sorting promise\r\n   */\r\n  sortingPromise: (() => void) | null = null;\r\n\r\n  /**\r\n   * We need to sort only so often\r\n   */\r\n  postponeSort = debounce(\r\n    (order?: SortingOrder, comparison?: SortingOrderFunction, ignoreViewportUpdate?: boolean) =>\r\n      this.runSorting(order, comparison, ignoreViewportUpdate),\r\n    50,\r\n  );\r\n\r\n  constructor(\r\n    public revogrid: HTMLRevoGridElement,\r\n    providers: PluginProviders,\r\n    config?: SortingConfig,\r\n  ) {\r\n    super(revogrid, providers);\r\n\r\n    const setConfig = (cfg?: SortingConfig) => {\r\n      if (cfg) {\r\n        const sortingFunc: SortingOrderFunction = {};\r\n        const order: SortingOrder = {};\r\n        cfg.columns?.forEach(col => {\r\n          sortingFunc[col.prop] = getComparer(col, col.order);\r\n          order[col.prop] = col.order;\r\n        });\r\n\r\n        if (cfg.additive) {\r\n          this.sorting = {\r\n            ...this.sorting,\r\n            ...order,\r\n          };\r\n          this.sortingFunc = {\r\n            ...this.sortingFunc,\r\n            ...sortingFunc,\r\n          };\r\n        } else {\r\n          // // set sorting\r\n          this.sorting = order;\r\n          this.sortingFunc = sortingFunc;\r\n        }\r\n      }\r\n    }\r\n\r\n    setConfig(config);\r\n\r\n    this.addEventListener('sortingconfigchanged', ({ detail }) => {\r\n      config = detail;\r\n      setConfig(detail);\r\n      this.startSorting(this.sorting, this.sortingFunc);\r\n    });\r\n\r\n    this.addEventListener('beforeheaderrender', ({\r\n      detail,\r\n    }) => {\r\n      const { data: column } = detail;\r\n      if (column.sortable) {\r\n        detail.data = {\r\n          ...column,\r\n          order: this.sorting?.[column.prop],\r\n        };\r\n      }\r\n    });\r\n\r\n    this.addEventListener('beforeanysource', ({\r\n      detail: { type },\r\n    }) => {\r\n      // if sorting was provided - sort data\r\n      if (!!this.sorting && this.sortingFunc) {\r\n        const event = this.emit('beforesourcesortingapply', { type, sorting: this.sorting });\r\n        if (event.defaultPrevented) {\r\n          return;\r\n        }\r\n        this.startSorting(this.sorting, this.sortingFunc);\r\n      }\r\n    });\r\n    this.addEventListener('aftercolumnsset', ({\r\n      detail: { order },\r\n    }) => {\r\n      // if config provided - do nothing, read from config\r\n      if (config) {\r\n        return;\r\n      }\r\n\r\n      const columns = this.providers.column.getColumns();\r\n      const sortingFunc: SortingOrderFunction = {};\r\n\r\n      for (let prop in order) {\r\n        const cmp = getComparer(\r\n          getColumnByProp(columns, prop),\r\n          order[prop],\r\n        );\r\n        sortingFunc[prop] = cmp;\r\n      }\r\n\r\n      // set sorting\r\n      this.sorting = order;\r\n      this.sortingFunc = order && sortingFunc;\r\n    });\r\n    this.addEventListener('beforeheaderclick', (e) => {\r\n      if (e.defaultPrevented) {\r\n        return;\r\n      }\r\n\r\n      if (!e.detail?.column?.sortable) {\r\n        return;\r\n      }\r\n\r\n      this.headerclick(\r\n        e.detail.column,\r\n        e.detail?.originalEvent?.shiftKey,\r\n      );\r\n    });\r\n  }\r\n\r\n  /**\r\n   * Entry point for sorting, waits for all delayes, registers jobs\r\n   */\r\n  startSorting(order?: SortingOrder, sortingFunc?: SortingOrderFunction, ignoreViewportUpdate?: boolean) {\r\n    if (!this.sortingPromise) {\r\n      // add job before render\r\n      this.revogrid.jobsBeforeRender.push(\r\n        new Promise<void>(resolve => {\r\n          this.sortingPromise = resolve;\r\n        }),\r\n      );\r\n    }\r\n    this.postponeSort(order, sortingFunc, ignoreViewportUpdate);\r\n  }\r\n\r\n\r\n  /**\r\n   * Apply sorting to data on header click\r\n   * If additive - add to existing sorting, multiple columns can be sorted\r\n   */\r\n  headerclick(column: ColumnRegular, additive: boolean) {\r\n    const columnProp = column.prop;\r\n    let order: Order = getNextOrder(this.sorting?.[columnProp]);\r\n    const beforeEvent = this.emit('beforesorting', { column, order, additive });\r\n    if (beforeEvent.defaultPrevented) {\r\n      return;\r\n    }\r\n    order = beforeEvent.detail.order;\r\n\r\n    // apply sort data\r\n    const beforeApplyEvent = this.emit('beforesortingapply', {\r\n      column: beforeEvent.detail.column,\r\n      order,\r\n      additive,\r\n    });\r\n    if (beforeApplyEvent.defaultPrevented) {\r\n      return;\r\n    }\r\n    const cmp = getComparer(beforeApplyEvent.detail.column, beforeApplyEvent.detail.order);\r\n\r\n    if (beforeApplyEvent.detail.additive && this.sorting) {\r\n      const sorting: SortingOrder = {};\r\n      const sortingFunc: SortingOrderFunction = {};\r\n\r\n      if (columnProp in sorting && size(sorting) > 1 && order === undefined) {\r\n        delete sorting[columnProp];\r\n        delete sortingFunc[columnProp];\r\n      } else {\r\n        sorting[columnProp] = order;\r\n        sortingFunc[columnProp] = cmp;\r\n      }      \r\n\r\n      this.sorting = {\r\n        ...this.sorting,\r\n        ...sorting,\r\n      };\r\n      \r\n      // extend sorting function with new sorting for multiple columns sorting\r\n      this.sortingFunc = {\r\n        ...this.sortingFunc,\r\n        ...sortingFunc,\r\n      };\r\n    } else {\r\n      if (order) {\r\n        // reset sorting\r\n        this.sorting = { [columnProp]: order };\r\n        this.sortingFunc = { [columnProp]: cmp };\r\n      } else {\r\n        delete this.sorting?.[columnProp];\r\n        delete this.sortingFunc?.[columnProp];\r\n      }\r\n    }\r\n\r\n    this.startSorting(this.sorting, this.sortingFunc);\r\n  }\r\n\r\n  runSorting(\r\n    order?: SortingOrder,\r\n    comparison?: SortingOrderFunction,\r\n    ignoreViewportUpdate?: boolean\r\n  ) {\r\n    this.sort(order, comparison, undefined, ignoreViewportUpdate);\r\n    this.sortingPromise?.();\r\n    this.sortingPromise = null;\r\n  }\r\n\r\n  /**\r\n   * Sort items by sorting function\r\n   * @requires proxyItems applied to row store\r\n   * @requires source applied to row store\r\n   *\r\n   * @param sorting - per column sorting\r\n   * @param data - this.stores['rgRow'].store.get('source')\r\n   */\r\n  sort(\r\n    sorting?: SortingOrder,\r\n    sortingFunc?: SortingOrderFunction,\r\n    types: DimensionRows[] = rowTypes,\r\n    ignoreViewportUpdate = false\r\n  ) {\r\n    // if no sorting - reset\r\n    if (!Object.keys(sorting || {}).length) {\r\n      for (let type of types) {\r\n        const storeService = this.providers.data.stores[type];\r\n        // row data\r\n        const source = storeService.store.get('source');\r\n        // row indexes\r\n        const proxyItems = storeService.store.get('proxyItems');\r\n        // row indexes\r\n        const newItemsOrder = Array.from({ length: source.length }, (_, i) => i); // recover indexes range(0, source.length)\r\n        this.providers.dimension.updateSizesPositionByNewDataIndexes(type, newItemsOrder, proxyItems);\r\n        storeService.setData({ proxyItems: newItemsOrder, source: [...source], });\r\n      }\r\n    } else {\r\n      for (let type of types) {\r\n        const storeService = this.providers.data.stores[type];\r\n        // row data\r\n        const source = storeService.store.get('source');\r\n        // row indexes\r\n        const proxyItems = storeService.store.get('proxyItems');\r\n\r\n        const newItemsOrder = sortIndexByItems(\r\n          [...proxyItems],\r\n          source,\r\n          sortingFunc,\r\n        );\r\n       \r\n        // take row indexes before trim applied and proxy items\r\n        const prevItems = storeService.store.get('items');\r\n        storeService.setData({\r\n          proxyItems: newItemsOrder,\r\n          source: [...source],\r\n        });\r\n        // take currently visible row indexes\r\n        const newItems = storeService.store.get('items');\r\n        if (!ignoreViewportUpdate) {\r\n          this.providers.dimension\r\n            .updateSizesPositionByNewDataIndexes(type, newItems, prevItems);\r\n        }\r\n      }\r\n    }\r\n    // refresh columns to redraw column headers and show correct icon\r\n    columnTypes.forEach((type) => {\r\n      this.providers.column.dataSources[type].refresh();\r\n    });\r\n    this.emit('aftersortingapply');\r\n  }\r\n}\r\n\r\n\r\n"]}

package/dist/collection/plugins/sorting/sorting.sign.js

@@ -0,0 +1,9 @@
+/*!
+ * Built by LevelSkill.Pro
+ */
+import { h } from "@stencil/core";
+export const SortingSign = ({ column }) => {
+    var _a;
+    return h("i", { class: (_a = column === null || column === void 0 ? void 0 : column.order) !== null && _a !== void 0 ? _a : 'sort-off' });
+};
+//# sourceMappingURL=sorting.sign.js.map

package/dist/collection/plugins/sorting/sorting.sign.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sorting.sign.js","sourceRoot":"","sources":["../../../src/plugins/sorting/sorting.sign.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,eAAe,CAAC;AAMlC,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,EAAE,MAAM,EAAS,EAAE,EAAE;;IAC/C,OAAO,SAAG,KAAK,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,mCAAI,UAAU,GAAI,CAAC;AACnD,CAAC,CAAC","sourcesContent":["import { h } from '@stencil/core';\r\nimport { ColumnRegular } from '@type';\r\n\r\ntype Props = {\r\n  column: ColumnRegular;\r\n};\r\nexport const SortingSign = ({ column }: Props) => {\r\n  return <i class={column?.order ?? 'sort-off'} />;\r\n};\r\n"]}

package/dist/collection/plugins/sorting/sorting.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=sorting.types.js.map

package/dist/collection/plugins/sorting/sorting.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sorting.types.js","sourceRoot":"","sources":["../../../src/plugins/sorting/sorting.types.ts"],"names":[],"mappings":"","sourcesContent":["import type { CellCompareFunc, ColumnProp, Order } from '@type';\r\n\r\nexport type SortingOrder = Record<ColumnProp, Order>;\r\nexport type SortingOrderFunction = Record<\r\n  ColumnProp,\r\n  CellCompareFunc | undefined\r\n>;\r\nexport type ColumnSetEvent = {\r\n  order: SortingOrder;\r\n};\r\n\r\nexport type SortingConfig = {\r\n  columns?: { prop: ColumnProp; order: Order; cellCompare?: CellCompareFunc }[];\r\n  additive?: boolean;\r\n};\r\n"]}

package/dist/collection/plugins/wcag/index.js

@@ -0,0 +1,84 @@
+/*!
+ * Built by LevelSkill.Pro
+ */
+import { BasePlugin } from "../base.plugin";
+/**
+ * WCAG Plugin is responsible for enhancing the accessibility features of the RevoGrid component.
+ * It ensures that the grid is fully compliant with Web Content Accessibility Guidelines (WCAG) 2.1.
+ * This plugin should be the last plugin you add, as it modifies the grid's default behavior.
+ *
+ * The WCAG Plugin performs the following tasks:
+ * - Sets the 'dir' attribute to 'ltr' for left-to-right text direction.
+ * - Sets the 'role' attribute to 'treegrid' for treelike hierarchical structure.
+ * - Sets the 'aria-keyshortcuts' attribute to 'Enter' and 'Esc' for keyboard shortcuts.
+ * - Adds event listeners for keyboard navigation and editing.
+ *
+ * By default, the plugin adds ARIA roles and properties to the grid elements, providing semantic information
+ * for assistive technologies. These roles include 'grid', 'row', and 'gridcell'. The plugin also sets
+ * ARIA attributes such as 'aria-rowindex', 'aria-colindex', and 'aria-selected'.
+ *
+ * The WCAG Plugin ensures that the grid is fully functional and usable for users with various disabilities,
+ * including visual impairments, deaf-blindness, and cognitive disabilities.
+ *
+ * Note: The WCAG Plugin should be added as the last plugin in the list of plugins, as it modifies the grid's
+ * default behavior and may conflict with other plugins if added earlier.
+ */
+export class WCAGPlugin extends BasePlugin {
+    constructor(revogrid, providers) {
+        super(revogrid, providers);
+        revogrid.setAttribute('role', 'treegrid');
+        revogrid.setAttribute('aria-keyshortcuts', 'Enter');
+        revogrid.setAttribute('aria-multiselectable', 'true');
+        revogrid.setAttribute('tabindex', '0');
+        /**
+         * Before Columns Set Event
+         */
+        this.addEventListener('beforecolumnsset', ({ detail }) => {
+            const columns = [
+                ...detail.columns.colPinStart,
+                ...detail.columns.rgCol,
+                ...detail.columns.colPinEnd,
+            ];
+            revogrid.setAttribute('aria-colcount', `${columns.length}`);
+            columns.forEach((column, index) => {
+                const { columnProperties, cellProperties } = column;
+                column.columnProperties = (...args) => {
+                    const result = (columnProperties === null || columnProperties === void 0 ? void 0 : columnProperties(...args)) || {};
+                    result.role = 'columnheader';
+                    result['aria-colindex'] = `${index}`;
+                    return result;
+                };
+                column.cellProperties = (...args) => {
+                    const wcagProps = {
+                        ['role']: 'gridcell',
+                        ['aria-colindex']: `${index}`,
+                        ['aria-rowindex']: `${args[0].rowIndex}`,
+                        ['tabindex']: -1,
+                    };
+                    const columnProps = (cellProperties === null || cellProperties === void 0 ? void 0 : cellProperties(...args)) || {};
+                    return Object.assign(Object.assign({}, wcagProps), columnProps);
+                };
+            });
+        });
+        /**
+         * Before Row Set Event
+         */
+        this.addEventListener('beforesourceset', ({ detail, }) => {
+            revogrid.setAttribute('aria-rowcount', `${detail.source.length}`);
+        });
+        this.addEventListener('beforerowrender', ({ detail, }) => {
+            detail.node.$attrs$ = Object.assign(Object.assign({}, detail.node.$attrs$), { role: 'row', ['aria-rowindex']: detail.item.itemIndex });
+        });
+        // focuscell
+        this.addEventListener('afterfocus', async (e) => {
+            if (e.defaultPrevented) {
+                return;
+            }
+            const el = this.revogrid.querySelector(`revogr-data[type="${e.detail.rowType}"][col-type="${e.detail.colType}"] [data-rgrow="${e.detail.rowIndex}"][data-rgcol="${e.detail.colIndex}"]`);
+            if (el instanceof HTMLElement) {
+                el.focus();
+            }
+        });
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/collection/plugins/wcag/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/plugins/wcag/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAG5C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAO,UAAW,SAAQ,UAAU;IACxC,YAAY,QAA6B,EAAE,SAA0B;QACnE,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAE3B,QAAQ,CAAC,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAC1C,QAAQ,CAAC,YAAY,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;QACpD,QAAQ,CAAC,YAAY,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;QACtD,QAAQ,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QAEvC;;WAEG;QACH,IAAI,CAAC,gBAAgB,CACnB,kBAAkB,EAClB,CAAC,EAAE,MAAM,EAAiC,EAAE,EAAE;YAC5C,MAAM,OAAO,GAAG;gBACd,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW;gBAC7B,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK;gBACvB,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS;aAC5B,CAAC;YAEF,QAAQ,CAAC,YAAY,CAAC,eAAe,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;YAE5D,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;gBAChC,MAAM,EAAE,gBAAgB,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;gBAEpD,MAAM,CAAC,gBAAgB,GAAG,CAAC,GAAG,IAAI,EAAE,EAAE;oBACpC,MAAM,MAAM,GAAG,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAG,GAAG,IAAI,CAAC,KAAI,EAAE,CAAC;oBAEjD,MAAM,CAAC,IAAI,GAAG,cAAc,CAAC;oBAC7B,MAAM,CAAC,eAAe,CAAC,GAAG,GAAG,KAAK,EAAE,CAAC;oBAErC,OAAO,MAAM,CAAC;gBAChB,CAAC,CAAC;gBAEF,MAAM,CAAC,cAAc,GAAG,CAAC,GAAG,IAAI,EAAE,EAAE;oBAClC,MAAM,SAAS,GAAc;wBAC3B,CAAC,MAAM,CAAC,EAAE,UAAU;wBACpB,CAAC,eAAe,CAAC,EAAE,GAAG,KAAK,EAAE;wBAC7B,CAAC,eAAe,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;wBACxC,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;qBACjB,CAAC;oBACF,MAAM,WAAW,GAAc,CAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAG,GAAG,IAAI,CAAC,KAAI,EAAE,CAAC;oBAE/D,uCACK,SAAS,GACT,WAAW,EACd;gBACJ,CAAC,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CACF,CAAC;QAEF;;WAEG;QACH,IAAI,CAAC,gBAAgB,CACnB,iBAAiB,EACjB,CAAC,EACC,MAAM,GACsD,EAAE,EAAE;YAChE,QAAQ,CAAC,YAAY,CAAC,eAAe,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QACpE,CAAC,CACF,CAAC;QACF,IAAI,CAAC,gBAAgB,CACnB,iBAAiB,EACjB,CAAC,EACC,MAAM,GACwD,EAAE,EAAE;YAClE,MAAM,CAAC,IAAI,CAAC,OAAO,mCACd,MAAM,CAAC,IAAI,CAAC,OAAO,KACtB,IAAI,EAAE,KAAK,EACX,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,GACzC,CAAC;QACJ,CAAC,CACF,CAAC;QAEF,YAAY;QACZ,IAAI,CAAC,gBAAgB,CACnB,YAAY,EACZ,KAAK,EACH,CAA4D,EAC5D,EAAE;YACF,IAAI,CAAC,CAAC,gBAAgB,EAAE,CAAC;gBACvB,OAAO;YACT,CAAC;YACD,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,CACpC,qBAAqB,CAAC,CAAC,MAAM,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,QAAQ,kBAAkB,CAAC,CAAC,MAAM,CAAC,QAAQ,IAAI,CACjJ,CAAC;YACF,IAAI,EAAE,YAAY,WAAW,EAAE,CAAC;gBAC9B,EAAE,CAAC,KAAK,EAAE,CAAC;YACb,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC;CACF","sourcesContent":["import { CellProps, PluginProviders } from '@type';\r\nimport { BasePlugin } from '../base.plugin';\r\nimport { ColumnCollection } from 'src/utils';\r\n\r\n/**\r\n * WCAG Plugin is responsible for enhancing the accessibility features of the RevoGrid component.\r\n * It ensures that the grid is fully compliant with Web Content Accessibility Guidelines (WCAG) 2.1.\r\n * This plugin should be the last plugin you add, as it modifies the grid's default behavior.\r\n *\r\n * The WCAG Plugin performs the following tasks:\r\n * - Sets the 'dir' attribute to 'ltr' for left-to-right text direction.\r\n * - Sets the 'role' attribute to 'treegrid' for treelike hierarchical structure.\r\n * - Sets the 'aria-keyshortcuts' attribute to 'Enter' and 'Esc' for keyboard shortcuts.\r\n * - Adds event listeners for keyboard navigation and editing.\r\n *\r\n * By default, the plugin adds ARIA roles and properties to the grid elements, providing semantic information\r\n * for assistive technologies. These roles include 'grid', 'row', and 'gridcell'. The plugin also sets\r\n * ARIA attributes such as 'aria-rowindex', 'aria-colindex', and 'aria-selected'.\r\n *\r\n * The WCAG Plugin ensures that the grid is fully functional and usable for users with various disabilities,\r\n * including visual impairments, deaf-blindness, and cognitive disabilities.\r\n *\r\n * Note: The WCAG Plugin should be added as the last plugin in the list of plugins, as it modifies the grid's\r\n * default behavior and may conflict with other plugins if added earlier.\r\n */\r\nexport class WCAGPlugin extends BasePlugin {\r\n  constructor(revogrid: HTMLRevoGridElement, providers: PluginProviders) {\r\n    super(revogrid, providers);\r\n\r\n    revogrid.setAttribute('role', 'treegrid');\r\n    revogrid.setAttribute('aria-keyshortcuts', 'Enter');\r\n    revogrid.setAttribute('aria-multiselectable', 'true');\r\n    revogrid.setAttribute('tabindex', '0');\r\n\r\n    /**\r\n     * Before Columns Set Event\r\n     */\r\n    this.addEventListener(\r\n      'beforecolumnsset',\r\n      ({ detail }: CustomEvent<ColumnCollection>) => {\r\n        const columns = [\r\n          ...detail.columns.colPinStart,\r\n          ...detail.columns.rgCol,\r\n          ...detail.columns.colPinEnd,\r\n        ];\r\n\r\n        revogrid.setAttribute('aria-colcount', `${columns.length}`);\r\n\r\n        columns.forEach((column, index) => {\r\n          const { columnProperties, cellProperties } = column;\r\n\r\n          column.columnProperties = (...args) => {\r\n            const result = columnProperties?.(...args) || {};\r\n\r\n            result.role = 'columnheader';\r\n            result['aria-colindex'] = `${index}`;\r\n\r\n            return result;\r\n          };\r\n\r\n          column.cellProperties = (...args) => {\r\n            const wcagProps: CellProps = {\r\n              ['role']: 'gridcell',\r\n              ['aria-colindex']: `${index}`,\r\n              ['aria-rowindex']: `${args[0].rowIndex}`,\r\n              ['tabindex']: -1,\r\n            };\r\n            const columnProps: CellProps = cellProperties?.(...args) || {};\r\n\r\n            return {\r\n              ...wcagProps,\r\n              ...columnProps,\r\n            };\r\n          };\r\n        });\r\n      },\r\n    );\r\n\r\n    /**\r\n     * Before Row Set Event\r\n     */\r\n    this.addEventListener(\r\n      'beforesourceset',\r\n      ({\r\n        detail,\r\n      }: CustomEvent<HTMLRevoGridElementEventMap['beforesourceset']>) => {\r\n        revogrid.setAttribute('aria-rowcount', `${detail.source.length}`);\r\n      },\r\n    );\r\n    this.addEventListener(\r\n      'beforerowrender',\r\n      ({\r\n        detail,\r\n      }: CustomEvent<HTMLRevogrDataElementEventMap['beforerowrender']>) => {\r\n        detail.node.$attrs$ = {\r\n          ...detail.node.$attrs$,\r\n          role: 'row',\r\n          ['aria-rowindex']: detail.item.itemIndex,\r\n        };\r\n      },\r\n    );\r\n\r\n    // focuscell\r\n    this.addEventListener(\r\n      'afterfocus',\r\n      async (\r\n        e: CustomEvent<HTMLRevogrFocusElementEventMap['afterfocus']>,\r\n      ) => {\r\n        if (e.defaultPrevented) {\r\n          return;\r\n        }\r\n        const el = this.revogrid.querySelector(\r\n          `revogr-data[type=\"${e.detail.rowType}\"][col-type=\"${e.detail.colType}\"] [data-rgrow=\"${e.detail.rowIndex}\"][data-rgcol=\"${e.detail.colIndex}\"]`,\r\n        );\r\n        if (el instanceof HTMLElement) {\r\n          el.focus();\r\n        }\r\n      },\r\n    );\r\n  }\r\n}\r\n"]}