[docs] Document aggregation selectors (#7148)

Closes #7129
mui · Dec 9, 2022 · 26dd361 · 26dd361
1 parent 9dfee2f
commit 26dd361
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/docs/data/data-grid/aggregation/aggregation.md b/docs/data/data-grid/aggregation/aggregation.md
@@ -294,6 +294,10 @@ In the example below, you can see that all the aggregation functions are rendere
 
 {{"demo": "AggregationRenderCell.js", "bg": "inline", "defaultCodeOpen": false}}
 
+## Selectors
+
+{{"component": "modules/components/SelectorsDocs.js", "category": "Aggregation"}}
+
 ## API
 
 - [DataGrid](/x/api/data-grid/data-grid/)

diff --git a/docs/pages/x/api/data-grid/selectors.json b/docs/pages/x/api/data-grid/selectors.json
@@ -2,13 +2,15 @@
   {
     "name": "gridAggregationLookupSelector",
     "returnType": "GridAggregationLookup",
-    "description": "",
+    "category": "Aggregation",
+    "description": "Get the aggregation results as a lookup.",
     "supportsApiRef": true
   },
   {
     "name": "gridAggregationModelSelector",
     "returnType": "GridAggregationModel",
-    "description": "",
+    "category": "Aggregation",
+    "description": "Get the aggregation model, containing the aggregation function of each column.\nIf a column is not in the model, it is not aggregated.",
     "supportsApiRef": true
   },
   {

diff --git a/packages/grid/x-data-grid-premium/src/hooks/features/aggregation/gridAggregationSelectors.ts b/packages/grid/x-data-grid-premium/src/hooks/features/aggregation/gridAggregationSelectors.ts
@@ -3,11 +3,20 @@ import { GridStatePremium } from '../../../models/gridStatePremium';
 
 export const gridAggregationStateSelector = (state: GridStatePremium) => state.aggregation;
 
+/**
+ * Get the aggregation model, containing the aggregation function of each column.
+ * If a column is not in the model, it is not aggregated.
+ * @category Aggregation
+ */
 export const gridAggregationModelSelector = createSelector(
   gridAggregationStateSelector,
   (aggregationState) => aggregationState.model,
 );
 
+/**
+ * Get the aggregation results as a lookup.
+ * @category Aggregation
+ */
 export const gridAggregationLookupSelector = createSelector(
   gridAggregationStateSelector,
   (aggregationState) => aggregationState.lookup,