From fcfe3c3ae47cb8e0ea3d4d02c50ded13cfec7a37 Mon Sep 17 00:00:00 2001 From: metonym Date: Fri, 15 Oct 2021 07:53:58 -0700 Subject: [PATCH] feat(types): loosen type for Carbon icons #806 --- COMPONENT_INDEX.md | 203 +++++++++--------- docs/src/COMPONENT_API.json | 34 +-- src/Button/Button.svelte | 2 +- src/ContextMenu/ContextMenuOption.svelte | 2 +- src/Icon/Icon.svelte | 2 +- src/Link/Link.svelte | 2 +- src/Notification/NotificationButton.svelte | 2 +- src/OverflowMenu/OverflowMenu.svelte | 2 +- src/Search/Search.svelte | 2 +- src/Tag/Tag.svelte | 2 +- src/Tooltip/Tooltip.svelte | 2 +- src/TooltipIcon/TooltipIcon.svelte | 2 +- src/TreeView/TreeViewNode.svelte | 2 +- src/TreeView/TreeViewNodeList.svelte | 2 +- src/UIShell/GlobalHeader/Header.svelte | 4 +- src/UIShell/GlobalHeader/HeaderAction.svelte | 2 +- .../GlobalHeader/HeaderActionLink.svelte | 2 +- src/UIShell/HeaderGlobalAction.svelte | 2 +- src/UIShell/SideNav/HamburgerMenu.svelte | 4 +- src/UIShell/SideNav/SideNavLink.svelte | 2 +- src/UIShell/SideNav/SideNavMenu.svelte | 2 +- types/Button/Button.d.ts | 2 +- types/ContextMenu/ContextMenuOption.d.ts | 2 +- types/Icon/Icon.d.ts | 2 +- types/Link/Link.d.ts | 2 +- types/Notification/NotificationButton.d.ts | 2 +- types/OverflowMenu/OverflowMenu.d.ts | 2 +- types/Search/Search.d.ts | 2 +- types/Tag/Tag.d.ts | 2 +- types/Tooltip/Tooltip.d.ts | 2 +- types/TooltipIcon/TooltipIcon.d.ts | 2 +- types/UIShell/GlobalHeader/Header.d.ts | 4 +- types/UIShell/GlobalHeader/HeaderAction.d.ts | 2 +- .../GlobalHeader/HeaderActionLink.d.ts | 2 +- types/UIShell/HeaderGlobalAction.d.ts | 2 +- types/UIShell/SideNav/SideNavLink.d.ts | 2 +- types/UIShell/SideNav/SideNavMenu.d.ts | 2 +- 37 files changed, 160 insertions(+), 153 deletions(-) diff --git a/COMPONENT_INDEX.md b/COMPONENT_INDEX.md index 6a739ac1..55f13c2b 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("carbon-icons-svelte").CarbonIcon | -- | Specify the icon from `carbon-icons-svelte` to render | +| icon | let | No | typeof import("svelte").SvelteComponent | -- | Specify the icon from `carbon-icons-svelte` 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 | @@ -839,18 +839,18 @@ None. ### Props -| Prop name | Kind | Reactive | Type | Default value | Description | -| :----------- | :--------------- | :------- | :----------------------------------------------------------- | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- | -| 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("carbon-icons-svelte").CarbonIcon | -- | Specify the icon from `carbon-icons-svelte` 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 | -| labelText | let | No | string | "" | Specify the label text
Alternatively, use the "labelText" slot (e.g., <span slot="labelText">...</span>) | -| shortcutText | let | No | string | "" | Specify the shortcut text
Alternatively, use the "shortcutText" slot (e.g., <span slot="shortcutText">...</span>) | -| id | let | No | string | "ccs-" + Math.random().toString(36) | Specify the id
It's recommended to provide an id as a value to bind to within a selectable/radio menu group | +| Prop name | Kind | Reactive | Type | Default value | Description | +| :----------- | :--------------- | :------- | :--------------------------------------------------- | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- | +| 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 | +| 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 | +| labelText | let | No | string | "" | Specify the label text
Alternatively, use the "labelText" slot (e.g., <span slot="labelText">...</span>) | +| shortcutText | let | No | string | "" | Specify the shortcut text
Alternatively, use the "shortcutText" slot (e.g., <span slot="shortcutText">...</span>) | +| id | let | No | string | "ccs-" + Math.random().toString(36) | Specify the id
It's recommended to provide an id as a value to bind to within a selectable/radio menu group | ### Slots @@ -1566,19 +1566,19 @@ None. ### Props -| Prop name | Kind | Reactive | Type | Default value | Description | -| :---------------------- | :--------------- | :------- | :----------------------------------------------------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| ref | let | Yes | null | HTMLAnchorElement | null | Obtain a reference to the HTML anchor element | -| isSideNavOpen | let | Yes | boolean | false | Set to `true` to open the side nav | -| expandedByDefault | let | No | boolean | true | Set to `false` to hide the side nav by default | -| uiShellAriaLabel | let | No | string | -- | Specify the ARIA label for the header | -| href | let | No | string | -- | Specify the `href` attribute | -| company | let | No | string | -- | Specify the company name | -| 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("carbon-icons-svelte").CarbonIcon | -- | Specify the icon from `carbon-icons-svelte` to render for the closed state
Defaults to `Menu20` | -| iconClose | let | No | typeof import("carbon-icons-svelte").CarbonIcon | -- | Specify the icon from `carbon-icons-svelte` to render for the opened state
Defaults to `Close20` | +| Prop name | Kind | Reactive | Type | Default value | Description | +| :---------------------- | :--------------- | :------- | :--------------------------------------------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ref | let | Yes | null | HTMLAnchorElement | null | Obtain a reference to the HTML anchor element | +| isSideNavOpen | let | Yes | boolean | false | Set to `true` to open the side nav | +| expandedByDefault | let | No | boolean | true | Set to `false` to hide the side nav by default | +| uiShellAriaLabel | let | No | string | -- | Specify the ARIA label for the header | +| href | let | No | string | -- | Specify the `href` attribute | +| company | let | No | string | -- | Specify the company name | +| 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` | ### Slots @@ -1616,6 +1616,13 @@ export interface HeaderActionSlideTransition { | closeIcon | let | No | typeof import("carbon-icons-svelte").CarbonIcon | -- | Specify the close icon from `carbon-icons-svelte` to render | | 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 | +| Prop name | Kind | Reactive | Type | Default value | Description | +| :--------- | :--------------- | :------- | :---------------------------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------- | +| 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 | +| 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 | ### Slots @@ -1635,12 +1642,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("carbon-icons-svelte").CarbonIcon | -- | 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 from `carbon-icons-svelte` to render | ### Slots @@ -1674,11 +1681,11 @@ None. ### Props -| Prop name | Kind | Reactive | Type | Default value | Description | -| :-------- | :--------------- | :------- | :----------------------------------------------------------- | ------------------ | --------------------------------------------- | -| ref | let | Yes | null | HTMLButtonElement | null | Obtain a reference to the HTML button element | -| isActive | let | No | boolean | false | Set to `true` to use the active variant | -| icon | let | No | typeof import("carbon-icons-svelte").CarbonIcon | -- | Specify the icon to render | +| Prop name | Kind | Reactive | Type | Default value | Description | +| :-------- | :--------------- | :------- | :--------------------------------------------------- | ------------------ | --------------------------------------------- | +| ref | let | Yes | null | HTMLButtonElement | null | Obtain a reference to the HTML button element | +| isActive | let | No | boolean | false | Set to `true` to use the active variant | +| icon | let | No | typeof import("svelte").SvelteComponent | -- | Specify the icon to render | ### Slots @@ -1883,10 +1890,10 @@ None. ### Props -| Prop name | Kind | Reactive | Type | Default value | Description | -| :-------- | :--------------- | :------- | :----------------------------------------------------------- | ------------------ | ----------------------------------------------------- | -| render | let | No | typeof import("carbon-icons-svelte").CarbonIcon | -- | 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 from `carbon-icons-svelte` to render | +| skeleton | let | No | boolean | false | Set to `true` to display the skeleton state | ### Slots @@ -2018,7 +2025,7 @@ None. | 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("carbon-icons-svelte").CarbonIcon | -- | Specify the icon from `carbon-icons-svelte` to render
`inline` must be `false` | +| 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 | @@ -2478,12 +2485,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("carbon-icons-svelte").CarbonIcon | -- | 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 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 | ### Slots @@ -2662,20 +2669,20 @@ None. ### Props -| Prop name | Kind | Reactive | Type | Default value | Description | -| :--------------- | :--------------- | :------- | :----------------------------------------------------------- | ------------------------------------------------ | ----------------------------------------------------------------- | -| 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("carbon-icons-svelte").CarbonIcon | -- | Specify the icon from `carbon-icons-svelte` 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 | -| light | let | No | boolean | false | Set to `true` to enable the light variant | -| flipped | let | No | boolean | false | Set to `true` to flip the menu relative to the button | -| menuOptionsClass | let | No | string | -- | Specify the menu options class | -| iconClass | let | No | string | -- | Specify the icon class | -| iconDescription | let | No | string | "Open and close list of options" | Specify the ARIA label for the icon | -| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the button element | +| Prop name | Kind | Reactive | Type | Default value | Description | +| :--------------- | :--------------- | :------- | :--------------------------------------------------- | ------------------------------------------------ | ----------------------------------------------------------------- | +| 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 | +| 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 | +| light | let | No | boolean | false | Set to `true` to enable the light variant | +| flipped | let | No | boolean | false | Set to `true` to flip the menu relative to the button | +| menuOptionsClass | let | No | string | -- | Specify the menu options class | +| iconClass | let | No | string | -- | Specify the icon class | +| iconDescription | let | No | string | "Open and close list of options" | Specify the ARIA label for the icon | +| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the button element | ### Slots @@ -3145,26 +3152,26 @@ None. ### Props -| Prop name | Kind | Reactive | Type | Default value | Description | -| :------------------- | :--------------- | :------- | :----------------------------------------------------------- | ------------------------------------------------ | ------------------------------------------------------- | -| ref | let | Yes | null | HTMLInputElement | null | Obtain a reference to the input HTML element | -| value | let | Yes | string | "" | Specify the value of the search input | -| expanded | let | Yes | boolean | false | Set to `true to expand the search input | -| small | let | No | boolean | false | -- | -| size | let | No | "sm" | "lg" | "xl" | "xl" | Specify the size of the search input | -| searchClass | let | No | string | "" | Specify the class name passed to the outer div element | -| skeleton | let | No | boolean | false | Set to `true` to display the skeleton state | -| light | let | No | boolean | false | Set to `true` to enable the light variant | -| disabled | let | No | boolean | false | Set to `true` to disable the search input | -| expandable | let | No | boolean | false | Set to `true` to enable the expandable variant | -| type | let | No | string | "text" | Specify the `type` attribute of the search input | -| placeholder | let | No | string | "Search..." | Specify the `placeholder` attribute of the search input | -| autocomplete | let | No | "on" | "off" | "off" | Specify the `autocomplete` attribute | -| 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("carbon-icons-svelte").CarbonIcon | -- | Specify the icon from `carbon-icons-svelte` to render | -| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element | +| Prop name | Kind | Reactive | Type | Default value | Description | +| :------------------- | :--------------- | :------- | :--------------------------------------------------- | ------------------------------------------------ | ------------------------------------------------------- | +| ref | let | Yes | null | HTMLInputElement | null | Obtain a reference to the input HTML element | +| value | let | Yes | string | "" | Specify the value of the search input | +| expanded | let | Yes | boolean | false | Set to `true to expand the search input | +| small | let | No | boolean | false | -- | +| size | let | No | "sm" | "lg" | "xl" | "xl" | Specify the size of the search input | +| searchClass | let | No | string | "" | Specify the class name passed to the outer div element | +| skeleton | let | No | boolean | false | Set to `true` to display the skeleton state | +| light | let | No | boolean | false | Set to `true` to enable the light variant | +| disabled | let | No | boolean | false | Set to `true` to disable the search input | +| expandable | let | No | boolean | false | Set to `true` to enable the expandable variant | +| type | let | No | string | "text" | Specify the `type` attribute of the search input | +| placeholder | let | No | string | "Search..." | Specify the `placeholder` attribute of the search input | +| autocomplete | let | No | "on" | "off" | "off" | Specify the `autocomplete` attribute | +| 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 | +| id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the input element | ### Slots @@ -3403,13 +3410,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("carbon-icons-svelte").CarbonIcon | -- | 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 from `carbon-icons-svelte` to render | ### Slots @@ -3425,12 +3432,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("carbon-icons-svelte").CarbonIcon | -- | 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 from `carbon-icons-svelte` to render | ### Slots @@ -4039,7 +4046,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("carbon-icons-svelte").CarbonIcon | -- | Specify the icon from `carbon-icons-svelte` to render | +| icon | let | No | typeof import("svelte").SvelteComponent | -- | Specify the icon from `carbon-icons-svelte` to render | | id | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the filterable tag | ### Slots @@ -4635,7 +4642,7 @@ None. | 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("carbon-icons-svelte").CarbonIcon | -- | Specify the icon from `carbon-icons-svelte` to render for the tooltip button
Icon size must be 16px (e.g., `Add16`, `Task16`) | +| 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 | @@ -4713,7 +4720,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("carbon-icons-svelte").CarbonIcon | -- | Specify the icon from `carbon-icons-svelte` to render | +| icon | let | No | typeof import("svelte").SvelteComponent | -- | Specify the icon from `carbon-icons-svelte` 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 f203cd5e..4593ecf5 100644 --- a/docs/src/COMPONENT_API.json +++ b/docs/src/COMPONENT_API.json @@ -490,7 +490,7 @@ "name": "icon", "kind": "let", "description": "Specify the icon from `carbon-icons-svelte` to render", - "type": "typeof import(\"carbon-icons-svelte\").CarbonIcon", + "type": "typeof import(\"svelte\").SvelteComponent", "isFunction": false, "isFunctionDeclaration": false, "constant": false, @@ -1943,7 +1943,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", - "type": "typeof import(\"carbon-icons-svelte\").CarbonIcon", + "type": "typeof import(\"svelte\").SvelteComponent", "isFunction": false, "isFunctionDeclaration": false, "constant": false, @@ -4323,7 +4323,7 @@ "name": "iconMenu", "kind": "let", "description": "Specify the icon from `carbon-icons-svelte` to render for the closed state\nDefaults to `Menu20`", - "type": "typeof import(\"carbon-icons-svelte\").CarbonIcon", + "type": "typeof import(\"svelte\").SvelteComponent", "isFunction": false, "isFunctionDeclaration": false, "constant": false, @@ -4333,7 +4333,7 @@ "name": "iconClose", "kind": "let", "description": "Specify the icon from `carbon-icons-svelte` to render for the opened state\nDefaults to `Close20`", - "type": "typeof import(\"carbon-icons-svelte\").CarbonIcon", + "type": "typeof import(\"svelte\").SvelteComponent", "isFunction": false, "isFunctionDeclaration": false, "constant": false, @@ -4373,7 +4373,7 @@ "name": "icon", "kind": "let", "description": "Specify the icon from `carbon-icons-svelte` to render", - "type": "typeof import(\"carbon-icons-svelte\").CarbonIcon", + "type": "typeof import(\"svelte\").SvelteComponent", "isFunction": false, "isFunctionDeclaration": false, "constant": false, @@ -4473,7 +4473,7 @@ "name": "icon", "kind": "let", "description": "Specify the icon from `carbon-icons-svelte` to render", - "type": "typeof import(\"carbon-icons-svelte\").CarbonIcon", + "type": "typeof import(\"svelte\").SvelteComponent", "isFunction": false, "isFunctionDeclaration": false, "constant": false, @@ -4543,7 +4543,7 @@ "name": "icon", "kind": "let", "description": "Specify the icon to render", - "type": "typeof import(\"carbon-icons-svelte\").CarbonIcon", + "type": "typeof import(\"svelte\").SvelteComponent", "isFunction": false, "isFunctionDeclaration": false, "constant": false, @@ -4871,7 +4871,7 @@ "name": "render", "kind": "let", "description": "Specify the icon from `carbon-icons-svelte` to render", - "type": "typeof import(\"carbon-icons-svelte\").CarbonIcon", + "type": "typeof import(\"svelte\").SvelteComponent", "isFunction": false, "isFunctionDeclaration": false, "constant": false, @@ -5244,7 +5244,7 @@ "name": "icon", "kind": "let", "description": "Specify the icon from `carbon-icons-svelte` to render\n`inline` must be `false`", - "type": "typeof import(\"carbon-icons-svelte\").CarbonIcon", + "type": "typeof import(\"svelte\").SvelteComponent", "isFunction": false, "isFunctionDeclaration": false, "constant": false, @@ -6710,7 +6710,7 @@ "name": "icon", "kind": "let", "description": "Specify the icon from `carbon-icons-svelte` to render", - "type": "typeof import(\"carbon-icons-svelte\").CarbonIcon", + "type": "typeof import(\"svelte\").SvelteComponent", "isFunction": false, "isFunctionDeclaration": false, "constant": false, @@ -7294,7 +7294,7 @@ "name": "icon", "kind": "let", "description": "Specify the icon from `carbon-icons-svelte` to render", - "type": "typeof import(\"carbon-icons-svelte\").CarbonIcon", + "type": "typeof import(\"svelte\").SvelteComponent", "isFunction": false, "isFunctionDeclaration": false, "constant": false, @@ -9066,7 +9066,7 @@ "name": "icon", "kind": "let", "description": "Specify the icon from `carbon-icons-svelte` to render", - "type": "typeof import(\"carbon-icons-svelte\").CarbonIcon", + "type": "typeof import(\"svelte\").SvelteComponent", "isFunction": false, "isFunctionDeclaration": false, "constant": false, @@ -9726,7 +9726,7 @@ "name": "icon", "kind": "let", "description": "Specify the icon from `carbon-icons-svelte` to render", - "type": "typeof import(\"carbon-icons-svelte\").CarbonIcon", + "type": "typeof import(\"svelte\").SvelteComponent", "isFunction": false, "isFunctionDeclaration": false, "constant": false, @@ -9778,7 +9778,7 @@ "name": "icon", "kind": "let", "description": "Specify the icon from `carbon-icons-svelte` to render", - "type": "typeof import(\"carbon-icons-svelte\").CarbonIcon", + "type": "typeof import(\"svelte\").SvelteComponent", "isFunction": false, "isFunctionDeclaration": false, "constant": false, @@ -11112,7 +11112,7 @@ "name": "icon", "kind": "let", "description": "Specify the icon from `carbon-icons-svelte` to render", - "type": "typeof import(\"carbon-icons-svelte\").CarbonIcon", + "type": "typeof import(\"svelte\").SvelteComponent", "isFunction": false, "isFunctionDeclaration": false, "constant": false, @@ -12761,7 +12761,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`)", - "type": "typeof import(\"carbon-icons-svelte\").CarbonIcon", + "type": "typeof import(\"svelte\").SvelteComponent", "isFunction": false, "isFunctionDeclaration": false, "constant": false, @@ -13007,7 +13007,7 @@ "name": "icon", "kind": "let", "description": "Specify the icon from `carbon-icons-svelte` to render", - "type": "typeof import(\"carbon-icons-svelte\").CarbonIcon", + "type": "typeof import(\"svelte\").SvelteComponent", "isFunction": false, "isFunctionDeclaration": false, "constant": false, diff --git a/src/Button/Button.svelte b/src/Button/Button.svelte index 174e6b63..a3d0746b 100644 --- a/src/Button/Button.svelte +++ b/src/Button/Button.svelte @@ -33,7 +33,7 @@ /** * Specify the icon from `carbon-icons-svelte` to render - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let icon = undefined; diff --git a/src/ContextMenu/ContextMenuOption.svelte b/src/ContextMenu/ContextMenuOption.svelte index 14062953..f4cc6290 100644 --- a/src/ContextMenu/ContextMenuOption.svelte +++ b/src/ContextMenu/ContextMenuOption.svelte @@ -14,7 +14,7 @@ /** * Specify the icon from `carbon-icons-svelte` to render * Icon is rendered to the left of the label text - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let icon = undefined; diff --git a/src/Icon/Icon.svelte b/src/Icon/Icon.svelte index 9113d25d..85ff5697 100644 --- a/src/Icon/Icon.svelte +++ b/src/Icon/Icon.svelte @@ -12,7 +12,7 @@ /** * Specify the icon from `carbon-icons-svelte` to render - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let render = undefined; diff --git a/src/Link/Link.svelte b/src/Link/Link.svelte index 016f56be..4456e1be 100644 --- a/src/Link/Link.svelte +++ b/src/Link/Link.svelte @@ -17,7 +17,7 @@ /** * Specify the icon from `carbon-icons-svelte` to render * `inline` must be `false` - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let icon = undefined; diff --git a/src/Notification/NotificationButton.svelte b/src/Notification/NotificationButton.svelte index 48f53ebe..4f158951 100644 --- a/src/Notification/NotificationButton.svelte +++ b/src/Notification/NotificationButton.svelte @@ -7,7 +7,7 @@ /** * Specify the icon from `carbon-icons-svelte` to render - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let icon = Close20; diff --git a/src/OverflowMenu/OverflowMenu.svelte b/src/OverflowMenu/OverflowMenu.svelte index 41e7d83a..0d569b0d 100644 --- a/src/OverflowMenu/OverflowMenu.svelte +++ b/src/OverflowMenu/OverflowMenu.svelte @@ -32,7 +32,7 @@ /** * Specify the icon from `carbon-icons-svelte` to render - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let icon = OverflowMenuVertical16; diff --git a/src/Search/Search.svelte b/src/Search/Search.svelte index 8b18c2ae..6461b0d2 100644 --- a/src/Search/Search.svelte +++ b/src/Search/Search.svelte @@ -60,7 +60,7 @@ /** * Specify the icon from `carbon-icons-svelte` to render - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let icon = Search16; diff --git a/src/Tag/Tag.svelte b/src/Tag/Tag.svelte index c2069f83..a9c361f2 100644 --- a/src/Tag/Tag.svelte +++ b/src/Tag/Tag.svelte @@ -27,7 +27,7 @@ /** * Specify the icon from `carbon-icons-svelte` to render - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let icon = undefined; diff --git a/src/Tooltip/Tooltip.svelte b/src/Tooltip/Tooltip.svelte index 368582d2..8b3482eb 100644 --- a/src/Tooltip/Tooltip.svelte +++ b/src/Tooltip/Tooltip.svelte @@ -26,7 +26,7 @@ /** * Specify the icon from `carbon-icons-svelte` to render for the tooltip button * Icon size must be 16px (e.g., `Add16`, `Task16`) - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let icon = Information16; diff --git a/src/TooltipIcon/TooltipIcon.svelte b/src/TooltipIcon/TooltipIcon.svelte index 62a41245..a6995a9d 100644 --- a/src/TooltipIcon/TooltipIcon.svelte +++ b/src/TooltipIcon/TooltipIcon.svelte @@ -7,7 +7,7 @@ /** * Specify the icon from `carbon-icons-svelte` to render - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let icon = undefined; diff --git a/src/TreeView/TreeViewNode.svelte b/src/TreeView/TreeViewNode.svelte index 038d2e52..d7b06379 100644 --- a/src/TreeView/TreeViewNode.svelte +++ b/src/TreeView/TreeViewNode.svelte @@ -45,7 +45,7 @@ /** * Specify the icon from `carbon-icons-svelte` to render - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let icon = undefined; diff --git a/src/TreeView/TreeViewNodeList.svelte b/src/TreeView/TreeViewNodeList.svelte index a1b4f407..fd4ad8dc 100644 --- a/src/TreeView/TreeViewNodeList.svelte +++ b/src/TreeView/TreeViewNodeList.svelte @@ -16,7 +16,7 @@ /** * Specify the icon from `carbon-icons-svelte` to render - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let icon = undefined; diff --git a/src/UIShell/GlobalHeader/Header.svelte b/src/UIShell/GlobalHeader/Header.svelte index 2241bb71..32988b8b 100644 --- a/src/UIShell/GlobalHeader/Header.svelte +++ b/src/UIShell/GlobalHeader/Header.svelte @@ -49,14 +49,14 @@ /** * Specify the icon from `carbon-icons-svelte` to render for the closed state * Defaults to `Menu20` - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let iconMenu = Menu20; /** * Specify the icon from `carbon-icons-svelte` to render for the opened state * Defaults to `Close20` - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let iconClose = Close20; diff --git a/src/UIShell/GlobalHeader/HeaderAction.svelte b/src/UIShell/GlobalHeader/HeaderAction.svelte index 6f101503..58f11911 100644 --- a/src/UIShell/GlobalHeader/HeaderAction.svelte +++ b/src/UIShell/GlobalHeader/HeaderAction.svelte @@ -8,7 +8,7 @@ /** * Specify the icon from `carbon-icons-svelte` to render - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let icon = AppSwitcher20; diff --git a/src/UIShell/GlobalHeader/HeaderActionLink.svelte b/src/UIShell/GlobalHeader/HeaderActionLink.svelte index d4530519..b4ad3a36 100644 --- a/src/UIShell/GlobalHeader/HeaderActionLink.svelte +++ b/src/UIShell/GlobalHeader/HeaderActionLink.svelte @@ -10,7 +10,7 @@ /** * Specify the icon from `carbon-icons-svelte` to render - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let icon = undefined; diff --git a/src/UIShell/HeaderGlobalAction.svelte b/src/UIShell/HeaderGlobalAction.svelte index 6f574918..db0cbc80 100644 --- a/src/UIShell/HeaderGlobalAction.svelte +++ b/src/UIShell/HeaderGlobalAction.svelte @@ -4,7 +4,7 @@ /** * Specify the icon to render - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let icon = undefined; diff --git a/src/UIShell/SideNav/HamburgerMenu.svelte b/src/UIShell/SideNav/HamburgerMenu.svelte index 4437a35a..4a24c2d1 100644 --- a/src/UIShell/SideNav/HamburgerMenu.svelte +++ b/src/UIShell/SideNav/HamburgerMenu.svelte @@ -11,14 +11,14 @@ /** * Specify the icon from `carbon-icons-svelte` to render for the closed state * Defaults to `Menu20` - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let iconMenu = Menu20; /** * Specify the icon from `carbon-icons-svelte` to render for the opened state * Defaults to `Close20` - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let iconClose = Close20; diff --git a/src/UIShell/SideNav/SideNavLink.svelte b/src/UIShell/SideNav/SideNavLink.svelte index 33244600..94f674ff 100644 --- a/src/UIShell/SideNav/SideNavLink.svelte +++ b/src/UIShell/SideNav/SideNavLink.svelte @@ -16,7 +16,7 @@ /** * Specify the icon from `carbon-icons-svelte` to render - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let icon = undefined; diff --git a/src/UIShell/SideNav/SideNavMenu.svelte b/src/UIShell/SideNav/SideNavMenu.svelte index 0625f3ac..9d19cbf4 100644 --- a/src/UIShell/SideNav/SideNavMenu.svelte +++ b/src/UIShell/SideNav/SideNavMenu.svelte @@ -10,7 +10,7 @@ /** * Specify the icon from `carbon-icons-svelte` to render - * @type {typeof import("carbon-icons-svelte").CarbonIcon} + * @type {typeof import("svelte").SvelteComponent} */ export let icon = undefined; diff --git a/types/Button/Button.d.ts b/types/Button/Button.d.ts index 471f240a..13c6c94e 100644 --- a/types/Button/Button.d.ts +++ b/types/Button/Button.d.ts @@ -47,7 +47,7 @@ export interface ButtonProps /** * Specify the icon from `carbon-icons-svelte` to render */ - icon?: typeof import("carbon-icons-svelte").CarbonIcon; + icon?: typeof import("svelte").SvelteComponent; /** * Specify the ARIA label for the button icon diff --git a/types/ContextMenu/ContextMenuOption.d.ts b/types/ContextMenu/ContextMenuOption.d.ts index 67a1cf04..dae07f4e 100644 --- a/types/ContextMenu/ContextMenuOption.d.ts +++ b/types/ContextMenu/ContextMenuOption.d.ts @@ -25,7 +25,7 @@ export interface ContextMenuOptionProps * Specify the icon from `carbon-icons-svelte` to render * Icon is rendered to the left of the label text */ - icon?: typeof import("carbon-icons-svelte").CarbonIcon; + icon?: typeof import("svelte").SvelteComponent; /** * Specify the label text diff --git a/types/Icon/Icon.d.ts b/types/Icon/Icon.d.ts index 2820cfde..eb5d6cf0 100644 --- a/types/Icon/Icon.d.ts +++ b/types/Icon/Icon.d.ts @@ -8,7 +8,7 @@ export interface IconProps /** * Specify the icon from `carbon-icons-svelte` to render */ - render?: typeof import("carbon-icons-svelte").CarbonIcon; + render?: typeof import("svelte").SvelteComponent; /** * Set to `true` to display the skeleton state diff --git a/types/Link/Link.d.ts b/types/Link/Link.d.ts index 759fbd30..a2b096d0 100644 --- a/types/Link/Link.d.ts +++ b/types/Link/Link.d.ts @@ -23,7 +23,7 @@ export interface LinkProps * Specify the icon from `carbon-icons-svelte` to render * `inline` must be `false` */ - icon?: typeof import("carbon-icons-svelte").CarbonIcon; + icon?: typeof import("svelte").SvelteComponent; /** * Set to `true` to disable the checkbox diff --git a/types/Notification/NotificationButton.d.ts b/types/Notification/NotificationButton.d.ts index 8596893d..55cf0cb6 100644 --- a/types/Notification/NotificationButton.d.ts +++ b/types/Notification/NotificationButton.d.ts @@ -12,7 +12,7 @@ export interface NotificationButtonProps /** * Specify the icon from `carbon-icons-svelte` to render */ - icon?: typeof import("carbon-icons-svelte").CarbonIcon; + icon?: typeof import("svelte").SvelteComponent; /** * Specify the title of the icon diff --git a/types/OverflowMenu/OverflowMenu.d.ts b/types/OverflowMenu/OverflowMenu.d.ts index cf16c37d..b1844d38 100644 --- a/types/OverflowMenu/OverflowMenu.d.ts +++ b/types/OverflowMenu/OverflowMenu.d.ts @@ -40,7 +40,7 @@ export interface OverflowMenuProps /** * Specify the icon from `carbon-icons-svelte` to render */ - icon?: typeof import("carbon-icons-svelte").CarbonIcon; + icon?: typeof import("svelte").SvelteComponent; /** * Specify the icon class diff --git a/types/Search/Search.d.ts b/types/Search/Search.d.ts index 8a38c411..e47c64ae 100644 --- a/types/Search/Search.d.ts +++ b/types/Search/Search.d.ts @@ -94,7 +94,7 @@ export interface SearchProps { /** * Specify the icon from `carbon-icons-svelte` to render */ - icon?: typeof import("carbon-icons-svelte").CarbonIcon; + icon?: typeof import("svelte").SvelteComponent; /** * Set an id for the input element diff --git a/types/Tag/Tag.d.ts b/types/Tag/Tag.d.ts index f9d1ed8d..121612e1 100644 --- a/types/Tag/Tag.d.ts +++ b/types/Tag/Tag.d.ts @@ -58,7 +58,7 @@ export interface TagProps /** * Specify the icon from `carbon-icons-svelte` to render */ - icon?: typeof import("carbon-icons-svelte").CarbonIcon; + icon?: typeof import("svelte").SvelteComponent; /** * Set an id for the filterable tag diff --git a/types/Tooltip/Tooltip.d.ts b/types/Tooltip/Tooltip.d.ts index 2b0d83fa..dfa910f0 100644 --- a/types/Tooltip/Tooltip.d.ts +++ b/types/Tooltip/Tooltip.d.ts @@ -31,7 +31,7 @@ export interface TooltipProps * Specify the icon from `carbon-icons-svelte` to render for the tooltip button * Icon size must be 16px (e.g., `Add16`, `Task16`) */ - icon?: typeof import("carbon-icons-svelte").CarbonIcon; + icon?: typeof import("svelte").SvelteComponent; /** * Specify the ARIA label for the tooltip button diff --git a/types/TooltipIcon/TooltipIcon.d.ts b/types/TooltipIcon/TooltipIcon.d.ts index 631511dd..79186201 100644 --- a/types/TooltipIcon/TooltipIcon.d.ts +++ b/types/TooltipIcon/TooltipIcon.d.ts @@ -13,7 +13,7 @@ export interface TooltipIconProps /** * Specify the icon from `carbon-icons-svelte` to render */ - icon?: typeof import("carbon-icons-svelte").CarbonIcon; + icon?: typeof import("svelte").SvelteComponent; /** * Set to `true` to disable the tooltip icon diff --git a/types/UIShell/GlobalHeader/Header.d.ts b/types/UIShell/GlobalHeader/Header.d.ts index 4c61fd74..8f4cf483 100644 --- a/types/UIShell/GlobalHeader/Header.d.ts +++ b/types/UIShell/GlobalHeader/Header.d.ts @@ -65,13 +65,13 @@ export interface HeaderProps * Specify the icon from `carbon-icons-svelte` to render for the closed state * Defaults to `Menu20` */ - iconMenu?: typeof import("carbon-icons-svelte").CarbonIcon; + iconMenu?: typeof import("svelte").SvelteComponent; /** * Specify the icon from `carbon-icons-svelte` to render for the opened state * Defaults to `Close20` */ - iconClose?: typeof import("carbon-icons-svelte").CarbonIcon; + iconClose?: typeof import("svelte").SvelteComponent; } export default class Header extends SvelteComponentTyped< diff --git a/types/UIShell/GlobalHeader/HeaderAction.d.ts b/types/UIShell/GlobalHeader/HeaderAction.d.ts index ed97e571..9509c132 100644 --- a/types/UIShell/GlobalHeader/HeaderAction.d.ts +++ b/types/UIShell/GlobalHeader/HeaderAction.d.ts @@ -18,7 +18,7 @@ export interface HeaderActionProps /** * Specify the icon from `carbon-icons-svelte` to render */ - icon?: typeof import("carbon-icons-svelte").CarbonIcon; + icon?: typeof import("svelte").SvelteComponent; /** * Specify the close icon from `carbon-icons-svelte` to render diff --git a/types/UIShell/GlobalHeader/HeaderActionLink.d.ts b/types/UIShell/GlobalHeader/HeaderActionLink.d.ts index 12804ee4..85764b83 100644 --- a/types/UIShell/GlobalHeader/HeaderActionLink.d.ts +++ b/types/UIShell/GlobalHeader/HeaderActionLink.d.ts @@ -17,7 +17,7 @@ export interface HeaderActionLinkProps /** * Specify the icon from `carbon-icons-svelte` to render */ - icon?: typeof import("carbon-icons-svelte").CarbonIcon; + icon?: typeof import("svelte").SvelteComponent; /** * Obtain a reference to the HTML anchor element diff --git a/types/UIShell/HeaderGlobalAction.d.ts b/types/UIShell/HeaderGlobalAction.d.ts index 95a584ce..113c0fd2 100644 --- a/types/UIShell/HeaderGlobalAction.d.ts +++ b/types/UIShell/HeaderGlobalAction.d.ts @@ -12,7 +12,7 @@ export interface HeaderGlobalActionProps /** * Specify the icon to render */ - icon?: typeof import("carbon-icons-svelte").CarbonIcon; + icon?: typeof import("svelte").SvelteComponent; /** * Obtain a reference to the HTML button element diff --git a/types/UIShell/SideNav/SideNavLink.d.ts b/types/UIShell/SideNav/SideNavLink.d.ts index 50829d20..ec95a2ea 100644 --- a/types/UIShell/SideNav/SideNavLink.d.ts +++ b/types/UIShell/SideNav/SideNavLink.d.ts @@ -22,7 +22,7 @@ export interface SideNavLinkProps /** * Specify the icon from `carbon-icons-svelte` to render */ - icon?: typeof import("carbon-icons-svelte").CarbonIcon; + icon?: typeof import("svelte").SvelteComponent; /** * Obtain a reference to the HTML anchor element diff --git a/types/UIShell/SideNav/SideNavMenu.d.ts b/types/UIShell/SideNav/SideNavMenu.d.ts index 4f1405f0..574e6e17 100644 --- a/types/UIShell/SideNav/SideNavMenu.d.ts +++ b/types/UIShell/SideNav/SideNavMenu.d.ts @@ -17,7 +17,7 @@ export interface SideNavMenuProps /** * Specify the icon from `carbon-icons-svelte` to render */ - icon?: typeof import("carbon-icons-svelte").CarbonIcon; + icon?: typeof import("svelte").SvelteComponent; /** * Obtain a reference to the HTML button element