@spectrum-web-components/tooltip 1.8.0 → 1.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/custom-elements.json +6 -0
- package/package.json +5 -5
- package/src/Tooltip.d.ts +20 -0
- package/src/Tooltip.dev.js +25 -6
- package/src/Tooltip.dev.js.map +2 -2
- package/src/Tooltip.js +2 -2
- package/src/Tooltip.js.map +3 -3
package/custom-elements.json
CHANGED
|
@@ -272,6 +272,12 @@
|
|
|
272
272
|
"text": "HTMLElement | null"
|
|
273
273
|
},
|
|
274
274
|
"privacy": "private",
|
|
275
|
+
"description": "Finds the trigger element for a self-managed tooltip by traversing up the composed DOM tree.\n\nSelf-managed tooltips automatically bind to their first focusable ancestor element.\nThis method walks up through shadow DOM boundaries to find a suitable trigger element.\n\nA trigger element must match the focusableSelector, which includes:\n- Interactive elements like buttons, inputs, links, etc.\n- Elements with tabindex (except -1)\n- Elements with focusable=\"true\"\n\nCommon scenarios where no trigger element is found:\n1. Tooltip is placed directly in document body without a focusable parent\n2. Tooltip is nested in non-interactive elements (divs, spans) without focusable ancestors\n3. All ancestor elements have tabindex=\"-1\" or are otherwise non-focusable\n\nExpected usage: <sp-action-button><sp-tooltip self-managed>...</sp-tooltip></sp-action-button>",
|
|
276
|
+
"return": {
|
|
277
|
+
"type": {
|
|
278
|
+
"text": ""
|
|
279
|
+
}
|
|
280
|
+
},
|
|
275
281
|
"readonly": true
|
|
276
282
|
}
|
|
277
283
|
],
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@spectrum-web-components/tooltip",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.9.0",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -68,10 +68,10 @@
|
|
|
68
68
|
"css"
|
|
69
69
|
],
|
|
70
70
|
"dependencies": {
|
|
71
|
-
"@spectrum-web-components/base": "1.
|
|
72
|
-
"@spectrum-web-components/overlay": "1.
|
|
73
|
-
"@spectrum-web-components/reactive-controllers": "1.
|
|
74
|
-
"@spectrum-web-components/shared": "1.
|
|
71
|
+
"@spectrum-web-components/base": "1.9.0",
|
|
72
|
+
"@spectrum-web-components/overlay": "1.9.0",
|
|
73
|
+
"@spectrum-web-components/reactive-controllers": "1.9.0",
|
|
74
|
+
"@spectrum-web-components/shared": "1.9.0"
|
|
75
75
|
},
|
|
76
76
|
"types": "./src/index.d.ts",
|
|
77
77
|
"customElements": "custom-elements.json",
|
package/src/Tooltip.d.ts
CHANGED
|
@@ -53,6 +53,26 @@ export declare class Tooltip extends SpectrumElement {
|
|
|
53
53
|
private handleOpenOverlay;
|
|
54
54
|
protected handleCloseOverlay: () => void;
|
|
55
55
|
protected forwardTransitionEvent(event: TransitionEvent): void;
|
|
56
|
+
/**
|
|
57
|
+
* Finds the trigger element for a self-managed tooltip by traversing up the composed DOM tree.
|
|
58
|
+
*
|
|
59
|
+
* Self-managed tooltips automatically bind to their first focusable ancestor element.
|
|
60
|
+
* This method walks up through shadow DOM boundaries to find a suitable trigger element.
|
|
61
|
+
*
|
|
62
|
+
* A trigger element must match the focusableSelector, which includes:
|
|
63
|
+
* - Interactive elements like buttons, inputs, links, etc.
|
|
64
|
+
* - Elements with tabindex (except -1)
|
|
65
|
+
* - Elements with focusable="true"
|
|
66
|
+
*
|
|
67
|
+
* Common scenarios where no trigger element is found:
|
|
68
|
+
* 1. Tooltip is placed directly in document body without a focusable parent
|
|
69
|
+
* 2. Tooltip is nested in non-interactive elements (divs, spans) without focusable ancestors
|
|
70
|
+
* 3. All ancestor elements have tabindex="-1" or are otherwise non-focusable
|
|
71
|
+
*
|
|
72
|
+
* Expected usage: <sp-action-button><sp-tooltip self-managed>...</sp-tooltip></sp-action-button>
|
|
73
|
+
*
|
|
74
|
+
* @returns The first focusable ancestor element, or null if none found
|
|
75
|
+
*/
|
|
56
76
|
private get triggerElement();
|
|
57
77
|
render(): TemplateResult;
|
|
58
78
|
connectedCallback(): void;
|
package/src/Tooltip.dev.js
CHANGED
|
@@ -18,9 +18,9 @@ import {
|
|
|
18
18
|
query
|
|
19
19
|
} from "@spectrum-web-components/base/src/decorators.js";
|
|
20
20
|
import { ifDefined } from "@spectrum-web-components/base/src/directives.js";
|
|
21
|
-
import tooltipStyles from "./tooltip.css.js";
|
|
22
|
-
import { focusableSelector } from "@spectrum-web-components/shared/src/focusable-selectors.js";
|
|
23
21
|
import { DependencyManagerController } from "@spectrum-web-components/reactive-controllers/src/DependencyManger.js";
|
|
22
|
+
import { focusableSelector } from "@spectrum-web-components/shared/src/focusable-selectors.js";
|
|
23
|
+
import tooltipStyles from "./tooltip.css.js";
|
|
24
24
|
class TooltipOpenable extends HTMLElement {
|
|
25
25
|
constructor() {
|
|
26
26
|
super();
|
|
@@ -135,6 +135,26 @@ export class Tooltip extends SpectrumElement {
|
|
|
135
135
|
})
|
|
136
136
|
);
|
|
137
137
|
}
|
|
138
|
+
/**
|
|
139
|
+
* Finds the trigger element for a self-managed tooltip by traversing up the composed DOM tree.
|
|
140
|
+
*
|
|
141
|
+
* Self-managed tooltips automatically bind to their first focusable ancestor element.
|
|
142
|
+
* This method walks up through shadow DOM boundaries to find a suitable trigger element.
|
|
143
|
+
*
|
|
144
|
+
* A trigger element must match the focusableSelector, which includes:
|
|
145
|
+
* - Interactive elements like buttons, inputs, links, etc.
|
|
146
|
+
* - Elements with tabindex (except -1)
|
|
147
|
+
* - Elements with focusable="true"
|
|
148
|
+
*
|
|
149
|
+
* Common scenarios where no trigger element is found:
|
|
150
|
+
* 1. Tooltip is placed directly in document body without a focusable parent
|
|
151
|
+
* 2. Tooltip is nested in non-interactive elements (divs, spans) without focusable ancestors
|
|
152
|
+
* 3. All ancestor elements have tabindex="-1" or are otherwise non-focusable
|
|
153
|
+
*
|
|
154
|
+
* Expected usage: <sp-action-button><sp-tooltip self-managed>...</sp-tooltip></sp-action-button>
|
|
155
|
+
*
|
|
156
|
+
* @returns The first focusable ancestor element, or null if none found
|
|
157
|
+
*/
|
|
138
158
|
get triggerElement() {
|
|
139
159
|
var _a;
|
|
140
160
|
let start = this.assignedSlot || this;
|
|
@@ -143,7 +163,7 @@ export class Tooltip extends SpectrumElement {
|
|
|
143
163
|
if (true) {
|
|
144
164
|
window.__swc.warn(
|
|
145
165
|
this,
|
|
146
|
-
`Self
|
|
166
|
+
`[INITIAL_TRAVERSAL] Self-managed <${this.localName}> is at document root without a parent element. Self-managed tooltips must be nested inside focusable elements like <sp-action-button>, <sp-button>, or elements with tabindex.`,
|
|
147
167
|
"https://opensource.adobe.com/spectrum-web-components/components/tooltip#self-managed-overlays",
|
|
148
168
|
{
|
|
149
169
|
level: "high"
|
|
@@ -152,8 +172,7 @@ export class Tooltip extends SpectrumElement {
|
|
|
152
172
|
}
|
|
153
173
|
return null;
|
|
154
174
|
}
|
|
155
|
-
let triggerElement = start.parentElement || root.host ||
|
|
156
|
-
root;
|
|
175
|
+
let triggerElement = start.parentElement || root.host || root;
|
|
157
176
|
while (!((_a = triggerElement == null ? void 0 : triggerElement.matches) == null ? void 0 : _a.call(triggerElement, focusableSelector))) {
|
|
158
177
|
start = triggerElement.assignedSlot || triggerElement;
|
|
159
178
|
root = start.getRootNode();
|
|
@@ -161,7 +180,7 @@ export class Tooltip extends SpectrumElement {
|
|
|
161
180
|
if (true) {
|
|
162
181
|
window.__swc.warn(
|
|
163
182
|
this,
|
|
164
|
-
`Self
|
|
183
|
+
`[TRAVERSAL_EXHAUSTED] Self-managed <${this.localName}> could not find a focusable trigger element. All ancestor elements are non-focusable. Ensure the tooltip is nested inside an interactive element like <sp-action-button>, <sp-button>, or add tabindex="0" to a parent element.`,
|
|
165
184
|
"https://opensource.adobe.com/spectrum-web-components/components/tooltip#self-managed-overlays",
|
|
166
185
|
{
|
|
167
186
|
level: "high"
|
package/src/Tooltip.dev.js.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["Tooltip.ts"],
|
|
4
|
-
"sourcesContent": ["/**\n * Copyright 2025 Adobe. All rights reserved.\n * This file is licensed to you under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License. You may obtain a copy\n * of the License at http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under\n * the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\n * OF ANY KIND, either express or implied. See the License for the specific language\n * governing permissions and limitations under the License.\n */\n\nimport {\n CSSResultArray,\n html,\n SpectrumElement,\n TemplateResult,\n} from '@spectrum-web-components/base';\nimport {\n property,\n query,\n} from '@spectrum-web-components/base/src/decorators.js';\nimport { ifDefined } from '@spectrum-web-components/base/src/directives.js';\nimport type {\n Overlay,\n OverlayOpenCloseDetail,\n Placement,\n} from '@spectrum-web-components/overlay';\n\nimport tooltipStyles from './tooltip.css.js';\nimport { focusableSelector } from '@spectrum-web-components/shared/src/focusable-selectors.js';\nimport { DependencyManagerController } from '@spectrum-web-components/reactive-controllers/src/DependencyManger.js';\n\nclass TooltipOpenable extends HTMLElement {\n constructor() {\n super();\n this.addEventListener('sp-opened', this.redispatchEvent);\n this.addEventListener('sp-closed', this.redispatchEvent);\n }\n redispatchEvent(event: Event): void {\n event.stopPropagation();\n this.tooltip.dispatchEvent(\n new CustomEvent<OverlayOpenCloseDetail>(event.type, {\n bubbles: event.bubbles,\n composed: event.composed,\n detail: (event as CustomEvent<OverlayOpenCloseDetail>).detail,\n })\n );\n }\n get tooltip(): Tooltip {\n return (this.getRootNode() as ShadowRoot).host as Tooltip;\n }\n static get observedAttributes(): string[] {\n return ['open', 'placement'];\n }\n attributeChangedCallback(\n name: 'open' | 'placement',\n _oldValue: string,\n newValue: 'string'\n ): void {\n switch (name) {\n // API generally sets `open` as a property\n /* c8 ignore next 3 */\n case 'open':\n this.open = newValue !== null;\n break;\n case 'placement':\n this.placement = newValue as Placement;\n break;\n }\n }\n set open(open: boolean) {\n this._open = open;\n const { tooltip } = this;\n /* c8 ignore next 3 */\n if (!tooltip) {\n return;\n }\n tooltip.open = open;\n }\n /* c8 ignore next 3 */\n get open(): boolean {\n return this._open;\n }\n private _open = false;\n /**\n * @type {\"top\" | \"top-start\" | \"top-end\" | \"right\" | \"right-start\" | \"right-end\" | \"bottom\" | \"bottom-start\" | \"bottom-end\" | \"left\" | \"left-start\" | \"left-end\"}\n * @attr\n */\n set placement(placement: Placement) {\n this._placement = placement;\n const { tooltip } = this;\n if (!tooltip) {\n return;\n }\n tooltip.placement = placement;\n }\n /* c8 ignore next 3 */\n get placement(): Placement {\n return this._placement;\n }\n private _placement: Placement = 'top';\n get tipElement(): HTMLElement {\n return this.tooltip.tipElement;\n }\n}\n\nif (!customElements.get('sp-tooltip-openable')) {\n customElements.define('sp-tooltip-openable', TooltipOpenable);\n}\n\n/**\n * @element sp-tooltip\n *\n * @slot icon - the icon element appearing at the start of the label\n * @slot - the text label of the Tooltip\n */\nexport class Tooltip extends SpectrumElement {\n public static override get styles(): CSSResultArray {\n return [tooltipStyles];\n }\n\n /**\n * A Tooltip that is `delayed` will its Overlay wait until a warm-up period of\n * 1000ms has completed before opening. Once the warmup period has completed, all\n * subsequent Overlays will open immediately. When no Overlays are opened, a\n * cooldown period of 1000ms will begin. Once the cooldown has completed, the next\n * Overlay to be opened will be subject to the warm-up period if provided that option.\n */\n @property({ type: Boolean })\n delayed = false;\n\n private dependencyManager = new DependencyManagerController(this);\n\n /**\n * Whether to prevent a self-managed Tooltip from responding to user input.\n */\n @property({ type: Boolean })\n disabled = false;\n\n /**\n * Automatically bind to the parent element of the assigned `slot` or the parent element of the `sp-tooltip`.\n * Without this, you must provide your own `overlay-trigger`.\n */\n @property({ type: Boolean, attribute: 'self-managed' })\n public selfManaged = false;\n\n @property({ type: Number })\n public offset = 0;\n\n @property({ type: Boolean, reflect: true })\n public open = false;\n\n @query('sp-overlay')\n public overlayElement?: Overlay;\n\n /**\n * @type {\"top\" | \"top-start\" | \"top-end\" | \"right\" | \"right-start\" | \"right-end\" | \"bottom\" | \"bottom-start\" | \"bottom-end\" | \"left\" | \"left-start\" | \"left-end\"}\n * @attr\n */\n @property({ reflect: true })\n public placement?: Placement;\n\n @query('#tip')\n public tipElement!: HTMLSpanElement;\n\n @property({ type: Number })\n public tipPadding?: number;\n\n /* Ensure that a '' value for `variant` removes the attribute instead of a blank value */\n private _variant = '';\n\n @property({ type: String })\n public get variant(): string {\n return this._variant;\n }\n public set variant(variant: string) {\n if (variant === this.variant) {\n return;\n }\n if (['info', 'positive', 'negative'].includes(variant)) {\n this.setAttribute('variant', variant);\n this._variant = variant;\n return;\n }\n this.removeAttribute('variant');\n this._variant = '';\n }\n\n private handleOpenOverlay = (): void => {\n this.open = true;\n };\n\n protected handleCloseOverlay = (): void => {\n this.open = false;\n };\n\n protected forwardTransitionEvent(event: TransitionEvent): void {\n this.dispatchEvent(\n new TransitionEvent(event.type, {\n bubbles: true,\n composed: true,\n propertyName: event.propertyName,\n })\n );\n }\n\n private get triggerElement(): HTMLElement | null {\n // Resolve the parent element of the assigned slot (if one exists) or of the Tooltip.\n let start: HTMLElement = this.assignedSlot || this;\n let root = start.getRootNode();\n if (root === document) {\n if (window.__swc.DEBUG) {\n window.__swc.warn(\n this,\n `Self managed <${this.localName}> elements walk up the composed tree to acquire a trigger element. No trigger element was found before the document.`,\n 'https://opensource.adobe.com/spectrum-web-components/components/tooltip#self-managed-overlays',\n {\n level: 'high',\n }\n );\n }\n return null;\n }\n let triggerElement = (start.parentElement ||\n (root as ShadowRoot).host ||\n /* c8 ignore next 1 */\n root) as HTMLElement;\n while (!triggerElement?.matches?.(focusableSelector)) {\n start =\n triggerElement.assignedSlot || (triggerElement as HTMLElement);\n root = start.getRootNode();\n /* c8 ignore next 13 */\n if (root === document) {\n if (window.__swc.DEBUG) {\n window.__swc.warn(\n this,\n `Self managed <${this.localName}> elements walk up the composed tree to acquire a trigger element. No trigger element was found before the document.`,\n 'https://opensource.adobe.com/spectrum-web-components/components/tooltip#self-managed-overlays',\n {\n level: 'high',\n }\n );\n }\n return null;\n }\n triggerElement = (start.parentElement ||\n (root as ShadowRoot).host ||\n /* c8 ignore next 1 */\n root) as HTMLElement;\n }\n return triggerElement;\n }\n\n override render(): TemplateResult {\n const tooltip = html`\n <sp-tooltip-openable\n id=\"tooltip\"\n placement=${ifDefined(this.placement)}\n @transitionrun=${this.forwardTransitionEvent}\n @transitionend=${this.forwardTransitionEvent}\n @transitioncancel=${this.forwardTransitionEvent}\n >\n <slot name=\"icon\"></slot>\n <span id=\"label\"><slot></slot></span>\n <span id=\"tip\" aria-hidden=\"true\"></span>\n </sp-tooltip-openable>\n `;\n if (this.selfManaged) {\n this.dependencyManager.add('sp-overlay');\n import('@spectrum-web-components/overlay/sp-overlay.js');\n return html`\n <sp-overlay\n ?open=${this.open &&\n !this.disabled &&\n this.dependencyManager.loaded}\n ?delayed=${this.delayed}\n ?disabled=${this.disabled}\n offset=${this.offset}\n .placement=${this.placement}\n type=\"hint\"\n .tipPadding=${this.tipPadding}\n .triggerInteraction=${'hover'}\n @sp-opened=${this.handleOpenOverlay}\n @sp-closed=${this.handleCloseOverlay}\n >\n ${tooltip}\n </sp-overlay>\n `;\n } else {\n return tooltip;\n }\n }\n\n public override connectedCallback(): void {\n super.connectedCallback();\n\n this.updateComplete.then(() => {\n if (!this.selfManaged) {\n return;\n }\n const overlayElement = this.overlayElement;\n if (overlayElement) {\n const triggerElement = this.triggerElement;\n overlayElement.triggerElement = triggerElement;\n }\n });\n }\n}\n"],
|
|
5
|
-
"mappings": ";;;;;;;;;;;AAYA;AAAA,EAEI;AAAA,EACA;AAAA,OAEG;AACP;AAAA,EACI;AAAA,EACA;AAAA,OACG;AACP,SAAS,iBAAiB;AAO1B,
|
|
4
|
+
"sourcesContent": ["/**\n * Copyright 2025 Adobe. All rights reserved.\n * This file is licensed to you under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License. You may obtain a copy\n * of the License at http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under\n * the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\n * OF ANY KIND, either express or implied. See the License for the specific language\n * governing permissions and limitations under the License.\n */\n\nimport {\n CSSResultArray,\n html,\n SpectrumElement,\n TemplateResult,\n} from '@spectrum-web-components/base';\nimport {\n property,\n query,\n} from '@spectrum-web-components/base/src/decorators.js';\nimport { ifDefined } from '@spectrum-web-components/base/src/directives.js';\nimport type {\n Overlay,\n OverlayOpenCloseDetail,\n Placement,\n} from '@spectrum-web-components/overlay';\n\nimport { DependencyManagerController } from '@spectrum-web-components/reactive-controllers/src/DependencyManger.js';\nimport { focusableSelector } from '@spectrum-web-components/shared/src/focusable-selectors.js';\nimport tooltipStyles from './tooltip.css.js';\n\nclass TooltipOpenable extends HTMLElement {\n constructor() {\n super();\n this.addEventListener('sp-opened', this.redispatchEvent);\n this.addEventListener('sp-closed', this.redispatchEvent);\n }\n redispatchEvent(event: Event): void {\n event.stopPropagation();\n this.tooltip.dispatchEvent(\n new CustomEvent<OverlayOpenCloseDetail>(event.type, {\n bubbles: event.bubbles,\n composed: event.composed,\n detail: (event as CustomEvent<OverlayOpenCloseDetail>).detail,\n })\n );\n }\n get tooltip(): Tooltip {\n return (this.getRootNode() as ShadowRoot).host as Tooltip;\n }\n static get observedAttributes(): string[] {\n return ['open', 'placement'];\n }\n attributeChangedCallback(\n name: 'open' | 'placement',\n _oldValue: string,\n newValue: 'string'\n ): void {\n switch (name) {\n // API generally sets `open` as a property\n /* c8 ignore next 3 */\n case 'open':\n this.open = newValue !== null;\n break;\n case 'placement':\n this.placement = newValue as Placement;\n break;\n }\n }\n set open(open: boolean) {\n this._open = open;\n const { tooltip } = this;\n /* c8 ignore next 3 */\n if (!tooltip) {\n return;\n }\n tooltip.open = open;\n }\n /* c8 ignore next 3 */\n get open(): boolean {\n return this._open;\n }\n private _open = false;\n /**\n * @type {\"top\" | \"top-start\" | \"top-end\" | \"right\" | \"right-start\" | \"right-end\" | \"bottom\" | \"bottom-start\" | \"bottom-end\" | \"left\" | \"left-start\" | \"left-end\"}\n * @attr\n */\n set placement(placement: Placement) {\n this._placement = placement;\n const { tooltip } = this;\n if (!tooltip) {\n return;\n }\n tooltip.placement = placement;\n }\n /* c8 ignore next 3 */\n get placement(): Placement {\n return this._placement;\n }\n private _placement: Placement = 'top';\n get tipElement(): HTMLElement {\n return this.tooltip.tipElement;\n }\n}\n\nif (!customElements.get('sp-tooltip-openable')) {\n customElements.define('sp-tooltip-openable', TooltipOpenable);\n}\n\n/**\n * @element sp-tooltip\n *\n * @slot icon - the icon element appearing at the start of the label\n * @slot - the text label of the Tooltip\n */\nexport class Tooltip extends SpectrumElement {\n public static override get styles(): CSSResultArray {\n return [tooltipStyles];\n }\n\n /**\n * A Tooltip that is `delayed` will its Overlay wait until a warm-up period of\n * 1000ms has completed before opening. Once the warmup period has completed, all\n * subsequent Overlays will open immediately. When no Overlays are opened, a\n * cooldown period of 1000ms will begin. Once the cooldown has completed, the next\n * Overlay to be opened will be subject to the warm-up period if provided that option.\n */\n @property({ type: Boolean })\n delayed = false;\n\n private dependencyManager = new DependencyManagerController(this);\n\n /**\n * Whether to prevent a self-managed Tooltip from responding to user input.\n */\n @property({ type: Boolean })\n disabled = false;\n\n /**\n * Automatically bind to the parent element of the assigned `slot` or the parent element of the `sp-tooltip`.\n * Without this, you must provide your own `overlay-trigger`.\n */\n @property({ type: Boolean, attribute: 'self-managed' })\n public selfManaged = false;\n\n @property({ type: Number })\n public offset = 0;\n\n @property({ type: Boolean, reflect: true })\n public open = false;\n\n @query('sp-overlay')\n public overlayElement?: Overlay;\n\n /**\n * @type {\"top\" | \"top-start\" | \"top-end\" | \"right\" | \"right-start\" | \"right-end\" | \"bottom\" | \"bottom-start\" | \"bottom-end\" | \"left\" | \"left-start\" | \"left-end\"}\n * @attr\n */\n @property({ reflect: true })\n public placement?: Placement;\n\n @query('#tip')\n public tipElement!: HTMLSpanElement;\n\n @property({ type: Number })\n public tipPadding?: number;\n\n /* Ensure that a '' value for `variant` removes the attribute instead of a blank value */\n private _variant = '';\n\n @property({ type: String })\n public get variant(): string {\n return this._variant;\n }\n public set variant(variant: string) {\n if (variant === this.variant) {\n return;\n }\n if (['info', 'positive', 'negative'].includes(variant)) {\n this.setAttribute('variant', variant);\n this._variant = variant;\n return;\n }\n this.removeAttribute('variant');\n this._variant = '';\n }\n\n private handleOpenOverlay = (): void => {\n this.open = true;\n };\n\n protected handleCloseOverlay = (): void => {\n this.open = false;\n };\n\n protected forwardTransitionEvent(event: TransitionEvent): void {\n this.dispatchEvent(\n new TransitionEvent(event.type, {\n bubbles: true,\n composed: true,\n propertyName: event.propertyName,\n })\n );\n }\n\n /**\n * Finds the trigger element for a self-managed tooltip by traversing up the composed DOM tree.\n *\n * Self-managed tooltips automatically bind to their first focusable ancestor element.\n * This method walks up through shadow DOM boundaries to find a suitable trigger element.\n *\n * A trigger element must match the focusableSelector, which includes:\n * - Interactive elements like buttons, inputs, links, etc.\n * - Elements with tabindex (except -1)\n * - Elements with focusable=\"true\"\n *\n * Common scenarios where no trigger element is found:\n * 1. Tooltip is placed directly in document body without a focusable parent\n * 2. Tooltip is nested in non-interactive elements (divs, spans) without focusable ancestors\n * 3. All ancestor elements have tabindex=\"-1\" or are otherwise non-focusable\n *\n * Expected usage: <sp-action-button><sp-tooltip self-managed>...</sp-tooltip></sp-action-button>\n *\n * @returns The first focusable ancestor element, or null if none found\n */\n private get triggerElement(): HTMLElement | null {\n // Start from the assigned slot (if tooltip is slotted) or the tooltip itself\n let start: HTMLElement = this.assignedSlot || this;\n let root = start.getRootNode();\n\n // Check if we've reached the document root without finding a parent\n // This happens when the tooltip is at the top level without a container\n if (root === document) {\n if (window.__swc.DEBUG) {\n window.__swc.warn(\n this,\n `[INITIAL_TRAVERSAL] Self-managed <${this.localName}> is at document root without a parent element. Self-managed tooltips must be nested inside focusable elements like <sp-action-button>, <sp-button>, or elements with tabindex.`,\n 'https://opensource.adobe.com/spectrum-web-components/components/tooltip#self-managed-overlays',\n {\n level: 'high',\n }\n );\n }\n return null;\n }\n\n // Get the initial candidate trigger element:\n // 1. Direct parent element in the same document/shadow root\n // 2. Shadow host if we're in a shadow root\n // 3. The root itself as fallback\n let triggerElement = (start.parentElement ||\n (root as ShadowRoot).host ||\n root) as HTMLElement;\n\n // Walk up the composed tree until we find a focusable element\n // The focusableSelector matches interactive elements that can receive focus\n while (!triggerElement?.matches?.(focusableSelector)) {\n // Move to the next level up in the composed tree\n // This handles both regular DOM and shadow DOM traversal\n start =\n triggerElement.assignedSlot || (triggerElement as HTMLElement);\n root = start.getRootNode();\n\n /* c8 ignore next 13 */\n // Check if we've reached the document root during traversal\n // This happens when no focusable ancestor is found\n if (root === document) {\n if (window.__swc.DEBUG) {\n window.__swc.warn(\n this,\n `[TRAVERSAL_EXHAUSTED] Self-managed <${this.localName}> could not find a focusable trigger element. All ancestor elements are non-focusable. Ensure the tooltip is nested inside an interactive element like <sp-action-button>, <sp-button>, or add tabindex=\"0\" to a parent element.`,\n 'https://opensource.adobe.com/spectrum-web-components/components/tooltip#self-managed-overlays',\n {\n level: 'high',\n }\n );\n }\n return null;\n }\n\n // Continue traversing up to find the next candidate\n triggerElement = (start.parentElement ||\n (root as ShadowRoot).host ||\n /* c8 ignore next 1 */\n root) as HTMLElement;\n }\n\n return triggerElement;\n }\n\n override render(): TemplateResult {\n const tooltip = html`\n <sp-tooltip-openable\n id=\"tooltip\"\n placement=${ifDefined(this.placement)}\n @transitionrun=${this.forwardTransitionEvent}\n @transitionend=${this.forwardTransitionEvent}\n @transitioncancel=${this.forwardTransitionEvent}\n >\n <slot name=\"icon\"></slot>\n <span id=\"label\"><slot></slot></span>\n <span id=\"tip\" aria-hidden=\"true\"></span>\n </sp-tooltip-openable>\n `;\n if (this.selfManaged) {\n this.dependencyManager.add('sp-overlay');\n import('@spectrum-web-components/overlay/sp-overlay.js');\n return html`\n <sp-overlay\n ?open=${this.open &&\n !this.disabled &&\n this.dependencyManager.loaded}\n ?delayed=${this.delayed}\n ?disabled=${this.disabled}\n offset=${this.offset}\n .placement=${this.placement}\n type=\"hint\"\n .tipPadding=${this.tipPadding}\n .triggerInteraction=${'hover'}\n @sp-opened=${this.handleOpenOverlay}\n @sp-closed=${this.handleCloseOverlay}\n >\n ${tooltip}\n </sp-overlay>\n `;\n } else {\n return tooltip;\n }\n }\n\n public override connectedCallback(): void {\n super.connectedCallback();\n\n this.updateComplete.then(() => {\n if (!this.selfManaged) {\n return;\n }\n const overlayElement = this.overlayElement;\n if (overlayElement) {\n const triggerElement = this.triggerElement;\n overlayElement.triggerElement = triggerElement;\n }\n });\n }\n}\n"],
|
|
5
|
+
"mappings": ";;;;;;;;;;;AAYA;AAAA,EAEI;AAAA,EACA;AAAA,OAEG;AACP;AAAA,EACI;AAAA,EACA;AAAA,OACG;AACP,SAAS,iBAAiB;AAO1B,SAAS,mCAAmC;AAC5C,SAAS,yBAAyB;AAClC,OAAO,mBAAmB;AAE1B,MAAM,wBAAwB,YAAY;AAAA,EACtC,cAAc;AACV,UAAM;AAiDV,SAAQ,QAAQ;AAiBhB,SAAQ,aAAwB;AAjE5B,SAAK,iBAAiB,aAAa,KAAK,eAAe;AACvD,SAAK,iBAAiB,aAAa,KAAK,eAAe;AAAA,EAC3D;AAAA,EACA,gBAAgB,OAAoB;AAChC,UAAM,gBAAgB;AACtB,SAAK,QAAQ;AAAA,MACT,IAAI,YAAoC,MAAM,MAAM;AAAA,QAChD,SAAS,MAAM;AAAA,QACf,UAAU,MAAM;AAAA,QAChB,QAAS,MAA8C;AAAA,MAC3D,CAAC;AAAA,IACL;AAAA,EACJ;AAAA,EACA,IAAI,UAAmB;AACnB,WAAQ,KAAK,YAAY,EAAiB;AAAA,EAC9C;AAAA,EACA,WAAW,qBAA+B;AACtC,WAAO,CAAC,QAAQ,WAAW;AAAA,EAC/B;AAAA,EACA,yBACI,MACA,WACA,UACI;AACJ,YAAQ,MAAM;AAAA,MAGV,KAAK;AACD,aAAK,OAAO,aAAa;AACzB;AAAA,MACJ,KAAK;AACD,aAAK,YAAY;AACjB;AAAA,IACR;AAAA,EACJ;AAAA,EACA,IAAI,KAAK,MAAe;AACpB,SAAK,QAAQ;AACb,UAAM,EAAE,QAAQ,IAAI;AAEpB,QAAI,CAAC,SAAS;AACV;AAAA,IACJ;AACA,YAAQ,OAAO;AAAA,EACnB;AAAA;AAAA,EAEA,IAAI,OAAgB;AAChB,WAAO,KAAK;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,UAAU,WAAsB;AAChC,SAAK,aAAa;AAClB,UAAM,EAAE,QAAQ,IAAI;AACpB,QAAI,CAAC,SAAS;AACV;AAAA,IACJ;AACA,YAAQ,YAAY;AAAA,EACxB;AAAA;AAAA,EAEA,IAAI,YAAuB;AACvB,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAI,aAA0B;AAC1B,WAAO,KAAK,QAAQ;AAAA,EACxB;AACJ;AAEA,IAAI,CAAC,eAAe,IAAI,qBAAqB,GAAG;AAC5C,iBAAe,OAAO,uBAAuB,eAAe;AAChE;AAQO,aAAM,gBAAgB,gBAAgB;AAAA,EAAtC;AAAA;AAaH,mBAAU;AAEV,SAAQ,oBAAoB,IAAI,4BAA4B,IAAI;AAMhE,oBAAW;AAOX,SAAO,cAAc;AAGrB,SAAO,SAAS;AAGhB,SAAO,OAAO;AAmBd;AAAA,SAAQ,WAAW;AAmBnB,SAAQ,oBAAoB,MAAY;AACpC,WAAK,OAAO;AAAA,IAChB;AAEA,SAAU,qBAAqB,MAAY;AACvC,WAAK,OAAO;AAAA,IAChB;AAAA;AAAA,EA7EA,WAA2B,SAAyB;AAChD,WAAO,CAAC,aAAa;AAAA,EACzB;AAAA,EAqDA,IAAW,UAAkB;AACzB,WAAO,KAAK;AAAA,EAChB;AAAA,EACA,IAAW,QAAQ,SAAiB;AAChC,QAAI,YAAY,KAAK,SAAS;AAC1B;AAAA,IACJ;AACA,QAAI,CAAC,QAAQ,YAAY,UAAU,EAAE,SAAS,OAAO,GAAG;AACpD,WAAK,aAAa,WAAW,OAAO;AACpC,WAAK,WAAW;AAChB;AAAA,IACJ;AACA,SAAK,gBAAgB,SAAS;AAC9B,SAAK,WAAW;AAAA,EACpB;AAAA,EAUU,uBAAuB,OAA8B;AAC3D,SAAK;AAAA,MACD,IAAI,gBAAgB,MAAM,MAAM;AAAA,QAC5B,SAAS;AAAA,QACT,UAAU;AAAA,QACV,cAAc,MAAM;AAAA,MACxB,CAAC;AAAA,IACL;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,IAAY,iBAAqC;AAnOrD;AAqOQ,QAAI,QAAqB,KAAK,gBAAgB;AAC9C,QAAI,OAAO,MAAM,YAAY;AAI7B,QAAI,SAAS,UAAU;AACnB,UAAI,MAAoB;AACpB,eAAO,MAAM;AAAA,UACT;AAAA,UACA,qCAAqC,KAAK,SAAS;AAAA,UACnD;AAAA,UACA;AAAA,YACI,OAAO;AAAA,UACX;AAAA,QACJ;AAAA,MACJ;AACA,aAAO;AAAA,IACX;AAMA,QAAI,iBAAkB,MAAM,iBACvB,KAAoB,QACrB;AAIJ,WAAO,GAAC,sDAAgB,YAAhB,wCAA0B,qBAAoB;AAGlD,cACI,eAAe,gBAAiB;AACpC,aAAO,MAAM,YAAY;AAKzB,UAAI,SAAS,UAAU;AACnB,YAAI,MAAoB;AACpB,iBAAO,MAAM;AAAA,YACT;AAAA,YACA,uCAAuC,KAAK,SAAS;AAAA,YACrD;AAAA,YACA;AAAA,cACI,OAAO;AAAA,YACX;AAAA,UACJ;AAAA,QACJ;AACA,eAAO;AAAA,MACX;AAGA,uBAAkB,MAAM,iBACnB,KAAoB;AAAA,MAErB;AAAA,IACR;AAEA,WAAO;AAAA,EACX;AAAA,EAES,SAAyB;AAC9B,UAAM,UAAU;AAAA;AAAA;AAAA,4BAGI,UAAU,KAAK,SAAS,CAAC;AAAA,iCACpB,KAAK,sBAAsB;AAAA,iCAC3B,KAAK,sBAAsB;AAAA,oCACxB,KAAK,sBAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAOvD,QAAI,KAAK,aAAa;AAClB,WAAK,kBAAkB,IAAI,YAAY;AACvC,aAAO,gDAAgD;AACvD,aAAO;AAAA;AAAA,4BAES,KAAK,QACb,CAAC,KAAK,YACN,KAAK,kBAAkB,MAAM;AAAA,+BAClB,KAAK,OAAO;AAAA,gCACX,KAAK,QAAQ;AAAA,6BAChB,KAAK,MAAM;AAAA,iCACP,KAAK,SAAS;AAAA;AAAA,kCAEb,KAAK,UAAU;AAAA,0CACP,OAAO;AAAA,iCAChB,KAAK,iBAAiB;AAAA,iCACtB,KAAK,kBAAkB;AAAA;AAAA,sBAElC,OAAO;AAAA;AAAA;AAAA,IAGrB,OAAO;AACH,aAAO;AAAA,IACX;AAAA,EACJ;AAAA,EAEgB,oBAA0B;AACtC,UAAM,kBAAkB;AAExB,SAAK,eAAe,KAAK,MAAM;AAC3B,UAAI,CAAC,KAAK,aAAa;AACnB;AAAA,MACJ;AACA,YAAM,iBAAiB,KAAK;AAC5B,UAAI,gBAAgB;AAChB,cAAM,iBAAiB,KAAK;AAC5B,uBAAe,iBAAiB;AAAA,MACpC;AAAA,IACJ,CAAC;AAAA,EACL;AACJ;AAxNI;AAAA,EADC,SAAS,EAAE,MAAM,QAAQ,CAAC;AAAA,GAZlB,QAaT;AAQA;AAAA,EADC,SAAS,EAAE,MAAM,QAAQ,CAAC;AAAA,GApBlB,QAqBT;AAOO;AAAA,EADN,SAAS,EAAE,MAAM,SAAS,WAAW,eAAe,CAAC;AAAA,GA3B7C,QA4BF;AAGA;AAAA,EADN,SAAS,EAAE,MAAM,OAAO,CAAC;AAAA,GA9BjB,QA+BF;AAGA;AAAA,EADN,SAAS,EAAE,MAAM,SAAS,SAAS,KAAK,CAAC;AAAA,GAjCjC,QAkCF;AAGA;AAAA,EADN,MAAM,YAAY;AAAA,GApCV,QAqCF;AAOA;AAAA,EADN,SAAS,EAAE,SAAS,KAAK,CAAC;AAAA,GA3ClB,QA4CF;AAGA;AAAA,EADN,MAAM,MAAM;AAAA,GA9CJ,QA+CF;AAGA;AAAA,EADN,SAAS,EAAE,MAAM,OAAO,CAAC;AAAA,GAjDjB,QAkDF;AAMI;AAAA,EADV,SAAS,EAAE,MAAM,OAAO,CAAC;AAAA,GAvDjB,QAwDE;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
package/src/Tooltip.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
"use strict";var c=Object.defineProperty;var m=Object.getOwnPropertyDescriptor;var o=(
|
|
1
|
+
"use strict";var c=Object.defineProperty;var m=Object.getOwnPropertyDescriptor;var o=(l,s,e,t)=>{for(var n=t>1?void 0:t?m(s,e):s,i=l.length-1,r;i>=0;i--)(r=l[i])&&(n=(t?r(s,e,n):r(n))||n);return t&&n&&c(s,e,n),n};import{html as p,SpectrumElement as u}from"@spectrum-web-components/base";import{property as a,query as d}from"@spectrum-web-components/base/src/decorators.js";import{ifDefined as h}from"@spectrum-web-components/base/src/directives.js";import{DependencyManagerController as b}from"@spectrum-web-components/reactive-controllers/src/DependencyManger.js";import{focusableSelector as v}from"@spectrum-web-components/shared/src/focusable-selectors.js";import f from"./tooltip.css.js";class g extends HTMLElement{constructor(){super();this._open=!1;this._placement="top";this.addEventListener("sp-opened",this.redispatchEvent),this.addEventListener("sp-closed",this.redispatchEvent)}redispatchEvent(e){e.stopPropagation(),this.tooltip.dispatchEvent(new CustomEvent(e.type,{bubbles:e.bubbles,composed:e.composed,detail:e.detail}))}get tooltip(){return this.getRootNode().host}static get observedAttributes(){return["open","placement"]}attributeChangedCallback(e,t,n){switch(e){case"open":this.open=n!==null;break;case"placement":this.placement=n;break}}set open(e){this._open=e;const{tooltip:t}=this;t&&(t.open=e)}get open(){return this._open}set placement(e){this._placement=e;const{tooltip:t}=this;t&&(t.placement=e)}get placement(){return this._placement}get tipElement(){return this.tooltip.tipElement}}customElements.get("sp-tooltip-openable")||customElements.define("sp-tooltip-openable",g);export class Tooltip extends u{constructor(){super(...arguments);this.delayed=!1;this.dependencyManager=new b(this);this.disabled=!1;this.selfManaged=!1;this.offset=0;this.open=!1;this._variant="";this.handleOpenOverlay=()=>{this.open=!0};this.handleCloseOverlay=()=>{this.open=!1}}static get styles(){return[f]}get variant(){return this._variant}set variant(e){if(e!==this.variant){if(["info","positive","negative"].includes(e)){this.setAttribute("variant",e),this._variant=e;return}this.removeAttribute("variant"),this._variant=""}}forwardTransitionEvent(e){this.dispatchEvent(new TransitionEvent(e.type,{bubbles:!0,composed:!0,propertyName:e.propertyName}))}get triggerElement(){var i;let e=this.assignedSlot||this,t=e.getRootNode();if(t===document)return null;let n=e.parentElement||t.host||t;for(;!((i=n==null?void 0:n.matches)!=null&&i.call(n,v));){if(e=n.assignedSlot||n,t=e.getRootNode(),t===document)return null;n=e.parentElement||t.host||t}return n}render(){const e=p`
|
|
2
2
|
<sp-tooltip-openable
|
|
3
3
|
id="tooltip"
|
|
4
|
-
placement=${
|
|
4
|
+
placement=${h(this.placement)}
|
|
5
5
|
@transitionrun=${this.forwardTransitionEvent}
|
|
6
6
|
@transitionend=${this.forwardTransitionEvent}
|
|
7
7
|
@transitioncancel=${this.forwardTransitionEvent}
|
package/src/Tooltip.js.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["Tooltip.ts"],
|
|
4
|
-
"sourcesContent": ["/**\n * Copyright 2025 Adobe. All rights reserved.\n * This file is licensed to you under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License. You may obtain a copy\n * of the License at http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under\n * the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\n * OF ANY KIND, either express or implied. See the License for the specific language\n * governing permissions and limitations under the License.\n */\n\nimport {\n CSSResultArray,\n html,\n SpectrumElement,\n TemplateResult,\n} from '@spectrum-web-components/base';\nimport {\n property,\n query,\n} from '@spectrum-web-components/base/src/decorators.js';\nimport { ifDefined } from '@spectrum-web-components/base/src/directives.js';\nimport type {\n Overlay,\n OverlayOpenCloseDetail,\n Placement,\n} from '@spectrum-web-components/overlay';\n\nimport tooltipStyles from './tooltip.css.js';\nimport { focusableSelector } from '@spectrum-web-components/shared/src/focusable-selectors.js';\nimport { DependencyManagerController } from '@spectrum-web-components/reactive-controllers/src/DependencyManger.js';\n\nclass TooltipOpenable extends HTMLElement {\n constructor() {\n super();\n this.addEventListener('sp-opened', this.redispatchEvent);\n this.addEventListener('sp-closed', this.redispatchEvent);\n }\n redispatchEvent(event: Event): void {\n event.stopPropagation();\n this.tooltip.dispatchEvent(\n new CustomEvent<OverlayOpenCloseDetail>(event.type, {\n bubbles: event.bubbles,\n composed: event.composed,\n detail: (event as CustomEvent<OverlayOpenCloseDetail>).detail,\n })\n );\n }\n get tooltip(): Tooltip {\n return (this.getRootNode() as ShadowRoot).host as Tooltip;\n }\n static get observedAttributes(): string[] {\n return ['open', 'placement'];\n }\n attributeChangedCallback(\n name: 'open' | 'placement',\n _oldValue: string,\n newValue: 'string'\n ): void {\n switch (name) {\n // API generally sets `open` as a property\n /* c8 ignore next 3 */\n case 'open':\n this.open = newValue !== null;\n break;\n case 'placement':\n this.placement = newValue as Placement;\n break;\n }\n }\n set open(open: boolean) {\n this._open = open;\n const { tooltip } = this;\n /* c8 ignore next 3 */\n if (!tooltip) {\n return;\n }\n tooltip.open = open;\n }\n /* c8 ignore next 3 */\n get open(): boolean {\n return this._open;\n }\n private _open = false;\n /**\n * @type {\"top\" | \"top-start\" | \"top-end\" | \"right\" | \"right-start\" | \"right-end\" | \"bottom\" | \"bottom-start\" | \"bottom-end\" | \"left\" | \"left-start\" | \"left-end\"}\n * @attr\n */\n set placement(placement: Placement) {\n this._placement = placement;\n const { tooltip } = this;\n if (!tooltip) {\n return;\n }\n tooltip.placement = placement;\n }\n /* c8 ignore next 3 */\n get placement(): Placement {\n return this._placement;\n }\n private _placement: Placement = 'top';\n get tipElement(): HTMLElement {\n return this.tooltip.tipElement;\n }\n}\n\nif (!customElements.get('sp-tooltip-openable')) {\n customElements.define('sp-tooltip-openable', TooltipOpenable);\n}\n\n/**\n * @element sp-tooltip\n *\n * @slot icon - the icon element appearing at the start of the label\n * @slot - the text label of the Tooltip\n */\nexport class Tooltip extends SpectrumElement {\n public static override get styles(): CSSResultArray {\n return [tooltipStyles];\n }\n\n /**\n * A Tooltip that is `delayed` will its Overlay wait until a warm-up period of\n * 1000ms has completed before opening. Once the warmup period has completed, all\n * subsequent Overlays will open immediately. When no Overlays are opened, a\n * cooldown period of 1000ms will begin. Once the cooldown has completed, the next\n * Overlay to be opened will be subject to the warm-up period if provided that option.\n */\n @property({ type: Boolean })\n delayed = false;\n\n private dependencyManager = new DependencyManagerController(this);\n\n /**\n * Whether to prevent a self-managed Tooltip from responding to user input.\n */\n @property({ type: Boolean })\n disabled = false;\n\n /**\n * Automatically bind to the parent element of the assigned `slot` or the parent element of the `sp-tooltip`.\n * Without this, you must provide your own `overlay-trigger`.\n */\n @property({ type: Boolean, attribute: 'self-managed' })\n public selfManaged = false;\n\n @property({ type: Number })\n public offset = 0;\n\n @property({ type: Boolean, reflect: true })\n public open = false;\n\n @query('sp-overlay')\n public overlayElement?: Overlay;\n\n /**\n * @type {\"top\" | \"top-start\" | \"top-end\" | \"right\" | \"right-start\" | \"right-end\" | \"bottom\" | \"bottom-start\" | \"bottom-end\" | \"left\" | \"left-start\" | \"left-end\"}\n * @attr\n */\n @property({ reflect: true })\n public placement?: Placement;\n\n @query('#tip')\n public tipElement!: HTMLSpanElement;\n\n @property({ type: Number })\n public tipPadding?: number;\n\n /* Ensure that a '' value for `variant` removes the attribute instead of a blank value */\n private _variant = '';\n\n @property({ type: String })\n public get variant(): string {\n return this._variant;\n }\n public set variant(variant: string) {\n if (variant === this.variant) {\n return;\n }\n if (['info', 'positive', 'negative'].includes(variant)) {\n this.setAttribute('variant', variant);\n this._variant = variant;\n return;\n }\n this.removeAttribute('variant');\n this._variant = '';\n }\n\n private handleOpenOverlay = (): void => {\n this.open = true;\n };\n\n protected handleCloseOverlay = (): void => {\n this.open = false;\n };\n\n protected forwardTransitionEvent(event: TransitionEvent): void {\n this.dispatchEvent(\n new TransitionEvent(event.type, {\n bubbles: true,\n composed: true,\n propertyName: event.propertyName,\n })\n );\n }\n\n private get triggerElement(): HTMLElement | null {\n // Resolve the parent element of the assigned slot (if one exists) or of the Tooltip.\n let start: HTMLElement = this.assignedSlot || this;\n let root = start.getRootNode();\n if (root === document) {\n if (window.__swc.DEBUG) {\n window.__swc.warn(\n this,\n `Self managed <${this.localName}> elements walk up the composed tree to acquire a trigger element. No trigger element was found before the document.`,\n 'https://opensource.adobe.com/spectrum-web-components/components/tooltip#self-managed-overlays',\n {\n level: 'high',\n }\n );\n }\n return null;\n }\n let triggerElement = (start.parentElement ||\n (root as ShadowRoot).host ||\n /* c8 ignore next 1 */\n root) as HTMLElement;\n while (!triggerElement?.matches?.(focusableSelector)) {\n start =\n triggerElement.assignedSlot || (triggerElement as HTMLElement);\n root = start.getRootNode();\n /* c8 ignore next 13 */\n if (root === document) {\n if (window.__swc.DEBUG) {\n window.__swc.warn(\n this,\n `Self managed <${this.localName}> elements walk up the composed tree to acquire a trigger element. No trigger element was found before the document.`,\n 'https://opensource.adobe.com/spectrum-web-components/components/tooltip#self-managed-overlays',\n {\n level: 'high',\n }\n );\n }\n return null;\n }\n triggerElement = (start.parentElement ||\n (root as ShadowRoot).host ||\n /* c8 ignore next 1 */\n root) as HTMLElement;\n }\n return triggerElement;\n }\n\n override render(): TemplateResult {\n const tooltip = html`\n <sp-tooltip-openable\n id=\"tooltip\"\n placement=${ifDefined(this.placement)}\n @transitionrun=${this.forwardTransitionEvent}\n @transitionend=${this.forwardTransitionEvent}\n @transitioncancel=${this.forwardTransitionEvent}\n >\n <slot name=\"icon\"></slot>\n <span id=\"label\"><slot></slot></span>\n <span id=\"tip\" aria-hidden=\"true\"></span>\n </sp-tooltip-openable>\n `;\n if (this.selfManaged) {\n this.dependencyManager.add('sp-overlay');\n import('@spectrum-web-components/overlay/sp-overlay.js');\n return html`\n <sp-overlay\n ?open=${this.open &&\n !this.disabled &&\n this.dependencyManager.loaded}\n ?delayed=${this.delayed}\n ?disabled=${this.disabled}\n offset=${this.offset}\n .placement=${this.placement}\n type=\"hint\"\n .tipPadding=${this.tipPadding}\n .triggerInteraction=${'hover'}\n @sp-opened=${this.handleOpenOverlay}\n @sp-closed=${this.handleCloseOverlay}\n >\n ${tooltip}\n </sp-overlay>\n `;\n } else {\n return tooltip;\n }\n }\n\n public override connectedCallback(): void {\n super.connectedCallback();\n\n this.updateComplete.then(() => {\n if (!this.selfManaged) {\n return;\n }\n const overlayElement = this.overlayElement;\n if (overlayElement) {\n const triggerElement = this.triggerElement;\n overlayElement.triggerElement = triggerElement;\n }\n });\n }\n}\n"],
|
|
5
|
-
"mappings": "qNAYA,OAEI,QAAAA,EACA,mBAAAC,MAEG,gCACP,OACI,YAAAC,EACA,SAAAC,MACG,kDACP,OAAS,aAAAC,MAAiB,kDAO1B,
|
|
6
|
-
"names": ["html", "SpectrumElement", "property", "query", "ifDefined", "
|
|
4
|
+
"sourcesContent": ["/**\n * Copyright 2025 Adobe. All rights reserved.\n * This file is licensed to you under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License. You may obtain a copy\n * of the License at http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under\n * the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\n * OF ANY KIND, either express or implied. See the License for the specific language\n * governing permissions and limitations under the License.\n */\n\nimport {\n CSSResultArray,\n html,\n SpectrumElement,\n TemplateResult,\n} from '@spectrum-web-components/base';\nimport {\n property,\n query,\n} from '@spectrum-web-components/base/src/decorators.js';\nimport { ifDefined } from '@spectrum-web-components/base/src/directives.js';\nimport type {\n Overlay,\n OverlayOpenCloseDetail,\n Placement,\n} from '@spectrum-web-components/overlay';\n\nimport { DependencyManagerController } from '@spectrum-web-components/reactive-controllers/src/DependencyManger.js';\nimport { focusableSelector } from '@spectrum-web-components/shared/src/focusable-selectors.js';\nimport tooltipStyles from './tooltip.css.js';\n\nclass TooltipOpenable extends HTMLElement {\n constructor() {\n super();\n this.addEventListener('sp-opened', this.redispatchEvent);\n this.addEventListener('sp-closed', this.redispatchEvent);\n }\n redispatchEvent(event: Event): void {\n event.stopPropagation();\n this.tooltip.dispatchEvent(\n new CustomEvent<OverlayOpenCloseDetail>(event.type, {\n bubbles: event.bubbles,\n composed: event.composed,\n detail: (event as CustomEvent<OverlayOpenCloseDetail>).detail,\n })\n );\n }\n get tooltip(): Tooltip {\n return (this.getRootNode() as ShadowRoot).host as Tooltip;\n }\n static get observedAttributes(): string[] {\n return ['open', 'placement'];\n }\n attributeChangedCallback(\n name: 'open' | 'placement',\n _oldValue: string,\n newValue: 'string'\n ): void {\n switch (name) {\n // API generally sets `open` as a property\n /* c8 ignore next 3 */\n case 'open':\n this.open = newValue !== null;\n break;\n case 'placement':\n this.placement = newValue as Placement;\n break;\n }\n }\n set open(open: boolean) {\n this._open = open;\n const { tooltip } = this;\n /* c8 ignore next 3 */\n if (!tooltip) {\n return;\n }\n tooltip.open = open;\n }\n /* c8 ignore next 3 */\n get open(): boolean {\n return this._open;\n }\n private _open = false;\n /**\n * @type {\"top\" | \"top-start\" | \"top-end\" | \"right\" | \"right-start\" | \"right-end\" | \"bottom\" | \"bottom-start\" | \"bottom-end\" | \"left\" | \"left-start\" | \"left-end\"}\n * @attr\n */\n set placement(placement: Placement) {\n this._placement = placement;\n const { tooltip } = this;\n if (!tooltip) {\n return;\n }\n tooltip.placement = placement;\n }\n /* c8 ignore next 3 */\n get placement(): Placement {\n return this._placement;\n }\n private _placement: Placement = 'top';\n get tipElement(): HTMLElement {\n return this.tooltip.tipElement;\n }\n}\n\nif (!customElements.get('sp-tooltip-openable')) {\n customElements.define('sp-tooltip-openable', TooltipOpenable);\n}\n\n/**\n * @element sp-tooltip\n *\n * @slot icon - the icon element appearing at the start of the label\n * @slot - the text label of the Tooltip\n */\nexport class Tooltip extends SpectrumElement {\n public static override get styles(): CSSResultArray {\n return [tooltipStyles];\n }\n\n /**\n * A Tooltip that is `delayed` will its Overlay wait until a warm-up period of\n * 1000ms has completed before opening. Once the warmup period has completed, all\n * subsequent Overlays will open immediately. When no Overlays are opened, a\n * cooldown period of 1000ms will begin. Once the cooldown has completed, the next\n * Overlay to be opened will be subject to the warm-up period if provided that option.\n */\n @property({ type: Boolean })\n delayed = false;\n\n private dependencyManager = new DependencyManagerController(this);\n\n /**\n * Whether to prevent a self-managed Tooltip from responding to user input.\n */\n @property({ type: Boolean })\n disabled = false;\n\n /**\n * Automatically bind to the parent element of the assigned `slot` or the parent element of the `sp-tooltip`.\n * Without this, you must provide your own `overlay-trigger`.\n */\n @property({ type: Boolean, attribute: 'self-managed' })\n public selfManaged = false;\n\n @property({ type: Number })\n public offset = 0;\n\n @property({ type: Boolean, reflect: true })\n public open = false;\n\n @query('sp-overlay')\n public overlayElement?: Overlay;\n\n /**\n * @type {\"top\" | \"top-start\" | \"top-end\" | \"right\" | \"right-start\" | \"right-end\" | \"bottom\" | \"bottom-start\" | \"bottom-end\" | \"left\" | \"left-start\" | \"left-end\"}\n * @attr\n */\n @property({ reflect: true })\n public placement?: Placement;\n\n @query('#tip')\n public tipElement!: HTMLSpanElement;\n\n @property({ type: Number })\n public tipPadding?: number;\n\n /* Ensure that a '' value for `variant` removes the attribute instead of a blank value */\n private _variant = '';\n\n @property({ type: String })\n public get variant(): string {\n return this._variant;\n }\n public set variant(variant: string) {\n if (variant === this.variant) {\n return;\n }\n if (['info', 'positive', 'negative'].includes(variant)) {\n this.setAttribute('variant', variant);\n this._variant = variant;\n return;\n }\n this.removeAttribute('variant');\n this._variant = '';\n }\n\n private handleOpenOverlay = (): void => {\n this.open = true;\n };\n\n protected handleCloseOverlay = (): void => {\n this.open = false;\n };\n\n protected forwardTransitionEvent(event: TransitionEvent): void {\n this.dispatchEvent(\n new TransitionEvent(event.type, {\n bubbles: true,\n composed: true,\n propertyName: event.propertyName,\n })\n );\n }\n\n /**\n * Finds the trigger element for a self-managed tooltip by traversing up the composed DOM tree.\n *\n * Self-managed tooltips automatically bind to their first focusable ancestor element.\n * This method walks up through shadow DOM boundaries to find a suitable trigger element.\n *\n * A trigger element must match the focusableSelector, which includes:\n * - Interactive elements like buttons, inputs, links, etc.\n * - Elements with tabindex (except -1)\n * - Elements with focusable=\"true\"\n *\n * Common scenarios where no trigger element is found:\n * 1. Tooltip is placed directly in document body without a focusable parent\n * 2. Tooltip is nested in non-interactive elements (divs, spans) without focusable ancestors\n * 3. All ancestor elements have tabindex=\"-1\" or are otherwise non-focusable\n *\n * Expected usage: <sp-action-button><sp-tooltip self-managed>...</sp-tooltip></sp-action-button>\n *\n * @returns The first focusable ancestor element, or null if none found\n */\n private get triggerElement(): HTMLElement | null {\n // Start from the assigned slot (if tooltip is slotted) or the tooltip itself\n let start: HTMLElement = this.assignedSlot || this;\n let root = start.getRootNode();\n\n // Check if we've reached the document root without finding a parent\n // This happens when the tooltip is at the top level without a container\n if (root === document) {\n if (window.__swc.DEBUG) {\n window.__swc.warn(\n this,\n `[INITIAL_TRAVERSAL] Self-managed <${this.localName}> is at document root without a parent element. Self-managed tooltips must be nested inside focusable elements like <sp-action-button>, <sp-button>, or elements with tabindex.`,\n 'https://opensource.adobe.com/spectrum-web-components/components/tooltip#self-managed-overlays',\n {\n level: 'high',\n }\n );\n }\n return null;\n }\n\n // Get the initial candidate trigger element:\n // 1. Direct parent element in the same document/shadow root\n // 2. Shadow host if we're in a shadow root\n // 3. The root itself as fallback\n let triggerElement = (start.parentElement ||\n (root as ShadowRoot).host ||\n root) as HTMLElement;\n\n // Walk up the composed tree until we find a focusable element\n // The focusableSelector matches interactive elements that can receive focus\n while (!triggerElement?.matches?.(focusableSelector)) {\n // Move to the next level up in the composed tree\n // This handles both regular DOM and shadow DOM traversal\n start =\n triggerElement.assignedSlot || (triggerElement as HTMLElement);\n root = start.getRootNode();\n\n /* c8 ignore next 13 */\n // Check if we've reached the document root during traversal\n // This happens when no focusable ancestor is found\n if (root === document) {\n if (window.__swc.DEBUG) {\n window.__swc.warn(\n this,\n `[TRAVERSAL_EXHAUSTED] Self-managed <${this.localName}> could not find a focusable trigger element. All ancestor elements are non-focusable. Ensure the tooltip is nested inside an interactive element like <sp-action-button>, <sp-button>, or add tabindex=\"0\" to a parent element.`,\n 'https://opensource.adobe.com/spectrum-web-components/components/tooltip#self-managed-overlays',\n {\n level: 'high',\n }\n );\n }\n return null;\n }\n\n // Continue traversing up to find the next candidate\n triggerElement = (start.parentElement ||\n (root as ShadowRoot).host ||\n /* c8 ignore next 1 */\n root) as HTMLElement;\n }\n\n return triggerElement;\n }\n\n override render(): TemplateResult {\n const tooltip = html`\n <sp-tooltip-openable\n id=\"tooltip\"\n placement=${ifDefined(this.placement)}\n @transitionrun=${this.forwardTransitionEvent}\n @transitionend=${this.forwardTransitionEvent}\n @transitioncancel=${this.forwardTransitionEvent}\n >\n <slot name=\"icon\"></slot>\n <span id=\"label\"><slot></slot></span>\n <span id=\"tip\" aria-hidden=\"true\"></span>\n </sp-tooltip-openable>\n `;\n if (this.selfManaged) {\n this.dependencyManager.add('sp-overlay');\n import('@spectrum-web-components/overlay/sp-overlay.js');\n return html`\n <sp-overlay\n ?open=${this.open &&\n !this.disabled &&\n this.dependencyManager.loaded}\n ?delayed=${this.delayed}\n ?disabled=${this.disabled}\n offset=${this.offset}\n .placement=${this.placement}\n type=\"hint\"\n .tipPadding=${this.tipPadding}\n .triggerInteraction=${'hover'}\n @sp-opened=${this.handleOpenOverlay}\n @sp-closed=${this.handleCloseOverlay}\n >\n ${tooltip}\n </sp-overlay>\n `;\n } else {\n return tooltip;\n }\n }\n\n public override connectedCallback(): void {\n super.connectedCallback();\n\n this.updateComplete.then(() => {\n if (!this.selfManaged) {\n return;\n }\n const overlayElement = this.overlayElement;\n if (overlayElement) {\n const triggerElement = this.triggerElement;\n overlayElement.triggerElement = triggerElement;\n }\n });\n }\n}\n"],
|
|
5
|
+
"mappings": "qNAYA,OAEI,QAAAA,EACA,mBAAAC,MAEG,gCACP,OACI,YAAAC,EACA,SAAAC,MACG,kDACP,OAAS,aAAAC,MAAiB,kDAO1B,OAAS,+BAAAC,MAAmC,wEAC5C,OAAS,qBAAAC,MAAyB,6DAClC,OAAOC,MAAmB,mBAE1B,MAAMC,UAAwB,WAAY,CACtC,aAAc,CACV,MAAM,EAiDV,KAAQ,MAAQ,GAiBhB,KAAQ,WAAwB,MAjE5B,KAAK,iBAAiB,YAAa,KAAK,eAAe,EACvD,KAAK,iBAAiB,YAAa,KAAK,eAAe,CAC3D,CACA,gBAAgBC,EAAoB,CAChCA,EAAM,gBAAgB,EACtB,KAAK,QAAQ,cACT,IAAI,YAAoCA,EAAM,KAAM,CAChD,QAASA,EAAM,QACf,SAAUA,EAAM,SAChB,OAASA,EAA8C,MAC3D,CAAC,CACL,CACJ,CACA,IAAI,SAAmB,CACnB,OAAQ,KAAK,YAAY,EAAiB,IAC9C,CACA,WAAW,oBAA+B,CACtC,MAAO,CAAC,OAAQ,WAAW,CAC/B,CACA,yBACIC,EACAC,EACAC,EACI,CACJ,OAAQF,EAAM,CAGV,IAAK,OACD,KAAK,KAAOE,IAAa,KACzB,MACJ,IAAK,YACD,KAAK,UAAYA,EACjB,KACR,CACJ,CACA,IAAI,KAAKC,EAAe,CACpB,KAAK,MAAQA,EACb,KAAM,CAAE,QAAAC,CAAQ,EAAI,KAEfA,IAGLA,EAAQ,KAAOD,EACnB,CAEA,IAAI,MAAgB,CAChB,OAAO,KAAK,KAChB,CAMA,IAAI,UAAUE,EAAsB,CAChC,KAAK,WAAaA,EAClB,KAAM,CAAE,QAAAD,CAAQ,EAAI,KACfA,IAGLA,EAAQ,UAAYC,EACxB,CAEA,IAAI,WAAuB,CACvB,OAAO,KAAK,UAChB,CAEA,IAAI,YAA0B,CAC1B,OAAO,KAAK,QAAQ,UACxB,CACJ,CAEK,eAAe,IAAI,qBAAqB,GACzC,eAAe,OAAO,sBAAuBP,CAAe,EASzD,aAAM,gBAAgBP,CAAgB,CAAtC,kCAaH,aAAU,GAEV,KAAQ,kBAAoB,IAAII,EAA4B,IAAI,EAMhE,cAAW,GAOX,KAAO,YAAc,GAGrB,KAAO,OAAS,EAGhB,KAAO,KAAO,GAmBd,KAAQ,SAAW,GAmBnB,KAAQ,kBAAoB,IAAY,CACpC,KAAK,KAAO,EAChB,EAEA,KAAU,mBAAqB,IAAY,CACvC,KAAK,KAAO,EAChB,EA7EA,WAA2B,QAAyB,CAChD,MAAO,CAACE,CAAa,CACzB,CAqDA,IAAW,SAAkB,CACzB,OAAO,KAAK,QAChB,CACA,IAAW,QAAQS,EAAiB,CAChC,GAAIA,IAAY,KAAK,QAGrB,IAAI,CAAC,OAAQ,WAAY,UAAU,EAAE,SAASA,CAAO,EAAG,CACpD,KAAK,aAAa,UAAWA,CAAO,EACpC,KAAK,SAAWA,EAChB,MACJ,CACA,KAAK,gBAAgB,SAAS,EAC9B,KAAK,SAAW,GACpB,CAUU,uBAAuBP,EAA8B,CAC3D,KAAK,cACD,IAAI,gBAAgBA,EAAM,KAAM,CAC5B,QAAS,GACT,SAAU,GACV,aAAcA,EAAM,YACxB,CAAC,CACL,CACJ,CAsBA,IAAY,gBAAqC,CAnOrD,IAAAQ,EAqOQ,IAAIC,EAAqB,KAAK,cAAgB,KAC1CC,EAAOD,EAAM,YAAY,EAI7B,GAAIC,IAAS,SAWT,OAAO,KAOX,IAAIC,EAAkBF,EAAM,eACvBC,EAAoB,MACrBA,EAIJ,KAAO,GAACF,EAAAG,GAAA,YAAAA,EAAgB,UAAhB,MAAAH,EAAA,KAAAG,EAA0Bd,KAAoB,CAUlD,GAPAY,EACIE,EAAe,cAAiBA,EACpCD,EAAOD,EAAM,YAAY,EAKrBC,IAAS,SAWT,OAAO,KAIXC,EAAkBF,EAAM,eACnBC,EAAoB,MAErBA,CACR,CAEA,OAAOC,CACX,CAES,QAAyB,CAC9B,MAAMN,EAAUd;AAAA;AAAA;AAAA,4BAGII,EAAU,KAAK,SAAS,CAAC;AAAA,iCACpB,KAAK,sBAAsB;AAAA,iCAC3B,KAAK,sBAAsB;AAAA,oCACxB,KAAK,sBAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,UAOvD,OAAI,KAAK,aACL,KAAK,kBAAkB,IAAI,YAAY,EACvC,OAAO,gDAAgD,EAChDJ;AAAA;AAAA,4BAES,KAAK,MACb,CAAC,KAAK,UACN,KAAK,kBAAkB,MAAM;AAAA,+BAClB,KAAK,OAAO;AAAA,gCACX,KAAK,QAAQ;AAAA,6BAChB,KAAK,MAAM;AAAA,iCACP,KAAK,SAAS;AAAA;AAAA,kCAEb,KAAK,UAAU;AAAA,0CACP,OAAO;AAAA,iCAChB,KAAK,iBAAiB;AAAA,iCACtB,KAAK,kBAAkB;AAAA;AAAA,sBAElCc,CAAO;AAAA;AAAA,eAIVA,CAEf,CAEgB,mBAA0B,CACtC,MAAM,kBAAkB,EAExB,KAAK,eAAe,KAAK,IAAM,CAC3B,GAAI,CAAC,KAAK,YACN,OAEJ,MAAMO,EAAiB,KAAK,eAC5B,GAAIA,EAAgB,CAChB,MAAMD,EAAiB,KAAK,eAC5BC,EAAe,eAAiBD,CACpC,CACJ,CAAC,CACL,CACJ,CAxNIE,EAAA,CADCpB,EAAS,CAAE,KAAM,OAAQ,CAAC,GAZlB,QAaT,uBAQAoB,EAAA,CADCpB,EAAS,CAAE,KAAM,OAAQ,CAAC,GApBlB,QAqBT,wBAOOoB,EAAA,CADNpB,EAAS,CAAE,KAAM,QAAS,UAAW,cAAe,CAAC,GA3B7C,QA4BF,2BAGAoB,EAAA,CADNpB,EAAS,CAAE,KAAM,MAAO,CAAC,GA9BjB,QA+BF,sBAGAoB,EAAA,CADNpB,EAAS,CAAE,KAAM,QAAS,QAAS,EAAK,CAAC,GAjCjC,QAkCF,oBAGAoB,EAAA,CADNnB,EAAM,YAAY,GApCV,QAqCF,8BAOAmB,EAAA,CADNpB,EAAS,CAAE,QAAS,EAAK,CAAC,GA3ClB,QA4CF,yBAGAoB,EAAA,CADNnB,EAAM,MAAM,GA9CJ,QA+CF,0BAGAmB,EAAA,CADNpB,EAAS,CAAE,KAAM,MAAO,CAAC,GAjDjB,QAkDF,0BAMIoB,EAAA,CADVpB,EAAS,CAAE,KAAM,MAAO,CAAC,GAvDjB,QAwDE",
|
|
6
|
+
"names": ["html", "SpectrumElement", "property", "query", "ifDefined", "DependencyManagerController", "focusableSelector", "tooltipStyles", "TooltipOpenable", "event", "name", "_oldValue", "newValue", "open", "tooltip", "placement", "variant", "_a", "start", "root", "triggerElement", "overlayElement", "__decorateClass"]
|
|
7
7
|
}
|