@equinor/eds-data-grid-react 0.7.2 → 0.7.4

package/dist/eds-data-grid-react.cjs

@@ -8,6 +8,7 @@ var styled = require('styled-components');
 var jsxRuntime = require('react/jsx-runtime');
 var edsIcons = require('@equinor/eds-icons');
 var edsTokens = require('@equinor/eds-tokens');
+var edsUtils = require('@equinor/eds-utils');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
@@ -535,7 +536,7 @@ function logDevelopmentWarningOfPropUse(deprecatedProps) {
 }
 
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
-function EdsDataGrid({
+function EdsDataGridInner({
   rows,
   columns,
   columnResizeMode,
@@ -580,6 +581,7 @@ function EdsDataGrid({
   height,
   getRowId,
   rowVirtualizerInstanceRef,
+  tableInstanceRef,
   columnSizing,
   onColumnResize,
   expansionState,
@@ -592,7 +594,7 @@ function EdsDataGrid({
   enableFooter,
   enableSortingRemoval,
   ...rest
-}) {
+}, ref) {
   logDevelopmentWarningOfPropUse({
     virtualHeight: {
       value: virtualHeight,
@@ -806,6 +808,9 @@ function EdsDataGrid({
     }));
   }, [pageSize]);
   const table = reactTable.useReactTable(options);
+  if (tableInstanceRef) {
+    tableInstanceRef.current = table;
+  }
   let tableWrapperStyle = {};
 
   /**
@@ -820,6 +825,7 @@ function EdsDataGrid({
     };
   }
   const parentRef = react.useRef(null);
+  const combinedRef = react.useMemo(() => edsUtils.mergeRefs(parentRef, ref), [parentRef, ref]);
 
   /**
    * Virtualization setup
@@ -868,7 +874,7 @@ function EdsDataGrid({
         ...rest.style,
         ...tableWrapperStyle
       },
-      ref: parentRef,
+      ref: combinedRef,
       $height: height,
       $width: width,
       $scrollbarHorizontal: scrollbarHorizontal,
@@ -978,6 +984,7 @@ const TableWrapper = styled__default.default.div.withConfig({
   $height,
   $width
 }) => Boolean($height) && Boolean($width) ? 'strict' : 'unset');
+const EdsDataGrid = /*#__PURE__*/react.forwardRef(EdsDataGridInner);
 
 Object.defineProperty(exports, "createColumnHelper", {
   enumerable: true,

package/dist/esm/EdsDataGrid.js

@@ -1,17 +1,18 @@
 import { Typography, useEds, Table, Pagination } from '@equinor/eds-core-react';
 import { getExpandedRowModel, getCoreRowModel, getSortedRowModel, getFacetedRowModel, getFacetedUniqueValues, getFacetedMinMaxValues, getFilteredRowModel, getPaginationRowModel, useReactTable } from '@tanstack/react-table';
 import { useVirtualizer } from '@tanstack/react-virtual';
-import { useState, useEffect, useMemo, useRef, useCallback } from 'react';
+import { forwardRef, useState, useEffect, useMemo, useRef, useCallback } from 'react';
 import styled from 'styled-components';
 import { TableProvider } from './EdsDataGridContext.js';
 import { TableHeaderRow } from './components/TableHeaderRow.js';
 import { TableFooterRow } from './components/TableFooterRow.js';
 import { TableRow } from './components/TableRow.js';
 import { addPxSuffixIfInputHasNoPrefix, logDevelopmentWarningOfPropUse } from './utils.js';
+import { mergeRefs } from '@equinor/eds-utils';
 import { jsx, jsxs, Fragment } from 'react/jsx-runtime';
 
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
-function EdsDataGrid({
+function EdsDataGridInner({
   rows,
   columns,
   columnResizeMode,
@@ -56,6 +57,7 @@ function EdsDataGrid({
   height,
   getRowId,
   rowVirtualizerInstanceRef,
+  tableInstanceRef,
   columnSizing,
   onColumnResize,
   expansionState,
@@ -68,7 +70,7 @@ function EdsDataGrid({
   enableFooter,
   enableSortingRemoval,
   ...rest
-}) {
+}, ref) {
   logDevelopmentWarningOfPropUse({
     virtualHeight: {
       value: virtualHeight,
@@ -282,6 +284,9 @@ function EdsDataGrid({
     }));
   }, [pageSize]);
   const table = useReactTable(options);
+  if (tableInstanceRef) {
+    tableInstanceRef.current = table;
+  }
   let tableWrapperStyle = {};
 
   /**
@@ -296,6 +301,7 @@ function EdsDataGrid({
     };
   }
   const parentRef = useRef(null);
+  const combinedRef = useMemo(() => mergeRefs(parentRef, ref), [parentRef, ref]);
 
   /**
    * Virtualization setup
@@ -344,7 +350,7 @@ function EdsDataGrid({
         ...rest.style,
         ...tableWrapperStyle
       },
-      ref: parentRef,
+      ref: combinedRef,
       $height: height,
       $width: width,
       $scrollbarHorizontal: scrollbarHorizontal,
@@ -454,5 +460,6 @@ const TableWrapper = styled.div.withConfig({
   $height,
   $width
 }) => Boolean($height) && Boolean($width) ? 'strict' : 'unset');
+const EdsDataGrid = /*#__PURE__*/forwardRef(EdsDataGridInner);
 
 export { EdsDataGrid };

package/dist/types/EdsDataGrid.d.ts

@@ -1,3 +1,7 @@
-import { HTMLAttributes } from 'react';
+import { HTMLAttributes, ForwardedRef } from 'react';
 import { EdsDataGridProps } from './EdsDataGridProps';
-export declare function EdsDataGrid<T>({ rows, columns, columnResizeMode, pageSize, rowSelection, enableRowSelection, enableMultiRowSelection, enableSubRowSelection, selectedRows, rowSelectionState, enableColumnFiltering, debug, enablePagination, enableSorting, stickyHeader, stickyFooter, onSelectRow, onRowSelectionChange, caption, enableVirtual, virtualHeight, columnVisibility, columnVisibilityChange, emptyMessage, columnOrder, cellClass, cellStyle, rowClass, rowStyle, headerClass, headerStyle, footerClass, footerStyle, externalPaginator, onSortingChange, manualSorting, sortingState, columnPinState, scrollbarHorizontal, width, minWidth, height, getRowId, rowVirtualizerInstanceRef, columnSizing, onColumnResize, expansionState, setExpansionState, getSubRows, defaultColumn, onRowContextMenu, onRowClick, onCellClick, enableFooter, enableSortingRemoval, ...rest }: EdsDataGridProps<T> & HTMLAttributes<HTMLDivElement>): import("react/jsx-runtime").JSX.Element;
+declare function EdsDataGridInner<T>({ rows, columns, columnResizeMode, pageSize, rowSelection, enableRowSelection, enableMultiRowSelection, enableSubRowSelection, selectedRows, rowSelectionState, enableColumnFiltering, debug, enablePagination, enableSorting, stickyHeader, stickyFooter, onSelectRow, onRowSelectionChange, caption, enableVirtual, virtualHeight, columnVisibility, columnVisibilityChange, emptyMessage, columnOrder, cellClass, cellStyle, rowClass, rowStyle, headerClass, headerStyle, footerClass, footerStyle, externalPaginator, onSortingChange, manualSorting, sortingState, columnPinState, scrollbarHorizontal, width, minWidth, height, getRowId, rowVirtualizerInstanceRef, tableInstanceRef, columnSizing, onColumnResize, expansionState, setExpansionState, getSubRows, defaultColumn, onRowContextMenu, onRowClick, onCellClick, enableFooter, enableSortingRemoval, ...rest }: EdsDataGridProps<T> & HTMLAttributes<HTMLDivElement>, ref: ForwardedRef<HTMLDivElement>): import("react/jsx-runtime").JSX.Element;
+export declare const EdsDataGrid: <T>(props: EdsDataGridProps<T> & HTMLAttributes<HTMLDivElement> & {
+    ref?: ForwardedRef<HTMLDivElement>;
+}) => ReturnType<typeof EdsDataGridInner>;
+export {};

package/dist/types/EdsDataGridProps.d.ts

@@ -1,4 +1,4 @@
-import { Cell, Column, ColumnDef, ColumnPinningState, ColumnResizeMode, ColumnSizingState, ExpandedState, OnChangeFn, Row, RowSelectionState, SortingState, TableOptions } from '@tanstack/react-table';
+import { Cell, Column, ColumnDef, ColumnPinningState, ColumnResizeMode, ColumnSizingState, ExpandedState, OnChangeFn, Row, RowSelectionState, SortingState, Table, TableOptions } from '@tanstack/react-table';
 import { Virtualizer } from '@tanstack/react-virtual';
 import { CSSProperties, MouseEvent, MutableRefObject, ReactElement } from 'react';
 type BaseProps<T> = {
@@ -272,15 +272,16 @@ type ColumnProps = {
     columnSizing?: ColumnSizingState;
     onColumnResize?: (e: ColumnSizingState) => void;
 };
-type RefProps = {
+type RefProps<T> = {
     rowVirtualizerInstanceRef?: MutableRefObject<Virtualizer<HTMLDivElement, Element> | null>;
+    tableInstanceRef?: MutableRefObject<Table<T> | null>;
 };
 type ExpansionProps<T> = {
     expansionState?: ExpandedState;
     setExpansionState?: React.Dispatch<React.SetStateAction<ExpandedState>>;
     getSubRows?: (row: T, rowIndex: number) => Array<T>;
 };
-export type EdsDataGridProps<T> = BaseProps<T> & RowSelectionProps<T> & StyleProps<T> & HandlersProps<T> & SortProps & FilterProps & PagingProps & ColumnProps & VirtualProps & RefProps & ExpansionProps<T> & {
+export type EdsDataGridProps<T> = BaseProps<T> & RowSelectionProps<T> & StyleProps<T> & HandlersProps<T> & SortProps & FilterProps & PagingProps & ColumnProps & VirtualProps & RefProps<T> & ExpansionProps<T> & {
     /**
      * Which columns are visible. If not set, all columns are visible. undefined means that the column is visible.
      * @default undefined

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/eds-data-grid-react",
-  "version": "0.7.2",
+  "version": "0.7.4",
   "description": "A feature-rich data-grid written in React, implementing the Equinor Design System",
   "license": "MIT",
   "types": "dist/types/index.d.ts",
@@ -23,8 +23,8 @@
     "@tanstack/react-table": "^8.20.1",
     "@tanstack/react-virtual": "^3.10.8",
     "@equinor/eds-icons": "^0.21.0",
-    "@equinor/eds-tokens": "0.9.2",
-    "@equinor/eds-utils": "^0.8.5"
+    "@equinor/eds-utils": "^0.8.5",
+    "@equinor/eds-tokens": "0.9.2"
   },
   "devDependencies": {
     "@rollup/plugin-babel": "^6.0.4",