diff --git a/COMPONENT_INDEX.md b/COMPONENT_INDEX.md index c51c63d1..c9b306d2 100644 --- a/COMPONENT_INDEX.md +++ b/COMPONENT_INDEX.md @@ -1622,6 +1622,8 @@ None. | icon | No | let | No | any | undefined | Specify the icon to render when the action panel is closed.
Defaults to `<Switcher size={20} />` | | closeIcon | No | let | No | any | undefined | Specify the icon to render when the action panel is open.
Defaults to `<Close size={20} />` | | text | No | let | No | string | undefined | Specify the text.
Alternatively, use the named slot "text" (e.g., `<div slot="text">...</div>`) | +| iconDescription | No | let | No | string | undefined | Specify an icon tooltip.
This only works if `text` or a named slot "text" is not provided. | +| tooltipAlignment | No | let | No | "start" | "center" | "end" | "center" | Set the alignment of the tooltip relative to the icon.
This only works if `iconDescription` is provided. | | transition | No | let | No | false | import("svelte/transition").SlideParams | { duration: 200 } | Customize the panel transition (i.e., `transition:slide`).
Set to `false` to disable the transition | | preventCloseOnClickOutside | No | let | No | boolean | false | Set to `true` to prevent the panel from closing when clicking outside | diff --git a/docs/src/COMPONENT_API.json b/docs/src/COMPONENT_API.json index 92f9dedb..c43d1765 100644 --- a/docs/src/COMPONENT_API.json +++ b/docs/src/COMPONENT_API.json @@ -5878,6 +5878,29 @@ "constant": false, "reactive": false }, + { + "name": "iconDescription", + "kind": "let", + "description": "Specify an icon tooltip.\nThis only works if `text` or a named slot \"text\" is not provided.", + "type": "string", + "isFunction": false, + "isFunctionDeclaration": false, + "isRequired": false, + "constant": false, + "reactive": false + }, + { + "name": "tooltipAlignment", + "kind": "let", + "description": "Set the alignment of the tooltip relative to the icon.\nThis only works if `iconDescription` is provided.", + "type": "\"start\" | \"center\" | \"end\"", + "value": "\"center\"", + "isFunction": false, + "isFunctionDeclaration": false, + "isRequired": false, + "constant": false, + "reactive": false + }, { "name": "ref", "kind": "let", diff --git a/types/UIShell/HeaderAction.svelte.d.ts b/types/UIShell/HeaderAction.svelte.d.ts index 73ed2853..f41f40ce 100644 --- a/types/UIShell/HeaderAction.svelte.d.ts +++ b/types/UIShell/HeaderAction.svelte.d.ts @@ -31,6 +31,20 @@ type $Props = { */ text?: string; + /** + * Specify an icon tooltip. + * This only works if `text` or a named slot "text" is not provided. + * @default undefined + */ + iconDescription?: string; + + /** + * Set the alignment of the tooltip relative to the icon. + * This only works if `iconDescription` is provided. + * @default "center" + */ + tooltipAlignment?: "start" | "center" | "end"; + /** * Obtain a reference to the button HTML element * @default null