docs: add jsdoc

channel-io · Dec 18, 2024 · 9a4a029 · 9a4a029
1 parent 1b2bf4c
commit 9a4a029
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/packages/bezier-react/src/components/AlphaIcon/Icon.tsx b/packages/bezier-react/src/components/AlphaIcon/Icon.tsx
@@ -13,6 +13,19 @@ import { type IconProps } from './Icon.types'
 
 import styles from './Icon.module.scss'
 
+/**
+ * `Icon` is a component that renders SVG icons from "@channel.io/bezier-icons"
+ * @example
+ * ```tsx
+ * import { ChannelBtnFilledIcon } from '@channel.io/bezier-icons'
+ *
+ * <Icon
+ *   source={ChannelBtnFilledIcon}
+ *   size="24"
+ *   color="fg-black-darker"
+ * />
+ * ```
+ */
 export const Icon = memo(
   forwardRef<SVGSVGElement, IconProps>(function Icon(props, forwardedRef) {
     const [marginProps, marginRest] = splitByMarginProps(props)