@mui/x-data-grid 5.4.0 → 5.6.0

package/modern/components/panel/filterPanel/GridFilterInputDate.js

@@ -0,0 +1,88 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["item", "applyValue", "type", "apiRef", "focusElementRef", "InputProps"];
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import { unstable_useId as useId } from '@mui/material/utils';
+import { GridLoadIcon } from '../../icons';
+import { useGridRootProps } from '../../../hooks/utils/useGridRootProps';
+import { jsx as _jsx } from "react/jsx-runtime";
+export const SUBMIT_FILTER_DATE_STROKE_TIME = 500;
+
+function GridFilterInputDate(props) {
+  const {
+    item,
+    applyValue,
+    type,
+    apiRef,
+    focusElementRef,
+    InputProps
+  } = props,
+        other = _objectWithoutPropertiesLoose(props, _excluded);
+
+  const filterTimeout = React.useRef();
+  const [filterValueState, setFilterValueState] = React.useState(item.value ?? '');
+  const [applying, setIsApplying] = React.useState(false);
+  const id = useId();
+  const rootProps = useGridRootProps();
+  const onFilterChange = React.useCallback(event => {
+    const value = event.target.value;
+    clearTimeout(filterTimeout.current);
+    setFilterValueState(String(value));
+    setIsApplying(true);
+    filterTimeout.current = setTimeout(() => {
+      applyValue(_extends({}, item, {
+        value
+      }));
+      setIsApplying(false);
+    }, SUBMIT_FILTER_DATE_STROKE_TIME);
+  }, [applyValue, item]);
+  React.useEffect(() => {
+    return () => {
+      clearTimeout(filterTimeout.current);
+    };
+  }, []);
+  React.useEffect(() => {
+    const itemValue = item.value ?? '';
+    setFilterValueState(String(itemValue));
+  }, [item.value]);
+  return /*#__PURE__*/_jsx(rootProps.components.BaseTextField, _extends({
+    id: id,
+    label: apiRef.current.getLocaleText('filterPanelInputLabel'),
+    placeholder: apiRef.current.getLocaleText('filterPanelInputPlaceholder'),
+    value: filterValueState,
+    onChange: onFilterChange,
+    type: type || 'text',
+    variant: "standard",
+    InputLabelProps: {
+      shrink: true
+    },
+    inputRef: focusElementRef,
+    InputProps: _extends({}, applying ? {
+      endAdornment: /*#__PURE__*/_jsx(GridLoadIcon, {})
+    } : {}, InputProps, {
+      inputProps: _extends({
+        max: type === 'datetime-local' ? '9999-12-31T23:59' : '9999-12-31'
+      }, InputProps?.inputProps)
+    })
+  }, other, rootProps.componentsProps?.baseTextField));
+}
+
+process.env.NODE_ENV !== "production" ? GridFilterInputDate.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "yarn proptypes"  |
+  // ----------------------------------------------------------------------
+  apiRef: PropTypes.any.isRequired,
+  applyValue: PropTypes.func.isRequired,
+  focusElementRef: PropTypes
+  /* @typescript-to-proptypes-ignore */
+  .oneOfType([PropTypes.func, PropTypes.object]),
+  item: PropTypes.shape({
+    columnField: PropTypes.string.isRequired,
+    id: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+    operatorValue: PropTypes.string,
+    value: PropTypes.any
+  }).isRequired
+} : void 0;
+export { GridFilterInputDate };

package/modern/components/panel/filterPanel/GridFilterInputMultipleSingleSelect.js

@@ -0,0 +1,132 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["item", "applyValue", "type", "apiRef", "focusElementRef"];
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import Autocomplete, { createFilterOptions } from '@mui/material/Autocomplete';
+import Chip from '@mui/material/Chip';
+import TextField from '@mui/material/TextField';
+import { unstable_useId as useId } from '@mui/material/utils';
+import { getValueFromOption } from './filterPanelUtils';
+import { jsx as _jsx } from "react/jsx-runtime";
+
+const getSingleSelectOptionFormatter = ({
+  valueFormatter,
+  field
+}, api) => option => {
+  if (typeof option === 'object') {
+    return option.label;
+  }
+
+  return valueFormatter && option !== '' ? valueFormatter({
+    value: option,
+    field,
+    api
+  }) : option;
+};
+
+const isOptionEqualToValue = (option, value) => getValueFromOption(option) === getValueFromOption(value);
+
+const filter = createFilterOptions();
+
+function GridFilterInputMultipleSingleSelect(props) {
+  const {
+    item,
+    applyValue,
+    apiRef,
+    focusElementRef
+  } = props,
+        other = _objectWithoutPropertiesLoose(props, _excluded);
+
+  const id = useId();
+  const resolvedColumn = item.columnField ? apiRef.current.getColumn(item.columnField) : null;
+  const resolvedValueOptions = React.useMemo(() => {
+    return typeof resolvedColumn.valueOptions === 'function' ? resolvedColumn.valueOptions({
+      field: resolvedColumn.field
+    }) : resolvedColumn.valueOptions;
+  }, [resolvedColumn]);
+  const resolvedFormattedValueOptions = React.useMemo(() => {
+    return resolvedValueOptions.map(getValueFromOption);
+  }, [resolvedValueOptions]);
+  const filterValueOptionFormatter = getSingleSelectOptionFormatter(apiRef.current.getColumn(item.columnField), apiRef.current); // The value is computed from the item.value and used directly
+  // If it was done by a useEffect/useSate, the Autocomplete could receive incoherent value and options
+
+  const filterValues = React.useMemo(() => {
+    if (!Array.isArray(item.value)) {
+      return [];
+    }
+
+    if (resolvedValueOptions !== undefined) {
+      const itemValueIndexes = item.value.map(element => {
+        // get the index matching between values and valueoptions
+        const formattedElement = getValueFromOption(element);
+        const index = resolvedFormattedValueOptions.findIndex(formatedOption => formatedOption === formattedElement);
+        return index;
+      });
+      return itemValueIndexes.filter(index => index >= 0).map(index => resolvedValueOptions[index]);
+    }
+
+    return item.value;
+  }, [item.value, resolvedValueOptions, resolvedFormattedValueOptions]);
+  React.useEffect(() => {
+    if (!Array.isArray(item.value) || filterValues.length !== item.value.length) {
+      // update the state if the filter value has been cleaned by the component
+      applyValue(_extends({}, item, {
+        value: filterValues.map(getValueFromOption)
+      }));
+    }
+  }, [item, filterValues, applyValue]);
+  const handleChange = React.useCallback((event, value) => {
+    applyValue(_extends({}, item, {
+      value: [...value.map(getValueFromOption)]
+    }));
+  }, [applyValue, item]);
+  return /*#__PURE__*/_jsx(Autocomplete, _extends({
+    multiple: true,
+    freeSolo: false,
+    limitTags: 1,
+    options: resolvedValueOptions,
+    isOptionEqualToValue: isOptionEqualToValue,
+    filterOptions: filter,
+    id: id,
+    value: filterValues,
+    onChange: handleChange,
+    renderTags: (value, getTagProps) => value.map((option, index) => /*#__PURE__*/_jsx(Chip, _extends({
+      variant: "outlined",
+      size: "small",
+      label: filterValueOptionFormatter(option)
+    }, getTagProps({
+      index
+    })))),
+    renderInput: params => /*#__PURE__*/_jsx(TextField, _extends({}, params, {
+      label: apiRef.current.getLocaleText('filterPanelInputLabel'),
+      placeholder: apiRef.current.getLocaleText('filterPanelInputPlaceholder'),
+      InputLabelProps: _extends({}, params.InputLabelProps, {
+        shrink: true
+      }),
+      inputRef: focusElementRef,
+      type: 'singleSelect',
+      variant: "standard"
+    }))
+  }, other));
+}
+
+process.env.NODE_ENV !== "production" ? GridFilterInputMultipleSingleSelect.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "yarn proptypes"  |
+  // ----------------------------------------------------------------------
+  apiRef: PropTypes.any.isRequired,
+  applyValue: PropTypes.func.isRequired,
+  focusElementRef: PropTypes
+  /* @typescript-to-proptypes-ignore */
+  .oneOfType([PropTypes.func, PropTypes.object]),
+  item: PropTypes.shape({
+    columnField: PropTypes.string.isRequired,
+    id: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+    operatorValue: PropTypes.string,
+    value: PropTypes.any
+  }).isRequired,
+  type: PropTypes.oneOf(['singleSelect'])
+} : void 0;
+export { GridFilterInputMultipleSingleSelect };

package/modern/components/panel/filterPanel/GridFilterInputMultipleValue.js

@@ -0,0 +1,86 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["item", "applyValue", "type", "apiRef", "focusElementRef"];
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import Autocomplete from '@mui/material/Autocomplete';
+import Chip from '@mui/material/Chip';
+import TextField from '@mui/material/TextField';
+import { unstable_useId as useId } from '@mui/material/utils';
+import { jsx as _jsx } from "react/jsx-runtime";
+
+function GridFilterInputMultipleValue(props) {
+  const {
+    item,
+    applyValue,
+    type,
+    apiRef,
+    focusElementRef
+  } = props,
+        other = _objectWithoutPropertiesLoose(props, _excluded);
+
+  const [filterValueState, setFilterValueState] = React.useState(item.value || []);
+  const id = useId();
+  React.useEffect(() => {
+    const itemValue = item.value ?? [];
+    setFilterValueState(itemValue.map(String));
+  }, [item.value]);
+  const handleChange = React.useCallback((event, value) => {
+    setFilterValueState(value.map(String));
+    applyValue(_extends({}, item, {
+      value: [...value]
+    }));
+  }, [applyValue, item]);
+  return /*#__PURE__*/_jsx(Autocomplete, _extends({
+    multiple: true,
+    freeSolo: true,
+    limitTags: 1,
+    options: [],
+    filterOptions: (options, params) => {
+      const {
+        inputValue
+      } = params;
+      return inputValue == null || inputValue === '' ? [] : [inputValue];
+    },
+    id: id,
+    value: filterValueState,
+    onChange: handleChange,
+    renderTags: (value, getTagProps) => value.map((option, index) => /*#__PURE__*/_jsx(Chip, _extends({
+      variant: "outlined",
+      size: "small",
+      label: option
+    }, getTagProps({
+      index
+    })))),
+    renderInput: params => /*#__PURE__*/_jsx(TextField, _extends({}, params, {
+      label: apiRef.current.getLocaleText('filterPanelInputLabel'),
+      placeholder: apiRef.current.getLocaleText('filterPanelInputPlaceholder'),
+      InputLabelProps: _extends({}, params.InputLabelProps, {
+        shrink: true
+      }),
+      inputRef: focusElementRef,
+      type: type || 'text',
+      variant: "standard"
+    }))
+  }, other));
+}
+
+process.env.NODE_ENV !== "production" ? GridFilterInputMultipleValue.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "yarn proptypes"  |
+  // ----------------------------------------------------------------------
+  apiRef: PropTypes.any.isRequired,
+  applyValue: PropTypes.func.isRequired,
+  focusElementRef: PropTypes
+  /* @typescript-to-proptypes-ignore */
+  .oneOfType([PropTypes.func, PropTypes.object]),
+  item: PropTypes.shape({
+    columnField: PropTypes.string.isRequired,
+    id: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+    operatorValue: PropTypes.string,
+    value: PropTypes.any
+  }).isRequired,
+  type: PropTypes.oneOf(['number', 'text'])
+} : void 0;
+export { GridFilterInputMultipleValue };

package/modern/components/panel/filterPanel/GridFilterInputSingleSelect.js

@@ -0,0 +1,118 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["item", "applyValue", "type", "apiRef", "focusElementRef"];
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import { unstable_useId as useId } from '@mui/material/utils';
+import { useGridRootProps } from '../../../hooks/utils/useGridRootProps';
+import { getValueFromValueOptions } from './filterPanelUtils';
+import { jsx as _jsx } from "react/jsx-runtime";
+
+const renderSingleSelectOptions = ({
+  valueOptions,
+  valueFormatter,
+  field
+}, api) => {
+  const iterableColumnValues = typeof valueOptions === 'function' ? ['', ...valueOptions({
+    field
+  })] : ['', ...(valueOptions || [])];
+  return iterableColumnValues.map(option => typeof option === 'object' ? /*#__PURE__*/_jsx("option", {
+    value: option.value,
+    children: option.label
+  }, option.value) : /*#__PURE__*/_jsx("option", {
+    value: option,
+    children: valueFormatter && option !== '' ? valueFormatter({
+      value: option,
+      field,
+      api
+    }) : option
+  }, option));
+};
+
+function GridFilterInputSingleSelect(props) {
+  const {
+    item,
+    applyValue,
+    type,
+    apiRef,
+    focusElementRef
+  } = props,
+        others = _objectWithoutPropertiesLoose(props, _excluded);
+
+  const [filterValueState, setFilterValueState] = React.useState(item.value ?? '');
+  const id = useId();
+  const rootProps = useGridRootProps();
+  const currentColumn = item.columnField ? apiRef.current.getColumn(item.columnField) : null;
+  const currentValueOptions = React.useMemo(() => {
+    return typeof currentColumn.valueOptions === 'function' ? currentColumn.valueOptions({
+      field: currentColumn.field
+    }) : currentColumn.valueOptions;
+  }, [currentColumn]);
+  const onFilterChange = React.useCallback(event => {
+    let value = event.target.value; // NativeSelect casts the value to a string.
+
+    value = getValueFromValueOptions(value, currentValueOptions);
+    setFilterValueState(String(value));
+    applyValue(_extends({}, item, {
+      value
+    }));
+  }, [applyValue, item, currentValueOptions]);
+  React.useEffect(() => {
+    let itemValue;
+
+    if (currentValueOptions !== undefined) {
+      // sanitize if valueOptions are provided
+      itemValue = getValueFromValueOptions(item.value, currentValueOptions);
+
+      if (itemValue !== item.value) {
+        applyValue(_extends({}, item, {
+          value: itemValue
+        }));
+        return;
+      }
+    } else {
+      itemValue = item.value;
+    }
+
+    itemValue = itemValue ?? '';
+    setFilterValueState(String(itemValue));
+  }, [item, currentValueOptions, applyValue]);
+  return /*#__PURE__*/_jsx(rootProps.components.BaseTextField, _extends({
+    id: id,
+    label: apiRef.current.getLocaleText('filterPanelInputLabel'),
+    placeholder: apiRef.current.getLocaleText('filterPanelInputPlaceholder'),
+    value: filterValueState,
+    onChange: onFilterChange,
+    type: type || 'text',
+    variant: "standard",
+    InputLabelProps: {
+      shrink: true
+    },
+    inputRef: focusElementRef,
+    select: true,
+    SelectProps: {
+      native: true
+    }
+  }, others, rootProps.componentsProps?.baseTextField, {
+    children: renderSingleSelectOptions(apiRef.current.getColumn(item.columnField), apiRef.current)
+  }));
+}
+
+process.env.NODE_ENV !== "production" ? GridFilterInputSingleSelect.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "yarn proptypes"  |
+  // ----------------------------------------------------------------------
+  apiRef: PropTypes.any.isRequired,
+  applyValue: PropTypes.func.isRequired,
+  focusElementRef: PropTypes
+  /* @typescript-to-proptypes-ignore */
+  .oneOfType([PropTypes.func, PropTypes.object]),
+  item: PropTypes.shape({
+    columnField: PropTypes.string.isRequired,
+    id: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+    operatorValue: PropTypes.string,
+    value: PropTypes.any
+  }).isRequired
+} : void 0;
+export { GridFilterInputSingleSelect };

package/modern/components/panel/filterPanel/GridFilterInputValue.js

@@ -0,0 +1,134 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["item", "applyValue", "type", "apiRef", "focusElementRef"];
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import { unstable_useId as useId } from '@mui/material/utils';
+import { GridLoadIcon } from '../../icons';
+import { useGridRootProps } from '../../../hooks/utils/useGridRootProps';
+import { getValueFromValueOptions } from './filterPanelUtils';
+import { jsx as _jsx } from "react/jsx-runtime";
+const warnedOnce = {};
+
+function warnDeprecatedTypeSupport(type) {
+  console.warn([`MUI: Using GridFilterInputValue with a "${type}" column is deprecated.`, 'Use GridFilterInputSingleSelect instead.'].join('\n'));
+  warnedOnce[type] = true;
+}
+
+const renderSingleSelectOptions = ({
+  valueOptions,
+  valueFormatter,
+  field
+}, api) => {
+  const iterableColumnValues = typeof valueOptions === 'function' ? ['', ...valueOptions({
+    field
+  })] : ['', ...(valueOptions || [])];
+  return iterableColumnValues.map(option => typeof option === 'object' ? /*#__PURE__*/_jsx("option", {
+    value: option.value,
+    children: option.label
+  }, option.value) : /*#__PURE__*/_jsx("option", {
+    value: option,
+    children: valueFormatter && option !== '' ? valueFormatter({
+      value: option,
+      field,
+      api
+    }) : option
+  }, option));
+};
+
+export const SUBMIT_FILTER_STROKE_TIME = 500;
+
+function GridFilterInputValue(props) {
+  const {
+    item,
+    applyValue,
+    type,
+    apiRef,
+    focusElementRef
+  } = props,
+        others = _objectWithoutPropertiesLoose(props, _excluded);
+
+  if (process.env.NODE_ENV !== 'production' && ['date', 'datetime-local', 'singleSelect'].includes(type) && !warnedOnce[type]) {
+    warnDeprecatedTypeSupport(type);
+  }
+
+  const filterTimeout = React.useRef();
+  const [filterValueState, setFilterValueState] = React.useState(item.value ?? '');
+  const [applying, setIsApplying] = React.useState(false);
+  const id = useId();
+  const rootProps = useGridRootProps();
+  const singleSelectProps = type === 'singleSelect' ? {
+    select: true,
+    SelectProps: {
+      native: true
+    },
+    children: renderSingleSelectOptions(apiRef.current.getColumn(item.columnField), apiRef.current)
+  } : {};
+  const onFilterChange = React.useCallback(event => {
+    let value = event.target.value; // NativeSelect casts the value to a string.
+
+    if (type === 'singleSelect') {
+      const column = apiRef.current.getColumn(item.columnField);
+      const columnValueOptions = typeof column.valueOptions === 'function' ? column.valueOptions({
+        field: column.field
+      }) : column.valueOptions;
+      value = getValueFromValueOptions(value, columnValueOptions);
+    }
+
+    clearTimeout(filterTimeout.current);
+    setFilterValueState(String(value));
+    setIsApplying(true); // TODO singleSelect doesn't debounce
+
+    filterTimeout.current = setTimeout(() => {
+      applyValue(_extends({}, item, {
+        value
+      }));
+      setIsApplying(false);
+    }, SUBMIT_FILTER_STROKE_TIME);
+  }, [apiRef, applyValue, item, type]);
+  React.useEffect(() => {
+    return () => {
+      clearTimeout(filterTimeout.current);
+    };
+  }, []);
+  React.useEffect(() => {
+    const itemValue = item.value ?? '';
+    setFilterValueState(String(itemValue));
+  }, [item.value]);
+  const InputProps = applying ? {
+    endAdornment: /*#__PURE__*/_jsx(GridLoadIcon, {})
+  } : others.InputProps;
+  return /*#__PURE__*/_jsx(rootProps.components.BaseTextField, _extends({
+    id: id,
+    label: apiRef.current.getLocaleText('filterPanelInputLabel'),
+    placeholder: apiRef.current.getLocaleText('filterPanelInputPlaceholder'),
+    value: filterValueState,
+    onChange: onFilterChange,
+    type: type || 'text',
+    variant: "standard",
+    InputProps: InputProps,
+    InputLabelProps: {
+      shrink: true
+    },
+    inputRef: focusElementRef
+  }, singleSelectProps, others, rootProps.componentsProps?.baseTextField));
+}
+
+process.env.NODE_ENV !== "production" ? GridFilterInputValue.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "yarn proptypes"  |
+  // ----------------------------------------------------------------------
+  apiRef: PropTypes.any.isRequired,
+  applyValue: PropTypes.func.isRequired,
+  focusElementRef: PropTypes
+  /* @typescript-to-proptypes-ignore */
+  .oneOfType([PropTypes.func, PropTypes.object]),
+  item: PropTypes.shape({
+    columnField: PropTypes.string.isRequired,
+    id: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+    operatorValue: PropTypes.string,
+    value: PropTypes.any
+  }).isRequired
+} : void 0;
+export { GridFilterInputValue };

package/modern/components/panel/filterPanel/GridFilterInputValueProps.js

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