@esri/calcite-components
Version:
Web Components for Esri's Calcite Design System.
417 lines (408 loc) • 18.1 kB
JavaScript
/*!
* All material copyright ESRI, All Rights Reserved, unless otherwise specified.
* See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
* v1.5.0-next.4
*/
'use strict';
Object.defineProperty(exports, '__esModule', { value: true });
const index = require('./index-55f8a3b7.js');
const dom = require('./dom-18ca68ff.js');
const floatingUi = require('./floating-ui-b6af0d52.js');
const guid = require('./guid-db20443e.js');
const openCloseComponent = require('./openCloseComponent-6cd419dc.js');
const FloatingArrow = require('./FloatingArrow-eae44e77.js');
require('./resources-45d84c94.js');
require('./browser-28ea2ce1.js');
require('./debounce-492319d0.js');
const CSS = {
container: "container"
};
const TOOLTIP_OPEN_DELAY_MS = 300;
const TOOLTIP_CLOSE_DELAY_MS = 500;
const ARIA_DESCRIBED_BY = "aria-describedby";
function getEffectiveReferenceElement(tooltip) {
const { referenceElement } = tooltip;
return ((typeof referenceElement === "string" ? dom.queryElementRoots(tooltip, { id: referenceElement }) : referenceElement) ||
null);
}
class TooltipManager {
constructor() {
// --------------------------------------------------------------------------
//
// Private Properties
//
// --------------------------------------------------------------------------
this.registeredElements = new WeakMap();
this.registeredShadowRootCounts = new WeakMap();
this.hoverOpenTimeout = null;
this.hoverCloseTimeout = null;
this.hoveredTooltip = null;
this.clickedTooltip = null;
this.activeTooltip = null;
this.registeredElementCount = 0;
// --------------------------------------------------------------------------
//
// Private Methods
//
// --------------------------------------------------------------------------
this.queryTooltip = (composedPath) => {
const { registeredElements } = this;
const registeredElement = composedPath.find((pathEl) => registeredElements.has(pathEl));
return registeredElements.get(registeredElement);
};
this.keyDownHandler = (event) => {
if (event.key === "Escape" && !event.defaultPrevented) {
const { activeTooltip } = this;
if (activeTooltip?.open) {
this.clearHoverTimeout();
this.closeActiveTooltip();
const referenceElement = getEffectiveReferenceElement(activeTooltip);
if (referenceElement instanceof Element && referenceElement.contains(event.target)) {
event.preventDefault();
}
}
}
};
this.pointerMoveHandler = (event) => {
const composedPath = event.composedPath();
const { activeTooltip } = this;
const hoveringActiveTooltip = activeTooltip?.open && composedPath.includes(activeTooltip);
if (hoveringActiveTooltip) {
this.clearHoverTimeout();
return;
}
const tooltip = this.queryTooltip(composedPath);
this.hoveredTooltip = tooltip;
if (this.isClosableClickedTooltip(tooltip)) {
return;
}
this.clickedTooltip = null;
if (tooltip) {
this.openHoveredTooltip(tooltip);
}
else if (activeTooltip) {
this.closeHoveredTooltip();
}
};
this.pointerDownHandler = (event) => {
if (!dom.isPrimaryPointerButton(event)) {
return;
}
const clickedTooltip = this.queryTooltip(event.composedPath());
this.clickedTooltip = clickedTooltip;
if (clickedTooltip?.closeOnClick) {
this.toggleTooltip(clickedTooltip, false);
this.clearHoverTimeout();
}
};
this.focusInHandler = (event) => {
this.queryFocusedTooltip(event, true);
};
this.focusOutHandler = (event) => {
this.queryFocusedTooltip(event, false);
};
this.openHoveredTooltip = (tooltip) => {
this.hoverOpenTimeout = window.setTimeout(() => {
if (this.hoverOpenTimeout === null) {
return;
}
this.clearHoverCloseTimeout();
this.closeActiveTooltip();
if (tooltip !== this.hoveredTooltip) {
return;
}
this.toggleTooltip(tooltip, true);
}, this.activeTooltip ? 0 : TOOLTIP_OPEN_DELAY_MS);
};
this.closeHoveredTooltip = () => {
this.hoverCloseTimeout = window.setTimeout(() => {
if (this.hoverCloseTimeout === null) {
return;
}
this.closeActiveTooltip();
}, TOOLTIP_CLOSE_DELAY_MS);
};
}
// --------------------------------------------------------------------------
//
// Public Methods
//
// --------------------------------------------------------------------------
registerElement(referenceEl, tooltip) {
this.registeredElementCount++;
this.registeredElements.set(referenceEl, tooltip);
const shadowRoot = this.getReferenceElShadowRootNode(referenceEl);
if (shadowRoot) {
this.registerShadowRoot(shadowRoot);
}
if (this.registeredElementCount === 1) {
this.addListeners();
}
}
unregisterElement(referenceEl) {
const shadowRoot = this.getReferenceElShadowRootNode(referenceEl);
if (shadowRoot) {
this.unregisterShadowRoot(shadowRoot);
}
if (this.registeredElements.delete(referenceEl)) {
this.registeredElementCount--;
}
if (this.registeredElementCount === 0) {
this.removeListeners();
}
}
addShadowListeners(shadowRoot) {
shadowRoot.addEventListener("focusin", this.focusInHandler, { capture: true });
shadowRoot.addEventListener("focusout", this.focusOutHandler, { capture: true });
}
removeShadowListeners(shadowRoot) {
shadowRoot.removeEventListener("focusin", this.focusInHandler, { capture: true });
shadowRoot.removeEventListener("focusout", this.focusOutHandler, { capture: true });
}
addListeners() {
document.addEventListener("keydown", this.keyDownHandler, { capture: true });
document.addEventListener("pointermove", this.pointerMoveHandler, { capture: true });
document.addEventListener("pointerdown", this.pointerDownHandler, { capture: true });
document.addEventListener("focusin", this.focusInHandler, { capture: true });
document.addEventListener("focusout", this.focusOutHandler, { capture: true });
}
removeListeners() {
document.removeEventListener("keydown", this.keyDownHandler, { capture: true });
document.removeEventListener("pointermove", this.pointerMoveHandler, { capture: true });
document.removeEventListener("pointerdown", this.pointerDownHandler, { capture: true });
document.removeEventListener("focusin", this.focusInHandler, { capture: true });
document.removeEventListener("focusout", this.focusOutHandler, { capture: true });
}
clearHoverOpenTimeout() {
window.clearTimeout(this.hoverOpenTimeout);
this.hoverOpenTimeout = null;
}
clearHoverCloseTimeout() {
window.clearTimeout(this.hoverCloseTimeout);
this.hoverCloseTimeout = null;
}
clearHoverTimeout() {
this.clearHoverOpenTimeout();
this.clearHoverCloseTimeout();
}
closeActiveTooltip() {
const { activeTooltip } = this;
if (activeTooltip?.open) {
this.toggleTooltip(activeTooltip, false);
}
}
toggleFocusedTooltip(tooltip, open) {
this.closeActiveTooltip();
if (open) {
this.clearHoverTimeout();
}
this.toggleTooltip(tooltip, open);
}
toggleTooltip(tooltip, open) {
tooltip.open = open;
this.activeTooltip = open ? tooltip : null;
}
queryFocusedTooltip(event, open) {
const tooltip = this.queryTooltip(event.composedPath());
if (!tooltip || this.isClosableClickedTooltip(tooltip)) {
return;
}
this.toggleFocusedTooltip(tooltip, open);
}
isClosableClickedTooltip(tooltip) {
return tooltip?.closeOnClick && tooltip === this.clickedTooltip;
}
registerShadowRoot(shadowRoot) {
const { registeredShadowRootCounts } = this;
const newCount = (registeredShadowRootCounts.get(shadowRoot) ?? 0) + 1;
if (newCount === 1) {
this.addShadowListeners(shadowRoot);
}
registeredShadowRootCounts.set(shadowRoot, newCount);
}
unregisterShadowRoot(shadowRoot) {
const { registeredShadowRootCounts } = this;
const newCount = registeredShadowRootCounts.get(shadowRoot) - 1;
if (newCount === 0) {
this.removeShadowListeners(shadowRoot);
}
registeredShadowRootCounts.set(shadowRoot, newCount);
}
getReferenceElShadowRootNode(referenceEl) {
return referenceEl instanceof Element ? dom.getShadowRootNode(referenceEl) : null;
}
}
const tooltipCss = "@keyframes in{0%{opacity:0}100%{opacity:1}}@keyframes in-down{0%{opacity:0;transform:translate3D(0, -5px, 0)}100%{opacity:1;transform:translate3D(0, 0, 0)}}@keyframes in-up{0%{opacity:0;transform:translate3D(0, 5px, 0)}100%{opacity:1;transform:translate3D(0, 0, 0)}}@keyframes in-right{0%{opacity:0;transform:translate3D(-5px, 0, 0)}100%{opacity:1;transform:translate3D(0, 0, 0)}}@keyframes in-left{0%{opacity:0;transform:translate3D(5px, 0, 0)}100%{opacity:1;transform:translate3D(0, 0, 0)}}@keyframes in-scale{0%{opacity:0;transform:scale3D(0.95, 0.95, 1)}100%{opacity:1;transform:scale3D(1, 1, 1)}}:root{--calcite-animation-timing:calc(150ms * var(--calcite-internal-duration-factor));--calcite-internal-duration-factor:var(--calcite-duration-factor, 1);--calcite-internal-animation-timing-fast:calc(100ms * var(--calcite-internal-duration-factor));--calcite-internal-animation-timing-medium:calc(200ms * var(--calcite-internal-duration-factor));--calcite-internal-animation-timing-slow:calc(300ms * var(--calcite-internal-duration-factor))}.calcite-animate{opacity:0;animation-fill-mode:both;animation-duration:var(--calcite-animation-timing)}.calcite-animate__in{animation-name:in}.calcite-animate__in-down{animation-name:in-down}.calcite-animate__in-up{animation-name:in-up}.calcite-animate__in-right{animation-name:in-right}.calcite-animate__in-left{animation-name:in-left}.calcite-animate__in-scale{animation-name:in-scale}@media (prefers-reduced-motion: reduce){:root{--calcite-internal-duration-factor:0.01}}:root{--calcite-floating-ui-transition:var(--calcite-animation-timing);--calcite-floating-ui-z-index:var(--calcite-app-z-index-dropdown)}:host([hidden]){display:none}:host{--calcite-floating-ui-z-index:var(--calcite-tooltip-z-index, 901);display:block;position:absolute;z-index:var(--calcite-floating-ui-z-index)}.calcite-floating-ui-anim{position:relative;transition:var(--calcite-floating-ui-transition);transition-property:transform, visibility, opacity;opacity:0;box-shadow:0 0 16px 0 rgba(0, 0, 0, 0.16);z-index:var(--calcite-app-z-index);border-radius:0.25rem}:host([data-placement^=bottom]) .calcite-floating-ui-anim{transform:translateY(-5px)}:host([data-placement^=top]) .calcite-floating-ui-anim{transform:translateY(5px)}:host([data-placement^=left]) .calcite-floating-ui-anim{transform:translateX(5px)}:host([data-placement^=right]) .calcite-floating-ui-anim{transform:translateX(-5px)}:host([data-placement]) .calcite-floating-ui-anim--active{opacity:1;transform:translate(0)}:host([calcite-hydrated-hidden]){visibility:hidden !important;pointer-events:none}.calcite-floating-ui-arrow{pointer-events:none;position:absolute;z-index:calc(var(--calcite-app-z-index) * -1);fill:var(--calcite-ui-foreground-1)}.calcite-floating-ui-arrow__stroke{stroke:var(--calcite-ui-border-3)}.container{position:relative;overflow:hidden;border-radius:0.25rem;padding-block:0.75rem;padding-inline:1rem;font-size:var(--calcite-font-size--2);line-height:1.375;font-weight:var(--calcite-font-weight-medium);color:var(--calcite-ui-text-1);max-inline-size:20rem;max-block-size:20rem;text-align:start}.calcite-floating-ui-anim{border-radius:0.25rem;border-width:1px;border-style:solid;border-color:var(--calcite-ui-border-3);background-color:var(--calcite-ui-foreground-1)}.arrow::before{outline:1px solid var(--calcite-ui-border-3)}";
const manager = new TooltipManager();
const Tooltip = class {
constructor(hostRef) {
index.registerInstance(this, hostRef);
this.calciteTooltipBeforeClose = index.createEvent(this, "calciteTooltipBeforeClose", 6);
this.calciteTooltipClose = index.createEvent(this, "calciteTooltipClose", 6);
this.calciteTooltipBeforeOpen = index.createEvent(this, "calciteTooltipBeforeOpen", 6);
this.calciteTooltipOpen = index.createEvent(this, "calciteTooltipOpen", 6);
this.guid = `calcite-tooltip-${guid.guid()}`;
this.hasLoaded = false;
this.openTransitionProp = "opacity";
this.setTransitionEl = (el) => {
this.transitionEl = el;
openCloseComponent.connectOpenCloseComponent(this);
};
this.setUpReferenceElement = (warn = true) => {
this.removeReferences();
this.effectiveReferenceElement = getEffectiveReferenceElement(this.el);
floatingUi.connectFloatingUI(this, this.effectiveReferenceElement, this.el);
const { el, referenceElement, effectiveReferenceElement } = this;
if (warn && referenceElement && !effectiveReferenceElement) {
console.warn(`${el.tagName}: reference-element id "${referenceElement}" was not found.`, {
el
});
}
this.addReferences();
};
this.getId = () => {
return this.el.id || this.guid;
};
this.addReferences = () => {
const { effectiveReferenceElement } = this;
if (!effectiveReferenceElement) {
return;
}
const id = this.getId();
if ("setAttribute" in effectiveReferenceElement) {
effectiveReferenceElement.setAttribute(ARIA_DESCRIBED_BY, id);
}
manager.registerElement(effectiveReferenceElement, this.el);
};
this.removeReferences = () => {
const { effectiveReferenceElement } = this;
if (!effectiveReferenceElement) {
return;
}
if ("removeAttribute" in effectiveReferenceElement) {
effectiveReferenceElement.removeAttribute(ARIA_DESCRIBED_BY);
}
manager.unregisterElement(effectiveReferenceElement);
};
this.closeOnClick = false;
this.label = undefined;
this.offsetDistance = floatingUi.defaultOffsetDistance;
this.offsetSkidding = 0;
this.open = false;
this.overlayPositioning = "absolute";
this.placement = "auto";
this.referenceElement = undefined;
this.effectiveReferenceElement = undefined;
this.floatingLayout = "vertical";
}
offsetDistanceOffsetHandler() {
this.reposition(true);
}
offsetSkiddingHandler() {
this.reposition(true);
}
openHandler(value) {
if (value) {
this.reposition(true);
}
}
overlayPositioningHandler() {
this.reposition(true);
}
placementHandler() {
this.reposition(true);
}
referenceElementHandler() {
this.setUpReferenceElement();
}
// --------------------------------------------------------------------------
//
// Lifecycle
//
// --------------------------------------------------------------------------
connectedCallback() {
openCloseComponent.connectOpenCloseComponent(this);
this.setUpReferenceElement(this.hasLoaded);
}
componentDidLoad() {
if (this.referenceElement && !this.effectiveReferenceElement) {
this.setUpReferenceElement();
}
this.reposition(true);
this.hasLoaded = true;
}
disconnectedCallback() {
this.removeReferences();
floatingUi.disconnectFloatingUI(this, this.effectiveReferenceElement, this.el);
openCloseComponent.disconnectOpenCloseComponent(this);
}
// --------------------------------------------------------------------------
//
// Public Methods
//
// --------------------------------------------------------------------------
/**
* Updates the position of the component.
*
* @param delayed
*/
async reposition(delayed = false) {
const { el, effectiveReferenceElement, placement, overlayPositioning, offsetDistance, offsetSkidding, arrowEl } = this;
return floatingUi.reposition(this, {
floatingEl: el,
referenceEl: effectiveReferenceElement,
overlayPositioning,
placement,
offsetDistance,
offsetSkidding,
arrowEl,
type: "tooltip"
}, delayed);
}
// --------------------------------------------------------------------------
//
// Private Methods
//
// --------------------------------------------------------------------------
onBeforeOpen() {
this.calciteTooltipBeforeOpen.emit();
}
onOpen() {
this.calciteTooltipOpen.emit();
}
onBeforeClose() {
this.calciteTooltipBeforeClose.emit();
}
onClose() {
this.calciteTooltipClose.emit();
}
// --------------------------------------------------------------------------
//
// Render Methods
//
// --------------------------------------------------------------------------
render() {
const { effectiveReferenceElement, label, open, floatingLayout } = this;
const displayed = effectiveReferenceElement && open;
const hidden = !displayed;
return (index.h(index.Host, { "aria-hidden": dom.toAriaBoolean(hidden), "aria-label": label, "aria-live": "polite", "calcite-hydrated-hidden": hidden, id: this.getId(), role: "tooltip" }, index.h("div", { class: {
[floatingUi.FloatingCSS.animation]: true,
[floatingUi.FloatingCSS.animationActive]: displayed
},
// eslint-disable-next-line react/jsx-sort-props
ref: this.setTransitionEl }, index.h(FloatingArrow.FloatingArrow, { floatingLayout: floatingLayout,
// eslint-disable-next-line react/jsx-sort-props
ref: (arrowEl) => (this.arrowEl = arrowEl) }), index.h("div", { class: CSS.container }, index.h("slot", null)))));
}
get el() { return index.getElement(this); }
static get watchers() { return {
"offsetDistance": ["offsetDistanceOffsetHandler"],
"offsetSkidding": ["offsetSkiddingHandler"],
"open": ["openHandler"],
"overlayPositioning": ["overlayPositioningHandler"],
"placement": ["placementHandler"],
"referenceElement": ["referenceElementHandler"]
}; }
};
Tooltip.style = tooltipCss;
exports.calcite_tooltip = Tooltip;