Skip to content

Commit

Permalink
yarn docs:api
Browse files Browse the repository at this point in the history
  • Loading branch information
@cherniavskii
cherniavskii committed Dec 20, 2023
1 parent 4f97f36 commit 92832be
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 48 deletions.
32 changes: 16 additions & 16 deletions docs/translations/api-docs/data-grid/data-grid-premium.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@
"typeDescriptions": {}
},
"aria-label": {
"description": "The label of the grid.",
"description": "The label of the Data Grid.",
"deprecated": "",
"typeDescriptions": {}
},
"aria-labelledby": {
"description": "The id of the element containing a label for the grid.",
"description": "The id of the element containing a label for the Data Grid.",
"deprecated": "",
"typeDescriptions": {}
},
"autoHeight": {
"description": "If <code>true</code>, the grid height is dynamic and follow the number of rows in the grid.",
"description": "If <code>true</code>, the Data Grid height is dynamic and follow the number of rows in the Data Grid.",
"deprecated": "",
"typeDescriptions": {}
},
Expand Down Expand Up @@ -67,7 +67,7 @@
"typeDescriptions": {}
},
"checkboxSelection": {
"description": "If <code>true</code>, the grid gets a first column with a checkbox that allows to select rows.",
"description": "If <code>true</code>, the Data Grid will display an extra column with checkboxes for selecting rows.",
"deprecated": "",
"typeDescriptions": {}
},
Expand All @@ -92,7 +92,7 @@
"typeDescriptions": {}
},
"columnHeaderHeight": {
"description": "Sets the height in pixel of the column headers in the grid.",
"description": "Sets the height in pixel of the column headers in the Data Grid.",
"deprecated": "",
"typeDescriptions": {}
},
Expand All @@ -107,7 +107,7 @@
"typeDescriptions": {}
},
"columnVisibilityModel": {
"description": "Set the column visibility model of the grid. If defined, the grid will ignore the <code>hide</code> property in <a href=\"/x/api/data-grid/grid-col-def/\">GridColDef</a>.",
"description": "Set the column visibility model of the Data Grid. If defined, the Data Grid will ignore the <code>hide</code> property in <a href=\"/x/api/data-grid/grid-col-def/\">GridColDef</a>.",
"deprecated": "",
"typeDescriptions": {}
},
Expand All @@ -117,7 +117,7 @@
"typeDescriptions": {}
},
"density": {
"description": "Set the density of the grid.",
"description": "Set the density of the Data Grid.",
"deprecated": "",
"typeDescriptions": {}
},
Expand Down Expand Up @@ -237,7 +237,7 @@
"typeDescriptions": {}
},
"filterModel": {
"description": "Set the filter model of the grid.",
"description": "Set the filter model of the Data Grid.",
"deprecated": "",
"typeDescriptions": {}
},
Expand Down Expand Up @@ -354,7 +354,7 @@
"typeDescriptions": {}
},
"ignoreValueFormatterDuringExport": {
"description": "If <code>true</code>, the grid will not use <code>valueFormatter</code> when exporting to CSV or copying to clipboard. If an object is provided, you can choose to ignore the <code>valueFormatter</code> for CSV export or clipboard export.",
"description": "If <code>true</code>, the Data Grid will not use <code>valueFormatter</code> when exporting to CSV or copying to clipboard. If an object is provided, you can choose to ignore the <code>valueFormatter</code> for CSV export or clipboard export.",
"deprecated": "",
"typeDescriptions": {}
},
Expand Down Expand Up @@ -403,7 +403,7 @@
"typeDescriptions": {}
},
"localeText": {
"description": "Set the locale text of the grid. You can find all the translation keys supported in <a href=\"https://github.com/mui/mui-x/blob/HEAD/packages/grid/x-data-grid/src/constants/localeTextConstants.ts\">the source</a> in the GitHub repository.",
"description": "Set the locale text of the Data Grid. You can find all the translation keys supported in <a href=\"https://github.com/mui/mui-x/blob/HEAD/packages/grid/x-data-grid/src/constants/localeTextConstants.ts\">the source</a> in the GitHub repository.",
"deprecated": "",
"typeDescriptions": {}
},
Expand Down Expand Up @@ -681,7 +681,7 @@
"typeDescriptions": { "error": "The error thrown." }
},
"onResize": {
"description": "Callback fired when the grid is resized.",
"description": "Callback fired when the Data Grid is resized.",
"deprecated": "",
"typeDescriptions": {
"containerSize": "With all properties from ElementSize.",
Expand Down Expand Up @@ -841,7 +841,7 @@
"typeDescriptions": {}
},
"rowHeight": {
"description": "Sets the height in pixel of a row in the grid.",
"description": "Sets the height in pixel of a row in the Data Grid.",
"deprecated": "",
"typeDescriptions": {}
},
Expand Down Expand Up @@ -871,7 +871,7 @@
"typeDescriptions": {}
},
"rowSelectionModel": {
"description": "Sets the row selection model of the grid.",
"description": "Sets the row selection model of the Data Grid.",
"deprecated": "",
"typeDescriptions": {}
},
Expand All @@ -891,7 +891,7 @@
"typeDescriptions": {}
},
"scrollbarSize": {
"description": "Override the height/width of the grid inner scrollbar.",
"description": "Override the height/width of the Data Grid inner scrollbar.",
"deprecated": "",
"typeDescriptions": {}
},
Expand Down Expand Up @@ -927,7 +927,7 @@
"typeDescriptions": {}
},
"sortModel": {
"description": "Set the sort model of the grid.",
"description": "Set the sort model of the Data Grid.",
"deprecated": "",
"typeDescriptions": {}
},
Expand All @@ -942,7 +942,7 @@
"typeDescriptions": {}
},
"throttleRowsMs": {
"description": "If positive, the grid will throttle updates coming from <code>apiRef.current.updateRows</code> and <code>apiRef.current.setRows</code>. It can be useful if you have a high update rate but do not want to do heavy work like filtering / sorting or rendering on each individual update.",
"description": "If positive, the Data Grid will throttle updates coming from <code>apiRef.current.updateRows</code> and <code>apiRef.current.setRows</code>. It can be useful if you have a high update rate but do not want to do heavy work like filtering / sorting or rendering on each individual update.",
"deprecated": "",
"typeDescriptions": {}
},
Expand Down
32 changes: 16 additions & 16 deletions docs/translations/api-docs/data-grid/data-grid-pro.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@
"typeDescriptions": {}
},
"aria-label": {
"description": "The label of the grid.",
"description": "The label of the Data Grid.",
"deprecated": "",
"typeDescriptions": {}
},
"aria-labelledby": {
"description": "The id of the element containing a label for the grid.",
"description": "The id of the element containing a label for the Data Grid.",
"deprecated": "",
"typeDescriptions": {}
},
"autoHeight": {
"description": "If <code>true</code>, the grid height is dynamic and follow the number of rows in the grid.",
"description": "If <code>true</code>, the Data Grid height is dynamic and follow the number of rows in the Data Grid.",
"deprecated": "",
"typeDescriptions": {}
},
Expand All @@ -42,7 +42,7 @@
"typeDescriptions": {}
},
"checkboxSelection": {
"description": "If <code>true</code>, the grid gets a first column with a checkbox that allows to select rows.",
"description": "If <code>true</code>, the Data Grid will display an extra column with checkboxes for selecting rows.",
"deprecated": "",
"typeDescriptions": {}
},
Expand All @@ -67,7 +67,7 @@
"typeDescriptions": {}
},
"columnHeaderHeight": {
"description": "Sets the height in pixel of the column headers in the grid.",
"description": "Sets the height in pixel of the column headers in the Data Grid.",
"deprecated": "",
"typeDescriptions": {}
},
Expand All @@ -82,7 +82,7 @@
"typeDescriptions": {}
},
"columnVisibilityModel": {
"description": "Set the column visibility model of the grid. If defined, the grid will ignore the <code>hide</code> property in <a href=\"/x/api/data-grid/grid-col-def/\">GridColDef</a>.",
"description": "Set the column visibility model of the Data Grid. If defined, the Data Grid will ignore the <code>hide</code> property in <a href=\"/x/api/data-grid/grid-col-def/\">GridColDef</a>.",
"deprecated": "",
"typeDescriptions": {}
},
Expand All @@ -92,7 +92,7 @@
"typeDescriptions": {}
},
"density": {
"description": "Set the density of the grid.",
"description": "Set the density of the Data Grid.",
"deprecated": "",
"typeDescriptions": {}
},
Expand Down Expand Up @@ -197,7 +197,7 @@
"typeDescriptions": {}
},
"filterModel": {
"description": "Set the filter model of the grid.",
"description": "Set the filter model of the Data Grid.",
"deprecated": "",
"typeDescriptions": {}
},
Expand Down Expand Up @@ -306,7 +306,7 @@
"typeDescriptions": {}
},
"ignoreValueFormatterDuringExport": {
"description": "If <code>true</code>, the grid will not use <code>valueFormatter</code> when exporting to CSV or copying to clipboard. If an object is provided, you can choose to ignore the <code>valueFormatter</code> for CSV export or clipboard export.",
"description": "If <code>true</code>, the Data Grid will not use <code>valueFormatter</code> when exporting to CSV or copying to clipboard. If an object is provided, you can choose to ignore the <code>valueFormatter</code> for CSV export or clipboard export.",
"deprecated": "",
"typeDescriptions": {}
},
Expand Down Expand Up @@ -355,7 +355,7 @@
"typeDescriptions": {}
},
"localeText": {
"description": "Set the locale text of the grid. You can find all the translation keys supported in <a href=\"https://github.com/mui/mui-x/blob/HEAD/packages/grid/x-data-grid/src/constants/localeTextConstants.ts\">the source</a> in the GitHub repository.",
"description": "Set the locale text of the Data Grid. You can find all the translation keys supported in <a href=\"https://github.com/mui/mui-x/blob/HEAD/packages/grid/x-data-grid/src/constants/localeTextConstants.ts\">the source</a> in the GitHub repository.",
"deprecated": "",
"typeDescriptions": {}
},
Expand Down Expand Up @@ -602,7 +602,7 @@
"typeDescriptions": { "error": "The error thrown." }
},
"onResize": {
"description": "Callback fired when the grid is resized.",
"description": "Callback fired when the Data Grid is resized.",
"deprecated": "",
"typeDescriptions": {
"containerSize": "With all properties from ElementSize.",
Expand Down Expand Up @@ -744,7 +744,7 @@
"typeDescriptions": {}
},
"rowHeight": {
"description": "Sets the height in pixel of a row in the grid.",
"description": "Sets the height in pixel of a row in the Data Grid.",
"deprecated": "",
"typeDescriptions": {}
},
Expand Down Expand Up @@ -774,7 +774,7 @@
"typeDescriptions": {}
},
"rowSelectionModel": {
"description": "Sets the row selection model of the grid.",
"description": "Sets the row selection model of the Data Grid.",
"deprecated": "",
"typeDescriptions": {}
},
Expand All @@ -794,7 +794,7 @@
"typeDescriptions": {}
},
"scrollbarSize": {
"description": "Override the height/width of the grid inner scrollbar.",
"description": "Override the height/width of the Data Grid inner scrollbar.",
"deprecated": "",
"typeDescriptions": {}
},
Expand Down Expand Up @@ -830,7 +830,7 @@
"typeDescriptions": {}
},
"sortModel": {
"description": "Set the sort model of the grid.",
"description": "Set the sort model of the Data Grid.",
"deprecated": "",
"typeDescriptions": {}
},
Expand All @@ -840,7 +840,7 @@
"typeDescriptions": {}
},
"throttleRowsMs": {
"description": "If positive, the grid will throttle updates coming from <code>apiRef.current.updateRows</code> and <code>apiRef.current.setRows</code>. It can be useful if you have a high update rate but do not want to do heavy work like filtering / sorting or rendering on each individual update.",
"description": "If positive, the Data Grid will throttle updates coming from <code>apiRef.current.updateRows</code> and <code>apiRef.current.setRows</code>. It can be useful if you have a high update rate but do not want to do heavy work like filtering / sorting or rendering on each individual update.",
"deprecated": "",
"typeDescriptions": {}
},
Expand Down
Loading

0 comments on commit 92832be

Please sign in to comment.