Skip to content

Commit 9a4a029

Browse files
committed
docs: add jsdoc
1 parent 1b2bf4c commit 9a4a029

File tree

1 file changed

+13
-0
lines changed
  • packages/bezier-react/src/components/AlphaIcon

1 file changed

+13
-0
lines changed

packages/bezier-react/src/components/AlphaIcon/Icon.tsx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,19 @@ import { type IconProps } from './Icon.types'
1313

1414
import styles from './Icon.module.scss'
1515

16+
/**
17+
* `Icon` is a component that renders SVG icons from "@channel.io/bezier-icons"
18+
* @example
19+
* ```tsx
20+
* import { ChannelBtnFilledIcon } from '@channel.io/bezier-icons'
21+
*
22+
* <Icon
23+
* source={ChannelBtnFilledIcon}
24+
* size="24"
25+
* color="fg-black-darker"
26+
* />
27+
* ```
28+
*/
1629
export const Icon = memo(
1730
forwardRef<SVGSVGElement, IconProps>(function Icon(props, forwardedRef) {
1831
const [marginProps, marginRest] = splitByMarginProps(props)

0 commit comments

Comments
 (0)