From 2715ed9c38bf52081476e11c1d3d5043ff67cf71 Mon Sep 17 00:00:00 2001
From: Eric Liu <ericyl.us@gmail.com>
Date: Thu, 13 Jul 2023 08:46:51 -0700
Subject: [PATCH] chore(ui-shell): update `company` prop description in
 `Header` (#1770)

---
 COMPONENT_INDEX.md               | 2 +-
 docs/src/COMPONENT_API.json      | 2 +-
 src/UIShell/Header.svelte        | 5 +++--
 types/UIShell/Header.svelte.d.ts | 3 ++-
 4 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/COMPONENT_INDEX.md b/COMPONENT_INDEX.md
index f7eb9e64..b3c23212 100644
--- a/COMPONENT_INDEX.md
+++ b/COMPONENT_INDEX.md
@@ -1575,7 +1575,7 @@ None.
 | expandedByDefault       | No       | <code>let</code> | No       | <code>boolean</code>                                 | <code>true</code>      | Set to `false` to hide the side nav by default                                                                                                                                                                                                                   |
 | uiShellAriaLabel        | No       | <code>let</code> | No       | <code>string</code>                                  | <code>undefined</code> | Specify the ARIA label for the header                                                                                                                                                                                                                            |
 | href                    | No       | <code>let</code> | No       | <code>string</code>                                  | <code>undefined</code> | Specify the `href` attribute                                                                                                                                                                                                                                     |
-| company                 | No       | <code>let</code> | No       | <code>string</code>                                  | <code>undefined</code> | Specify the company name                                                                                                                                                                                                                                         |
+| company                 | No       | <code>let</code> | No       | <code>string</code>                                  | <code>undefined</code> | Specify the company name. <br />Alternatively, use the named slot "company" (e.g., `&lt;span slot="company"&gt;...&lt;/span&gt;`)                                                                                                                                |
 | platformName            | No       | <code>let</code> | No       | <code>string</code>                                  | <code>""</code>        | Specify the platform name<br />Alternatively, use the named slot "platform" (e.g., &lt;span slot="platform"&gt;...&lt;/span&gt;)                                                                                                                                 |
 | persistentHamburgerMenu | No       | <code>let</code> | No       | <code>boolean</code>                                 | <code>false</code>     | Set to `true` to persist the hamburger menu                                                                                                                                                                                                                      |
 | expansionBreakpoint     | No       | <code>let</code> | No       | <code>number</code>                                  | <code>1056</code>      | The window width (px) at which the SideNav is expanded and the hamburger menu is hidden<br />1056 represents the "large" breakpoint in pixels from the Carbon Design System:<br />small: 320<br />medium: 672<br />large: 1056<br />x-large: 1312<br />max: 1584 |
diff --git a/docs/src/COMPONENT_API.json b/docs/src/COMPONENT_API.json
index 8081cd3f..ee847ae5 100644
--- a/docs/src/COMPONENT_API.json
+++ b/docs/src/COMPONENT_API.json
@@ -4751,7 +4751,7 @@
         {
           "name": "company",
           "kind": "let",
-          "description": "Specify the company name",
+          "description": "Specify the company name.  \nAlternatively, use the named slot \"company\" (e.g., `<span slot=\"company\">...</span>`)",
           "type": "string",
           "isFunction": false,
           "isFunctionDeclaration": false,
diff --git a/src/UIShell/Header.svelte b/src/UIShell/Header.svelte
index c0153607..6ef59a15 100644
--- a/src/UIShell/Header.svelte
+++ b/src/UIShell/Header.svelte
@@ -17,8 +17,9 @@
    */
   export let href = undefined;
 
-  /**
-   * Specify the company name
+   /**
+   * Specify the company name.  
+   * Alternatively, use the named slot "company" (e.g., `<span slot="company">...</span>`)
    * @type {string}
    */
   export let company = undefined;
diff --git a/types/UIShell/Header.svelte.d.ts b/types/UIShell/Header.svelte.d.ts
index 5f620ab8..fc78b0af 100644
--- a/types/UIShell/Header.svelte.d.ts
+++ b/types/UIShell/Header.svelte.d.ts
@@ -28,7 +28,8 @@ export interface HeaderProps
   href?: string;
 
   /**
-   * Specify the company name
+   * Specify the company name.
+   * Alternatively, use the named slot "company" (e.g., `<span slot="company">...</span>`)
    * @default undefined
    */
   company?: string;