@umbraco-ui/uui-icon-registry 1.2.0 → 1.3.0-rc.0

package/lib/index.js

@@ -28,18 +28,31 @@ class UUIIconRegistry {
       }
     };
   }
+  /**
+   * Attach an element to provide this registry. Use detach when disconnected.
+   * @param {EventTarget} element the element of which to provide this icon-set.
+   */
   attach(element) {
     element.addEventListener(
       UUIIconRequestEvent.ICON_REQUEST,
       this._onIconRequest
     );
   }
+  /**
+   * Detach an element from providing this registry.
+   * @param {EventTarget} element the element of which to stop providing this icon-set.
+   */
   detach(element) {
     element.removeEventListener(
       UUIIconRequestEvent.ICON_REQUEST,
       this._onIconRequest
     );
   }
+  /**
+   * Define a icon to be served by this registry.
+   * @param {string} iconName the name to use for this icon.
+   * @param {string} svgString the svg source for this icon.
+   */
   defineIcon(iconName, svgString) {
     if (this.icons[iconName]) {
       this.icons[iconName].svg = svgString;
@@ -47,18 +60,55 @@ class UUIIconRegistry {
     }
     this.icons[iconName] = new UUIIconHost(svgString);
   }
+  /**
+   * Retrieve the SVG source of an icon, Returns ´null´ if the name does not exist.
+   * @param {string} iconName the name of the icon to retrieve.
+   */
   getIcon(iconName) {
     if (!!this.icons[iconName] || this.acceptIcon(iconName)) {
       return this.icons[iconName].promise;
     }
     return null;
   }
+  /**
+   * Declare that this registry will be providing a icon for this name
+   * @param {string} iconName the name of the icon to be provided.
+   */
   provideIcon(iconName) {
     return this.icons[iconName] = new UUIIconHost();
   }
+  /**
+   * extend this method to provide your own logic.
+   * @param iconName
+   * @returns
+   */
+  //@ts-ignore-start
+  // eslint-disable-next-line
   acceptIcon(iconName) {
     return false;
   }
+  //@ts-ignore-end
+  /**
+     * Dynamic concept by extending this class:
+     * extend getIcon in this way:
+  
+      protected acceptIcon(iconName: string): boolean {
+  
+        // Check if this is something we want to accept and provide.
+        if(iconName === "myCustomIcon") {
+  
+          // Inform that we will be providing this.
+          const icon = this.provideIcon(iconName);
+  
+          // When data is available set it on this icon object, this can be done at any point in time:
+          icon.svg = "...";
+  
+          return true;
+        }
+  
+        return false;
+      }
+    */
   getIconNames() {
     return Object.keys(this.icons);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@umbraco-ui/uui-icon-registry",
-  "version": "1.2.0",
+  "version": "1.3.0-rc.0",
   "license": "MIT",
   "keywords": [
     "Umbraco",
@@ -30,17 +30,17 @@
     "custom-elements.json"
   ],
   "dependencies": {
-    "@umbraco-ui/uui-base": "1.2.0",
-    "@umbraco-ui/uui-icon": "1.2.0"
+    "@umbraco-ui/uui-base": "1.3.0-rc.0",
+    "@umbraco-ui/uui-icon": "1.3.0-rc.0"
   },
   "scripts": {
     "build": "npm run analyze && tsc --build --force && rollup -c rollup.config.js",
-    "clean": "tsc --build --clean && rimraf dist lib/*.js lib/**/*.js custom-elements.json",
+    "clean": "tsc --build --clean && rimraf -g dist lib/*.js lib/**/*.js custom-elements.json",
     "analyze": "web-component-analyzer **/*.element.ts --outFile custom-elements.json"
   },
   "publishConfig": {
     "access": "public"
   },
   "homepage": "https://uui.umbraco.com/?path=/story/uui-icon-registry",
-  "gitHead": "78ce6df4b259921ed47e25ce10812920f25cbc1c"
+  "gitHead": "45c3824056586d9817efb3f61dc0bef5478747f0"
 }