@revolist/revogrid 4.9.6 → 4.9.8

package/dist/types/components.d.ts

@@ -5,7 +5,7 @@
  * It contains typing information for all components that exist in this project.
  */
 import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
-import { AfterEditEvent, AllDimensionType, ApplyFocusEvent, BeforeCellRenderEvent, BeforeEdit, BeforeRangeSaveDataDetails, BeforeRowRenderEvent, BeforeSaveDataDetails, Cell, ChangedRange, ColumnDataSchemaModel, ColumnGrouping, ColumnProp, ColumnRegular, ColumnType, DataFormat, DataType, DimensionCols, DimensionRows, DimensionSettingsState, DimensionType, DimensionTypeCol, DragStartEvent, EditCell, EditorCtr, Editors, ElementScroll, FocusRenderEvent, FocusTemplateFunc, InitialHeaderClick, MultiDimensionType, Nullable, PluginBaseComponent, PositionItem, RangeArea, RangeClipboardCopyEventProps, RangeClipboardPasteEvent, RowDefinition, RowHeaders, SaveDataDetails, SelectionStoreState, TempRange, Theme, ViewportData, ViewPortResizeEvent, ViewPortScrollEvent, ViewportState, ViewSettingSizeProp } from "./types/index";
+import { AfterEditEvent, AllDimensionType, ApplyFocusEvent, BeforeCellRenderEvent, BeforeEdit, BeforeRangeSaveDataDetails, BeforeRowRenderEvent, BeforeSaveDataDetails, Cell, ChangedRange, ColumnDataSchemaModel, ColumnGrouping, ColumnProp, ColumnRegular, ColumnType, DataFormat, DataType, DimensionCols, DimensionRows, DimensionSettingsState, DimensionType, DimensionTypeCol, DragStartEvent, EditCell, EditorCtr, Editors, ElementScroll, FocusAfterRenderEvent, FocusRenderEvent, FocusTemplateFunc, InitialHeaderClick, MultiDimensionType, Nullable, PluginBaseComponent, PositionItem, RangeArea, RangeClipboardCopyEventProps, RangeClipboardPasteEvent, RowDefinition, RowHeaders, SaveDataDetails, SelectionStoreState, TempRange, Theme, ViewportData, ViewPortResizeEvent, ViewPortScrollEvent, ViewportState, ViewSettingSizeProp } from "./types/index";
 import { GridPlugin } from "./plugins/base.plugin";
 import { AutoSizeColumnConfig } from "./plugins/column.auto-size.plugin";
 import { ColumnFilterConfig, FilterCaptions, FilterCollection } from "./plugins/filter/filter.plugin";
@@ -21,7 +21,7 @@ import { LogicFunction } from "./plugins/filter/filter.types";
 import { ResizeProps } from "./components/header/resizable.directive";
 import { Cell as Cell1, ColumnRegular as ColumnRegular1, DataType as DataType1, DimensionCols as DimensionCols1, DimensionRows as DimensionRows1, DimensionSettingsState as DimensionSettingsState1, Observable as Observable1, SelectionStoreState as SelectionStoreState1 } from "./components";
 import { EventData } from "./components/overlay/selection.utils";
-export { AfterEditEvent, AllDimensionType, ApplyFocusEvent, BeforeCellRenderEvent, BeforeEdit, BeforeRangeSaveDataDetails, BeforeRowRenderEvent, BeforeSaveDataDetails, Cell, ChangedRange, ColumnDataSchemaModel, ColumnGrouping, ColumnProp, ColumnRegular, ColumnType, DataFormat, DataType, DimensionCols, DimensionRows, DimensionSettingsState, DimensionType, DimensionTypeCol, DragStartEvent, EditCell, EditorCtr, Editors, ElementScroll, FocusRenderEvent, FocusTemplateFunc, InitialHeaderClick, MultiDimensionType, Nullable, PluginBaseComponent, PositionItem, RangeArea, RangeClipboardCopyEventProps, RangeClipboardPasteEvent, RowDefinition, RowHeaders, SaveDataDetails, SelectionStoreState, TempRange, Theme, ViewportData, ViewPortResizeEvent, ViewPortScrollEvent, ViewportState, ViewSettingSizeProp } from "./types/index";
+export { AfterEditEvent, AllDimensionType, ApplyFocusEvent, BeforeCellRenderEvent, BeforeEdit, BeforeRangeSaveDataDetails, BeforeRowRenderEvent, BeforeSaveDataDetails, Cell, ChangedRange, ColumnDataSchemaModel, ColumnGrouping, ColumnProp, ColumnRegular, ColumnType, DataFormat, DataType, DimensionCols, DimensionRows, DimensionSettingsState, DimensionType, DimensionTypeCol, DragStartEvent, EditCell, EditorCtr, Editors, ElementScroll, FocusAfterRenderEvent, FocusRenderEvent, FocusTemplateFunc, InitialHeaderClick, MultiDimensionType, Nullable, PluginBaseComponent, PositionItem, RangeArea, RangeClipboardCopyEventProps, RangeClipboardPasteEvent, RowDefinition, RowHeaders, SaveDataDetails, SelectionStoreState, TempRange, Theme, ViewportData, ViewPortResizeEvent, ViewPortScrollEvent, ViewportState, ViewSettingSizeProp } from "./types/index";
 export { GridPlugin } from "./plugins/base.plugin";
 export { AutoSizeColumnConfig } from "./plugins/column.auto-size.plugin";
 export { ColumnFilterConfig, FilterCaptions, FilterCollection } from "./plugins/filter/filter.plugin";
@@ -52,6 +52,11 @@ export namespace Components {
      * @example focus-rgCol-rgRow - focus layer for main data. Applies extra elements in <revogr-focus />.
      */
     interface RevoGrid {
+        /**
+          * Enable accessibility. If disabled, the grid will not be accessible.
+          * @default true
+         */
+        "accessible": boolean;
         /**
           * Add trimmed by type
          */
@@ -745,10 +750,7 @@ declare global {
         "afteredit": AfterEditEvent;
         "beforeautofill": ChangedRange;
         "beforerange": ChangedRange;
-        "afterfocus": {
-    model: any;
-    column: ColumnRegular;
-  };
+        "afterfocus": FocusAfterRenderEvent;
         "roworderchanged": { from: number; to: number };
         "beforesortingapply": {
     column: ColumnRegular;
@@ -898,7 +900,7 @@ declare global {
     interface HTMLRevogrDataElementEventMap {
         "beforerowrender": BeforeRowRenderEvent;
         "afterrender": { type: DimensionRows };
-        "beforecellrender": BeforeCellRenderEvent;
+        "beforecellrender": BeforeCellRenderEvent<ColumnDataSchemaModel>;
         "dragstartcell": DragStartEvent;
     }
     /**
@@ -962,10 +964,7 @@ declare global {
     interface HTMLRevogrFocusElementEventMap {
         "beforefocusrender": FocusRenderEvent;
         "beforescrollintoview": { el: HTMLElement };
-        "afterfocus": {
-    model: any;
-    column: ColumnRegular;
-  };
+        "afterfocus": FocusAfterRenderEvent;
     }
     /**
      * Focus component. Shows focus layer around the cell that is currently in focus.
@@ -1207,6 +1206,11 @@ declare namespace LocalJSX {
      * @example focus-rgCol-rgRow - focus layer for main data. Applies extra elements in <revogr-focus />.
      */
     interface RevoGrid {
+        /**
+          * Enable accessibility. If disabled, the grid will not be accessible.
+          * @default true
+         */
+        "accessible"?: boolean;
         /**
           * Additional data to be passed to plugins, renders or editors. For example if you need to pass Vue component instance.
          */
@@ -1308,12 +1312,9 @@ declare namespace LocalJSX {
          */
         "onAfteredit"?: (event: RevoGridCustomEvent<AfterEditEvent>) => void;
         /**
-          * Triggered after focus render finished. Can be used to access a focus element through `event.target`
+          * Triggered after focus render finished. Can be used to access a focus element through `event.target`. This is just a duplicate of `afterfocus` from `revogr-focus.tsx`.
          */
-        "onAfterfocus"?: (event: RevoGridCustomEvent<{
-    model: any;
-    column: ColumnRegular;
-  }>) => void;
+        "onAfterfocus"?: (event: RevoGridCustomEvent<FocusAfterRenderEvent>) => void;
         /**
           * Emmited after the grid is initialized. Connected to the DOM.
          */
@@ -1632,7 +1633,7 @@ declare namespace LocalJSX {
         /**
           * Before each cell render function. Allows to override cell properties
          */
-        "onBeforecellrender"?: (event: RevogrDataCustomEvent<BeforeCellRenderEvent>) => void;
+        "onBeforecellrender"?: (event: RevogrDataCustomEvent<BeforeCellRenderEvent<ColumnDataSchemaModel>>) => void;
         /**
           * Before each row render
          */
@@ -1746,10 +1747,7 @@ declare namespace LocalJSX {
         /**
           * Used to setup properties after focus was rendered
          */
-        "onAfterfocus"?: (event: RevogrFocusCustomEvent<{
-    model: any;
-    column: ColumnRegular;
-  }>) => void;
+        "onAfterfocus"?: (event: RevogrFocusCustomEvent<FocusAfterRenderEvent>) => void;
         /**
           * Before focus render event. Can be prevented by event.preventDefault(). If preventDefault used slot will be rendered.
          */

package/dist/types/plugins/groupingRow/grouping.service.d.ts

@@ -1,4 +1,5 @@
 import { DataType, ColumnProp, ColumnRegular } from "../../types/index";
+import { GROUP_DEPTH, GROUP_EXPANDED, PSEUDO_GROUP_ITEM, PSEUDO_GROUP_ITEM_VALUE } from './grouping.const';
 import { GroupLabelTemplateFunc } from './grouping.row.types';
 export type ExpandedOptions = {
     prevExpanded?: Record<string, boolean>;
@@ -12,7 +13,7 @@ export type ExpandedOptions = {
  * @param groupIds - ids of groups
  * @param expanded - potentially expanded items if present
  */
-export declare function gatherGrouping(array: DataType[], groupIds: ColumnProp[], { prevExpanded, expandedAll, getGroupValue }: ExpandedOptions): {
+export declare function gatherGrouping(array: DataType[], groupIds: ColumnProp[], { prevExpanded, expandedAll, getGroupValue, }: ExpandedOptions): {
     sourceWithGroups: DataType[];
     depth: number;
     trimmed: Record<number, boolean>;
@@ -20,8 +21,15 @@ export declare function gatherGrouping(array: DataType[], groupIds: ColumnProp[]
     childrenByGroup: Record<string, number[]>;
 };
 export declare function getGroupingName(rgRow?: DataType): any;
-export declare function isGrouping(rgRow?: DataType): boolean | undefined;
+type GroupingItem = {
+    [PSEUDO_GROUP_ITEM]: string;
+    [GROUP_EXPANDED]: boolean;
+    [PSEUDO_GROUP_ITEM_VALUE]: string;
+    [GROUP_DEPTH]: number;
+};
+export declare function isGrouping(rgRow?: DataType): rgRow is GroupingItem;
 export declare function isGroupingColumn(column?: ColumnRegular): boolean | undefined;
 export declare function measureEqualDepth<T>(groupA: T[], groupB: T[]): number;
 export declare function getParsedGroup(id: string): any[] | null;
 export declare function isSameGroup(currentGroup: any[], currentModel: DataType, nextModel: DataType): boolean;
+export {};

package/dist/types/plugins/wcag/index.d.ts

@@ -0,0 +1,26 @@
+import { PluginProviders } from "../../types/index";
+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 declare class WCAGPlugin extends BasePlugin {
+    constructor(revogrid: HTMLRevoGridElement, providers: PluginProviders);
+}

package/dist/types/services/data.provider.d.ts

@@ -17,7 +17,7 @@ export declare class DataProvider {
         groups?: Groups;
         customRenderer?: GroupLabelTemplateFunc;
     }, silent?: boolean): DataType[];
-    getModel(virtualIndex: number, type?: DimensionRows): any;
+    getModel(virtualIndex: number, type?: DimensionRows): DataType;
     setCellData({ type, rowIndex, prop, val }: BeforeSaveDataDetails, mutate?: boolean): void;
     setRangeData(data: DataLookup, type: DimensionRows): void;
     refresh(type?: DimensionRows | 'all'): void;

package/dist/types/store/dataSource/data.store.d.ts

@@ -51,14 +51,14 @@ export declare function getVisibleSourceItem(store: Observable<DSourceState<any,
  * @param store - store to process
  * @param virtualIndex - virtual index to process
  */
-export declare const getSourceItem: (store: Observable<DSourceState<any, any>>, virtualIndex: number) => any | undefined;
+export declare const getSourceItem: <T1 extends GDataType, T2 extends GDimension>(store: Observable<DSourceState<T1, T2>>, virtualIndex: number) => T1;
 /**
  * Apple item/model/row value to data source
  * @param store  - data source with changes
  * @param modelByIndex - collection of rows/values with virtual indexes to setup/replace in store/data source
  * @param mutate - if true, store will be mutated and whole viewport will be re-rendered
  */
-export declare function setSourceByVirtualIndex<T extends GDataType>(store: Observable<DSourceState<T, any>>, modelByIndex: Record<number, T>, mutate?: boolean): void;
+export declare function setSourceByVirtualIndex<T extends GDataType>(store: Observable<DSourceState<T, any>>, modelByIndex: Record<number, T | undefined>, mutate?: boolean): void;
 /**
  * set item to source
  * @param store  - store to process

package/dist/types/types/interfaces.d.ts

@@ -654,6 +654,18 @@ export interface FocusRenderEvent extends AllDimensionType {
      */
     next?: Partial<Cell>;
 }
+export interface FocusAfterRenderEvent extends AllDimensionType {
+    model?: any;
+    column?: ColumnRegular;
+    /**
+     * Index of the row in the viewport
+     */
+    rowIndex: number;
+    /**
+     * Index of the column in the viewport
+     */
+    colIndex: number;
+}
 /**
  * Represents the event object that is emitted when scrolling occurs.
  * The `type` property indicates the type of dimension (row or column) being scrolled.
@@ -674,9 +686,7 @@ export type ScrollCoordinateEvent = {
 /** Range paste. */
 export type RangeClipboardPasteEvent = {
     data: DataLookup;
-    models: {
-        [rowIndex: number]: DataType;
-    };
+    models: Partial<DataLookup>;
     range: RangeArea | null;
 } & AllDimensionType;
 /** Range copy. */

package/dist/types/types/selection.d.ts

@@ -102,9 +102,7 @@ export type BeforeSaveDataDetails = {
 };
 export type BeforeRangeSaveDataDetails = {
     data: DataLookup;
-    models: {
-        [rowIndex: number]: DataType;
-    };
+    models: Partial<DataLookup>;
     type: DimensionRows;
 };
 export type AfterEditEvent = BeforeRangeSaveDataDetails | BeforeSaveDataDetails;