Skip to content

feat(core): add headerCursor override for column headers #1146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(core): add headerCursor override for column headers #1146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/core/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,7 @@ interface BaseGridColumn {
readonly group?: string;
readonly icon?: GridColumnIcon | string;
readonly overlayIcon?: GridColumnIcon | string;
readonly headerCursor?: CSSProperties["cursor"];
readonly hasMenu?: boolean;
readonly style?: "normal" | "highlight";
readonly grow?: number;
Expand Down Expand Up @@ -293,6 +294,7 @@ export type GridColumn = SizedGridColumn | AutoGridColumn;
| group | The name of the group the column belongs to |
| icon | The icon the column belongs to. The icon must be either one of the predefined icons or an icon passed to the `headerIcons` prop |
| overlayIcon | An icon which is painted on top offset bottom right of the `icon`. Must be a predefined icon or an icon passed to the `headerIcons` prop |
| headerCursor | Optional cursor to use when hovering the column header. Falls back to pointer/default based on interaction if not provided. |
| hasMenu | Enables/disables the menu dropdown indicator. If not enabled, `onHeaderMenuClick` will not be emitted. |
| style | Makes the column use the highlighted theming from the `Theme`. `themeOverride` can be used to perform the same effect. |
| grow | When set to a number > 0 the column will grow to consume extra available space according to the weight of its grow property. |
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/internal/data-grid/data-grid-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ export interface BaseGridColumn {
readonly group?: string;
readonly icon?: GridColumnIcon | string;
readonly overlayIcon?: GridColumnIcon | string;
readonly headerCursor?: CSSProperties["cursor"];
readonly menuIcon?: GridColumnMenuIcon | string;
readonly indicatorIcon?: GridColumnIcon | string;
readonly hasMenu?: boolean;
Expand Down
7 changes: 6 additions & 1 deletion packages/core/src/internal/data-grid/data-grid.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -971,6 +971,9 @@ const DataGrid: React.ForwardRefRenderFunction<DataGridRef, DataGridProps> = (p,
cursorOverride = cell.cursor;
}
const canDrag = hoveredOnEdge ?? false;
const headerCursorOverride =
headerHovered && hCol !== undefined ? mappedColumns[hCol]?.headerCursor : undefined;

const cursor = isDragging
? "grabbing"
: canDrag || isResizing
Expand All @@ -979,7 +982,9 @@ const DataGrid: React.ForwardRefRenderFunction<DataGridRef, DataGridProps> = (p,
? "crosshair"
: cursorOverride !== undefined
? cursorOverride
: headerHovered || clickableInnerCellHovered || editableBoolHovered || groupHeaderHovered
: headerCursorOverride !== undefined
? headerCursorOverride
: headerHovered || clickableInnerCellHovered || editableBoolHovered || groupHeaderHovered
? "pointer"
: "default";

Expand Down
1 change: 1 addition & 0 deletions packages/core/src/internal/data-grid/render/data-grid-lib.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export function useMappedColumns(
grow: c.grow,
hasMenu: c.hasMenu,
icon: c.icon,
headerCursor: c.headerCursor,
id: c.id,
menuIcon: c.menuIcon,
overlayIcon: c.overlayIcon,
Expand Down