feat(ui-shell): make company in Header slottable (#1764)

carbon-design-system · Jul 13, 2023 · 9b3f014 · 9b3f014
1 parent 14d584d
commit 9b3f014
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 8 deletions.
diff --git a/COMPONENT_INDEX.md b/COMPONENT_INDEX.md
@@ -1584,11 +1584,12 @@ None.
 
 ### Slots
 
-| Slot name       | Default | Props | Fallback                    |
-| :-------------- | :------ | :---- | :-------------------------- |
-| --              | Yes     | --    | --                          |
-| platform        | No      | --    | <code>{platformName}</code> |
-| skip-to-content | No      | --    | --                          |
+| Slot name       | Default | Props | Fallback                     |
+| :-------------- | :------ | :---- | :--------------------------- |
+| --              | Yes     | --    | --                           |
+| company         | No      | --    | <code>{company}&nbsp;</code> |
+| platform        | No      | --    | <code>{platformName}</code>  |
+| skip-to-content | No      | --    | --                           |
 
 ### Events
 

diff --git a/docs/src/COMPONENT_API.json b/docs/src/COMPONENT_API.json
@@ -4833,6 +4833,12 @@
       "moduleExports": [],
       "slots": [
         { "name": "__default__", "default": true, "slot_props": "{}" },
+        {
+          "name": "company",
+          "default": false,
+          "fallback": "{company}&nbsp;",
+          "slot_props": "{}"
+        },
         {
           "name": "platform",
           "default": false,

diff --git a/src/UIShell/Header.svelte b/src/UIShell/Header.svelte
@@ -94,8 +94,10 @@
     {...$$restProps}
     on:click
   >
-    {#if company}
-      <span class:bx--header__name--prefix="{true}">{company}&nbsp;</span>
+    {#if company || $$slots.company}
+      <span class:bx--header__name--prefix="{true}"
+        ><slot name="company">{company}&nbsp;</slot></span
+      >
     {/if}
     <slot name="platform">{platformName}</slot>
   </a>

diff --git a/types/UIShell/Header.svelte.d.ts b/types/UIShell/Header.svelte.d.ts
@@ -84,5 +84,5 @@ export interface HeaderProps
 export default class Header extends SvelteComponentTyped<
   HeaderProps,
   { click: WindowEventMap["click"] },
-  { default: {}; platform: {}; ["skip-to-content"]: {} }
+  { default: {}; company: {}; platform: {}; ["skip-to-content"]: {} }
 > {}