Omit explicit "from carbon-icons-svelte" from icon prop definitions (…

…carbon-design-system#866) * fix(types): update description for icon props carbon-design-system#865 * docs(component-api): remove hardcoded Carbon Svelte icon description
Mattchine · Oct 20, 2021 · 7b65a15 · 7b65a15
1 parent 0509e8f
commit 7b65a15
Show file tree

Hide file tree

Showing 36 changed files with 120 additions and 131 deletions.
diff --git a/COMPONENT_INDEX.md b/COMPONENT_INDEX.md
diff --git a/docs/src/COMPONENT_API.json b/docs/src/COMPONENT_API.json
@@ -489,7 +489,7 @@
         {
           "name": "icon",
           "kind": "let",
-          "description": "Specify the icon from `carbon-icons-svelte` to render",
+          "description": "Specify the icon to render",
           "type": "typeof import(\"svelte\").SvelteComponent",
           "isFunction": false,
           "isFunctionDeclaration": false,
@@ -1942,7 +1942,7 @@
         {
           "name": "icon",
           "kind": "let",
-          "description": "Specify the icon from `carbon-icons-svelte` to render\nIcon is rendered to the left of the label text",
+          "description": "Specify the icon to render\nIcon is rendered to the left of the label text",
           "type": "typeof import(\"svelte\").SvelteComponent",
           "isFunction": false,
           "isFunctionDeclaration": false,
@@ -4339,7 +4339,7 @@
         {
           "name": "iconMenu",
           "kind": "let",
-          "description": "Specify the icon from `carbon-icons-svelte` to render for the closed state\nDefaults to `Menu20`",
+          "description": "Specify the icon to render for the closed state\nDefaults to `Menu20`",
           "type": "typeof import(\"svelte\").SvelteComponent",
           "isFunction": false,
           "isFunctionDeclaration": false,
@@ -4349,7 +4349,7 @@
         {
           "name": "iconClose",
           "kind": "let",
-          "description": "Specify the icon from `carbon-icons-svelte` to render for the opened state\nDefaults to `Close20`",
+          "description": "Specify the icon to render for the opened state\nDefaults to `Close20`",
           "type": "typeof import(\"svelte\").SvelteComponent",
           "isFunction": false,
           "isFunctionDeclaration": false,
@@ -4389,7 +4389,7 @@
         {
           "name": "icon",
           "kind": "let",
-          "description": "Specify the icon from `carbon-icons-svelte` to render",
+          "description": "Specify the icon to render",
           "type": "typeof import(\"svelte\").SvelteComponent",
           "isFunction": false,
           "isFunctionDeclaration": false,
@@ -4399,7 +4399,7 @@
         {
           "name": "closeIcon",
           "kind": "let",
-          "description": "Specify the close icon from `carbon-icons-svelte` to render",
+          "description": "Specify the icon to render when the action panel is open",
           "type": "typeof import(\"svelte\").SvelteComponent",
           "isFunction": false,
           "isFunctionDeclaration": false,
@@ -4489,7 +4489,7 @@
         {
           "name": "icon",
           "kind": "let",
-          "description": "Specify the icon from `carbon-icons-svelte` to render",
+          "description": "Specify the icon to render",
           "type": "typeof import(\"svelte\").SvelteComponent",
           "isFunction": false,
           "isFunctionDeclaration": false,
@@ -4887,7 +4887,7 @@
         {
           "name": "render",
           "kind": "let",
-          "description": "Specify the icon from `carbon-icons-svelte` to render",
+          "description": "Specify the icon to render",
           "type": "typeof import(\"svelte\").SvelteComponent",
           "isFunction": false,
           "isFunctionDeclaration": false,
@@ -5260,7 +5260,7 @@
         {
           "name": "icon",
           "kind": "let",
-          "description": "Specify the icon from `carbon-icons-svelte` to render\n`inline` must be `false`",
+          "description": "Specify the icon to render\n`inline` must be `false`",
           "type": "typeof import(\"svelte\").SvelteComponent",
           "isFunction": false,
           "isFunctionDeclaration": false,
@@ -6737,7 +6737,7 @@
         {
           "name": "icon",
           "kind": "let",
-          "description": "Specify the icon from `carbon-icons-svelte` to render",
+          "description": "Specify the icon to render",
           "type": "typeof import(\"svelte\").SvelteComponent",
           "isFunction": false,
           "isFunctionDeclaration": false,
@@ -7321,7 +7321,7 @@
         {
           "name": "icon",
           "kind": "let",
-          "description": "Specify the icon from `carbon-icons-svelte` to render",
+          "description": "Specify the icon to render",
           "type": "typeof import(\"svelte\").SvelteComponent",
           "isFunction": false,
           "isFunctionDeclaration": false,
@@ -9093,7 +9093,7 @@
         {
           "name": "icon",
           "kind": "let",
-          "description": "Specify the icon from `carbon-icons-svelte` to render",
+          "description": "Specify the icon to render",
           "type": "typeof import(\"svelte\").SvelteComponent",
           "isFunction": false,
           "isFunctionDeclaration": false,
@@ -9753,7 +9753,7 @@
         {
           "name": "icon",
           "kind": "let",
-          "description": "Specify the icon from `carbon-icons-svelte` to render",
+          "description": "Specify the icon to render",
           "type": "typeof import(\"svelte\").SvelteComponent",
           "isFunction": false,
           "isFunctionDeclaration": false,
@@ -9805,7 +9805,7 @@
         {
           "name": "icon",
           "kind": "let",
-          "description": "Specify the icon from `carbon-icons-svelte` to render",
+          "description": "Specify the icon to render",
           "type": "typeof import(\"svelte\").SvelteComponent",
           "isFunction": false,
           "isFunctionDeclaration": false,
@@ -11139,7 +11139,7 @@
         {
           "name": "icon",
           "kind": "let",
-          "description": "Specify the icon from `carbon-icons-svelte` to render",
+          "description": "Specify the icon to render",
           "type": "typeof import(\"svelte\").SvelteComponent",
           "isFunction": false,
           "isFunctionDeclaration": false,
@@ -12788,7 +12788,7 @@
         {
           "name": "icon",
           "kind": "let",
-          "description": "Specify the icon from `carbon-icons-svelte` to render for the tooltip button\nIcon size must be 16px (e.g., `Add16`, `Task16`)",
+          "description": "Specify the icon to render for the tooltip button\nIcon size must be 16px (e.g., `Add16`, `Task16`)",
           "type": "typeof import(\"svelte\").SvelteComponent",
           "isFunction": false,
           "isFunctionDeclaration": false,
@@ -13034,7 +13034,7 @@
         {
           "name": "icon",
           "kind": "let",
-          "description": "Specify the icon from `carbon-icons-svelte` to render",
+          "description": "Specify the icon to render",
           "type": "typeof import(\"svelte\").SvelteComponent",
           "isFunction": false,
           "isFunctionDeclaration": false,

diff --git a/docs/src/components/ComponentApi.svelte b/docs/src/components/ComponentApi.svelte
@@ -8,21 +8,18 @@
   };
 
   import {
-    Link,
     OutboundLink,
     StructuredList,
     StructuredListHead,
     StructuredListRow,
     StructuredListCell,
     StructuredListBody,
-    TooltipDefinition,
     UnorderedList,
     ListItem,
     Tag,
     CodeSnippet,
   } from "carbon-components-svelte";
   import InlineSnippet from "./InlineSnippet.svelte";
-  import Launch16 from "carbon-icons-svelte/lib/Launch16";
 
   const mdn_api = "https://developer.mozilla.org/en-US/docs/Web/API/";
   const typeMap = {
@@ -85,15 +82,7 @@
                   class="cell"
                   style="z-index: {(prop.type || '').split(' | ').length - i}"
                 >
-                  {#if type.startsWith("typeof")}
-                    <TooltipDefinition
-                      direction="top"
-                      align="start"
-                      tooltipText="{`From "carbon-icons-svelte"`}"
-                    >
-                      Carbon Svelte icon
-                    </TooltipDefinition>
-                  {:else if type.startsWith("HTML")}
+                  {#if type.startsWith("HTML")}
                     <OutboundLink
                       href="{mdn_api}{type}"
                       style="white-space: nowrap"

diff --git a/src/Button/Button.svelte b/src/Button/Button.svelte
@@ -32,7 +32,7 @@
   export let hasIconOnly = false;
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render
+   * Specify the icon to render
    * @type {typeof import("svelte").SvelteComponent}
    */
   export let icon = undefined;

diff --git a/src/ContextMenu/ContextMenuOption.svelte b/src/ContextMenu/ContextMenuOption.svelte
@@ -12,7 +12,7 @@
   export let indented = false;
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render
+   * Specify the icon to render
    * Icon is rendered to the left of the label text
    * @type {typeof import("svelte").SvelteComponent}
    */

diff --git a/src/Icon/Icon.svelte b/src/Icon/Icon.svelte
@@ -11,7 +11,7 @@
    */
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render
+   * Specify the icon to render
    * @type {typeof import("svelte").SvelteComponent}
    */
   export let render = undefined;

diff --git a/src/Link/Link.svelte b/src/Link/Link.svelte
@@ -15,7 +15,7 @@
   export let inline = false;
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render
+   * Specify the icon to render
    * `inline` must be `false`
    * @type {typeof import("svelte").SvelteComponent}
    */

diff --git a/src/Notification/NotificationButton.svelte b/src/Notification/NotificationButton.svelte
@@ -6,7 +6,7 @@
   export let notificationType = "toast";
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render
+   * Specify the icon to render
    * @type {typeof import("svelte").SvelteComponent}
    */
   export let icon = Close20;

diff --git a/src/OverflowMenu/OverflowMenu.svelte b/src/OverflowMenu/OverflowMenu.svelte
@@ -31,7 +31,7 @@
   export let menuOptionsClass = undefined;
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render
+   * Specify the icon to render
    * @type {typeof import("svelte").SvelteComponent}
    */
   export let icon = OverflowMenuVertical16;

diff --git a/src/Search/Search.svelte b/src/Search/Search.svelte
@@ -59,7 +59,7 @@
   export let labelText = "";
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render
+   * Specify the icon to render
    * @type {typeof import("svelte").SvelteComponent}
    */
   export let icon = Search16;

diff --git a/src/Tag/Tag.svelte b/src/Tag/Tag.svelte
@@ -26,7 +26,7 @@
   export let title = "Clear filter";
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render
+   * Specify the icon to render
    * @type {typeof import("svelte").SvelteComponent}
    */
   export let icon = undefined;

diff --git a/src/Tooltip/Tooltip.svelte b/src/Tooltip/Tooltip.svelte
@@ -24,7 +24,7 @@
   export let hideIcon = false;
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render for the tooltip button
+   * Specify the icon to render for the tooltip button
    * Icon size must be 16px (e.g., `Add16`, `Task16`)
    * @type {typeof import("svelte").SvelteComponent}
    */

diff --git a/src/TooltipIcon/TooltipIcon.svelte b/src/TooltipIcon/TooltipIcon.svelte
@@ -6,7 +6,7 @@
   export let tooltipText = "";
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render
+   * Specify the icon to render
    * @type {typeof import("svelte").SvelteComponent}
    */
   export let icon = undefined;

diff --git a/src/TreeView/TreeViewNode.svelte b/src/TreeView/TreeViewNode.svelte
@@ -44,7 +44,7 @@
   export let disabled = false;
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render
+   * Specify the icon to render
    * @type {typeof import("svelte").SvelteComponent}
    */
   export let icon = undefined;

diff --git a/src/TreeView/TreeViewNodeList.svelte b/src/TreeView/TreeViewNodeList.svelte
@@ -15,7 +15,7 @@
   export let disabled = false;
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render
+   * Specify the icon to render
    * @type {typeof import("svelte").SvelteComponent}
    */
   export let icon = undefined;

diff --git a/src/UIShell/GlobalHeader/Header.svelte b/src/UIShell/GlobalHeader/Header.svelte
@@ -47,14 +47,14 @@
   export let ref = null;
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render for the closed state
+   * Specify the icon to render for the closed state
    * Defaults to `Menu20`
    * @type {typeof import("svelte").SvelteComponent}
    */
   export let iconMenu = Menu20;
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render for the opened state
+   * Specify the icon to render for the opened state
    * Defaults to `Close20`
    * @type {typeof import("svelte").SvelteComponent}
    */

diff --git a/src/UIShell/GlobalHeader/HeaderAction.svelte b/src/UIShell/GlobalHeader/HeaderAction.svelte
@@ -7,13 +7,13 @@
   export let isOpen = false;
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render
+   * Specify the icon to render
    * @type {typeof import("svelte").SvelteComponent}
    */
   export let icon = AppSwitcher20;
 
   /**
-   * Specify the close icon from `carbon-icons-svelte` to render
+   * Specify the icon to render when the action panel is open
    * @type {typeof import("svelte").SvelteComponent}
    */
   export let closeIcon = Close20;

diff --git a/src/UIShell/GlobalHeader/HeaderActionLink.svelte b/src/UIShell/GlobalHeader/HeaderActionLink.svelte
@@ -9,7 +9,7 @@
   export let href = undefined;
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render
+   * Specify the icon to render
    * @type {typeof import("svelte").SvelteComponent}
    */
   export let icon = undefined;

diff --git a/src/UIShell/SideNav/HamburgerMenu.svelte b/src/UIShell/SideNav/HamburgerMenu.svelte
@@ -9,14 +9,14 @@
   export let isOpen = false;
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render for the closed state
+   * Specify the icon to render for the closed state
    * Defaults to `Menu20`
    * @type {typeof import("svelte").SvelteComponent}
    */
   export let iconMenu = Menu20;
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render for the opened state
+   * Specify the icon to render for the opened state
    * Defaults to `Close20`
    * @type {typeof import("svelte").SvelteComponent}
    */

diff --git a/src/UIShell/SideNav/SideNavLink.svelte b/src/UIShell/SideNav/SideNavLink.svelte
@@ -15,7 +15,7 @@
   export let text = undefined;
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render
+   * Specify the icon to render
    * @type {typeof import("svelte").SvelteComponent}
    */
   export let icon = undefined;

diff --git a/src/UIShell/SideNav/SideNavMenu.svelte b/src/UIShell/SideNav/SideNavMenu.svelte
@@ -9,7 +9,7 @@
   export let text = undefined;
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render
+   * Specify the icon to render
    * @type {typeof import("svelte").SvelteComponent}
    */
   export let icon = undefined;

diff --git a/types/Button/Button.svelte.d.ts b/types/Button/Button.svelte.d.ts
@@ -45,7 +45,7 @@ export interface ButtonProps
   hasIconOnly?: boolean;
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render
+   * Specify the icon to render
    */
   icon?: typeof import("svelte").SvelteComponent;
 

diff --git a/types/ContextMenu/ContextMenuOption.svelte.d.ts b/types/ContextMenu/ContextMenuOption.svelte.d.ts
@@ -22,7 +22,7 @@ export interface ContextMenuOptionProps
   indented?: boolean;
 
   /**
-   * Specify the icon from `carbon-icons-svelte` to render
+   * Specify the icon to render
    * Icon is rendered to the left of the label text
    */
   icon?: typeof import("svelte").SvelteComponent;