File tree Expand file tree Collapse file tree 12 files changed +64
-35
lines changed
x-charts/src/internals/plugins/models/seriesConfig
x-data-grid-pro/src/utils/tree
x-tree-view/src/internals/utils Expand file tree Collapse file tree 12 files changed +64
-35
lines changed Original file line number Diff line number Diff line change 144144 "eslint-import-resolver-webpack" : " ^0.13.10" ,
145145 "eslint-plugin-consistent-default-export-name" : " ^0.0.15" ,
146146 "eslint-plugin-import" : " ^2.31.0" ,
147- "eslint-plugin-jsdoc" : " ^50.6.14 " ,
147+ "eslint-plugin-jsdoc" : " ^50.7.1 " ,
148148 "eslint-plugin-jsx-a11y" : " ^6.10.2" ,
149149 "eslint-plugin-material-ui" : " workspace:^" ,
150150 "eslint-plugin-mocha" : " ^10.5.0" ,
151- "eslint-plugin-prettier" : " ^5.4.0 " ,
151+ "eslint-plugin-prettier" : " ^5.4.1 " ,
152152 "eslint-plugin-react" : " ^7.37.5" ,
153153 "eslint-plugin-react-compiler" : " 19.0.0-beta-ebf51a3-20250411" ,
154154 "eslint-plugin-react-hooks" : " ^5.2.0" ,
155- "eslint-plugin-testing-library" : " ^7.2.2 " ,
155+ "eslint-plugin-testing-library" : " ^7.4.0 " ,
156156 "fast-glob" : " ^3.3.3" ,
157157 "format-util" : " ^1.0.5" ,
158158 "fs-extra" : " ^11.3.0" ,
Original file line number Diff line number Diff line change @@ -17,6 +17,11 @@ export type ColorGetter<TSeriesType extends ChartSeriesType> = TSeriesType exten
1717/**
1818 * Transforms charts config to a color getter.
1919 * If dataIndex is not defined, it falls back to the series color.
20+ * @param {DefaultizedSeriesType<TSeriesType> } series - The series configuration.
21+ * @param {ComputedXAxis | undefined } xAxis - The computed x-axis configuration.
22+ * @param {ComputedYAxis | undefined } yAxis - The computed y-axis configuration.
23+ * @param {ZAxisDefaultized | undefined } zAxis - The defaulted z-axis configuration.
24+ * @returns {ColorGetter<TSeriesType> } A function that takes a data index and returns a color string.
2025 */
2126export type ColorProcessor < TSeriesType extends ChartSeriesType > = (
2227 series : DefaultizedSeriesType < TSeriesType > ,
Original file line number Diff line number Diff line change @@ -86,9 +86,10 @@ export type TooltipGetter<TSeriesType extends ChartSeriesType> = (params: {
8686 | null ;
8787
8888/**
89- * Return an array of the axes that should trigger the tooltip.
90- *
9189 * If `axisId` is set to undefined, the default axis will be used.
90+ *
91+ * @param {Record<SeriesId, ChartSeriesDefaultized<TSeriesType>> } series A map of series ID to their series configuration.
92+ * @returns {{ direction: Directions; axisId: AxisId | undefined }[] } an array of the axes that should trigger the tooltip.
9293 */
9394export type AxisTooltipGetter <
9495 TSeriesType extends ChartSeriesType ,
Original file line number Diff line number Diff line change @@ -13,6 +13,9 @@ export interface RowTreeBuilderNode {
1313
1414/**
1515 * Callback called when trying to insert a data row in the tree in place of an already existing data row.
16+ * @param {GridRowId } firstId The id of the row that is already in the tree.
17+ * @param {GridRowId } secondId The id of the row that is being inserted.
18+ * @param {RowTreeBuilderGroupingCriterion[] } path The path of the row that is being inserted.
1619 */
1720export type GridTreePathDuplicateHandler = (
1821 firstId : GridRowId ,
Original file line number Diff line number Diff line change @@ -52,8 +52,9 @@ export interface GridAggregatedFilterItemApplierResult {
5252}
5353
5454/**
55- * @param {GridRowId } rowId The id of the row we want to filter.
55+ * @param {GridValidRowModel } row The model of the row we want to filter.
5656 * @param {(filterItem: GridFilterItem) => boolean } shouldApplyItem An optional callback to allow the filtering engine to only apply some items.
57+ * @param {GridAggregatedFilterItemApplierResult } result The previous result of the filtering engine.
5758 */
5859export type GridAggregatedFilterItemApplier = (
5960 row : GridValidRowModel ,
Original file line number Diff line number Diff line change @@ -3,6 +3,8 @@ import { GridCellParams } from './params/gridCellParams';
33
44/**
55 * A function used to process cellClassName params.
6+ * @param {GridCellParams<R, V> } params The parameters of the cell.
7+ * @returns {string } The class name to be added to the cell.
68 */
79export type GridCellClassFn < R extends GridValidRowModel = any , V = unknown > = (
810 params : GridCellParams < R , V > ,
Original file line number Diff line number Diff line change @@ -13,6 +13,8 @@ export function isLeaf(node: GridColumnNode): node is GridLeafColumn {
1313
1414/**
1515 * A function used to process headerClassName params.
16+ * @param {GridColumnGroupHeaderParams } params The parameters of the column group header.
17+ * @returns {string } The class name to be added to the column group header cell.
1618 */
1719export type GridColumnGroupHeaderClassFn = ( params : GridColumnGroupHeaderParams ) => string ;
1820
Original file line number Diff line number Diff line change @@ -2,6 +2,8 @@ import { GridColumnHeaderParams } from './params/gridColumnHeaderParams';
22
33/**
44 * A function used to process headerClassName params.
5+ * @param {GridColumnHeaderParams } params The parameters of the column header.
6+ * @returns {string } The class name to be added to the column header cell.
57 */
68export type GridColumnHeaderClassFn = ( params : GridColumnHeaderParams ) => string ;
79
Original file line number Diff line number Diff line change @@ -208,6 +208,8 @@ export interface GridRowEntry<R extends GridValidRowModel = GridValidRowModel> {
208208
209209/**
210210 * The function to retrieve the id of a [[GridRowModel]].
211+ * @param {R } row The row model.
212+ * @returns {GridRowId } The id of the row.
211213 */
212214export type GridRowIdGetter < R extends GridValidRowModel = GridValidRowModel > = (
213215 row : R ,
Original file line number Diff line number Diff line change @@ -12,6 +12,11 @@ export interface GridSortCellParams<V = any> {
1212
1313/**
1414 * The type of the sort comparison function.
15+ * @param {V } v1 The first value to compare.
16+ * @param {V } v2 The second value to compare.
17+ * @param {GridSortCellParams<V> } cellParams1 The parameters of the first cell.
18+ * @param {GridSortCellParams<V> } cellParams2 The parameters of the second cell.
19+ * @returns {number } The result of the comparison.
1520 */
1621export type GridComparatorFn < V = any > = (
1722 v1 : V ,
You can’t perform that action at this time.
0 commit comments