fix: mark headerRenderer as unsupported for GridSortColumn

vaadin · Dec 6, 2023 · e595932 · e595932
1 parent 4be5956
commit e595932
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 7 deletions.
diff --git a/src/GridSortColumn.tsx b/src/GridSortColumn.tsx
@@ -11,33 +11,32 @@ import { useSimpleRenderer } from './renderers/useSimpleRenderer.js';
 
 export * from './generated/GridSortColumn.js';
 
+/*
+ * The `headerRenderer` is not allowed for `vaadin-grid-sort-column`.
+ */
 export type GridSortColumnProps<TItem> = Partial<
   Omit<_GridSortColumnProps<TItem>, 'children' | 'footerRenderer' | 'headerRenderer' | 'renderer'>
 > &
   Readonly<{
     children?: ComponentType<GridBodyReactRendererProps<TItem>> | null;
     footerRenderer?: ComponentType<GridEdgeReactRendererProps<TItem>> | null;
-    headerRenderer?: ComponentType<GridEdgeReactRendererProps<TItem>> | null;
     renderer?: ComponentType<GridBodyReactRendererProps<TItem>> | null;
   }>;
 
 function GridSortColumn<TItem = GridDefaultItem>(
   props: GridSortColumnProps<TItem>,
   ref: ForwardedRef<GridSortColumnElement<TItem>>,
 ): ReactElement | null {
-  const [headerPortals, headerRenderer] = useSimpleRenderer(props.headerRenderer);
   const [footerPortals, footerRenderer] = useSimpleRenderer(props.footerRenderer);
   const [bodyPortals, bodyRenderer] = useModelRenderer(props.renderer ?? props.children);
 
   return (
     <_GridSortColumn<TItem>
       {...props}
       footerRenderer={footerRenderer}
-      headerRenderer={headerRenderer}
       ref={ref}
       renderer={bodyRenderer}
     >
-      {headerPortals}
       {footerPortals}
       {bodyPortals}
     </_GridSortColumn>

diff --git a/test/Grid.spec.tsx b/test/Grid.spec.tsx
@@ -169,9 +169,7 @@ describe('Grid', () => {
     it('should render correctly', async () => {
       render(
         <Grid<Item> items={items}>
-          <GridSortColumn<Item> headerRenderer={DefaultHeaderRenderer} footerRenderer={DefaultFooterRenderer}>
-            {DefaultBodyRenderer}
-          </GridSortColumn>
+          <GridSortColumn<Item> footerRenderer={DefaultFooterRenderer}>{DefaultBodyRenderer}</GridSortColumn>
         </Grid>,
       );