@trackunit/ui-icons 0.0.62 → 0.0.63

package/index.cjs

@@ -1030,6 +1030,13 @@ const validateIconName = (name) => {
     }
     return found;
 };
+/**
+ * Ensures that the icon name is valid, otherwise it returns the fallback icon name.
+ *
+ * @param name - The icon name to validate.
+ * @param fallbackIconName - The fallback icon name to use if the icon name is invalid.
+ * @returns {TrackunitIconName | HeroIconName} - Returns the icon name if it is valid, otherwise it returns the fallback icon name.
+ */
 const ensureIconWithFallback = (name, fallbackIconName = FALLBACK_ICON_NAME) => {
     if (!name) {
         return fallbackIconName;
@@ -1045,6 +1052,13 @@ const ensureIconWithFallback = (name, fallbackIconName = FALLBACK_ICON_NAME) =>
     }
 };
 
+/**
+ * Returns the icon from the library based on the name and type provided.
+ *
+ * @param iconName - The name of the icon you want to use.
+ * @param type - The type of the icon you want to use.
+ * @returns {HeroIcon} - Returns the icon from the library based on the name and type provided.
+ */
 const heroIconLookup = (iconName, type) => {
     if (!HeroIconsArray.includes(iconName)) {
         // eslint-disable-next-line no-console
@@ -1054,6 +1068,12 @@ const heroIconLookup = (iconName, type) => {
     return type === "solid" ? lookupSolid[iconName] : lookupOutline[iconName];
 };
 
+/**
+ * Returns the icon component for the given icon name.
+ *
+ * @param iconName - The icon name to lookup.
+ * @param type - The icon type to lookup.
+ */
 const trackunitIconLookup = (iconName, type) => {
     if ((type === "solid" && !TrackunitSolidIconsArray.includes(iconName)) ||
         (type === "outline" && !TrackunitOutlineIconsArray.includes(iconName))) {

package/index.js

@@ -1004,6 +1004,13 @@ const validateIconName = (name) => {
     }
     return found;
 };
+/**
+ * Ensures that the icon name is valid, otherwise it returns the fallback icon name.
+ *
+ * @param name - The icon name to validate.
+ * @param fallbackIconName - The fallback icon name to use if the icon name is invalid.
+ * @returns {TrackunitIconName | HeroIconName} - Returns the icon name if it is valid, otherwise it returns the fallback icon name.
+ */
 const ensureIconWithFallback = (name, fallbackIconName = FALLBACK_ICON_NAME) => {
     if (!name) {
         return fallbackIconName;
@@ -1019,6 +1026,13 @@ const ensureIconWithFallback = (name, fallbackIconName = FALLBACK_ICON_NAME) =>
     }
 };
 
+/**
+ * Returns the icon from the library based on the name and type provided.
+ *
+ * @param iconName - The name of the icon you want to use.
+ * @param type - The type of the icon you want to use.
+ * @returns {HeroIcon} - Returns the icon from the library based on the name and type provided.
+ */
 const heroIconLookup = (iconName, type) => {
     if (!HeroIconsArray.includes(iconName)) {
         // eslint-disable-next-line no-console
@@ -1028,6 +1042,12 @@ const heroIconLookup = (iconName, type) => {
     return type === "solid" ? lookupSolid[iconName] : lookupOutline[iconName];
 };
 
+/**
+ * Returns the icon component for the given icon name.
+ *
+ * @param iconName - The icon name to lookup.
+ * @param type - The icon type to lookup.
+ */
 const trackunitIconLookup = (iconName, type) => {
     if ((type === "solid" && !TrackunitSolidIconsArray.includes(iconName)) ||
         (type === "outline" && !TrackunitOutlineIconsArray.includes(iconName))) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/ui-icons",
-  "version": "0.0.62",
+  "version": "0.0.63",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "module": "./index.js",

package/src/ensureIconWithFallback.d.ts

@@ -1,3 +1,10 @@
 import { HeroIconName } from "./heroiconsTypes";
 import { TrackunitIconName } from "./TrackunitIcons.generated";
+/**
+ * Ensures that the icon name is valid, otherwise it returns the fallback icon name.
+ *
+ * @param name - The icon name to validate.
+ * @param fallbackIconName - The fallback icon name to use if the icon name is invalid.
+ * @returns {TrackunitIconName | HeroIconName} - Returns the icon name if it is valid, otherwise it returns the fallback icon name.
+ */
 export declare const ensureIconWithFallback: (name: string, fallbackIconName?: TrackunitIconName | HeroIconName) => TrackunitIconName | HeroIconName;

package/src/heroIconLookup.d.ts

@@ -1,2 +1,9 @@
 import { HeroIcon, HeroIconName } from "./heroiconsTypes";
+/**
+ * Returns the icon from the library based on the name and type provided.
+ *
+ * @param iconName - The name of the icon you want to use.
+ * @param type - The type of the icon you want to use.
+ * @returns {HeroIcon} - Returns the icon from the library based on the name and type provided.
+ */
 export declare const heroIconLookup: (iconName: HeroIconName, type: "solid" | "outline") => HeroIcon;

package/src/scripts/generate-icons.d.ts

@@ -1,2 +1,8 @@
+/**
+ * This function removes a directory if it exists.
+ */
 export declare const rmDir: (name: string) => void;
+/**
+ * This function creates a directory if it doesn't exist.
+ */
 export declare const mkDir: (name: string) => void;

package/src/trackunitIconLookup.d.ts

@@ -1,2 +1,8 @@
 import { TrackunitIcon, TrackunitIconName } from "./TrackunitIcons.generated";
+/**
+ * Returns the icon component for the given icon name.
+ *
+ * @param iconName - The icon name to lookup.
+ * @param type - The icon type to lookup.
+ */
 export declare const trackunitIconLookup: (iconName: TrackunitIconName, type: "solid" | "outline") => TrackunitIcon;