fix(avatar types): make size prop optional to match previous api surf…

…ace with defaultProps in TAvatarProps, update avatar styles to assert that the size prop will always be assigned due to default param assignment
commercetools · Jan 21, 2025 · ca0403a · ca0403a
1 parent cbb21cd
commit ca0403a
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 26 deletions.
diff --git a/.changeset/curly-rings-collect.md b/.changeset/curly-rings-collect.md
@@ -0,0 +1,6 @@
+---
+'@commercetools-uikit/data-table': patch
+'@commercetools-uikit/avatar': patch
+---
+
+Update TAvatarProps.size type to be optional for backward compatibility, update readmes
diff --git a/packages/components/avatar/src/avatar.styles.ts b/packages/components/avatar/src/avatar.styles.ts
@@ -48,11 +48,11 @@ export const getFontSize = (
   avatarSize: TAvatarProps['size']
 ) => {
   const widthCode = avatarInitials.length > 1 ? 'wide' : 'narrow';
-  return fontSizeMap[avatarSize][widthCode];
+  return fontSizeMap[avatarSize!][widthCode];
 };
 
 export const getWidthSize = (avatarSize: TAvatarProps['size']) =>
-  widthSizeMap[avatarSize];
+  widthSizeMap[avatarSize!];
 
 export const getBackgroundColor = (
   avatarColor: TAvatarProps['color'] = 'accent',

diff --git a/packages/components/avatar/src/avatar.tsx b/packages/components/avatar/src/avatar.tsx
@@ -28,7 +28,7 @@ export type TAvatarProps = {
   /**
    * The size of the rendered avatar.
    */
-  size: 's' | 'm' | 'l';
+  size?: 's' | 'm' | 'l';
   /**
    * The color of the avatar.
    */