Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -144,15 +144,15 @@
"eslint-import-resolver-webpack": "^0.13.10",
"eslint-plugin-consistent-default-export-name": "^0.0.15",
"eslint-plugin-import": "^2.31.0",
"eslint-plugin-jsdoc": "^50.6.14",
"eslint-plugin-jsdoc": "^50.7.1",
"eslint-plugin-jsx-a11y": "^6.10.2",
"eslint-plugin-material-ui": "workspace:^",
"eslint-plugin-mocha": "^10.5.0",
"eslint-plugin-prettier": "^5.4.0",
"eslint-plugin-prettier": "^5.4.1",
"eslint-plugin-react": "^7.37.5",
"eslint-plugin-react-compiler": "19.0.0-beta-ebf51a3-20250411",
"eslint-plugin-react-hooks": "^5.2.0",
"eslint-plugin-testing-library": "^7.2.2",
"eslint-plugin-testing-library": "^7.4.0",
"fast-glob": "^3.3.3",
"format-util": "^1.0.5",
"fs-extra": "^11.3.0",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ export type ColorGetter<TSeriesType extends ChartSeriesType> = TSeriesType exten
/**
* Transforms charts config to a color getter.
* If dataIndex is not defined, it falls back to the series color.
* @param {DefaultizedSeriesType<TSeriesType>} series - The series configuration.
* @param {ComputedXAxis | undefined} xAxis - The computed x-axis configuration.
* @param {ComputedYAxis | undefined} yAxis - The computed y-axis configuration.
* @param {ZAxisDefaultized | undefined} zAxis - The defaulted z-axis configuration.
* @returns {ColorGetter<TSeriesType>} A function that takes a data index and returns a color string.
*/
export type ColorProcessor<TSeriesType extends ChartSeriesType> = (
series: DefaultizedSeriesType<TSeriesType>,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,10 @@ export type TooltipGetter<TSeriesType extends ChartSeriesType> = (params: {
| null;

/**
* Return an array of the axes that should trigger the tooltip.
*
* If `axisId` is set to undefined, the default axis will be used.
*
* @param {Record<SeriesId, ChartSeriesDefaultized<TSeriesType>>} series A map of series ID to their series configuration.
* @returns {{ direction: Directions; axisId: AxisId | undefined }[]} an array of the axes that should trigger the tooltip.
*/
export type AxisTooltipGetter<
TSeriesType extends ChartSeriesType,
Expand Down
3 changes: 3 additions & 0 deletions packages/x-data-grid-pro/src/utils/tree/models.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ export interface RowTreeBuilderNode {

/**
* Callback called when trying to insert a data row in the tree in place of an already existing data row.
* @param {GridRowId} firstId The id of the row that is already in the tree.
* @param {GridRowId} secondId The id of the row that is being inserted.
* @param {RowTreeBuilderGroupingCriterion[]} path The path of the row that is being inserted.
*/
export type GridTreePathDuplicateHandler = (
firstId: GridRowId,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,9 @@ export interface GridAggregatedFilterItemApplierResult {
}

/**
* @param {GridRowId} rowId The id of the row we want to filter.
* @param {GridValidRowModel} row The model of the row we want to filter.
* @param {(filterItem: GridFilterItem) => boolean} shouldApplyItem An optional callback to allow the filtering engine to only apply some items.
* @param {GridAggregatedFilterItemApplierResult} result The previous result of the filtering engine.
*/
export type GridAggregatedFilterItemApplier = (
row: GridValidRowModel,
Expand Down
2 changes: 2 additions & 0 deletions packages/x-data-grid/src/models/gridCellClass.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ import { GridCellParams } from './params/gridCellParams';

/**
* A function used to process cellClassName params.
* @param {GridCellParams<R, V>} params The parameters of the cell.
* @returns {string} The class name to be added to the cell.
*/
export type GridCellClassFn<R extends GridValidRowModel = any, V = unknown> = (
params: GridCellParams<R, V>,
Expand Down
2 changes: 2 additions & 0 deletions packages/x-data-grid/src/models/gridColumnGrouping.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ export function isLeaf(node: GridColumnNode): node is GridLeafColumn {

/**
* A function used to process headerClassName params.
* @param {GridColumnGroupHeaderParams} params The parameters of the column group header.
* @returns {string} The class name to be added to the column group header cell.
*/
export type GridColumnGroupHeaderClassFn = (params: GridColumnGroupHeaderParams) => string;

Expand Down
2 changes: 2 additions & 0 deletions packages/x-data-grid/src/models/gridColumnHeaderClass.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ import { GridColumnHeaderParams } from './params/gridColumnHeaderParams';

/**
* A function used to process headerClassName params.
* @param {GridColumnHeaderParams} params The parameters of the column header.
* @returns {string} The class name to be added to the column header cell.
*/
export type GridColumnHeaderClassFn = (params: GridColumnHeaderParams) => string;

Expand Down
2 changes: 2 additions & 0 deletions packages/x-data-grid/src/models/gridRows.ts
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,8 @@ export interface GridRowEntry<R extends GridValidRowModel = GridValidRowModel> {

/**
* The function to retrieve the id of a [[GridRowModel]].
* @param {R} row The row model.
* @returns {GridRowId} The id of the row.
*/
export type GridRowIdGetter<R extends GridValidRowModel = GridValidRowModel> = (
row: R,
Expand Down
5 changes: 5 additions & 0 deletions packages/x-data-grid/src/models/gridSortModel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ export interface GridSortCellParams<V = any> {

/**
* The type of the sort comparison function.
* @param {V} v1 The first value to compare.
* @param {V} v2 The second value to compare.
* @param {GridSortCellParams<V>} cellParams1 The parameters of the first cell.
* @param {GridSortCellParams<V>} cellParams2 The parameters of the second cell.
* @returns {number} The result of the comparison.
*/
export type GridComparatorFn<V = any> = (
v1: V,
Expand Down
5 changes: 5 additions & 0 deletions packages/x-tree-view/src/internals/utils/selectors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ const cache = new WeakMap<

/**
* Type of a selector that take the whole tree view state as input and returns a value based on a required plugin.
* @param {TreeViewState} state The state of the Tree View.
* @returns {any | undefined} The value of the plugin state.
*/
export type TreeViewRootSelector<
TSignature extends TreeViewAnyPluginSignature,
Expand All @@ -31,6 +33,9 @@ export type TreeViewRootSelector<

/**
* Type of a selector that take the whole tree view state as input and returns a value based on an optional plugin.
*
* @param {TreeViewState} state The state of the Tree View.
* @returns {any | undefined} The value of the plugin state or undefined if the plugin is not registered.
*/
export type TreeViewRootSelectorForOptionalPlugin<TSignature extends TreeViewAnyPluginSignature> = <
TSignatures extends [],
Expand Down
59 changes: 30 additions & 29 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.