diff --git a/COMPONENT_INDEX.md b/COMPONENT_INDEX.md
index ae29fbf10e..9e76a2d010 100644
--- a/COMPONENT_INDEX.md
+++ b/COMPONENT_INDEX.md
@@ -388,7 +388,7 @@ export type BreakpointValue = 320 | 672 | 1056 | 1312 | 1584;
| size | let
| No | "default" | "field" | "small" | "lg" | "xl"
| "default"
| Specify the size of button |
| expressive | let
| No | boolean
| false
| Set to `true` to use Carbon's expressive typesetting |
| isSelected | let
| No | boolean
| false
| Set to `true` to enable the selected state for an icon-only, ghost button |
-| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon from `carbon-icons-svelte` to render |
+| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon to render |
| iconDescription | let
| No | string
| -- | Specify the ARIA label for the button icon |
| tooltipAlignment | let
| No | "start" | "center" | "end"
| "center"
| Set the alignment of the tooltip relative to the icon
`hasIconOnly` must be set to `true` |
| tooltipPosition | let
| No | "top" | "right" | "bottom" | "left"
| "bottom"
| Set the position of the tooltip relative to the icon |
@@ -844,7 +844,7 @@ None.
| ref | let
| Yes | null | HTMLLIElement
| null
| Obtain a reference to the list item HTML element |
| selectable | let
| Yes | boolean
| false
| Set to `true` to enable the selectable variant
Automatically set to `true` if `selected` is `true` |
| selected | let
| Yes | boolean
| false
| Set to `true` to use the selected variant |
-| icon | let
| Yes | typeof import("svelte").SvelteComponent
| -- | Specify the icon from `carbon-icons-svelte` to render
Icon is rendered to the left of the label text |
+| icon | let
| Yes | typeof import("svelte").SvelteComponent
| -- | Specify the icon to render
Icon is rendered to the left of the label text |
| indented | let
| Yes | boolean
| false
| Set to `true` to indent the label |
| kind | let
| No | "default" | "danger"
| "default"
| Specify the kind of option |
| disabled | let
| No | boolean
| false
| Set to `true` to enable the disabled state |
@@ -1578,8 +1578,8 @@ None.
| platformName | let
| No | string
| ""
| Specify the platform name
Alternatively, use the named slot "platform" (e.g., <span slot="platform">...</span>) |
| persistentHamburgerMenu | let
| No | boolean
| false
| Set to `true` to persist the hamburger menu |
| expansionBreakpoint | 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 | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon from `carbon-icons-svelte` to render for the closed state
Defaults to `Menu20` |
-| iconClose | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon from `carbon-icons-svelte` to render for the opened state
Defaults to `Close20` |
+| iconMenu | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon to render for the closed state
Defaults to `Menu20` |
+| iconClose | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon to render for the opened state
Defaults to `Close20` |
### Slots
@@ -1613,8 +1613,8 @@ export interface HeaderActionSlideTransition {
| :--------- | :--------------- | :------- | :---------------------------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------- |
| ref | let
| Yes | null | HTMLButtonElement
| null
| Obtain a reference to the button HTML element |
| isOpen | let
| Yes | boolean
| false
| Set to `true` to open the panel |
-| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon from `carbon-icons-svelte` to render |
-| closeIcon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the close icon from `carbon-icons-svelte` to render |
+| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon to render |
+| closeIcon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon to render when the action panel is open |
| text | let
| No | string
| -- | Specify the text
Alternatively, use the named slot "text" (e.g., <div slot="text">...</div>) |
| transition | let
| No | false | HeaderActionSlideTransition
| { duration: 200 }
| Customize the panel transition (i.e., `transition:slide`)
Set to `false` to disable the transition |
@@ -1636,12 +1636,12 @@ export interface HeaderActionSlideTransition {
### Props
-| Prop name | Kind | Reactive | Type | Default value | Description |
-| :----------- | :--------------- | :------- | :--------------------------------------------------- | ------------------ | ----------------------------------------------------- |
-| ref | let
| Yes | null | HTMLAnchorElement
| null
| Obtain a reference to the HTML anchor element |
-| linkIsActive | let
| No | boolean
| false
| Set to `true` to use the active state |
-| href | let
| No | string
| -- | Specify the `href` attribute |
-| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon from `carbon-icons-svelte` to render |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :----------- | :--------------- | :------- | :--------------------------------------------------- | ------------------ | --------------------------------------------- |
+| ref | let
| Yes | null | HTMLAnchorElement
| null
| Obtain a reference to the HTML anchor element |
+| linkIsActive | let
| No | boolean
| false
| Set to `true` to use the active state |
+| href | let
| No | string
| -- | Specify the `href` attribute |
+| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon to render |
### Slots
@@ -1884,10 +1884,10 @@ None.
### Props
-| Prop name | Kind | Reactive | Type | Default value | Description |
-| :-------- | :--------------- | :------- | :--------------------------------------------------- | ------------------ | ----------------------------------------------------- |
-| render | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon from `carbon-icons-svelte` to render |
-| skeleton | let
| No | boolean
| false
| Set to `true` to display the skeleton state |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :--------------------------------------------------- | ------------------ | ------------------------------------------- |
+| render | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon to render |
+| skeleton | let
| No | boolean
| false
| Set to `true` to display the skeleton state |
### Slots
@@ -2013,15 +2013,15 @@ None.
### Props
-| Prop name | Kind | Reactive | Type | Default value | Description |
-| :-------- | :--------------- | :------- | :--------------------------------------------------------------------- | ------------------ | ----------------------------------------------------------------------------------- |
-| ref | let
| Yes | null | HTMLAnchorElement | HTMLParagraphElement
| null
| Obtain a reference to the top-level HTML element |
-| size | let
| No | "sm" | "lg"
| -- | Specify the size of the link |
-| href | let
| No | string
| -- | Specify the href value |
-| inline | let
| No | boolean
| false
| Set to `true` to use the inline variant |
-| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon from `carbon-icons-svelte` to render
`inline` must be `false` |
-| disabled | let
| No | boolean
| false
| Set to `true` to disable the checkbox |
-| visited | let
| No | boolean
| false
| Set to `true` to allow visited styles |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :--------------------------------------------------------------------- | ------------------ | -------------------------------------------------------- |
+| ref | let
| Yes | null | HTMLAnchorElement | HTMLParagraphElement
| null
| Obtain a reference to the top-level HTML element |
+| size | let
| No | "sm" | "lg"
| -- | Specify the size of the link |
+| href | let
| No | string
| -- | Specify the href value |
+| inline | let
| No | boolean
| false
| Set to `true` to use the inline variant |
+| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon to render
`inline` must be `false` |
+| disabled | let
| No | boolean
| false
| Set to `true` to disable the checkbox |
+| visited | let
| No | boolean
| false
| Set to `true` to allow visited styles |
### Slots
@@ -2480,12 +2480,12 @@ None.
### Props
-| Prop name | Kind | Reactive | Type | Default value | Description |
-| :--------------- | :--------------- | :------- | :--------------------------------------------------- | ------------------------- | ----------------------------------------------------- |
-| notificationType | let
| No | "toast" | "inline"
| "toast"
| Set the type of notification |
-| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon from `carbon-icons-svelte` to render |
-| title | let
| No | string
| -- | Specify the title of the icon |
-| iconDescription | let
| No | string
| "Close icon"
| Specify the ARIA label for the icon |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :--------------- | :--------------- | :------- | :--------------------------------------------------- | ------------------------- | ----------------------------------- |
+| notificationType | let
| No | "toast" | "inline"
| "toast"
| Set the type of notification |
+| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon to render |
+| title | let
| No | string
| -- | Specify the title of the icon |
+| iconDescription | let
| No | string
| "Close icon"
| Specify the ARIA label for the icon |
### Slots
@@ -2668,7 +2668,7 @@ None.
| :--------------- | :--------------- | :------- | :--------------------------------------------------- | ------------------------------------------------ | ----------------------------------------------------------------- |
| menuRef | let
| Yes | null | HTMLUListElement
| null
| Obtain a reference to the overflow menu element |
| buttonRef | let
| Yes | null | HTMLButtonElement
| null
| Obtain a reference to the trigger button element |
-| icon | let
| Yes | typeof import("svelte").SvelteComponent
| -- | Specify the icon from `carbon-icons-svelte` to render |
+| icon | let
| Yes | typeof import("svelte").SvelteComponent
| -- | Specify the icon to render |
| open | let
| Yes | boolean
| false
| Set to `true` to open the menu |
| size | let
| No | "sm" | "xl"
| -- | Specify the size of the overflow menu |
| direction | let
| No | "top" | "bottom"
| "bottom"
| Specify the direction of the overflow menu relative to the button |
@@ -3165,7 +3165,7 @@ None.
| autofocus | let
| No | boolean
| false
| Set to `true` to auto focus the search element |
| closeButtonLabelText | let
| No | string
| "Clear search input"
| Specify the close button label text |
| labelText | let
| No | string
| ""
| Specify the label text |
-| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon from `carbon-icons-svelte` to render |
+| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon to render |
| id | let
| No | string
| "ccs-" + Math.random().toString(36)
| Set an id for the input element |
### Slots
@@ -3405,13 +3405,13 @@ None.
### Props
-| Prop name | Kind | Reactive | Type | Default value | Description |
-| :--------- | :--------------- | :------- | :--------------------------------------------------- | ------------------ | ----------------------------------------------------- |
-| ref | let
| Yes | null | HTMLAnchorElement
| null
| Obtain a reference to the HTML anchor element |
-| isSelected | let
| No | boolean
| false
| Set to `true` to select the current link |
-| href | let
| No | string
| -- | Specify the `href` attribute |
-| text | let
| No | string
| -- | Specify the text |
-| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon from `carbon-icons-svelte` to render |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :--------- | :--------------- | :------- | :--------------------------------------------------- | ------------------ | --------------------------------------------- |
+| ref | let
| Yes | null | HTMLAnchorElement
| null
| Obtain a reference to the HTML anchor element |
+| isSelected | let
| No | boolean
| false
| Set to `true` to select the current link |
+| href | let
| No | string
| -- | Specify the `href` attribute |
+| text | let
| No | string
| -- | Specify the text |
+| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon to render |
### Slots
@@ -3427,12 +3427,12 @@ None.
### Props
-| Prop name | Kind | Reactive | Type | Default value | Description |
-| :-------- | :--------------- | :------- | :--------------------------------------------------- | ------------------ | ----------------------------------------------------- |
-| ref | let
| Yes | null | HTMLButtonElement
| null
| Obtain a reference to the HTML button element |
-| expanded | let
| Yes | boolean
| false
| Set to `true` to toggle the expanded state |
-| text | let
| No | string
| -- | Specify the text |
-| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon from `carbon-icons-svelte` to render |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------- | :--------------- | :------- | :--------------------------------------------------- | ------------------ | --------------------------------------------- |
+| ref | let
| Yes | null | HTMLButtonElement
| null
| Obtain a reference to the HTML button element |
+| expanded | let
| Yes | boolean
| false
| Set to `true` to toggle the expanded state |
+| text | let
| No | string
| -- | Specify the text |
+| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon to render |
### Slots
@@ -4041,7 +4041,7 @@ None.
| interactive | let
| No | boolean
| false
| Set to `true` to render a `button` element instead of a `div` |
| skeleton | let
| No | boolean
| false
| Set to `true` to display the skeleton state |
| title | let
| No | string
| "Clear filter"
| Set the title for the close button in a filterable tag |
-| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon from `carbon-icons-svelte` to render |
+| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon to render |
| id | let
| No | string
| "ccs-" + Math.random().toString(36)
| Set an id for the filterable tag |
### Slots
@@ -4628,22 +4628,22 @@ None.
### Props
-| Prop name | Kind | Reactive | Type | Default value | Description |
-| :-------------- | :--------------- | :------- | :-------------------------------------------------------------- | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- |
-| refIcon | let
| Yes | null | HTMLDivElement
| null
| Obtain a reference to the icon HTML element |
-| refTooltip | let
| Yes | null | HTMLDivElement
| null
| Obtain a reference to the tooltip HTML element |
-| ref | let
| Yes | null | HTMLDivElement
| null
| Obtain a reference to the trigger text HTML element |
-| open | let
| Yes | boolean
| false
| Set to `true` to open the tooltip |
-| align | let
| No | "start" | "center" | "end"
| "center"
| Set the alignment of the tooltip relative to the icon |
-| direction | let
| No | "top" | "right" | "bottom" | "left"
| "bottom"
| Set the direction of the tooltip relative to the button |
-| hideIcon | let
| No | boolean
| false
| Set to `true` to hide the tooltip icon |
-| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon from `carbon-icons-svelte` to render for the tooltip button
Icon size must be 16px (e.g., `Add16`, `Task16`) |
-| iconDescription | let
| No | string
| ""
| Specify the ARIA label for the tooltip button |
-| iconName | let
| No | string
| ""
| Specify the icon name attribute |
-| tabindex | let
| No | string
| "0"
| Set the button tabindex |
-| tooltipId | let
| No | string
| "ccs-" + Math.random().toString(36)
| Set an id for the tooltip |
-| triggerId | let
| No | string
| "ccs-" + Math.random().toString(36)
| Set an id for the tooltip button |
-| triggerText | let
| No | string
| ""
| Set the tooltip button text |
+| Prop name | Kind | Reactive | Type | Default value | Description |
+| :-------------- | :--------------- | :------- | :-------------------------------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------- |
+| refIcon | let
| Yes | null | HTMLDivElement
| null
| Obtain a reference to the icon HTML element |
+| refTooltip | let
| Yes | null | HTMLDivElement
| null
| Obtain a reference to the tooltip HTML element |
+| ref | let
| Yes | null | HTMLDivElement
| null
| Obtain a reference to the trigger text HTML element |
+| open | let
| Yes | boolean
| false
| Set to `true` to open the tooltip |
+| align | let
| No | "start" | "center" | "end"
| "center"
| Set the alignment of the tooltip relative to the icon |
+| direction | let
| No | "top" | "right" | "bottom" | "left"
| "bottom"
| Set the direction of the tooltip relative to the button |
+| hideIcon | let
| No | boolean
| false
| Set to `true` to hide the tooltip icon |
+| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon to render for the tooltip button
Icon size must be 16px (e.g., `Add16`, `Task16`) |
+| iconDescription | let
| No | string
| ""
| Specify the ARIA label for the tooltip button |
+| iconName | let
| No | string
| ""
| Specify the icon name attribute |
+| tabindex | let
| No | string
| "0"
| Set the button tabindex |
+| tooltipId | let
| No | string
| "ccs-" + Math.random().toString(36)
| Set an id for the tooltip |
+| triggerId | let
| No | string
| "ccs-" + Math.random().toString(36)
| Set an id for the tooltip button |
+| triggerText | let
| No | string
| ""
| Set the tooltip button text |
### Slots
@@ -4715,7 +4715,7 @@ None.
| :---------- | :--------------- | :------- | :-------------------------------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------ |
| ref | let
| Yes | null | HTMLButtonElement
| null
| Obtain a reference to the button HTML element |
| tooltipText | let
| No | string
| ""
| Specify the tooltip text.
Alternatively, use the "tooltipText" slot |
-| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon from `carbon-icons-svelte` to render |
+| icon | let
| No | typeof import("svelte").SvelteComponent
| -- | Specify the icon to render |
| disabled | let
| No | boolean
| false
| Set to `true` to disable the tooltip icon |
| align | let
| No | "start" | "center" | "end"
| "center"
| Set the alignment of the tooltip relative to the icon |
| direction | let
| No | "top" | "right" | "bottom" | "left"
| "bottom"
| Set the direction of the tooltip relative to the icon |
diff --git a/docs/src/COMPONENT_API.json b/docs/src/COMPONENT_API.json
index 790f58a297..9176f27251 100644
--- 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
index 4ec66fbd45..2e2602029f 100644
--- 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")}
-
- Carbon Svelte icon
-
- {:else if type.startsWith("HTML")}
+ {#if type.startsWith("HTML")}
{
/**
- * Specify the icon from `carbon-icons-svelte` to render
+ * Specify the icon to render
*/
render?: typeof import("svelte").SvelteComponent;
diff --git a/types/Link/Link.svelte.d.ts b/types/Link/Link.svelte.d.ts
index a2b096d0a8..5a5efca394 100644
--- a/types/Link/Link.svelte.d.ts
+++ b/types/Link/Link.svelte.d.ts
@@ -20,7 +20,7 @@ export interface LinkProps
inline?: boolean;
/**
- * Specify the icon from `carbon-icons-svelte` to render
+ * Specify the icon to render
* `inline` must be `false`
*/
icon?: typeof import("svelte").SvelteComponent;
diff --git a/types/Notification/NotificationButton.svelte.d.ts b/types/Notification/NotificationButton.svelte.d.ts
index 55cf0cb64e..682c819f74 100644
--- a/types/Notification/NotificationButton.svelte.d.ts
+++ b/types/Notification/NotificationButton.svelte.d.ts
@@ -10,7 +10,7 @@ export interface NotificationButtonProps
notificationType?: "toast" | "inline";
/**
- * Specify the icon from `carbon-icons-svelte` to render
+ * Specify the icon to render
*/
icon?: typeof import("svelte").SvelteComponent;
diff --git a/types/OverflowMenu/OverflowMenu.svelte.d.ts b/types/OverflowMenu/OverflowMenu.svelte.d.ts
index b1844d38c5..823a6a4b83 100644
--- a/types/OverflowMenu/OverflowMenu.svelte.d.ts
+++ b/types/OverflowMenu/OverflowMenu.svelte.d.ts
@@ -38,7 +38,7 @@ export interface OverflowMenuProps
menuOptionsClass?: string;
/**
- * Specify the icon from `carbon-icons-svelte` to render
+ * Specify the icon to render
*/
icon?: typeof import("svelte").SvelteComponent;
diff --git a/types/Search/Search.svelte.d.ts b/types/Search/Search.svelte.d.ts
index e47c64ae1a..143e02a5fd 100644
--- a/types/Search/Search.svelte.d.ts
+++ b/types/Search/Search.svelte.d.ts
@@ -92,7 +92,7 @@ export interface SearchProps {
labelText?: string;
/**
- * Specify the icon from `carbon-icons-svelte` to render
+ * Specify the icon to render
*/
icon?: typeof import("svelte").SvelteComponent;
diff --git a/types/Tag/Tag.svelte.d.ts b/types/Tag/Tag.svelte.d.ts
index 4172d642e0..fd6cb90b7c 100644
--- a/types/Tag/Tag.svelte.d.ts
+++ b/types/Tag/Tag.svelte.d.ts
@@ -57,7 +57,7 @@ export interface TagProps
title?: string;
/**
- * Specify the icon from `carbon-icons-svelte` to render
+ * Specify the icon to render
*/
icon?: typeof import("svelte").SvelteComponent;
diff --git a/types/Tooltip/Tooltip.svelte.d.ts b/types/Tooltip/Tooltip.svelte.d.ts
index dfa910f016..5e6f28ed0b 100644
--- a/types/Tooltip/Tooltip.svelte.d.ts
+++ b/types/Tooltip/Tooltip.svelte.d.ts
@@ -28,7 +28,7 @@ export interface TooltipProps
hideIcon?: boolean;
/**
- * 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`)
*/
icon?: typeof import("svelte").SvelteComponent;
diff --git a/types/TooltipIcon/TooltipIcon.svelte.d.ts b/types/TooltipIcon/TooltipIcon.svelte.d.ts
index 791862011b..c648f307db 100644
--- a/types/TooltipIcon/TooltipIcon.svelte.d.ts
+++ b/types/TooltipIcon/TooltipIcon.svelte.d.ts
@@ -11,7 +11,7 @@ export interface TooltipIconProps
tooltipText?: string;
/**
- * Specify the icon from `carbon-icons-svelte` to render
+ * Specify the icon to render
*/
icon?: typeof import("svelte").SvelteComponent;
diff --git a/types/UIShell/GlobalHeader/Header.svelte.d.ts b/types/UIShell/GlobalHeader/Header.svelte.d.ts
index 8f4cf48305..e6dd5d9a80 100644
--- a/types/UIShell/GlobalHeader/Header.svelte.d.ts
+++ b/types/UIShell/GlobalHeader/Header.svelte.d.ts
@@ -62,13 +62,13 @@ export interface HeaderProps
ref?: null | HTMLAnchorElement;
/**
- * 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`
*/
iconMenu?: typeof import("svelte").SvelteComponent;
/**
- * 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`
*/
iconClose?: typeof import("svelte").SvelteComponent;
diff --git a/types/UIShell/GlobalHeader/HeaderAction.svelte.d.ts b/types/UIShell/GlobalHeader/HeaderAction.svelte.d.ts
index 41c9d6af8e..1b35128fc2 100644
--- a/types/UIShell/GlobalHeader/HeaderAction.svelte.d.ts
+++ b/types/UIShell/GlobalHeader/HeaderAction.svelte.d.ts
@@ -16,12 +16,12 @@ export interface HeaderActionProps
isOpen?: boolean;
/**
- * Specify the icon from `carbon-icons-svelte` to render
+ * Specify the icon to render
*/
icon?: typeof import("svelte").SvelteComponent;
/**
- * Specify the close icon from `carbon-icons-svelte` to render
+ * Specify the icon to render when the action panel is open
*/
closeIcon?: typeof import("svelte").SvelteComponent;
diff --git a/types/UIShell/GlobalHeader/HeaderActionLink.svelte.d.ts b/types/UIShell/GlobalHeader/HeaderActionLink.svelte.d.ts
index 85764b8339..3ac65409d4 100644
--- a/types/UIShell/GlobalHeader/HeaderActionLink.svelte.d.ts
+++ b/types/UIShell/GlobalHeader/HeaderActionLink.svelte.d.ts
@@ -15,7 +15,7 @@ export interface HeaderActionLinkProps
href?: string;
/**
- * Specify the icon from `carbon-icons-svelte` to render
+ * Specify the icon to render
*/
icon?: typeof import("svelte").SvelteComponent;
diff --git a/types/UIShell/SideNav/SideNavLink.svelte.d.ts b/types/UIShell/SideNav/SideNavLink.svelte.d.ts
index ec95a2eadc..6cb66fc2de 100644
--- a/types/UIShell/SideNav/SideNavLink.svelte.d.ts
+++ b/types/UIShell/SideNav/SideNavLink.svelte.d.ts
@@ -20,7 +20,7 @@ export interface SideNavLinkProps
text?: string;
/**
- * Specify the icon from `carbon-icons-svelte` to render
+ * Specify the icon to render
*/
icon?: typeof import("svelte").SvelteComponent;
diff --git a/types/UIShell/SideNav/SideNavMenu.svelte.d.ts b/types/UIShell/SideNav/SideNavMenu.svelte.d.ts
index 574e6e17c9..02e155b314 100644
--- a/types/UIShell/SideNav/SideNavMenu.svelte.d.ts
+++ b/types/UIShell/SideNav/SideNavMenu.svelte.d.ts
@@ -15,7 +15,7 @@ export interface SideNavMenuProps
text?: string;
/**
- * Specify the icon from `carbon-icons-svelte` to render
+ * Specify the icon to render
*/
icon?: typeof import("svelte").SvelteComponent;