feat: addGlobalStyle now returns the style element (closes #31)

Sv443 · Sv443 · commit 4a58caac055f · 2024-02-11T18:56:46.000+01:00
diff --git a/.changeset/mean-elephants-pull.md b/.changeset/mean-elephants-pull.md
@@ -0,0 +1,5 @@
+---
+"@sv443-network/userutils": minor
+---
+
+`addGlobalStyle` now returns the created style element
diff --git a/README.md b/README.md
@@ -506,10 +506,11 @@ addParent(element, newParent);
 ### addGlobalStyle()
 Usage:  
 ```ts
-addGlobalStyle(css: string): void
+addGlobalStyle(css: string): HTMLStyleElement
 ```
   
 Adds a global style to the page in form of a `<style>` element that's inserted into the `<head>`.  
+Returns the style element that was just created.  
 ⚠️ This function needs to be run after the DOM has loaded (when using `@run-at document-end` or after `DOMContentLoaded` has fired).  
   
 <details><summary><b>Example - click to view</b></summary>
diff --git a/lib/dom.ts b/lib/dom.ts
@@ -40,11 +40,13 @@ export function addParent(element: Element, newParent: Element) {
  * Adds global CSS style in the form of a `<style>` element in the document's `<head>`  
  * This needs to be run after the `DOMContentLoaded` event has fired on the document object (or instantly if `@run-at document-end` is used).
  * @param style CSS string
+ * @returns Returns the created style element
  */
 export function addGlobalStyle(style: string) {
   const styleElem = document.createElement("style");
   styleElem.innerHTML = style;
   document.head.appendChild(styleElem);
+  return styleElem;
 }
 
 /**
