Add icon button JSDoc

element-hq · Aug 21, 2023 · a8dcdf6 · a8dcdf6
1 parent 8f93100
commit a8dcdf6
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/components/IconButton/IconButton.tsx b/src/components/IconButton/IconButton.tsx
@@ -35,6 +35,9 @@ type IconButtonProps = JSX.IntrinsicElements["button"] & {
   indicator?: "default" | "highlight";
 };
 
+/**
+ * Display an icon as a button. Can render an indicator
+ */
 export const IconButton = forwardRef<
   HTMLButtonElement,
   PropsWithChildren<IconButtonProps>