feat: 🎸 [Adornment] Added badge overlap, defaults to circular

melfore · Jul 15, 2022 · 9895bba · 9895bba
1 parent 948188c
commit 9895bba
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/src/components/Adornment/components/Badge/index.tsx b/src/components/Adornment/components/Badge/index.tsx
@@ -19,10 +19,10 @@ const AdornmentBadge: FC<IAdornment> = ({ badge, children, dataCy = DEFAULT_DATA
     return <Fragment>{children}</Fragment>;
   }
 
-  const { color = "default", value, variant = "standard" } = badge;
+  const { color = "default", overlap = "circular", value, variant = "standard" } = badge;
 
   return (
-    <MUIBadge badgeContent={value} color={color} data-cy={badgeDataCy} overlap="circular" variant={variant}>
+    <MUIBadge badgeContent={value} color={color} data-cy={badgeDataCy} overlap={overlap} variant={variant}>
       {children}
     </MUIBadge>
   );

diff --git a/src/types/Adornment.ts b/src/types/Adornment.ts
@@ -8,11 +8,26 @@ export type IAdornmentSubpart = "adornment" | IAdornmentBadgeSubpart | IAdornmen
 
 type IBadgeColor = "default" | "error" | "primary" | "secondary";
 
+type IBadgeOverlap = "circular" | "rectangular";
+
 type IBadgeVariant = "dot" | "standard";
 
 export interface IAdornmentBadge {
+  /**
+   * Badge color
+   */
   color?: IBadgeColor;
+  /**
+   * Badge overlap
+   */
+  overlap?: IBadgeOverlap;
+  /**
+   * Badge content
+   */
   value: string;
+  /**
+   * Badge variant
+   */
   variant?: IBadgeVariant;
 }