fix: inconsistent naming of SelectList (#3924)

* fix: inconsistent naming of `SelectList` * Create tidy-sloths-trade.md
marigold-ui · May 28, 2024 · 290dc0e · 290dc0e
1 parent f008691
commit 290dc0e
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 6 deletions.
diff --git a/.changeset/tidy-sloths-trade.md b/.changeset/tidy-sloths-trade.md
@@ -0,0 +1,6 @@
+---
+"@marigold/docs": patch
+"@marigold/components": patch
+---
+
+fix: inconsistent naming of `SelectList`
diff --git a/docs/content/components/collection/selectlist/selectlist.mdx b/docs/content/components/collection/selectlist/selectlist.mdx
@@ -56,7 +56,7 @@ import { SelectList } from '@marigold/components';
     },
     {
       property: 'renderEmptyState',
-      type: '(props: GridListRenderProps) => React.ReactNode',
+      type: '(props: SelectListRenderProps) => React.ReactNode',
       description:
         'Provides content to display when there are no items in the list.',
       default: 'none',
@@ -93,7 +93,7 @@ import { SelectList } from '@marigold/components';
       property: 'dragAndDropHooks',
       type: 'DragAndDropHooks | undefined',
       description:
-        'The drag and drop hooks returned by useDragAndDrop used to enable drag and drop behavior for the GridList.',
+        'The drag and drop hooks returned by useDragAndDrop used to enable drag and drop behavior for the SelectList.',
       default: 'none',
     },
     {
@@ -155,7 +155,7 @@ import { SelectList } from '@marigold/components';
     },
     {
       property: 'renderEmptyState',
-      type: '(props: GridListRenderProps) => React.ReactNode',
+      type: '(props: SelectListRenderProps) => React.ReactNode',
       description:
         'Provides content to display when there are no items in the list.',
       default: 'none',

diff --git a/packages/components/src/SelectList/SelectList.tsx b/packages/components/src/SelectList/SelectList.tsx
@@ -16,7 +16,7 @@ import { SelectListItem } from './SelectListItem';
 
 type RemoveProps = 'style' | 'className' | 'onSelectionChange';
 
-export interface GridListProps
+export interface SelectListProps
   extends Omit<RAC.GridListProps<object>, RemoveProps> {
   onChange?:
     | RAC.GridListProps<object>['onSelectionChange']
@@ -25,12 +25,12 @@ export interface GridListProps
 
 interface SelectListComponent
   extends ForwardRefExoticComponent<
-    GridListProps & RefAttributes<HTMLUListElement>
+    SelectListProps & RefAttributes<HTMLUListElement>
   > {
   Item: typeof SelectListItem;
 }
 
-const _SelectList = forwardRef<HTMLUListElement, GridListProps>(
+const _SelectList = forwardRef<HTMLUListElement, SelectListProps>(
   ({ onChange, ...rest }, ref) => {
     const classNames = useClassNames({ component: 'ListBox' });