Rename the global helper function for the icon metadata
authorAlexander Ebert <ebert@woltlab.com>
Mon, 8 Aug 2022 16:13:22 +0000 (18:13 +0200)
committerAlexander Ebert <ebert@woltlab.com>
Fri, 12 Aug 2022 19:25:55 +0000 (21:25 +0200)
global.d.ts
ts/WoltLabSuite/WebComponent/fa-icon.ts
ts/WoltLabSuite/WebComponent/global.d.ts
wcfsetup/install/files/js/WoltLabSuite/WebComponent/fa-icon.js

index b1774eb9c8af10672e4fab89c9bda9338bb57cd3..f2553a04abac9a4fb4c37d2fcdcf5ae5a4543e63 100644 (file)
@@ -25,7 +25,7 @@ declare global {
     WCF_PATH: string;
     WSC_API_URL: string;
 
-    getFontAwesome6Styles: (name: string) => IconMetadata | undefined;
+    getFontAwesome6IconMetadata: (name: string) => IconMetadata | undefined;
 
     jQuery: JQueryStatic;
     WCF: any;
index c61b8b7556c71637dfa45019b3aa14ead14c9a1d..e13a598d497076614f4414fa7046062ee48a2580 100644 (file)
         slot.name = "svg";
         root.append(slot);
       } else {
-        const [codepoint] = window.getFontAwesome6Styles(this.name)!;
+        const [codepoint] = window.getFontAwesome6IconMetadata(this.name)!;
         root.append(codepoint);
-
-        // TODO: Add style
       }
     }
 
@@ -43,7 +41,7 @@
           throw new TypeError("Must provide the name of the icon.");
         }
 
-        const styles = window.getFontAwesome6Styles(this.name);
+        const styles = window.getFontAwesome6IconMetadata(this.name);
         if (styles === undefined) {
           throw new TypeError(`The icon '${this.name}' is unknown or unsupported.`);
         }
@@ -75,7 +73,7 @@
         throw new Error("Cannot change the icon of a brand icon.");
       }
 
-      const metadata = window.getFontAwesome6Styles(name);
+      const metadata = window.getFontAwesome6IconMetadata(name);
       if (metadata === undefined) {
         throw new TypeError(`The icon '${name}' is unknown or unsupported.`);
       }
index eabd215e0c36eed9c4286f0aa4739fa57761826e..7a8b6ac727eff7ab06607c8cdf013c74c58901b2 100644 (file)
@@ -9,6 +9,6 @@ type IconMetadata = [Codepoint, IconStyles];
 
 declare global {
   interface Window {
-    getFontAwesome6Styles: (name: string) => IconMetadata | undefined;
+    getFontAwesome6IconMetadata: (name: string) => IconMetadata | undefined;
   }
 }
index f1d863964917f9d4814a9fc6e6beeff24bd4a6a2..95b78b4c7e3dd23b57d85ffdcd21469731cc322a 100644 (file)
@@ -19,9 +19,8 @@
                 root.append(slot);
             }
             else {
-                const [codepoint] = window.getFontAwesome6Styles(this.name);
+                const [codepoint] = window.getFontAwesome6IconMetadata(this.name);
                 root.append(codepoint);
-                // TODO: Add style
             }
         }
         validate() {
@@ -40,7 +39,7 @@
                 if (this.name === "") {
                     throw new TypeError("Must provide the name of the icon.");
                 }
-                const styles = window.getFontAwesome6Styles(this.name);
+                const styles = window.getFontAwesome6IconMetadata(this.name);
                 if (styles === undefined) {
                     throw new TypeError(`The icon '${this.name}' is unknown or unsupported.`);
                 }
@@ -67,7 +66,7 @@
             if (this.brand) {
                 throw new Error("Cannot change the icon of a brand icon.");
             }
-            const metadata = window.getFontAwesome6Styles(name);
+            const metadata = window.getFontAwesome6IconMetadata(name);
             if (metadata === undefined) {
                 throw new TypeError(`The icon '${name}' is unknown or unsupported.`);
             }