calcite-tooltip.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384
  1. /*!
  2. * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  3. * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
  4. * v1.0.0-beta.82
  5. */
  6. import { proxyCustomElement, HTMLElement, h, Host } from '@stencil/core/internal/client';
  7. import { g as guid } from './guid.js';
  8. import { d as defaultOffsetDistance, u as updatePopper, c as createPopper, C as CSS$1 } from './popper.js';
  9. import { c as queryElementRoots, t as toAriaBoolean } from './dom.js';
  10. const CSS = {
  11. container: "container",
  12. arrow: "arrow"
  13. };
  14. const TOOLTIP_DELAY_MS = 500;
  15. const ARIA_DESCRIBED_BY = "aria-describedby";
  16. class TooltipManager {
  17. constructor() {
  18. // --------------------------------------------------------------------------
  19. //
  20. // Private Properties
  21. //
  22. // --------------------------------------------------------------------------
  23. this.registeredElements = new WeakMap();
  24. this.hoverTimeouts = new WeakMap();
  25. this.registeredElementCount = 0;
  26. // --------------------------------------------------------------------------
  27. //
  28. // Private Methods
  29. //
  30. // --------------------------------------------------------------------------
  31. this.queryTooltip = (composedPath) => {
  32. const { registeredElements } = this;
  33. const registeredElement = composedPath.find((pathEl) => registeredElements.has(pathEl));
  34. return registeredElements.get(registeredElement);
  35. };
  36. this.keyDownHandler = (event) => {
  37. if (event.key === "Escape") {
  38. const { activeTooltipEl } = this;
  39. if (activeTooltipEl) {
  40. this.clearHoverTimeout(activeTooltipEl);
  41. this.toggleTooltip(activeTooltipEl, false);
  42. }
  43. }
  44. };
  45. this.mouseEnterShow = (event) => {
  46. this.hoverEvent(event, true);
  47. };
  48. this.mouseLeaveHide = (event) => {
  49. this.hoverEvent(event, false);
  50. };
  51. this.clickHandler = (event) => {
  52. this.clickedTooltip = this.queryTooltip(event.composedPath());
  53. };
  54. this.focusShow = (event) => {
  55. this.focusEvent(event, true);
  56. };
  57. this.blurHide = (event) => {
  58. this.focusEvent(event, false);
  59. };
  60. this.hoverToggle = (tooltip, value) => {
  61. const { hoverTimeouts } = this;
  62. hoverTimeouts.delete(tooltip);
  63. if (value) {
  64. this.closeExistingTooltip();
  65. }
  66. this.toggleTooltip(tooltip, value);
  67. };
  68. }
  69. // --------------------------------------------------------------------------
  70. //
  71. // Public Methods
  72. //
  73. // --------------------------------------------------------------------------
  74. registerElement(referenceEl, tooltip) {
  75. this.registeredElementCount++;
  76. this.registeredElements.set(referenceEl, tooltip);
  77. if (this.registeredElementCount === 1) {
  78. this.addListeners();
  79. }
  80. }
  81. unregisterElement(referenceEl) {
  82. if (this.registeredElements.delete(referenceEl)) {
  83. this.registeredElementCount--;
  84. }
  85. if (this.registeredElementCount === 0) {
  86. this.removeListeners();
  87. }
  88. }
  89. addListeners() {
  90. document.addEventListener("keydown", this.keyDownHandler);
  91. document.addEventListener("mouseover", this.mouseEnterShow, { capture: true });
  92. document.addEventListener("mouseout", this.mouseLeaveHide, { capture: true });
  93. document.addEventListener("pointerdown", this.clickHandler, { capture: true });
  94. document.addEventListener("focusin", this.focusShow), { capture: true };
  95. document.addEventListener("focusout", this.blurHide, { capture: true });
  96. }
  97. removeListeners() {
  98. document.removeEventListener("keydown", this.keyDownHandler);
  99. document.removeEventListener("mouseover", this.mouseEnterShow, { capture: true });
  100. document.removeEventListener("mouseout", this.mouseLeaveHide, { capture: true });
  101. document.removeEventListener("pointerdown", this.clickHandler, { capture: true });
  102. document.removeEventListener("focusin", this.focusShow, { capture: true });
  103. document.removeEventListener("focusout", this.blurHide, { capture: true });
  104. }
  105. clearHoverTimeout(tooltip) {
  106. const { hoverTimeouts } = this;
  107. if (hoverTimeouts.has(tooltip)) {
  108. window.clearTimeout(hoverTimeouts.get(tooltip));
  109. hoverTimeouts.delete(tooltip);
  110. }
  111. }
  112. closeExistingTooltip() {
  113. const { activeTooltipEl } = this;
  114. if (activeTooltipEl) {
  115. this.toggleTooltip(activeTooltipEl, false);
  116. }
  117. }
  118. focusTooltip(tooltip, value) {
  119. this.closeExistingTooltip();
  120. if (value) {
  121. this.clearHoverTimeout(tooltip);
  122. }
  123. this.toggleTooltip(tooltip, value);
  124. }
  125. toggleTooltip(tooltip, value) {
  126. tooltip.open = value;
  127. if (value) {
  128. this.activeTooltipEl = tooltip;
  129. }
  130. }
  131. hoverTooltip(tooltip, value) {
  132. this.clearHoverTimeout(tooltip);
  133. const { hoverTimeouts } = this;
  134. const timeoutId = window.setTimeout(() => this.hoverToggle(tooltip, value), TOOLTIP_DELAY_MS );
  135. hoverTimeouts.set(tooltip, timeoutId);
  136. }
  137. activeTooltipHover(event) {
  138. const { activeTooltipEl, hoverTimeouts } = this;
  139. const { type } = event;
  140. if (!activeTooltipEl) {
  141. return;
  142. }
  143. if (type === "mouseover" && event.composedPath().includes(activeTooltipEl)) {
  144. this.clearHoverTimeout(activeTooltipEl);
  145. }
  146. else if (type === "mouseout" && !hoverTimeouts.has(activeTooltipEl)) {
  147. this.hoverTooltip(activeTooltipEl, false);
  148. }
  149. }
  150. hoverEvent(event, value) {
  151. const tooltip = this.queryTooltip(event.composedPath());
  152. this.activeTooltipHover(event);
  153. if (!tooltip) {
  154. return;
  155. }
  156. this.hoverTooltip(tooltip, value);
  157. }
  158. focusEvent(event, value) {
  159. const tooltip = this.queryTooltip(event.composedPath());
  160. if (!tooltip || tooltip === this.clickedTooltip) {
  161. this.clickedTooltip = null;
  162. return;
  163. }
  164. this.focusTooltip(tooltip, value);
  165. }
  166. }
  167. const tooltipCss = "@-webkit-keyframes in{0%{opacity:0}100%{opacity:1}}@keyframes in{0%{opacity:0}100%{opacity:1}}@-webkit-keyframes in-down{0%{opacity:0;-webkit-transform:translate3D(0, -5px, 0);transform:translate3D(0, -5px, 0)}100%{opacity:1;-webkit-transform:translate3D(0, 0, 0);transform:translate3D(0, 0, 0)}}@keyframes in-down{0%{opacity:0;-webkit-transform:translate3D(0, -5px, 0);transform:translate3D(0, -5px, 0)}100%{opacity:1;-webkit-transform:translate3D(0, 0, 0);transform:translate3D(0, 0, 0)}}@-webkit-keyframes in-up{0%{opacity:0;-webkit-transform:translate3D(0, 5px, 0);transform:translate3D(0, 5px, 0)}100%{opacity:1;-webkit-transform:translate3D(0, 0, 0);transform:translate3D(0, 0, 0)}}@keyframes in-up{0%{opacity:0;-webkit-transform:translate3D(0, 5px, 0);transform:translate3D(0, 5px, 0)}100%{opacity:1;-webkit-transform:translate3D(0, 0, 0);transform:translate3D(0, 0, 0)}}@-webkit-keyframes in-scale{0%{opacity:0;-webkit-transform:scale3D(0.95, 0.95, 1);transform:scale3D(0.95, 0.95, 1)}100%{opacity:1;-webkit-transform:scale3D(1, 1, 1);transform:scale3D(1, 1, 1)}}@keyframes in-scale{0%{opacity:0;-webkit-transform:scale3D(0.95, 0.95, 1);transform:scale3D(0.95, 0.95, 1)}100%{opacity:1;-webkit-transform:scale3D(1, 1, 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;-webkit-animation-fill-mode:both;animation-fill-mode:both;-webkit-animation-duration:var(--calcite-animation-timing);animation-duration:var(--calcite-animation-timing)}.calcite-animate__in{-webkit-animation-name:in;animation-name:in}.calcite-animate__in-down{-webkit-animation-name:in-down;animation-name:in-down}.calcite-animate__in-up{-webkit-animation-name:in-up;animation-name:in-up}.calcite-animate__in-scale{-webkit-animation-name:in-scale;animation-name:in-scale}:root{--calcite-popper-transition:var(--calcite-animation-timing)}:host([hidden]){display:none}:host{display:block;position:absolute;z-index:999;-webkit-transform:scale(0);transform:scale(0)}.calcite-popper-anim{position:relative;z-index:1;-webkit-transition:var(--calcite-popper-transition);transition:var(--calcite-popper-transition);visibility:hidden;-webkit-transition-property:visibility, opacity, -webkit-transform;transition-property:visibility, opacity, -webkit-transform;transition-property:transform, visibility, opacity;transition-property:transform, visibility, opacity, -webkit-transform;opacity:0;-webkit-box-shadow:0 0 16px 0 rgba(0, 0, 0, 0.16);box-shadow:0 0 16px 0 rgba(0, 0, 0, 0.16);border-radius:0.25rem}:host([data-popper-placement^=bottom]) .calcite-popper-anim{-webkit-transform:translateY(-5px);transform:translateY(-5px)}:host([data-popper-placement^=top]) .calcite-popper-anim{-webkit-transform:translateY(5px);transform:translateY(5px)}:host([data-popper-placement^=left]) .calcite-popper-anim{-webkit-transform:translateX(5px);transform:translateX(5px)}:host([data-popper-placement^=right]) .calcite-popper-anim{-webkit-transform:translateX(-5px);transform:translateX(-5px)}:host([data-popper-placement]) .calcite-popper-anim--active{opacity:1;visibility:visible;-webkit-transform:translate(0);transform:translate(0)}:host([data-popper-placement][data-popper-reference-hidden]){pointer-events:none;opacity:0}.arrow,.arrow::before{position:absolute;width:8px;height:8px;z-index:-1}.arrow::before{content:\"\";--tw-shadow:0 4px 8px -1px rgba(0, 0, 0, 0.08), 0 2px 4px -1px rgba(0, 0, 0, 0.04);--tw-shadow-colored:0 4px 8px -1px var(--tw-shadow-color), 0 2px 4px -1px var(--tw-shadow-color);-webkit-box-shadow:var(--tw-ring-offset-shadow, 0 0 #0000), var(--tw-ring-shadow, 0 0 #0000), var(--tw-shadow);box-shadow:var(--tw-ring-offset-shadow, 0 0 #0000), var(--tw-ring-shadow, 0 0 #0000), var(--tw-shadow);-webkit-transform:rotate(45deg);transform:rotate(45deg);background:var(--calcite-ui-foreground-1)}:host([data-popper-placement^=top]) .arrow{bottom:-4px}:host([data-popper-placement^=bottom]) .arrow{top:-4px}:host([data-popper-placement^=left]) .arrow{right:-4px}:host([data-popper-placement^=right]) .arrow{left:-4px}.container{position:relative;display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;-ms-flex-pack:start;justify-content:flex-start;overflow:hidden;border-radius:0.25rem;background-color:var(--calcite-ui-foreground-1);padding-top:0.75rem;padding-bottom:0.75rem;padding-left:1rem;padding-right: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-width:20rem;max-height:20rem}.calcite-popper-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)}";
  168. const manager = new TooltipManager();
  169. const Tooltip = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
  170. constructor() {
  171. super();
  172. this.__registerHost();
  173. this.__attachShadow();
  174. /**
  175. * Offset the position of the tooltip away from the reference element.
  176. * @default 6
  177. */
  178. this.offsetDistance = defaultOffsetDistance;
  179. /**
  180. * Offset the position of the tooltip along the reference element.
  181. */
  182. this.offsetSkidding = 0;
  183. /**
  184. * Display and position the component.
  185. */
  186. this.open = false;
  187. /** Describes the type of positioning to use for the overlaid content. If your element is in a fixed container, use the 'fixed' value. */
  188. this.overlayPositioning = "absolute";
  189. /**
  190. * Determines where the component will be positioned relative to the referenceElement.
  191. * @see [PopperPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/popper.ts#L25)
  192. */
  193. this.placement = "auto";
  194. this.guid = `calcite-tooltip-${guid()}`;
  195. // --------------------------------------------------------------------------
  196. //
  197. // Private Methods
  198. //
  199. // --------------------------------------------------------------------------
  200. this.setUpReferenceElement = () => {
  201. this.removeReferences();
  202. this.effectiveReferenceElement = this.getReferenceElement();
  203. const { el, referenceElement, effectiveReferenceElement } = this;
  204. if (referenceElement && !effectiveReferenceElement) {
  205. console.warn(`${el.tagName}: reference-element id "${referenceElement}" was not found.`, {
  206. el
  207. });
  208. }
  209. this.addReferences();
  210. this.createPopper();
  211. };
  212. this.getId = () => {
  213. return this.el.id || this.guid;
  214. };
  215. this.addReferences = () => {
  216. const { effectiveReferenceElement } = this;
  217. if (!effectiveReferenceElement) {
  218. return;
  219. }
  220. const id = this.getId();
  221. effectiveReferenceElement.setAttribute(ARIA_DESCRIBED_BY, id);
  222. manager.registerElement(effectiveReferenceElement, this.el);
  223. };
  224. this.removeReferences = () => {
  225. const { effectiveReferenceElement } = this;
  226. if (!effectiveReferenceElement) {
  227. return;
  228. }
  229. effectiveReferenceElement.removeAttribute(ARIA_DESCRIBED_BY);
  230. manager.unregisterElement(effectiveReferenceElement);
  231. };
  232. }
  233. offsetDistanceOffsetHandler() {
  234. this.reposition();
  235. }
  236. offsetSkiddingHandler() {
  237. this.reposition();
  238. }
  239. openHandler() {
  240. this.reposition();
  241. }
  242. placementHandler() {
  243. this.reposition();
  244. }
  245. referenceElementHandler() {
  246. this.setUpReferenceElement();
  247. }
  248. // --------------------------------------------------------------------------
  249. //
  250. // Lifecycle
  251. //
  252. // --------------------------------------------------------------------------
  253. componentWillLoad() {
  254. this.setUpReferenceElement();
  255. }
  256. componentDidLoad() {
  257. this.reposition();
  258. }
  259. disconnectedCallback() {
  260. this.removeReferences();
  261. this.destroyPopper();
  262. }
  263. // --------------------------------------------------------------------------
  264. //
  265. // Public Methods
  266. //
  267. // --------------------------------------------------------------------------
  268. /** Updates the position of the component. */
  269. async reposition() {
  270. const { popper, el, placement } = this;
  271. const modifiers = this.getModifiers();
  272. popper
  273. ? await updatePopper({
  274. el,
  275. modifiers,
  276. placement,
  277. popper
  278. })
  279. : this.createPopper();
  280. }
  281. getReferenceElement() {
  282. const { referenceElement, el } = this;
  283. return ((typeof referenceElement === "string"
  284. ? queryElementRoots(el, { id: referenceElement })
  285. : referenceElement) || null);
  286. }
  287. getModifiers() {
  288. const { arrowEl, offsetDistance, offsetSkidding } = this;
  289. const arrowModifier = {
  290. name: "arrow",
  291. enabled: true,
  292. options: {
  293. element: arrowEl
  294. }
  295. };
  296. const offsetModifier = {
  297. name: "offset",
  298. enabled: true,
  299. options: {
  300. offset: [offsetSkidding, offsetDistance]
  301. }
  302. };
  303. const eventListenerModifier = {
  304. name: "eventListeners",
  305. enabled: this.open
  306. };
  307. return [arrowModifier, offsetModifier, eventListenerModifier];
  308. }
  309. createPopper() {
  310. this.destroyPopper();
  311. const { el, placement, effectiveReferenceElement: referenceEl, overlayPositioning } = this;
  312. const modifiers = this.getModifiers();
  313. this.popper = createPopper({
  314. el,
  315. modifiers,
  316. placement,
  317. overlayPositioning,
  318. referenceEl
  319. });
  320. }
  321. destroyPopper() {
  322. const { popper } = this;
  323. if (popper) {
  324. popper.destroy();
  325. }
  326. this.popper = null;
  327. }
  328. // --------------------------------------------------------------------------
  329. //
  330. // Render Methods
  331. //
  332. // --------------------------------------------------------------------------
  333. render() {
  334. const { effectiveReferenceElement, label, open } = this;
  335. const displayed = effectiveReferenceElement && open;
  336. const hidden = !displayed;
  337. return (h(Host, { "aria-hidden": toAriaBoolean(hidden), "aria-label": label, "calcite-hydrated-hidden": hidden, id: this.getId(), role: "tooltip" }, h("div", { class: {
  338. [CSS$1.animation]: true,
  339. [CSS$1.animationActive]: displayed
  340. } }, h("div", { class: CSS.arrow, ref: (arrowEl) => (this.arrowEl = arrowEl) }), h("div", { class: CSS.container }, h("slot", null)))));
  341. }
  342. get el() { return this; }
  343. static get watchers() { return {
  344. "offsetDistance": ["offsetDistanceOffsetHandler"],
  345. "offsetSkidding": ["offsetSkiddingHandler"],
  346. "open": ["openHandler"],
  347. "placement": ["placementHandler"],
  348. "referenceElement": ["referenceElementHandler"]
  349. }; }
  350. static get style() { return tooltipCss; }
  351. }, [1, "calcite-tooltip", {
  352. "label": [1],
  353. "offsetDistance": [514, "offset-distance"],
  354. "offsetSkidding": [514, "offset-skidding"],
  355. "open": [516],
  356. "overlayPositioning": [1, "overlay-positioning"],
  357. "placement": [513],
  358. "referenceElement": [1, "reference-element"],
  359. "effectiveReferenceElement": [32],
  360. "reposition": [64]
  361. }]);
  362. function defineCustomElement$1() {
  363. if (typeof customElements === "undefined") {
  364. return;
  365. }
  366. const components = ["calcite-tooltip"];
  367. components.forEach(tagName => { switch (tagName) {
  368. case "calcite-tooltip":
  369. if (!customElements.get(tagName)) {
  370. customElements.define(tagName, Tooltip);
  371. }
  372. break;
  373. } });
  374. }
  375. defineCustomElement$1();
  376. const CalciteTooltip = Tooltip;
  377. const defineCustomElement = defineCustomElement$1;
  378. export { CalciteTooltip, defineCustomElement };