[DataGrid] Improve column definition typing #7224
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cherniavskii
added
breaking change
component: data grid
cherniavskii
commented
Dec 16, 2022
| @@ -112,13 +112,8 @@ const parseInterfaceSymbol = ( | |||
|
|
|||
| const exportedSymbol = project.exports[interfaceName]; | |||
| const type = project.checker.getDeclaredTypeOfSymbol(exportedSymbol); | |||
| const typeDeclaration = type.symbol.declarations?.[0]; | |||
There was a problem hiding this comment.
I had to remove typeDeclaration check since GridColDef is now TypeAlias, not Interface.
Otherwise it was throwing an error here.
These are the results for the performance tests:
|
cherniavskii
commented
Dec 16, 2022
| const getApplyFilterFn = ( | ||
| filterItem: GridFilterItem, | ||
| column: GridStateColDef, | ||
| const getApplyFilterFn: GridFilterOperator['getApplyFilterFn'] = ( |
There was a problem hiding this comment.
It's actually better to type the whole function rather than arguments. And this way we can avoid exporting GridStateColDef
cherniavskii
commented
Dec 16, 2022
| | <span class="prop-name optional">width<sup><abbr title="optional">?</abbr></sup></span> | <span class="prop-type">number</span> | <span class="prop-default">100</span> | Set the width of the column. | | ||
| | Name | Type | Default | Description | | ||
| | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | <span class="prop-name optional">aggregable<sup><abbr title="optional">?</abbr></sup> [<span class="plan-premium" title="Premium plan"></span>](/x/introduction/licensing/#premium-plan)</span> | <span class="prop-type">boolean</span> | <span class="prop-default">true</span> | If `true`, the cells of the column can be aggregated based. | |
There was a problem hiding this comment.
Premium properties weren't documented here before, so this is a useful side-effect :)
cherniavskii
commented
Dec 16, 2022
| @@ -173,7 +172,7 @@ const defaultColumnsStyles = { | |||
| [GRID_DATETIME_COL_DEF.type as string]: { numFmt: 'dd.mm.yyyy hh:mm' }, | |||
| }; | |||
|
|
|||
| const serializeColumn = (column: GridStateColDef, columnsStyles: ColumnsStylesInterface) => { | |||
| const serializeColumn = (column: GridColDef, columnsStyles: ColumnsStylesInterface) => { | |||
There was a problem hiding this comment.
No need to use GridStateColDef here, since we don't use any properties specific to GridStateColDef, like computedWidth
cherniavskii
commented
Dec 16, 2022
| groupedByColDef: GridColDef | GridStateColDef, | ||
| applyHeaderName: boolean, | ||
| ) => { | ||
| const getGroupingCriteriaProperties = (groupedByColDef: GridColDef, applyHeaderName: boolean) => { |
There was a problem hiding this comment.
Same as #7224 (comment)
MBilalShafi
approved these changes
Dec 19, 2022
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #7188
Changelog
Breaking changes
GridColumnstype was removed. UseGridColDef[]instead.GridActionsColDefinterface was removed. UseGridColDefinstead.GridEnrichedColDeftype was removed. UseGridColDefinstead.GridStateColDeftype was removed.If you use it to type
searchPredicate- useGridColumnsPanelProps['searchPredicate']instead.If you use it to type
getApplyFilterFn- useGridFilterOperator['getApplyFilterFn']instead.