Skip to content

Commit

Permalink
scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
@alexfauquette
alexfauquette committed Jun 7, 2022
1 parent f5cac73 commit be7b21c
Show file tree
Hide file tree
Showing 17 changed files with 40 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/pages/x/api/data-grid/data-grid-premium.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@
"getRowSpacing": { "type": { "name": "func" } },
"getTreeDataPath": { "type": { "name": "func" } },
"groupingColDef": { "type": { "name": "union", "description": "func<br>&#124;&nbsp;object" } },
"headerGroupingRowHeight": { "type": { "name": "number" }, "default": "32" },
"headerHeight": { "type": { "name": "number" }, "default": "56" },
"hideFooter": { "type": { "name": "bool" } },
"hideFooterPagination": { "type": { "name": "bool" } },
Expand Down
1 change: 1 addition & 0 deletions docs/pages/x/api/data-grid/data-grid-pro.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@
"getRowSpacing": { "type": { "name": "func" } },
"getTreeDataPath": { "type": { "name": "func" } },
"groupingColDef": { "type": { "name": "union", "description": "func<br>&#124;&nbsp;object" } },
"headerGroupingRowHeight": { "type": { "name": "number" }, "default": "32" },
"headerHeight": { "type": { "name": "number" }, "default": "56" },
"hideFooter": { "type": { "name": "bool" } },
"hideFooterPagination": { "type": { "name": "bool" } },
Expand Down
1 change: 1 addition & 0 deletions docs/pages/x/api/data-grid/data-grid.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
"getRowHeight": { "type": { "name": "func" } },
"getRowId": { "type": { "name": "func" } },
"getRowSpacing": { "type": { "name": "func" } },
"headerGroupingRowHeight": { "type": { "name": "number" }, "default": "32" },
"headerHeight": { "type": { "name": "number" }, "default": "56" },
"hideFooter": { "type": { "name": "bool" } },
"hideFooterPagination": { "type": { "name": "bool" } },
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/x/api/data-grid/grid-api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ import { GridApi } from '@mui/x-data-grid-pro';
| <span class="prop-name">setColumnVisibility</span> | <span class="prop-type">(field: string, isVisible: boolean) =&gt; void</span> | Changes the visibility of the column referred by `field`. |
| <span class="prop-name">setColumnVisibilityModel</span> | <span class="prop-type">(model: GridColumnVisibilityModel) =&gt; void</span> | Sets the column visibility model to the one given by `model`. |
| <span class="prop-name">setColumnWidth</span> | <span class="prop-type">(field: string, width: number) =&gt; void</span> | Updates the width of a column. |
| <span class="prop-name">setDensity</span> | <span class="prop-type">(density: GridDensity, headerHeight?: number, rowHeight?: number) =&gt; void</span> | Sets the density of the grid. |
| <span class="prop-name">setDensity</span> | <span class="prop-type">(density: GridDensity, headerHeight?: number, rowHeight?: number, maxDepth?: number, headerGroupingRowHeight?: number) =&gt; void</span> | Sets the density of the grid. |
| <span class="prop-name">setEditCellValue</span> | <span class="prop-type">(params: GridEditCellValueParams, event?: MuiBaseEvent) =&gt; Promise&lt;boolean&gt; \| void</span> | Sets the value of the edit cell.<br />Commonly used inside the edit cell component. |
| <span class="prop-name">setEditRowsModel</span> | <span class="prop-type">(model: GridEditRowsModel) =&gt; void</span> | Set the edit rows model of the grid. |
| <span class="prop-name">setExpandedDetailPanels [<span class="plan-pro" title="Pro plan"></span>](https://mui.com/store/items/mui-x-pro/)</span> | <span class="prop-type">(ids: GridRowId[]) =&gt; void</span> | Changes which rows to expand the detail panel. |
Expand Down
18 changes: 18 additions & 0 deletions docs/pages/x/api/data-grid/selectors.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,18 @@
"description": "",
"supportsApiRef": true
},
{
"name": "gridDensityHeaderGroupingMaxDepthSelector",
"returnType": "number",
"description": "",
"supportsApiRef": true
},
{
"name": "gridDensityHeaderGroupingRowHeightSelector",
"returnType": "number",
"description": "",
"supportsApiRef": true
},
{
"name": "gridDensityHeaderHeightSelector",
"returnType": "number",
Expand All @@ -89,6 +101,12 @@
"description": "",
"supportsApiRef": false
},
{
"name": "gridDensityTotalHeaderHeightSelector",
"returnType": "number",
"description": "",
"supportsApiRef": true
},
{
"name": "gridDensityValueSelector",
"returnType": "GridDensity",
Expand Down
1 change: 1 addition & 0 deletions docs/translations/api-docs/data-grid/data-grid-premium-pt.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
"getRowSpacing": "Function that allows to specify the spacing between rows.<br><br><strong>Signature:</strong><br><code>function(params: GridRowSpacingParams) =&gt; GridRowSpacing</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-row-spacing-params/\">GridRowSpacingParams</a>.<br> <em>returns</em> (GridRowSpacing): The row spacing values.",
"getTreeDataPath": "Determines the path of a row in the tree data. For instance, a row with the path [&quot;A&quot;, &quot;B&quot;] is the child of the row with the path [&quot;A&quot;]. Note that all paths must contain at least one element.<br><br><strong>Signature:</strong><br><code>function(row: R) =&gt; Array&lt;string&gt;</code><br><em>row:</em> The row from which we want the path.<br> <em>returns</em> (Array<string>): The path to the row.",
"groupingColDef": "The grouping column used by the tree data.",
"headerGroupingRowHeight": "The height of a row of grouping column headers. TODO: choose correctly this value",
"headerHeight": "Set the height in pixel of the column headers in the grid.",
"hideFooter": "If <code>true</code>, the footer component is hidden.",
"hideFooterPagination": "If <code>true</code>, the pagination component in the footer is hidden.",
Expand Down
1 change: 1 addition & 0 deletions docs/translations/api-docs/data-grid/data-grid-premium-zh.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
"getRowSpacing": "Function that allows to specify the spacing between rows.<br><br><strong>Signature:</strong><br><code>function(params: GridRowSpacingParams) =&gt; GridRowSpacing</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-row-spacing-params/\">GridRowSpacingParams</a>.<br> <em>returns</em> (GridRowSpacing): The row spacing values.",
"getTreeDataPath": "Determines the path of a row in the tree data. For instance, a row with the path [&quot;A&quot;, &quot;B&quot;] is the child of the row with the path [&quot;A&quot;]. Note that all paths must contain at least one element.<br><br><strong>Signature:</strong><br><code>function(row: R) =&gt; Array&lt;string&gt;</code><br><em>row:</em> The row from which we want the path.<br> <em>returns</em> (Array<string>): The path to the row.",
"groupingColDef": "The grouping column used by the tree data.",
"headerGroupingRowHeight": "The height of a row of grouping column headers. TODO: choose correctly this value",
"headerHeight": "Set the height in pixel of the column headers in the grid.",
"hideFooter": "If <code>true</code>, the footer component is hidden.",
"hideFooterPagination": "If <code>true</code>, the pagination component in the footer is hidden.",
Expand Down
1 change: 1 addition & 0 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 @@ -52,6 +52,7 @@
"getRowSpacing": "Function that allows to specify the spacing between rows.<br><br><strong>Signature:</strong><br><code>function(params: GridRowSpacingParams) =&gt; GridRowSpacing</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-row-spacing-params/\">GridRowSpacingParams</a>.<br> <em>returns</em> (GridRowSpacing): The row spacing values.",
"getTreeDataPath": "Determines the path of a row in the tree data. For instance, a row with the path [&quot;A&quot;, &quot;B&quot;] is the child of the row with the path [&quot;A&quot;]. Note that all paths must contain at least one element.<br><br><strong>Signature:</strong><br><code>function(row: R) =&gt; Array&lt;string&gt;</code><br><em>row:</em> The row from which we want the path.<br> <em>returns</em> (Array<string>): The path to the row.",
"groupingColDef": "The grouping column used by the tree data.",
"headerGroupingRowHeight": "The height of a row of grouping column headers. TODO: choose correctly this value",
"headerHeight": "Set the height in pixel of the column headers in the grid.",
"hideFooter": "If <code>true</code>, the footer component is hidden.",
"hideFooterPagination": "If <code>true</code>, the pagination component in the footer is hidden.",
Expand Down
1 change: 1 addition & 0 deletions docs/translations/api-docs/data-grid/data-grid-pro-pt.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
"getRowSpacing": "Function that allows to specify the spacing between rows.<br><br><strong>Signature:</strong><br><code>function(params: GridRowSpacingParams) =&gt; GridRowSpacing</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-row-spacing-params/\">GridRowSpacingParams</a>.<br> <em>returns</em> (GridRowSpacing): The row spacing values.",
"getTreeDataPath": "Determines the path of a row in the tree data. For instance, a row with the path [&quot;A&quot;, &quot;B&quot;] is the child of the row with the path [&quot;A&quot;]. Note that all paths must contain at least one element.<br><br><strong>Signature:</strong><br><code>function(row: R) =&gt; Array&lt;string&gt;</code><br><em>row:</em> The row from which we want the path.<br> <em>returns</em> (Array<string>): The path to the row.",
"groupingColDef": "The grouping column used by the tree data.",
"headerGroupingRowHeight": "The height of a row of grouping column headers. TODO: choose correctly this value",
"headerHeight": "Set the height in pixel of the column headers in the grid.",
"hideFooter": "If <code>true</code>, the footer component is hidden.",
"hideFooterPagination": "If <code>true</code>, the pagination component in the footer is hidden.",
Expand Down
1 change: 1 addition & 0 deletions docs/translations/api-docs/data-grid/data-grid-pro-zh.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
"getRowSpacing": "Function that allows to specify the spacing between rows.<br><br><strong>Signature:</strong><br><code>function(params: GridRowSpacingParams) =&gt; GridRowSpacing</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-row-spacing-params/\">GridRowSpacingParams</a>.<br> <em>returns</em> (GridRowSpacing): The row spacing values.",
"getTreeDataPath": "Determines the path of a row in the tree data. For instance, a row with the path [&quot;A&quot;, &quot;B&quot;] is the child of the row with the path [&quot;A&quot;]. Note that all paths must contain at least one element.<br><br><strong>Signature:</strong><br><code>function(row: R) =&gt; Array&lt;string&gt;</code><br><em>row:</em> The row from which we want the path.<br> <em>returns</em> (Array<string>): The path to the row.",
"groupingColDef": "The grouping column used by the tree data.",
"headerGroupingRowHeight": "The height of a row of grouping column headers. TODO: choose correctly this value",
"headerHeight": "Set the height in pixel of the column headers in the grid.",
"hideFooter": "If <code>true</code>, the footer component is hidden.",
"hideFooterPagination": "If <code>true</code>, the pagination component in the footer is hidden.",
Expand Down
1 change: 1 addition & 0 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 @@ -51,6 +51,7 @@
"getRowSpacing": "Function that allows to specify the spacing between rows.<br><br><strong>Signature:</strong><br><code>function(params: GridRowSpacingParams) =&gt; GridRowSpacing</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-row-spacing-params/\">GridRowSpacingParams</a>.<br> <em>returns</em> (GridRowSpacing): The row spacing values.",
"getTreeDataPath": "Determines the path of a row in the tree data. For instance, a row with the path [&quot;A&quot;, &quot;B&quot;] is the child of the row with the path [&quot;A&quot;]. Note that all paths must contain at least one element.<br><br><strong>Signature:</strong><br><code>function(row: R) =&gt; Array&lt;string&gt;</code><br><em>row:</em> The row from which we want the path.<br> <em>returns</em> (Array<string>): The path to the row.",
"groupingColDef": "The grouping column used by the tree data.",
"headerGroupingRowHeight": "The height of a row of grouping column headers. TODO: choose correctly this value",
"headerHeight": "Set the height in pixel of the column headers in the grid.",
"hideFooter": "If <code>true</code>, the footer component is hidden.",
"hideFooterPagination": "If <code>true</code>, the pagination component in the footer is hidden.",
Expand Down
1 change: 1 addition & 0 deletions docs/translations/api-docs/data-grid/data-grid-pt.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
"getRowHeight": "Function that sets the row height per row.<br><br><strong>Signature:</strong><br><code>function(params: GridRowHeightParams) =&gt; GridRowHeightReturnValue</code><br><em>params:</em> With all properties from GridRowHeightParams.<br> <em>returns</em> (GridRowHeightReturnValue): The row height value. If <code>null</code> or <code>undefined</code> then the default row height is applied. If &quot;auto&quot; then the row height is calculated based on the content.",
"getRowId": "Return the id of a given GridRowModel.",
"getRowSpacing": "Function that allows to specify the spacing between rows.<br><br><strong>Signature:</strong><br><code>function(params: GridRowSpacingParams) =&gt; GridRowSpacing</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-row-spacing-params/\">GridRowSpacingParams</a>.<br> <em>returns</em> (GridRowSpacing): The row spacing values.",
"headerGroupingRowHeight": "The height of a row of grouping column headers. TODO: choose correctly this value",
"headerHeight": "Set the height in pixel of the column headers in the grid.",
"hideFooter": "If <code>true</code>, the footer component is hidden.",
"hideFooterPagination": "If <code>true</code>, the pagination component in the footer is hidden.",
Expand Down
1 change: 1 addition & 0 deletions docs/translations/api-docs/data-grid/data-grid-zh.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
"getRowHeight": "Function that sets the row height per row.<br><br><strong>Signature:</strong><br><code>function(params: GridRowHeightParams) =&gt; GridRowHeightReturnValue</code><br><em>params:</em> With all properties from GridRowHeightParams.<br> <em>returns</em> (GridRowHeightReturnValue): The row height value. If <code>null</code> or <code>undefined</code> then the default row height is applied. If &quot;auto&quot; then the row height is calculated based on the content.",
"getRowId": "Return the id of a given GridRowModel.",
"getRowSpacing": "Function that allows to specify the spacing between rows.<br><br><strong>Signature:</strong><br><code>function(params: GridRowSpacingParams) =&gt; GridRowSpacing</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-row-spacing-params/\">GridRowSpacingParams</a>.<br> <em>returns</em> (GridRowSpacing): The row spacing values.",
"headerGroupingRowHeight": "The height of a row of grouping column headers. TODO: choose correctly this value",
"headerHeight": "Set the height in pixel of the column headers in the grid.",
"hideFooter": "If <code>true</code>, the footer component is hidden.",
"hideFooterPagination": "If <code>true</code>, the pagination component in the footer is hidden.",
Expand Down
1 change: 1 addition & 0 deletions docs/translations/api-docs/data-grid/data-grid.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
"getRowHeight": "Function that sets the row height per row.<br><br><strong>Signature:</strong><br><code>function(params: GridRowHeightParams) =&gt; GridRowHeightReturnValue</code><br><em>params:</em> With all properties from GridRowHeightParams.<br> <em>returns</em> (GridRowHeightReturnValue): The row height value. If <code>null</code> or <code>undefined</code> then the default row height is applied. If &quot;auto&quot; then the row height is calculated based on the content.",
"getRowId": "Return the id of a given GridRowModel.",
"getRowSpacing": "Function that allows to specify the spacing between rows.<br><br><strong>Signature:</strong><br><code>function(params: GridRowSpacingParams) =&gt; GridRowSpacing</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-row-spacing-params/\">GridRowSpacingParams</a>.<br> <em>returns</em> (GridRowSpacing): The row spacing values.",
"headerGroupingRowHeight": "The height of a row of grouping column headers. TODO: choose correctly this value",
"headerHeight": "Set the height in pixel of the column headers in the grid.",
"hideFooter": "If <code>true</code>, the footer component is hidden.",
"hideFooterPagination": "If <code>true</code>, the pagination component in the footer is hidden.",
Expand Down
3 changes: 3 additions & 0 deletions scripts/x-data-grid-premium.exports.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -174,11 +174,14 @@
{ "name": "GridDensity", "kind": "TypeAlias" },
{ "name": "GridDensityApi", "kind": "Interface" },
{ "name": "gridDensityFactorSelector", "kind": "Variable" },
{ "name": "gridDensityHeaderGroupingMaxDepthSelector", "kind": "Variable" },
{ "name": "gridDensityHeaderGroupingRowHeightSelector", "kind": "Variable" },
{ "name": "gridDensityHeaderHeightSelector", "kind": "Variable" },
{ "name": "GridDensityOption", "kind": "Interface" },
{ "name": "gridDensityRowHeightSelector", "kind": "Variable" },
{ "name": "gridDensitySelector", "kind": "Variable" },
{ "name": "GridDensityState", "kind": "Interface" },
{ "name": "gridDensityTotalHeaderHeightSelector", "kind": "Variable" },
{ "name": "GridDensityTypes", "kind": "Enum" },
{ "name": "gridDensityValueSelector", "kind": "Variable" },
{ "name": "GridDetailPanelApi", "kind": "Interface" },
Expand Down
3 changes: 3 additions & 0 deletions scripts/x-data-grid-pro.exports.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -171,11 +171,14 @@
{ "name": "GridDensity", "kind": "TypeAlias" },
{ "name": "GridDensityApi", "kind": "Interface" },
{ "name": "gridDensityFactorSelector", "kind": "Variable" },
{ "name": "gridDensityHeaderGroupingMaxDepthSelector", "kind": "Variable" },
{ "name": "gridDensityHeaderGroupingRowHeightSelector", "kind": "Variable" },
{ "name": "gridDensityHeaderHeightSelector", "kind": "Variable" },
{ "name": "GridDensityOption", "kind": "Interface" },
{ "name": "gridDensityRowHeightSelector", "kind": "Variable" },
{ "name": "gridDensitySelector", "kind": "Variable" },
{ "name": "GridDensityState", "kind": "Interface" },
{ "name": "gridDensityTotalHeaderHeightSelector", "kind": "Variable" },
{ "name": "GridDensityTypes", "kind": "Enum" },
{ "name": "gridDensityValueSelector", "kind": "Variable" },
{ "name": "GridDetailPanelApi", "kind": "Interface" },
Expand Down
Loading

0 comments on commit be7b21c

Please sign in to comment.