diff --git a/COMPONENT_INDEX.md b/COMPONENT_INDEX.md index 6a739ac1..068b9ebd 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 @@ -1608,14 +1608,14 @@ export interface HeaderActionSlideTransition { ### Props -| 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("carbon-icons-svelte").CarbonIcon | -- | Specify the icon from `carbon-icons-svelte` to render | -| 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 | +| closeIcon | let | No | typeof import("svelte").SvelteComponent | -- | 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 | ### Slots @@ -1635,12 +1635,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 +1674,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 +1883,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 +2018,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 +2478,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 +2662,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 +3145,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 +3403,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 +3425,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 +4039,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 +4635,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 +4713,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 | @@ -4746,7 +4746,7 @@ export type TreeNodeId = string | number; export interface TreeNode { id: TreeNodeId; text: string; - icon?: typeof import("carbon-icons-svelte").CarbonIcon; + icon?: typeof import("svelte").SvelteComponent; disabled?: boolean; expanded?: boolean; } diff --git a/docs/src/COMPONENT_API.json b/docs/src/COMPONENT_API.json index f203cd5e..e201e2ae 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, @@ -4383,7 +4383,7 @@ "name": "closeIcon", "kind": "let", "description": "Specify the close 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, @@ -13252,9 +13252,9 @@ "ts": "type TreeNodeId = string | number" }, { - "type": "{ id: TreeNodeId; text: string; icon?: typeof import(\"carbon-icons-svelte\").CarbonIcon; disabled?: boolean; expanded?: boolean; }", + "type": "{ id: TreeNodeId; text: string; icon?: typeof import(\"svelte\").SvelteComponent; disabled?: boolean; expanded?: boolean; }", "name": "TreeNode", - "ts": "interface TreeNode { id: TreeNodeId; text: string; icon?: typeof import(\"carbon-icons-svelte\").CarbonIcon; disabled?: boolean; expanded?: boolean; }" + "ts": "interface TreeNode { id: TreeNodeId; text: string; icon?: typeof import(\"svelte\").SvelteComponent; disabled?: boolean; expanded?: boolean; }" } ], "rest_props": { "type": "Element", "name": "ul" } 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/TreeView.svelte b/src/TreeView/TreeView.svelte index 7e36da2e..f1620ae7 100644 --- a/src/TreeView/TreeView.svelte +++ b/src/TreeView/TreeView.svelte @@ -1,7 +1,7 @@