diff --git a/COMPONENT_INDEX.md b/COMPONENT_INDEX.md
index b3c23212..0e5d2e81 100644
--- a/COMPONENT_INDEX.md
+++ b/COMPONENT_INDEX.md
@@ -1568,19 +1568,19 @@ None.
### Props
-| Prop name | Required | Kind | Reactive | Type | Default value | Description |
-| :---------------------- | :------- | :--------------- | :------- | ---------------------------------------------------- | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| ref | No | let | Yes | null | HTMLAnchorElement | null | Obtain a reference to the HTML anchor element |
-| isSideNavOpen | No | let | Yes | boolean | false | Set to `true` to open the side nav |
-| expandedByDefault | No | let | No | boolean | true | Set to `false` to hide the side nav by default |
-| uiShellAriaLabel | No | let | No | string | undefined | Specify the ARIA label for the header |
-| href | No | let | No | string | undefined | Specify the `href` attribute |
-| company | No | let | No | string | undefined | Specify the company name.
Alternatively, use the named slot "company" (e.g., `<span slot="company">...</span>`) |
-| platformName | No | let | No | string | "" | Specify the platform name
Alternatively, use the named slot "platform" (e.g., <span slot="platform">...</span>) |
-| persistentHamburgerMenu | No | let | No | boolean | false | Set to `true` to persist the hamburger menu |
-| expansionBreakpoint | No | let | No | number | 1056 | The window width (px) at which the SideNav is expanded and the hamburger menu is hidden
1056 represents the "large" breakpoint in pixels from the Carbon Design System:
small: 320
medium: 672
large: 1056
x-large: 1312
max: 1584 |
-| iconMenu | No | let | No | typeof import("svelte").SvelteComponent | undefined | Specify the icon to render for the closed state.
Defaults to `<Menu size={20} />` |
-| iconClose | No | let | No | typeof import("svelte").SvelteComponent | undefined | Specify the icon to render for the opened state.
Defaults to `<Close size={20} />` |
+| Prop name | Required | Kind | Reactive | Type | Default value | Description |
+| :---------------------- | :------- | :--------------- | :------- | ---------------------------------------------------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| ref | No | let | Yes | null | HTMLAnchorElement | null | Obtain a reference to the HTML anchor element |
+| isSideNavOpen | No | let | Yes | boolean | false | Set to `true` to open the side nav |
+| expandedByDefault | No | let | No | boolean | true | Set to `false` to hide the side nav by default |
+| uiShellAriaLabel | No | let | No | string | undefined | Specify the ARIA label for the header |
+| href | No | let | No | string | undefined | Specify the `href` attribute |
+| company | No | let | No | string | undefined | Specify the company name.
Alternatively, use the named slot "company" (e.g., `<span slot="company">...</span>`) |
+| platformName | No | let | No | string | "" | Specify the platform name.
Alternatively, use the named slot "platform" (e.g., `<span slot="platform">...</span>`) |
+| persistentHamburgerMenu | No | let | No | boolean | false | Set to `true` to persist the hamburger menu |
+| expansionBreakpoint | No | let | No | number | 1056 | The window width (px) at which the SideNav is expanded and the hamburger menu is hidden.
1056 represents the "large" breakpoint in pixels from the Carbon Design System:
- small: 320
- medium: 672
- large: 1056
- x-large: 1312
- max: 1584 |
+| iconMenu | No | let | No | typeof import("svelte").SvelteComponent | undefined | Specify the icon to render for the closed state.
Defaults to `<Menu size={20} />` |
+| iconClose | No | let | No | typeof import("svelte").SvelteComponent | undefined | Specify the icon to render for the opened state.
Defaults to `<Close size={20} />` |
### Slots
@@ -3293,13 +3293,13 @@ None.
### Props
-| Prop name | Required | Kind | Reactive | Type | Default value | Description |
-| :------------------ | :------- | :--------------- | :------- | -------------------- | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| isOpen | No | let | Yes | boolean | false | Set to `true` to toggle the expanded state |
-| fixed | No | let | No | boolean | false | Set to `true` to use the fixed variant |
-| rail | No | let | No | boolean | false | Set to `true` to use the rail variant |
-| ariaLabel | No | let | No | string | undefined | Specify the ARIA label for the nav |
-| expansionBreakpoint | No | let | No | number | 1056 | The window width (px) at which the SideNav is expanded and the hamburger menu is hidden
1056 represents the "large" breakpoint in pixels from the Carbon Design System:
small: 320
medium: 672
large: 1056
x-large: 1312
max: 1584 |
+| Prop name | Required | Kind | Reactive | Type | Default value | Description |
+| :------------------ | :------- | :--------------- | :------- | -------------------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| isOpen | No | let | Yes | boolean | false | Set to `true` to toggle the expanded state |
+| fixed | No | let | No | boolean | false | Set to `true` to use the fixed variant |
+| rail | No | let | No | boolean | false | Set to `true` to use the rail variant |
+| ariaLabel | No | let | No | string | undefined | Specify the ARIA label for the nav |
+| expansionBreakpoint | No | let | No | number | 1056 | The window width (px) at which the SideNav is expanded and the hamburger menu is hidden.
1056 represents the "large" breakpoint in pixels from the Carbon Design System:
- small: 320
- medium: 672
- large: 1056
- x-large: 1312
- max: 1584 |
### Slots
diff --git a/docs/src/COMPONENT_API.json b/docs/src/COMPONENT_API.json
index ee847ae5..d6ab73f4 100644
--- a/docs/src/COMPONENT_API.json
+++ b/docs/src/COMPONENT_API.json
@@ -4762,7 +4762,7 @@
{
"name": "platformName",
"kind": "let",
- "description": "Specify the platform name\nAlternatively, use the named slot \"platform\" (e.g., ...)",
+ "description": "Specify the platform name.\nAlternatively, use the named slot \"platform\" (e.g., `...`)",
"type": "string",
"value": "\"\"",
"isFunction": false,
@@ -4786,7 +4786,7 @@
{
"name": "expansionBreakpoint",
"kind": "let",
- "description": "The window width (px) at which the SideNav is expanded and the hamburger menu is hidden\n1056 represents the \"large\" breakpoint in pixels from the Carbon Design System:\nsmall: 320\nmedium: 672\nlarge: 1056\nx-large: 1312\nmax: 1584",
+ "description": "The window width (px) at which the SideNav is expanded and the hamburger menu is hidden.\n1056 represents the \"large\" breakpoint in pixels from the Carbon Design System:\n- small: 320\n- medium: 672\n- large: 1056\n- x-large: 1312\n- max: 1584",
"type": "number",
"value": "1056",
"isFunction": false,
@@ -10658,7 +10658,7 @@
{
"name": "expansionBreakpoint",
"kind": "let",
- "description": "The window width (px) at which the SideNav is expanded and the hamburger menu is hidden\n1056 represents the \"large\" breakpoint in pixels from the Carbon Design System:\nsmall: 320\nmedium: 672\nlarge: 1056\nx-large: 1312\nmax: 1584",
+ "description": "The window width (px) at which the SideNav is expanded and the hamburger menu is hidden.\n1056 represents the \"large\" breakpoint in pixels from the Carbon Design System:\n- small: 320\n- medium: 672\n- large: 1056\n- x-large: 1312\n- max: 1584",
"type": "number",
"value": "1056",
"isFunction": false,
diff --git a/src/UIShell/Header.svelte b/src/UIShell/Header.svelte
index 6ef59a15..47f5c171 100644
--- a/src/UIShell/Header.svelte
+++ b/src/UIShell/Header.svelte
@@ -25,8 +25,8 @@
export let company = undefined;
/**
- * Specify the platform name
- * Alternatively, use the named slot "platform" (e.g., ...)
+ * Specify the platform name.
+ * Alternatively, use the named slot "platform" (e.g., `...`)
*/
export let platformName = "";
@@ -34,13 +34,13 @@
export let persistentHamburgerMenu = false;
/**
- * The window width (px) at which the SideNav is expanded and the hamburger menu is hidden
+ * The window width (px) at which the SideNav is expanded and the hamburger menu is hidden.
* 1056 represents the "large" breakpoint in pixels from the Carbon Design System:
- * small: 320
- * medium: 672
- * large: 1056
- * x-large: 1312
- * max: 1584
+ * - small: 320
+ * - medium: 672
+ * - large: 1056
+ * - x-large: 1312
+ * - max: 1584
*/
export let expansionBreakpoint = 1056;
diff --git a/src/UIShell/SideNav.svelte b/src/UIShell/SideNav.svelte
index e6b14adc..add7269b 100644
--- a/src/UIShell/SideNav.svelte
+++ b/src/UIShell/SideNav.svelte
@@ -21,13 +21,13 @@
export let isOpen = false;
/**
- * The window width (px) at which the SideNav is expanded and the hamburger menu is hidden
+ * The window width (px) at which the SideNav is expanded and the hamburger menu is hidden.
* 1056 represents the "large" breakpoint in pixels from the Carbon Design System:
- * small: 320
- * medium: 672
- * large: 1056
- * x-large: 1312
- * max: 1584
+ * - small: 320
+ * - medium: 672
+ * - large: 1056
+ * - x-large: 1312
+ * - max: 1584
*/
export let expansionBreakpoint = 1056;
diff --git a/types/UIShell/Header.svelte.d.ts b/types/UIShell/Header.svelte.d.ts
index fc78b0af..f0f50805 100644
--- a/types/UIShell/Header.svelte.d.ts
+++ b/types/UIShell/Header.svelte.d.ts
@@ -35,8 +35,8 @@ export interface HeaderProps
company?: string;
/**
- * Specify the platform name
- * Alternatively, use the named slot "platform" (e.g., ...)
+ * Specify the platform name.
+ * Alternatively, use the named slot "platform" (e.g., `...`)
* @default ""
*/
platformName?: string;
@@ -48,13 +48,13 @@ export interface HeaderProps
persistentHamburgerMenu?: boolean;
/**
- * The window width (px) at which the SideNav is expanded and the hamburger menu is hidden
+ * The window width (px) at which the SideNav is expanded and the hamburger menu is hidden.
* 1056 represents the "large" breakpoint in pixels from the Carbon Design System:
- * small: 320
- * medium: 672
- * large: 1056
- * x-large: 1312
- * max: 1584
+ * - small: 320
+ * - medium: 672
+ * - large: 1056
+ * - x-large: 1312
+ * - max: 1584
* @default 1056
*/
expansionBreakpoint?: number;
diff --git a/types/UIShell/SideNav.svelte.d.ts b/types/UIShell/SideNav.svelte.d.ts
index 11e5e52f..389b5e2c 100644
--- a/types/UIShell/SideNav.svelte.d.ts
+++ b/types/UIShell/SideNav.svelte.d.ts
@@ -28,13 +28,13 @@ export interface SideNavProps
isOpen?: boolean;
/**
- * The window width (px) at which the SideNav is expanded and the hamburger menu is hidden
+ * The window width (px) at which the SideNav is expanded and the hamburger menu is hidden.
* 1056 represents the "large" breakpoint in pixels from the Carbon Design System:
- * small: 320
- * medium: 672
- * large: 1056
- * x-large: 1312
- * max: 1584
+ * - small: 320
+ * - medium: 672
+ * - large: 1056
+ * - x-large: 1312
+ * - max: 1584
* @default 1056
*/
expansionBreakpoint?: number;