Skip to content
This repository was archived by the owner on Feb 27, 2024. It is now read-only.

Commit aba405d

Browse files
author
Mike England
committed
Correct Icon doc block
1 parent d56aa58 commit aba405d

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

components/atoms/Icon/Icon.js

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,16 @@ function sizeToPx(size) {
2020
}
2121

2222
/**
23-
* @param props0
24-
* @param props0.icon
25-
* @param props0.size
26-
* @param props0.style
27-
* @param props0.title
28-
* @param props0.className
29-
* @param props0.ariaHidden
23+
* Render the Icon component.
24+
*
25+
* @param {object} props props.
26+
* @param {boolean} props.ariaHidden If aria-hidden is true.
27+
* @param {string} props.className Icon className.
28+
* @param {string} props.icon Icon svg.
29+
* @param {string} props.size Icon size.
30+
* @param {string} props.style Icon style variation.
31+
* @param {string} props.title Icon title.
32+
* @return {Element} The Icon component.
3033
*/
3134
export default function Icon({
3235
ariaHidden,

0 commit comments

Comments
 (0)