Skip to content

Commit

Permalink
yarn proptypes
Browse files Browse the repository at this point in the history
  • Loading branch information
@cherniavskii
cherniavskii committed Dec 20, 2023
1 parent fece5cb commit 4f97f36
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 57 deletions.
38 changes: 19 additions & 19 deletions packages/grid/x-data-grid-premium/src/DataGridPremium/DataGridPremium.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,15 +97,15 @@ DataGridPremiumRaw.propTypes = {
current: PropTypes.object.isRequired,
}),
/**
* The label of the grid.
* The label of the Data Grid.
*/
'aria-label': PropTypes.string,
/**
* The id of the element containing a label for the grid.
* The id of the element containing a label for the Data Grid.
*/
'aria-labelledby': PropTypes.string,
/**
* If `true`, the grid height is dynamic and follow the number of rows in the grid.
* If `true`, the Data Grid height is dynamic and follow the number of rows in the Data Grid.
* @default false
*/
autoHeight: PropTypes.bool,
Expand Down Expand Up @@ -143,7 +143,7 @@ DataGridPremiumRaw.propTypes = {
*/
cellSelectionModel: PropTypes.object,
/**
* If `true`, the grid gets a first column with a checkbox that allows to select rows.
* If `true`, the Data Grid will display an extra column with checkboxes for selecting rows.
* @default false
*/
checkboxSelection: PropTypes.bool,
Expand Down Expand Up @@ -176,7 +176,7 @@ DataGridPremiumRaw.propTypes = {
columnBuffer: PropTypes.number,
columnGroupingModel: PropTypes.arrayOf(PropTypes.object),
/**
* Sets the height in pixel of the column headers in the grid.
* Sets the height in pixel of the column headers in the Data Grid.
* @default 56
*/
columnHeaderHeight: PropTypes.number,
Expand All @@ -190,8 +190,8 @@ DataGridPremiumRaw.propTypes = {
*/
columnThreshold: PropTypes.number,
/**
* Set the column visibility model of the grid.
* If defined, the grid will ignore the `hide` property in [[GridColDef]].
* Set the column visibility model of the Data Grid.
* If defined, the Data Grid will ignore the `hide` property in [[GridColDef]].
*/
columnVisibilityModel: PropTypes.object,
/**
Expand All @@ -201,7 +201,7 @@ DataGridPremiumRaw.propTypes = {
*/
defaultGroupingExpansionDepth: PropTypes.number,
/**
* Set the density of the grid.
* Set the density of the Data Grid.
* @default "standard"
*/
density: PropTypes.oneOf(['comfortable', 'compact', 'standard']),
Expand Down Expand Up @@ -341,7 +341,7 @@ DataGridPremiumRaw.propTypes = {
return null;
}),
/**
* Set the filter model of the grid.
* Set the filter model of the Data Grid.
*/
filterModel: PropTypes.shape({
items: PropTypes.arrayOf(
Expand All @@ -358,7 +358,7 @@ DataGridPremiumRaw.propTypes = {
quickFilterValues: PropTypes.array,
}),
/**
* Forwarded props for the grid root element.
* Forwarded props for the Data Grid root element.
* @ignore - do not document.
*/
forwardedProps: PropTypes.object,
Expand Down Expand Up @@ -471,7 +471,7 @@ DataGridPremiumRaw.propTypes = {
*/
ignoreDiacritics: PropTypes.bool,
/**
* If `true`, the grid will not use `valueFormatter` when exporting to CSV or copying to clipboard.
* If `true`, the Data Grid will not use `valueFormatter` when exporting to CSV or copying to clipboard.
* If an object is provided, you can choose to ignore the `valueFormatter` for CSV export or clipboard export.
* @default false
*/
Expand Down Expand Up @@ -525,7 +525,7 @@ DataGridPremiumRaw.propTypes = {
*/
loading: PropTypes.bool,
/**
* Set the locale text of the grid.
* Set the locale text of the Data Grid.
* You can find all the translation keys supported in [the source](https://github.com/mui/mui-x/blob/HEAD/packages/grid/x-data-grid/src/constants/localeTextConstants.ts) in the GitHub repository.
*/
localeText: PropTypes.object,
Expand Down Expand Up @@ -751,7 +751,7 @@ DataGridPremiumRaw.propTypes = {
*/
onProcessRowUpdateError: PropTypes.func,
/**
* Callback fired when the grid is resized.
* Callback fired when the Data Grid is resized.
* @param {ElementSize} containerSize With all properties from [[ElementSize]].
* @param {MuiEvent<{}>} event The event object.
* @param {GridCallbackDetails} details Additional details for this callback.
Expand Down Expand Up @@ -829,7 +829,7 @@ DataGridPremiumRaw.propTypes = {
*/
onSortModelChange: PropTypes.func,
/**
* Callback fired when the state of the grid is updated.
* Callback fired when the state of the Data Grid is updated.
* @param {GridState} state The new state.
* @param {MuiEvent<{}>} event The event object.
* @param {GridCallbackDetails} details Additional details for this callback.
Expand Down Expand Up @@ -911,7 +911,7 @@ DataGridPremiumRaw.propTypes = {
*/
rowGroupingModel: PropTypes.arrayOf(PropTypes.string),
/**
* Sets the height in pixel of a row in the grid.
* Sets the height in pixel of a row in the Data Grid.
* @default 52
*/
rowHeight: PropTypes.number,
Expand Down Expand Up @@ -941,7 +941,7 @@ DataGridPremiumRaw.propTypes = {
*/
rowSelection: PropTypes.bool,
/**
* Sets the row selection model of the grid.
* Sets the row selection model of the Data Grid.
*/
rowSelectionModel: PropTypes.oneOfType([
PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.number, PropTypes.string]).isRequired),
Expand All @@ -966,7 +966,7 @@ DataGridPremiumRaw.propTypes = {
*/
rowThreshold: PropTypes.number,
/**
* Override the height/width of the grid inner scrollbar.
* Override the height/width of the Data Grid inner scrollbar.
*/
scrollbarSize: PropTypes.number,
/**
Expand Down Expand Up @@ -1005,7 +1005,7 @@ DataGridPremiumRaw.propTypes = {
*/
sortingOrder: PropTypes.arrayOf(PropTypes.oneOf(['asc', 'desc'])),
/**
* Set the sort model of the grid.
* Set the sort model of the Data Grid.
*/
sortModel: PropTypes.arrayOf(
PropTypes.shape({
Expand All @@ -1029,7 +1029,7 @@ DataGridPremiumRaw.propTypes = {
PropTypes.object,
]),
/**
* If positive, the grid will throttle updates coming from `apiRef.current.updateRows` and `apiRef.current.setRows`.
* If positive, the Data Grid will throttle updates coming from `apiRef.current.updateRows` and `apiRef.current.setRows`.
* 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.
* @default 0
*/
Expand Down
38 changes: 19 additions & 19 deletions packages/grid/x-data-grid-pro/src/DataGridPro/DataGridPro.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,15 +80,15 @@ DataGridProRaw.propTypes = {
current: PropTypes.object.isRequired,
}),
/**
* The label of the grid.
* The label of the Data Grid.
*/
'aria-label': PropTypes.string,
/**
* The id of the element containing a label for the grid.
* The id of the element containing a label for the Data Grid.
*/
'aria-labelledby': PropTypes.string,
/**
* If `true`, the grid height is dynamic and follow the number of rows in the grid.
* If `true`, the Data Grid height is dynamic and follow the number of rows in the Data Grid.
* @default false
*/
autoHeight: PropTypes.bool,
Expand Down Expand Up @@ -117,7 +117,7 @@ DataGridProRaw.propTypes = {
*/
cellModesModel: PropTypes.object,
/**
* If `true`, the grid gets a first column with a checkbox that allows to select rows.
* If `true`, the Data Grid will display an extra column with checkboxes for selecting rows.
* @default false
*/
checkboxSelection: PropTypes.bool,
Expand Down Expand Up @@ -150,7 +150,7 @@ DataGridProRaw.propTypes = {
columnBuffer: PropTypes.number,
columnGroupingModel: PropTypes.arrayOf(PropTypes.object),
/**
* Sets the height in pixel of the column headers in the grid.
* Sets the height in pixel of the column headers in the Data Grid.
* @default 56
*/
columnHeaderHeight: PropTypes.number,
Expand All @@ -164,8 +164,8 @@ DataGridProRaw.propTypes = {
*/
columnThreshold: PropTypes.number,
/**
* Set the column visibility model of the grid.
* If defined, the grid will ignore the `hide` property in [[GridColDef]].
* Set the column visibility model of the Data Grid.
* If defined, the Data Grid will ignore the `hide` property in [[GridColDef]].
*/
columnVisibilityModel: PropTypes.object,
/**
Expand All @@ -175,7 +175,7 @@ DataGridProRaw.propTypes = {
*/
defaultGroupingExpansionDepth: PropTypes.number,
/**
* Set the density of the grid.
* Set the density of the Data Grid.
* @default "standard"
*/
density: PropTypes.oneOf(['comfortable', 'compact', 'standard']),
Expand Down Expand Up @@ -300,7 +300,7 @@ DataGridProRaw.propTypes = {
return null;
}),
/**
* Set the filter model of the grid.
* Set the filter model of the Data Grid.
*/
filterModel: PropTypes.shape({
items: PropTypes.arrayOf(
Expand All @@ -317,7 +317,7 @@ DataGridProRaw.propTypes = {
quickFilterValues: PropTypes.array,
}),
/**
* Forwarded props for the grid root element.
* Forwarded props for the Data Grid root element.
* @ignore - do not document.
*/
forwardedProps: PropTypes.object,
Expand Down Expand Up @@ -423,7 +423,7 @@ DataGridProRaw.propTypes = {
*/
ignoreDiacritics: PropTypes.bool,
/**
* If `true`, the grid will not use `valueFormatter` when exporting to CSV or copying to clipboard.
* If `true`, the Data Grid will not use `valueFormatter` when exporting to CSV or copying to clipboard.
* If an object is provided, you can choose to ignore the `valueFormatter` for CSV export or clipboard export.
* @default false
*/
Expand Down Expand Up @@ -477,7 +477,7 @@ DataGridProRaw.propTypes = {
*/
loading: PropTypes.bool,
/**
* Set the locale text of the grid.
* Set the locale text of the Data Grid.
* You can find all the translation keys supported in [the source](https://github.com/mui/mui-x/blob/HEAD/packages/grid/x-data-grid/src/constants/localeTextConstants.ts) in the GitHub repository.
*/
localeText: PropTypes.object,
Expand Down Expand Up @@ -678,7 +678,7 @@ DataGridProRaw.propTypes = {
*/
onProcessRowUpdateError: PropTypes.func,
/**
* Callback fired when the grid is resized.
* Callback fired when the Data Grid is resized.
* @param {ElementSize} containerSize With all properties from [[ElementSize]].
* @param {MuiEvent<{}>} event The event object.
* @param {GridCallbackDetails} details Additional details for this callback.
Expand Down Expand Up @@ -750,7 +750,7 @@ DataGridProRaw.propTypes = {
*/
onSortModelChange: PropTypes.func,
/**
* Callback fired when the state of the grid is updated.
* Callback fired when the state of the Data Grid is updated.
* @param {GridState} state The new state.
* @param {MuiEvent<{}>} event The event object.
* @param {GridCallbackDetails} details Additional details for this callback.
Expand Down Expand Up @@ -822,7 +822,7 @@ DataGridProRaw.propTypes = {
*/
rowCount: PropTypes.number,
/**
* Sets the height in pixel of a row in the grid.
* Sets the height in pixel of a row in the Data Grid.
* @default 52
*/
rowHeight: PropTypes.number,
Expand Down Expand Up @@ -852,7 +852,7 @@ DataGridProRaw.propTypes = {
*/
rowSelection: PropTypes.bool,
/**
* Sets the row selection model of the grid.
* Sets the row selection model of the Data Grid.
*/
rowSelectionModel: PropTypes.oneOfType([
PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.number, PropTypes.string]).isRequired),
Expand All @@ -877,7 +877,7 @@ DataGridProRaw.propTypes = {
*/
rowThreshold: PropTypes.number,
/**
* Override the height/width of the grid inner scrollbar.
* Override the height/width of the Data Grid inner scrollbar.
*/
scrollbarSize: PropTypes.number,
/**
Expand Down Expand Up @@ -916,7 +916,7 @@ DataGridProRaw.propTypes = {
*/
sortingOrder: PropTypes.arrayOf(PropTypes.oneOf(['asc', 'desc'])),
/**
* Set the sort model of the grid.
* Set the sort model of the Data Grid.
*/
sortModel: PropTypes.arrayOf(
PropTypes.shape({
Expand All @@ -933,7 +933,7 @@ DataGridProRaw.propTypes = {
PropTypes.object,
]),
/**
* If positive, the grid will throttle updates coming from `apiRef.current.updateRows` and `apiRef.current.setRows`.
* If positive, the Data Grid will throttle updates coming from `apiRef.current.updateRows` and `apiRef.current.setRows`.
* 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.
* @default 0
*/
Expand Down
Loading

0 comments on commit 4f97f36

Please sign in to comment.