Document Badge props

Shopify · Oct 13, 2023 · 9a8dda8 · 9a8dda8
1 parent cc4150e
commit 9a8dda8
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/.changeset/giant-chairs-hunt.md b/.changeset/giant-chairs-hunt.md
@@ -0,0 +1,6 @@
+---
+'@shopify/ui-extensions': patch
+'@shopify/ui-extensions-react': patch
+---
+
+Add Badge component to admin
diff --git a/packages/ui-extensions/src/surfaces/admin/components/Badge/Badge.ts b/packages/ui-extensions/src/surfaces/admin/components/Badge/Badge.ts
@@ -3,12 +3,26 @@ import type {AccessibilityLabelProps, SizeScale, Tone} from '../shared';
 import {IconName} from '../Icon/IconName';
 
 interface BadgeBaseProps extends AccessibilityLabelProps {
+  /**
+   * Adjusts the color of the badge.
+   */
   tone?: Tone;
+  /**
+   * Adjusts the size of the badge.
+   */
   size?: Extract<SizeScale, 'small-100' | 'base'>;
 }
 
 interface BadgeIconProps {
+  /**
+   * Adds an icon to the badge.
+   */
   icon: IconName;
+  /**
+   * Adjusts the position of the icon within the badge. Requires `icon` to be set.
+   *
+   * @defaultValue 'start'
+   */
   iconPosition?: 'start' | 'end';
 }