270 lines
12 KiB
JavaScript
270 lines
12 KiB
JavaScript
'use client';
|
|
|
|
import _extends from "@babel/runtime/helpers/esm/extends";
|
|
import * as React from 'react';
|
|
import PropTypes from 'prop-types';
|
|
import clsx from 'clsx';
|
|
import composeClasses from '@mui/utils/composeClasses';
|
|
import capitalize from '@mui/utils/capitalize';
|
|
import useId from '@mui/utils/useId';
|
|
import { fastMemo } from '@mui/x-internals/fastMemo';
|
|
import { useRtl } from '@mui/system/RtlProvider';
|
|
import { focusElement } from "../../utils/focusElement.mjs";
|
|
import { useGridPrivateApiContext } from "../../hooks/utils/useGridPrivateApiContext.mjs";
|
|
import { getColumnMenuItemKeys } from "../../hooks/features/columnMenu/getColumnMenuItemKeys.mjs";
|
|
import { ColumnHeaderMenuIcon } from "./ColumnHeaderMenuIcon.mjs";
|
|
import { GridColumnHeaderMenu } from "../menu/columnMenu/GridColumnHeaderMenu.mjs";
|
|
import { gridClasses, getDataGridUtilityClass } from "../../constants/gridClasses.mjs";
|
|
import { useGridRootProps } from "../../hooks/utils/useGridRootProps.mjs";
|
|
import { GridGenericColumnHeaderItem } from "./GridGenericColumnHeaderItem.mjs";
|
|
import { isEventTargetInPortal } from "../../utils/domUtils.mjs";
|
|
import { PinnedColumnPosition } from "../../internals/constants.mjs";
|
|
import { attachPinnedStyle } from "../../internals/utils/index.mjs";
|
|
import { usePinnedScrollOffset } from "../../hooks/utils/usePinnedScrollOffset.mjs";
|
|
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
const useUtilityClasses = ownerState => {
|
|
const {
|
|
disableColumnSorting
|
|
} = useGridRootProps();
|
|
const {
|
|
colDef,
|
|
classes,
|
|
isDragging,
|
|
sortDirection,
|
|
showRightBorder,
|
|
showLeftBorder,
|
|
filterItemsCounter,
|
|
pinnedPosition,
|
|
isSiblingFocused
|
|
} = ownerState;
|
|
const isColumnSortable = colDef.sortable && !disableColumnSorting;
|
|
const isColumnSorted = sortDirection != null;
|
|
const isColumnFiltered = filterItemsCounter != null && filterItemsCounter > 0;
|
|
// todo refactor to a prop on col isNumeric or ?? ie: coltype===price wont work
|
|
const isColumnNumeric = colDef.type === 'number';
|
|
const slots = {
|
|
root: ['columnHeader', colDef.headerAlign && `columnHeader--align${capitalize(colDef.headerAlign)}`, isColumnSortable && 'columnHeader--sortable', isDragging && 'columnHeader--moving', isColumnSorted && 'columnHeader--sorted', isColumnFiltered && 'columnHeader--filtered', isColumnNumeric && 'columnHeader--numeric', 'withBorderColor', showRightBorder && 'columnHeader--withRightBorder', showLeftBorder && 'columnHeader--withLeftBorder', pinnedPosition === PinnedColumnPosition.LEFT && 'columnHeader--pinnedLeft', pinnedPosition === PinnedColumnPosition.RIGHT && 'columnHeader--pinnedRight',
|
|
// TODO: Remove classes below and restore `:has` selectors when they are supported in jsdom
|
|
// See https://github.com/mui/mui-x/pull/14559
|
|
isSiblingFocused && 'columnHeader--siblingFocused'],
|
|
draggableContainer: ['columnHeaderDraggableContainer'],
|
|
titleContainer: ['columnHeaderTitleContainer'],
|
|
titleContainerContent: ['columnHeaderTitleContainerContent']
|
|
};
|
|
return composeClasses(slots, getDataGridUtilityClass, classes);
|
|
};
|
|
function GridColumnHeaderItem(props) {
|
|
const {
|
|
colDef,
|
|
columnMenuOpen,
|
|
colIndex,
|
|
headerHeight,
|
|
isResizing,
|
|
isLast,
|
|
sortDirection,
|
|
sortIndex,
|
|
filterItemsCounter,
|
|
hasFocus,
|
|
tabIndex,
|
|
disableReorder,
|
|
separatorSide,
|
|
showLeftBorder,
|
|
showRightBorder,
|
|
pinnedPosition,
|
|
pinnedOffset
|
|
} = props;
|
|
const apiRef = useGridPrivateApiContext();
|
|
const rootProps = useGridRootProps();
|
|
const isRtl = useRtl();
|
|
const headerCellRef = React.useRef(null);
|
|
const columnMenuId = useId();
|
|
const columnMenuButtonId = useId();
|
|
const iconButtonRef = React.useRef(null);
|
|
const [showColumnMenuIcon, setShowColumnMenuIcon] = React.useState(columnMenuOpen);
|
|
const columnMenuSlotProps = rootProps.slotProps?.columnMenu;
|
|
const columnMenuComponent = rootProps.slots.columnMenu;
|
|
const defaultSlots = columnMenuComponent?.defaultSlots;
|
|
const defaultSlotProps = columnMenuComponent?.defaultSlotProps;
|
|
const hasKnownDefaultColumnMenu = defaultSlots != null && defaultSlotProps != null;
|
|
const columnMenuItemKeys = React.useMemo(() => {
|
|
if (!hasKnownDefaultColumnMenu) {
|
|
return [];
|
|
}
|
|
return getColumnMenuItemKeys({
|
|
apiRef,
|
|
colDef,
|
|
defaultSlots,
|
|
defaultSlotProps,
|
|
slots: columnMenuSlotProps?.slots,
|
|
slotProps: columnMenuSlotProps?.slotProps
|
|
});
|
|
}, [apiRef, colDef, defaultSlotProps, defaultSlots, hasKnownDefaultColumnMenu, columnMenuSlotProps?.slotProps, columnMenuSlotProps?.slots]);
|
|
|
|
// If we don't have a "known" default column menu (i.e. a custom menu component
|
|
// without `defaultSlots` / `defaultSlotProps` statics), we treat it as opaque
|
|
// and assume it has items, so we always show the column menu icon.
|
|
// Only the built-in/default menu path can hide the icon when there are no items.
|
|
const hasColumnMenuItems = !hasKnownDefaultColumnMenu || columnMenuItemKeys.length > 0;
|
|
const isDraggable = !rootProps.disableColumnReorder && !disableReorder && !colDef.disableReorder;
|
|
let headerComponent;
|
|
if (colDef.renderHeader) {
|
|
headerComponent = colDef.renderHeader(apiRef.current.getColumnHeaderParams(colDef.field));
|
|
}
|
|
const ownerState = _extends({}, props, {
|
|
classes: rootProps.classes,
|
|
showRightBorder,
|
|
showLeftBorder
|
|
});
|
|
const classes = useUtilityClasses(ownerState);
|
|
const publish = React.useCallback(eventName => event => {
|
|
// Ignore portal
|
|
// See https://github.com/mui/mui-x/issues/1721
|
|
if (isEventTargetInPortal(event)) {
|
|
return;
|
|
}
|
|
apiRef.current.publishEvent(eventName, apiRef.current.getColumnHeaderParams(colDef.field), event);
|
|
}, [apiRef, colDef.field]);
|
|
const mouseEventsHandlers = React.useMemo(() => ({
|
|
onClick: publish('columnHeaderClick'),
|
|
onContextMenu: publish('columnHeaderContextMenu'),
|
|
onDoubleClick: publish('columnHeaderDoubleClick'),
|
|
onMouseOver: publish('columnHeaderOver'),
|
|
// TODO remove as it's not used
|
|
onMouseOut: publish('columnHeaderOut'),
|
|
// TODO remove as it's not used
|
|
onMouseEnter: publish('columnHeaderEnter'),
|
|
// TODO remove as it's not used
|
|
onMouseLeave: publish('columnHeaderLeave'),
|
|
// TODO remove as it's not used
|
|
onKeyDown: publish('columnHeaderKeyDown'),
|
|
onFocus: publish('columnHeaderFocus'),
|
|
onBlur: publish('columnHeaderBlur')
|
|
}), [publish]);
|
|
const draggableEventHandlers = React.useMemo(() => isDraggable ? {
|
|
onDragStart: publish('columnHeaderDragStart'),
|
|
onDragEnter: publish('columnHeaderDragEnter'),
|
|
onDragOver: publish('columnHeaderDragOver'),
|
|
onDragEndCapture: publish('columnHeaderDragEnd')
|
|
} : {}, [isDraggable, publish]);
|
|
const columnHeaderSeparatorProps = React.useMemo(() => ({
|
|
onMouseDown: publish('columnSeparatorMouseDown'),
|
|
onDoubleClick: publish('columnSeparatorDoubleClick')
|
|
}), [publish]);
|
|
React.useEffect(() => {
|
|
if (!showColumnMenuIcon && columnMenuOpen) {
|
|
setShowColumnMenuIcon(columnMenuOpen);
|
|
}
|
|
}, [showColumnMenuIcon, columnMenuOpen]);
|
|
React.useEffect(() => {
|
|
if (hasKnownDefaultColumnMenu && columnMenuOpen && !hasColumnMenuItems) {
|
|
apiRef.current.hideColumnMenu();
|
|
}
|
|
}, [apiRef, columnMenuOpen, hasColumnMenuItems, hasKnownDefaultColumnMenu]);
|
|
const handleExited = React.useCallback(() => {
|
|
setShowColumnMenuIcon(false);
|
|
}, []);
|
|
const columnMenuIconButton = !rootProps.disableColumnMenu && !colDef.disableColumnMenu && hasColumnMenuItems && /*#__PURE__*/_jsx(ColumnHeaderMenuIcon, {
|
|
colDef: colDef,
|
|
columnMenuId: columnMenuId,
|
|
columnMenuButtonId: columnMenuButtonId,
|
|
open: showColumnMenuIcon,
|
|
iconButtonRef: iconButtonRef
|
|
});
|
|
const columnMenu = /*#__PURE__*/_jsx(GridColumnHeaderMenu, {
|
|
columnMenuId: columnMenuId,
|
|
columnMenuButtonId: columnMenuButtonId,
|
|
field: colDef.field,
|
|
open: columnMenuOpen,
|
|
target: iconButtonRef.current,
|
|
ContentComponent: rootProps.slots.columnMenu,
|
|
contentComponentProps: rootProps.slotProps?.columnMenu,
|
|
onExited: handleExited
|
|
});
|
|
const sortingOrder = colDef.sortingOrder ?? rootProps.sortingOrder;
|
|
const showSortIcon = (colDef.sortable || sortDirection != null) && !colDef.hideSortIcons && !rootProps.disableColumnSorting;
|
|
const columnTitleIconButtons = /*#__PURE__*/_jsxs(React.Fragment, {
|
|
children: [!rootProps.disableColumnFilter && /*#__PURE__*/_jsx(rootProps.slots.columnHeaderFilterIconButton, _extends({
|
|
field: colDef.field,
|
|
counter: filterItemsCounter
|
|
}, rootProps.slotProps?.columnHeaderFilterIconButton)), showSortIcon && /*#__PURE__*/_jsx(rootProps.slots.columnHeaderSortIcon, _extends({
|
|
field: colDef.field,
|
|
direction: sortDirection,
|
|
index: sortIndex,
|
|
sortingOrder: sortingOrder,
|
|
disabled: !colDef.sortable
|
|
}, rootProps.slotProps?.columnHeaderSortIcon))]
|
|
});
|
|
React.useLayoutEffect(() => {
|
|
const columnMenuState = apiRef.current.state.columnMenu;
|
|
if (hasFocus && !columnMenuState.open) {
|
|
const focusableElement = headerCellRef.current.querySelector('[tabindex="0"]');
|
|
const elementToFocus = focusableElement || headerCellRef.current;
|
|
if (!elementToFocus) {
|
|
return;
|
|
}
|
|
focusElement(elementToFocus, apiRef);
|
|
}
|
|
}, [apiRef, hasFocus]);
|
|
const headerClassName = typeof colDef.headerClassName === 'function' ? colDef.headerClassName({
|
|
field: colDef.field,
|
|
colDef
|
|
}) : colDef.headerClassName;
|
|
const label = colDef.headerName ?? colDef.field;
|
|
const pinnedScrollOffset = usePinnedScrollOffset(apiRef, pinnedPosition);
|
|
const style = React.useMemo(() => attachPinnedStyle(_extends({}, props.style), isRtl, pinnedPosition, pinnedOffset !== undefined ? pinnedOffset + pinnedScrollOffset : undefined), [pinnedPosition, pinnedOffset, pinnedScrollOffset, props.style, isRtl]);
|
|
return /*#__PURE__*/_jsx(GridGenericColumnHeaderItem, _extends({
|
|
ref: headerCellRef,
|
|
classes: classes,
|
|
columnMenuOpen: columnMenuOpen,
|
|
colIndex: colIndex,
|
|
height: headerHeight,
|
|
isResizing: isResizing,
|
|
sortDirection: sortDirection,
|
|
hasFocus: hasFocus,
|
|
tabIndex: tabIndex,
|
|
separatorSide: separatorSide,
|
|
isDraggable: isDraggable,
|
|
headerComponent: headerComponent,
|
|
description: colDef.description,
|
|
elementId: colDef.field,
|
|
width: colDef.computedWidth,
|
|
columnMenuIconButton: columnMenuIconButton,
|
|
columnTitleIconButtons: columnTitleIconButtons,
|
|
headerClassName: clsx(headerClassName, isLast && gridClasses['columnHeader--last']),
|
|
label: label,
|
|
resizable: !rootProps.disableColumnResize && !!colDef.resizable,
|
|
"data-field": colDef.field,
|
|
columnMenu: columnMenu,
|
|
draggableContainerProps: draggableEventHandlers,
|
|
columnHeaderSeparatorProps: columnHeaderSeparatorProps,
|
|
style: style
|
|
}, mouseEventsHandlers));
|
|
}
|
|
process.env.NODE_ENV !== "production" ? GridColumnHeaderItem.propTypes /* remove-proptypes */ = {
|
|
// ----------------------------- Warning --------------------------------
|
|
// | These PropTypes are generated from the TypeScript type definitions |
|
|
// | To update them edit the TypeScript types and run "pnpm proptypes" |
|
|
// ----------------------------------------------------------------------
|
|
colDef: PropTypes.object.isRequired,
|
|
colIndex: PropTypes.number.isRequired,
|
|
columnMenuOpen: PropTypes.bool.isRequired,
|
|
disableReorder: PropTypes.bool,
|
|
filterItemsCounter: PropTypes.number,
|
|
hasFocus: PropTypes.bool,
|
|
headerHeight: PropTypes.number.isRequired,
|
|
isDragging: PropTypes.bool.isRequired,
|
|
isLast: PropTypes.bool.isRequired,
|
|
isResizing: PropTypes.bool.isRequired,
|
|
isSiblingFocused: PropTypes.bool.isRequired,
|
|
pinnedOffset: PropTypes.number,
|
|
pinnedPosition: PropTypes.oneOf([0, 1, 2, 3]),
|
|
separatorSide: PropTypes.oneOf(['left', 'right']),
|
|
showLeftBorder: PropTypes.bool.isRequired,
|
|
showRightBorder: PropTypes.bool.isRequired,
|
|
sortDirection: PropTypes.oneOf(['asc', 'desc']),
|
|
sortIndex: PropTypes.number,
|
|
style: PropTypes.object,
|
|
tabIndex: PropTypes.oneOf([-1, 0]).isRequired
|
|
} : void 0;
|
|
const Memoized = fastMemo(GridColumnHeaderItem);
|
|
export { Memoized as GridColumnHeaderItem }; |