@equinor/eds-data-grid-react 0.2.0 → 0.3.0

package/dist/types/EdsDataGridProps.d.ts

@@ -1,5 +1,6 @@
-import { Column, ColumnDef, ColumnPinningState, ColumnResizeMode, OnChangeFn, Row, RowSelectionState, SortingState } from '@tanstack/react-table';
-import { CSSProperties, ReactElement } from 'react';
+import { Column, ColumnDef, ColumnPinningState, ColumnResizeMode, ColumnSizingState, OnChangeFn, Row, RowSelectionState, SortingState, TableOptions } from '@tanstack/react-table';
+import { Virtualizer } from '@tanstack/react-virtual';
+import { CSSProperties, MutableRefObject, ReactElement } from 'react';
 type BaseProps<T> = {
     /**
      * The rows to display in the table
@@ -57,14 +58,32 @@ type BaseProps<T> = {
     scrollbarHorizontal?: boolean;
     /**
      * Width of the table. Only takes effect if {@link scrollbarHorizontal} is true.
+     *
+     * No suffix (like `px` or `rem`) equals to `px`.
      * @default 800
      */
-    width?: number;
+    width?: string | number;
+    /**
+     * Min width of the table element.
+     *
+     * @example minWidth: 800
+     * @default none
+     */
+    minWidth?: string | number;
     /**
      * Height of the table.
+     *
+     * No suffix (like `px` or `rem`) equals to `px`.
      * @default none
      */
-    height?: number;
+    height?: string | number;
+    /**
+     * This optional function is used to derive a unique ID for any given row. If not provided the rows index is used (nested rows join together with `.` using their grandparents' index eg. `index.index.index`). If you need to identify individual rows that are originating from any server-side operations, it's suggested you use this function to return an ID that makes sense regardless of network IO/ambiguity eg. a userId, taskId, database ID field, etc.
+     * @example getRowId: row => row.userId
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#getrowid)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+     */
+    getRowId?: TableOptions<T>['getRowId'];
 };
 type StyleProps<T> = {
     /**
@@ -162,8 +181,13 @@ type SortProps = {
 };
 type ColumnProps = {
     columnPinState?: ColumnPinningState;
+    columnSizing?: ColumnSizingState;
+    onColumnResize?: (e: ColumnSizingState) => void;
+};
+type RefProps = {
+    rowVirtualizerInstanceRef?: MutableRefObject<Virtualizer<HTMLDivElement, Element> | null>;
 };
-export type EdsDataGridProps<T> = BaseProps<T> & StyleProps<T> & SortProps & FilterProps & PagingProps & ColumnProps & VirtualProps & {
+export type EdsDataGridProps<T> = BaseProps<T> & StyleProps<T> & SortProps & FilterProps & PagingProps & ColumnProps & VirtualProps & RefProps & {
     /**
      * Which columns are visible. If not set, all columns are visible. undefined means that the column is visible.
      * @default undefined

package/dist/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from './EdsDataGrid';
 export * from './EdsDataGridProps';
+export * from './types';

package/dist/types/types.d.ts

@@ -0,0 +1,3 @@
+import type { Cell, CellContext, ColumnDef, ColumnPinningState, ColumnResizeMode, ColumnSort, ExpandedState, HeaderContext, OnChangeFn, Row, RowSelectionState, SortingState, Table, VisibilityState } from '@tanstack/react-table';
+import type { Virtualizer } from '@tanstack/react-virtual';
+export type { Cell, CellContext, ColumnDef, ColumnPinningState, ColumnResizeMode, ColumnSort, ExpandedState, HeaderContext, OnChangeFn, Row, RowSelectionState, SortingState, Table, VisibilityState, Virtualizer, };

package/dist/types/utils.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Function returning wether a string only contains number. Allows leading or trailing spaces.
+ *
+ * Examples:
+ *
+ * ```
+ * isNumberOnlyString("10") // true
+ * isNumberOnlyString("10.10") // true
+ * isNumberOnlyString("10px") // false
+ * isNumberOnlyString("10%") // false
+ * isNumberOnlyString("10 ") // true
+ * ```
+ *
+ * @param number
+ * @returns
+ */
+export declare function isNumberOnlyString(number: string): boolean;
+export declare function addPxSuffixIfInputHasNoPrefix(size: number | string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/eds-data-grid-react",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "A feature-rich data-grid written in React, implementing the Equinor Design System",
   "license": "MIT",
   "types": "dist/types/index.d.ts",
@@ -14,16 +14,16 @@
     "email": "fg_eds@equinor.com"
   },
   "peerDependencies": {
+    "@equinor/eds-core-react": ">=0.36.0",
     "react": ">=16.8",
     "react-dom": ">=16.8",
     "styled-components": ">=4.2"
   },
   "dependencies": {
     "@tanstack/react-table": "^8.10.7",
-    "@tanstack/react-virtual": "^3.0.0-beta.54",
-    "@equinor/eds-core-react": "^0.35.0",
-    "@equinor/eds-icons": "^0.20.0",
-    "@equinor/eds-utils": "^0.8.3",
+    "@tanstack/react-virtual": "^3.0.4",
+    "@equinor/eds-icons": "^0.21.0",
+    "@equinor/eds-utils": "^0.8.4",
     "@equinor/eds-tokens": "0.9.2"
   },
   "devDependencies": {
@@ -92,7 +92,6 @@
     "pnpm": ">=4",
     "node": ">=10.0.0"
   },
-  "browserslist": "defaults, not IE 11",
   "scripts": {
     "build": "rollup -c --bundleConfigAsCjs && tsc -p tsconfig.build.json",
     "test": "tsc -p tsconfig.spec.json && jest",