refactor: add jsdoc for monicon props

oktaysenkan · Jan 7, 2025 · 5fa1612 · 5fa1612
1 parent 441c9a3
commit 5fa1612
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -248,9 +248,29 @@ declare module "@monicon/icon-loader" {
   export type MoniconIconName = ${iconNamesAsCode};
 
   export type MoniconProps = {
+    /**
+     * The name of the icon to render.
+     *
+     * @example "mdi:home"
+     *
+     * For TypeScript users, you must check https://monicon-docs.vercel.app/troubleshooting/typescript for more information.
+     */
     name: MoniconIconName;
+    /**
+     * The size of the icon.
+     *
+     * @default icon collection size
+     */
     size?: number;
+    /**
+     * The color of the icon.
+     *
+     * @default "currentColor"
+     */
     color?: string;
+    /**
+     * The stroke width of the icon. This feature is only available for limited icon collections.
+     */
     strokeWidth?: number;
   };
 }

diff --git a/packages/icon-loader/src/index.ts b/packages/icon-loader/src/index.ts
@@ -4,9 +4,29 @@ import { parseSync, stringify } from "svgson";
 import icons from "@monicon/runtime";
 
 export type MoniconProps = {
+  /**
+   * The name of the icon to render.
+   *
+   * @example "mdi:home"
+   *
+   * For TypeScript users, you must check https://monicon-docs.vercel.app/troubleshooting/typescript for more information.
+   */
   name: string;
+  /**
+   * The size of the icon.
+   *
+   * @default icon collection size
+   */
   size?: number;
+  /**
+   * The color of the icon.
+   *
+   * @default "currentColor"
+   */
   color?: string;
+  /**
+   * The stroke width of the icon. This feature is only available for limited icon collections.
+   */
   strokeWidth?: number;
 };