Skip to content
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

[DataGrid] Changed columns[] param to field[] #11245

Merged
merged 5 commits into from
Dec 1, 2023
Merged

[DataGrid] Changed columns[] param to field[] #11245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4b6483c
changed columns[] param to field[]
michelengelen Nov 29, 2023
c7e3857
removed `getColumns` method from column API
michelengelen Nov 30, 2023
bbbd404
updated docs
michelengelen Nov 30, 2023
fbacab5
Merge remote-tracking branch 'upstream/next' into data-grid/10378
michelengelen Nov 30, 2023
37a3caa
Merge remote-tracking branch 'upstream/next' into data-grid/10378
michelengelen Dec 1, 2023
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: 1 addition & 1 deletion docs/pages/x/api/data-grid/grid-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ import { GridApi } from '@mui/x-data-grid';
| <span class="prop-name">showFilterPanel</span> | <span class="prop-type">(targetColumnField?: string, panelId?: string, labelId?: string) =&gt; void</span> | Shows the filter panel. If `targetColumnField` is given, a filter for this field is also added. |
| <span class="prop-name">showHeaderFilterMenu</span> | <span class="prop-type">(field: GridColDef['field']) =&gt; void</span> | Opens the header filter menu for the given field. |
| <span class="prop-name">showPreferences</span> | <span class="prop-type">(newValue: GridPreferencePanelsValue, panelId?: string, labelId?: string) =&gt; void</span> | Displays the preferences panel. The `newValue` argument controls the content of the panel. |
| <span class="prop-name">sortColumn</span> | <span class="prop-type">(column: GridColDef, direction?: GridSortDirection, allowMultipleSorting?: boolean) =&gt; void</span> | Sorts a column. |
| <span class="prop-name">sortColumn</span> | <span class="prop-type">(field: GridColDef['field'], direction?: GridSortDirection, allowMultipleSorting?: boolean) =&gt; void</span> | Sorts a column. |
| <span class="prop-name">startCellEditMode</span> | <span class="prop-type">(params: GridStartCellEditModeParams) =&gt; void</span> | Puts the cell corresponding to the given row id and field into edit mode. |
| <span class="prop-name">startHeaderFilterEditMode</span> | <span class="prop-type">(field: GridColDef['field']) =&gt; void</span> | Puts the cell corresponding to the given row id and field into edit mode. |
| <span class="prop-name">startRowEditMode</span> | <span class="prop-type">(params: GridStartRowEditModeParams) =&gt; void</span> | Puts the row corresponding to the given id into edit mode. |
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/x/api/data-grid/grid-sort-api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
{
"name": "sortColumn",
"description": "Sorts a column.",
"type": "(column: GridColDef, direction?: GridSortDirection, allowMultipleSorting?: boolean) => void"
"type": "(field: GridColDef['field'], direction?: GridSortDirection, allowMultipleSorting?: boolean) => void"
}
]
}
2 changes: 1 addition & 1 deletion ...ages/grid/x-data-grid/src/components/menu/columnMenu/menuItems/GridColumnMenuSortItem.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ function GridColumnMenuSortItem(props: GridColumnMenuItemProps) {
onClick(event);
const direction = event.currentTarget.getAttribute('data-value') || null;
apiRef.current.sortColumn(
colDef!,
colDef!.field,
(direction === sortDirection ? null : direction) as GridSortDirection,
);
},
Expand Down
11 changes: 6 additions & 5 deletions packages/grid/x-data-grid/src/hooks/features/sorting/useGridSorting.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,8 @@ export const useGridSorting = (
);

const sortColumn = React.useCallback<GridSortApi['sortColumn']>(
(column, direction, allowMultipleSorting) => {
(field, direction, allowMultipleSorting) => {
const column = apiRef.current.getColumn(field);
if (!column.sortable) {
return;
}
Expand Down Expand Up @@ -307,18 +308,18 @@ export const useGridSorting = (
* EVENTS
*/
const handleColumnHeaderClick = React.useCallback<GridEventListener<'columnHeaderClick'>>(
({ colDef }, event) => {
({ field }, event) => {
const allowMultipleSorting = event.shiftKey || event.metaKey || event.ctrlKey;
sortColumn(colDef, undefined, allowMultipleSorting);
sortColumn(field, undefined, allowMultipleSorting);
},
[sortColumn],
);

const handleColumnHeaderKeyDown = React.useCallback<GridEventListener<'columnHeaderKeyDown'>>(
({ colDef }, event) => {
({ field }, event) => {
// Ctrl + Enter opens the column menu
if (isEnterKey(event.key) && !event.ctrlKey && !event.metaKey) {
sortColumn(colDef, undefined, event.shiftKey);
sortColumn(field, undefined, event.shiftKey);
}
},
[sortColumn],
Expand Down
4 changes: 2 additions & 2 deletions packages/grid/x-data-grid/src/models/api/gridSortApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ export interface GridSortApi {
setSortModel: (model: GridSortModel) => void;
/**
* Sorts a column.
* @param {GridColDef} column The [[GridColDef]] of the column to be sorted.
* @param {GridColDef['field']} field The field identifier of the column to be sorted.
* @param {GridSortDirection} direction The direction to be sorted. By default, the next in the `sortingOrder` prop.
* @param {boolean} allowMultipleSorting Whether to keep the existing [[GridSortItem]]. Default is `false`.
*/
sortColumn: (
column: GridColDef,
field: GridColDef['field'],
direction?: GridSortDirection,
allowMultipleSorting?: boolean,
) => void;
Expand Down