@mui/x-data-grid 5.5.1 → 5.7.0

package/utils/domUtils.js

@@ -0,0 +1,44 @@
+import { gridClasses } from '../constants/gridClasses';
+export function isOverflown(element) {
+  return element.scrollHeight > element.clientHeight || element.scrollWidth > element.clientWidth;
+}
+export function findParentElementFromClassName(elem, className) {
+  return elem.closest(`.${className}`);
+}
+export function getRowEl(cell) {
+  if (!cell) {
+    return null;
+  }
+
+  return findParentElementFromClassName(cell, gridClasses.row);
+} // TODO remove
+
+export function isGridCellRoot(elem) {
+  return elem != null && elem.classList.contains(gridClasses.cell);
+}
+export function isGridHeaderCellRoot(elem) {
+  return elem != null && elem.classList.contains(gridClasses.columnHeader);
+}
+
+function escapeOperandAttributeSelector(operand) {
+  return operand.replace(/["\\]/g, '\\$&');
+}
+
+export function getGridColumnHeaderElement(root, field) {
+  return root.querySelector(`[role="columnheader"][data-field="${escapeOperandAttributeSelector(field)}"]`);
+}
+export function getGridRowElement(root, id) {
+  return root.querySelector(`.${gridClasses.row}[data-id="${escapeOperandAttributeSelector(String(id))}"]`);
+}
+export function getGridCellElement(root, {
+  id,
+  field
+}) {
+  const row = getGridRowElement(root, id);
+
+  if (!row) {
+    return null;
+  }
+
+  return row.querySelector(`.${gridClasses.cell}[data-field="${escapeOperandAttributeSelector(field)}"]`);
+}

package/utils/exportAs.d.ts

@@ -0,0 +1,12 @@
+import { GridExportFormat } from '../models/gridExport';
+/**
+ * I have hesitated to use https://github.com/eligrey/FileSaver.js.
+ * If we get bug reports that this project solves, we should consider using it.
+ *
+ * Related resources.
+ * https://blog.logrocket.com/programmatic-file-downloads-in-the-browser-9a5186298d5c/
+ * https://github.com/mbrn/filefy/blob/ec4ed0b7415d93be7158c23029f2ea1fa0b8e2d9/src/core/BaseBuilder.ts
+ * https://unpkg.com/browse/@progress/kendo-file-saver@1.0.7/dist/es/save-as.js
+ * https://github.com/ag-grid/ag-grid/blob/9565c219b6210aa85fa833c929d0728f9d163a91/community-modules/csv-export/src/csvExport/downloader.ts
+ */
+export declare function exportAs(blob: Blob, extension?: GridExportFormat, filename?: string): void;

package/utils/exportAs.js

@@ -0,0 +1,34 @@
+/**
+ * I have hesitated to use https://github.com/eligrey/FileSaver.js.
+ * If we get bug reports that this project solves, we should consider using it.
+ *
+ * Related resources.
+ * https://blog.logrocket.com/programmatic-file-downloads-in-the-browser-9a5186298d5c/
+ * https://github.com/mbrn/filefy/blob/ec4ed0b7415d93be7158c23029f2ea1fa0b8e2d9/src/core/BaseBuilder.ts
+ * https://unpkg.com/browse/@progress/kendo-file-saver@1.0.7/dist/es/save-as.js
+ * https://github.com/ag-grid/ag-grid/blob/9565c219b6210aa85fa833c929d0728f9d163a91/community-modules/csv-export/src/csvExport/downloader.ts
+ */
+export function exportAs(blob, extension = 'csv', filename = document.title) {
+  const fullName = `${filename}.${extension}`; // Test download attribute first
+  // https://github.com/eligrey/FileSaver.js/issues/193
+
+  if ('download' in HTMLAnchorElement.prototype) {
+    // Create an object URL for the blob object
+    const url = URL.createObjectURL(blob); // Create a new anchor element
+
+    const a = document.createElement('a');
+    a.href = url;
+    a.download = fullName; // Programmatically trigger a click on the anchor element
+    // Useful if you want the download to happen automatically
+    // Without attaching the anchor element to the DOM
+
+    a.click(); // https://github.com/eligrey/FileSaver.js/issues/205
+
+    setTimeout(() => {
+      URL.revokeObjectURL(url);
+    });
+    return;
+  }
+
+  throw new Error('MUI: exportAs not supported');
+}

package/utils/getGridLocalization.d.ts

@@ -0,0 +1,12 @@
+import { Localization as CoreLocalization } from '@mui/material/locale';
+import { GridLocaleText } from '../models/api/gridLocaleTextApi';
+export interface Localization {
+    components: {
+        MuiDataGrid: {
+            defaultProps: {
+                localeText: Partial<GridLocaleText>;
+            };
+        };
+    };
+}
+export declare const getGridLocalization: (gridTranslations: Partial<GridLocaleText>, coreTranslations?: CoreLocalization | undefined) => Localization;

package/utils/getGridLocalization.js

@@ -0,0 +1,16 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+export const getGridLocalization = (gridTranslations, coreTranslations) => {
+  var _coreTranslations$com, _coreTranslations$com2;
+
+  return {
+    components: {
+      MuiDataGrid: {
+        defaultProps: {
+          localeText: _extends({}, gridTranslations, {
+            MuiTablePagination: (coreTranslations == null ? void 0 : (_coreTranslations$com = coreTranslations.components) == null ? void 0 : (_coreTranslations$com2 = _coreTranslations$com.MuiTablePagination) == null ? void 0 : _coreTranslations$com2.defaultProps) || {}
+          })
+        }
+      }
+    }
+  };
+};

package/utils/index.d.ts

@@ -0,0 +1 @@
+export type { OutputSelector } from './createSelector';

package/utils/index.js

@@ -0,0 +1 @@
+export {};

package/utils/keyboardUtils.d.ts

@@ -0,0 +1,20 @@
+import * as React from 'react';
+export declare const isEscapeKey: (key: string) => boolean;
+export declare const isEnterKey: (key: string) => boolean;
+export declare const isTabKey: (key: string) => boolean;
+export declare const isSpaceKey: (key: string) => boolean;
+export declare const isArrowKeys: (key: string) => boolean;
+export declare const isHomeOrEndKeys: (key: string) => boolean;
+export declare const isPageKeys: (key: string) => boolean;
+export declare const isDeleteKeys: (key: string) => boolean;
+export declare const isPrintableKey: (key: string) => boolean;
+export declare const GRID_MULTIPLE_SELECTION_KEYS: string[];
+export declare const GRID_CELL_EXIT_EDIT_MODE_KEYS: string[];
+export declare const GRID_CELL_EDIT_COMMIT_KEYS: string[];
+export declare const isMultipleKey: (key: string) => boolean;
+export declare const isCellEnterEditModeKeys: (key: string) => boolean;
+export declare const isCellExitEditModeKeys: (key: string) => boolean;
+export declare const isCellEditCommitKeys: (key: string) => boolean;
+export declare const isNavigationKey: (key: string) => boolean;
+export declare const isKeyboardEvent: (event: any) => event is React.KeyboardEvent<HTMLElement>;
+export declare const isHideMenuKey: (key: React.KeyboardEvent['key']) => boolean;

package/utils/keyboardUtils.js

@@ -0,0 +1,23 @@
+export const isEscapeKey = key => key === 'Escape'; // TODO remove
+
+export const isEnterKey = key => key === 'Enter'; // TODO remove
+
+export const isTabKey = key => key === 'Tab'; // TODO remove
+
+export const isSpaceKey = key => key === ' ';
+export const isArrowKeys = key => key.indexOf('Arrow') === 0;
+export const isHomeOrEndKeys = key => key === 'Home' || key === 'End';
+export const isPageKeys = key => key.indexOf('Page') === 0;
+export const isDeleteKeys = key => key === 'Delete' || key === 'Backspace';
+const printableCharRegex = /^(\p{L}|\p{M}\p{L}|\p{M}|\p{N}|\p{Z}|\p{S}|\p{P})$/iu;
+export const isPrintableKey = key => printableCharRegex.test(key);
+export const GRID_MULTIPLE_SELECTION_KEYS = ['Meta', 'Control', 'Shift'];
+export const GRID_CELL_EXIT_EDIT_MODE_KEYS = ['Enter', 'Escape', 'Tab'];
+export const GRID_CELL_EDIT_COMMIT_KEYS = ['Enter', 'Tab'];
+export const isMultipleKey = key => GRID_MULTIPLE_SELECTION_KEYS.indexOf(key) > -1;
+export const isCellEnterEditModeKeys = key => isEnterKey(key) || isDeleteKeys(key) || isPrintableKey(key);
+export const isCellExitEditModeKeys = key => GRID_CELL_EXIT_EDIT_MODE_KEYS.indexOf(key) > -1;
+export const isCellEditCommitKeys = key => GRID_CELL_EDIT_COMMIT_KEYS.indexOf(key) > -1;
+export const isNavigationKey = key => isHomeOrEndKeys(key) || isArrowKeys(key) || isPageKeys(key) || isSpaceKey(key);
+export const isKeyboardEvent = event => !!event.key;
+export const isHideMenuKey = key => isTabKey(key) || isEscapeKey(key);

package/utils/package.json

@@ -0,0 +1,6 @@
+{
+  "sideEffects": false,
+  "module": "./index.js",
+  "main": "../node/utils/index.js",
+  "types": "./index.d.ts"
+}

package/utils/utils.d.ts

@@ -0,0 +1,37 @@
+export declare function isNumber(value: any): value is number;
+export declare function isFunction(value: any): value is Function;
+export declare function isObject(value: any): value is Record<string, any>;
+export declare function localStorageAvailable(): boolean;
+export declare function escapeRegExp(value: string): string;
+/**
+ * Follows the CSS specification behavior for min and max
+ * If min > max, then the min have priority
+ */
+export declare const clamp: (value: number, min: number, max: number) => number;
+/**
+ * Based on `fast-deep-equal`
+ *
+ *  MIT License
+ *
+ * Copyright (c) 2017 Evgeny Poberezkin
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ * We only type the public interface to avoid dozens of `as` in the function.
+ */
+export declare function isDeepEqual<T>(actual: any, expected: T): actual is T;

package/utils/utils.js

@@ -0,0 +1,180 @@
+export function isNumber(value) {
+  return typeof value === 'number';
+}
+export function isFunction(value) {
+  return typeof value === 'function';
+}
+export function isObject(value) {
+  return typeof value === 'object';
+}
+export function localStorageAvailable() {
+  try {
+    // Incognito mode might reject access to the localStorage for security reasons.
+    // window isn't defined on Node.js
+    // https://stackoverflow.com/questions/16427636/check-if-localstorage-is-available
+    const key = '__some_random_key_you_are_not_going_to_use__';
+    window.localStorage.setItem(key, key);
+    window.localStorage.removeItem(key);
+    return true;
+  } catch (err) {
+    return false;
+  }
+}
+export function escapeRegExp(value) {
+  return value.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&');
+}
+/**
+ * Follows the CSS specification behavior for min and max
+ * If min > max, then the min have priority
+ */
+
+export const clamp = (value, min, max) => Math.max(min, Math.min(max, value));
+/**
+ * Based on `fast-deep-equal`
+ *
+ *  MIT License
+ *
+ * Copyright (c) 2017 Evgeny Poberezkin
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ * We only type the public interface to avoid dozens of `as` in the function.
+ */
+
+export function isDeepEqual(a, b) {
+  if (a === b) {
+    return true;
+  }
+
+  if (a && b && typeof a === 'object' && typeof b === 'object') {
+    if (a.constructor !== b.constructor) {
+      return false;
+    }
+
+    if (Array.isArray(a)) {
+      const length = a.length;
+
+      if (length !== b.length) {
+        return false;
+      }
+
+      for (let i = 0; i < length; i += 1) {
+        if (!isDeepEqual(a[i], b[i])) {
+          return false;
+        }
+      }
+
+      return true;
+    }
+
+    if (a instanceof Map && b instanceof Map) {
+      if (a.size !== b.size) {
+        return false;
+      }
+
+      const entriesA = Array.from(a.entries());
+
+      for (let i = 0; i < entriesA.length; i += 1) {
+        if (!b.has(entriesA[i][0])) {
+          return false;
+        }
+      }
+
+      for (let i = 0; i < entriesA.length; i += 1) {
+        const entryA = entriesA[i];
+
+        if (!isDeepEqual(entryA[1], b.get(entryA[0]))) {
+          return false;
+        }
+      }
+
+      return true;
+    }
+
+    if (a instanceof Set && b instanceof Set) {
+      if (a.size !== b.size) {
+        return false;
+      }
+
+      const entries = Array.from(a.entries());
+
+      for (let i = 0; i < entries.length; i += 1) {
+        if (!b.has(entries[i][0])) {
+          return false;
+        }
+      }
+
+      return true;
+    }
+
+    if (ArrayBuffer.isView(a) && ArrayBuffer.isView(b)) {
+      const length = a.length;
+
+      if (length !== b.length) {
+        return false;
+      }
+
+      for (let i = 0; i < length; i += 1) {
+        if (a[i] !== b[i]) {
+          return false;
+        }
+      }
+
+      return true;
+    }
+
+    if (a.constructor === RegExp) {
+      return a.source === b.source && a.flags === b.flags;
+    }
+
+    if (a.valueOf !== Object.prototype.valueOf) {
+      return a.valueOf() === b.valueOf();
+    }
+
+    if (a.toString !== Object.prototype.toString) {
+      return a.toString() === b.toString();
+    }
+
+    const keys = Object.keys(a);
+    const length = keys.length;
+
+    if (length !== Object.keys(b).length) {
+      return false;
+    }
+
+    for (let i = 0; i < length; i += 1) {
+      if (!Object.prototype.hasOwnProperty.call(b, keys[i])) {
+        return false;
+      }
+    }
+
+    for (let i = 0; i < length; i += 1) {
+      const key = keys[i];
+
+      if (!isDeepEqual(a[key], b[key])) {
+        return false;
+      }
+    }
+
+    return true;
+  } // true if both NaN, false otherwise
+  // eslint-disable-next-line no-self-compare
+
+
+  return a !== a && b !== b;
+}

package/utils/warning.d.ts

@@ -0,0 +1,2 @@
+export declare const buildWarning: (message: string | string[], gravity?: 'warning' | 'error') => () => void;
+export declare const wrapWithWarningOnCall: <F extends Function>(method: F, message: string | string[]) => F | ((...args: any[]) => any);

package/utils/warning.js

@@ -0,0 +1,26 @@
+export const buildWarning = (message, gravity = 'warning') => {
+  let alreadyWarned = false;
+  const cleanMessage = Array.isArray(message) ? message.join('\n') : message;
+  return () => {
+    if (!alreadyWarned) {
+      alreadyWarned = true;
+
+      if (gravity === 'error') {
+        console.error(cleanMessage);
+      } else {
+        console.warn(cleanMessage);
+      }
+    }
+  };
+};
+export const wrapWithWarningOnCall = (method, message) => {
+  if (process.env.NODE_ENV === 'production') {
+    return method;
+  }
+
+  const warning = buildWarning(message);
+  return (...args) => {
+    warning();
+    return method(...args);
+  };
+};

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020 Material-UI SAS
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.