refactor(types): shorten ref, id JSDocs, use CarbonIcon type, export component props

src/UIShell/GlobalHeader/Header.svelte

@@ -29,10 +29,7 @@
    */
   export let platformName = "";
 
-  /**
-   * Obtain a reference to the HTML anchor element
-   * @type {null | HTMLAnchorElement}
-   */
+  /** Obtain a reference to the HTML anchor element */
   export let ref = null;
 
   import HamburgerMenu from "../SideNav/HamburgerMenu.svelte";

src/UIShell/GlobalHeader/HeaderAction.svelte

@@ -4,7 +4,7 @@
 
   /**
    * Specify the icon props
-   * @type {{ render: typeof import("carbon-icons-svelte/lib/Add16").default; skeleton: boolean; }}
+   * @type {{ render: import("carbon-icons-svelte").CarbonIcon; skeleton: boolean; }}
    */
   export let icon = undefined;
 
@@ -15,10 +15,7 @@
    */
   export let text = undefined;
 
-  /**
-   * Obtain a reference to the button HTML element
-   * @type {null | HTMLButtonElement}
-   */
+  /** Obtain a reference to the button HTML element */
   export let ref = null;
 
   import { createEventDispatcher } from "svelte";

src/UIShell/GlobalHeader/HeaderActionLink.svelte

@@ -10,14 +10,11 @@
 
   /**
    * Specify the icon props
-   * @type {{ render: typeof import("carbon-icons-svelte/lib/Add16").default; skeleton: boolean; }}
+   * @type {{ render: import("carbon-icons-svelte").CarbonIcon; skeleton: boolean; }}
    */
   export let icon = undefined;
 
-  /**
-   * Obtain a reference to the HTML anchor element
-   * @type {null | HTMLAnchorElement}
-   */
+  /** Obtain a reference to the HTML anchor element */
   export let ref = null;
 
   import { Icon } from "../../Icon";

src/UIShell/GlobalHeader/HeaderNavItem.svelte

@@ -11,10 +11,7 @@
    */
   export let text = undefined;
 
-  /**
-   * Obtain a reference to the HTML anchor element
-   * @type {null | HTMLAnchorElement}
-   */
+  /** Obtain a reference to the HTML anchor element */
   export let ref = null;
 </script>
 

src/UIShell/GlobalHeader/HeaderNavMenu.svelte

@@ -11,10 +11,7 @@
    */
   export let text = undefined;
 
-  /**
-   * Obtain a reference to the HTML anchor element
-   * @type {null | HTMLAnchorElement}
-   */
+  /** Obtain a reference to the HTML anchor element */
   export let ref = null;
 
   /** Specify the ARIA label for the chevron icon */

src/UIShell/GlobalHeader/HeaderPanelLink.svelte

@@ -5,10 +5,7 @@
    */
   export let href = undefined;
 
-  /**
-   * Obtain a reference to the HTML anchor element
-   * @type {null | HTMLAnchorElement}
-   */
+  /** Obtain a reference to the HTML anchor element */
   export let ref = null;
 </script>
 

src/UIShell/HeaderGlobalAction.svelte

@@ -4,14 +4,11 @@
 
   /**
    * Specify the icon to render
-   * @type {typeof import("carbon-icons-svelte/lib/Add16").default}
+   * @type {import("carbon-icons-svelte").CarbonIcon}
    */
   export let icon = undefined;
 
-  /**
-   * Obtain a reference to the HTML button element
-   * @type {null | HTMLButtonElement}
-   */
+  /** Obtain a reference to the HTML button element */
   export let ref = null;
 </script>
 

src/UIShell/SideNav/HamburgerMenu.svelte

@@ -8,10 +8,7 @@
   /** Set to `true` to toggle the open state */
   export let isOpen = false;
 
-  /**
-   * Obtain a reference to the HTML button element
-   * @type {null | HTMLButtonElement}
-   */
+  /** Obtain a reference to the HTML button element */
   export let ref = null;
 
   import { fly } from "svelte/transition";

src/UIShell/SideNav/SideNavLink.svelte

@@ -16,14 +16,11 @@
 
   /**
    * Specify the icon props
-   * @type {{ render: typeof import("carbon-icons-svelte/lib/Add16").default; skeleton: boolean; }}
+   * @type {{ render: import("carbon-icons-svelte").CarbonIcon; skeleton: boolean; }}
    */
   export let icon = undefined;
 
-  /**
-   * Obtain a reference to the HTML anchor element
-   * @type {null | HTMLAnchorElement}
-   */
+  /** Obtain a reference to the HTML anchor element */
   export let ref = null;
 
   import { Icon } from "../../Icon";

src/UIShell/SideNav/SideNavMenu.svelte

@@ -10,14 +10,11 @@
 
   /**
    * Specify the icon props
-   * @type {{ render: typeof import("carbon-icons-svelte/lib/Add16").default; skeleton: boolean; }}
+   * @type {{ render: import("carbon-icons-svelte").CarbonIcon; skeleton: boolean; }}
    */
   export let icon = undefined;
 
-  /**
-   * Obtain a reference to the HTML button element
-   * @type {null | HTMLButtonElement}
-   */
+  /** Obtain a reference to the HTML button element */
   export let ref = null;
 
   import ChevronDown16 from "carbon-icons-svelte/lib/ChevronDown16";

src/UIShell/SideNav/SideNavMenuItem.svelte

@@ -17,10 +17,7 @@
    */
   export let text = undefined;
 
-  /**
-   * Obtain a reference to the HTML anchor element
-   * @type {null | HTMLAnchorElement}
-   */
+  /** Obtain a reference to the HTML anchor element */
   export let ref = null;
 </script>