|
| 1 | +import $ from "jquery"; |
| 2 | +import theOneLocalizationManager from "../../lib/localizationManager/localizationManager"; |
| 3 | + |
| 4 | +const kTooltipTargetClass = "bloom-page-tooltip-target"; |
| 5 | +const kGutterTargetClass = "bloom-gutter-tooltip-target"; |
| 6 | +const kGutterLeftClass = "bloom-gutter-target-side-left"; |
| 7 | +const kGutterRightClass = "bloom-gutter-target-side-right"; |
| 8 | +const kTooltipTextAttribute = "data-bloom-page-tooltip-text"; |
| 9 | +const kTooltipBubbleClass = "bloom-page-tooltip"; |
| 10 | +const kTooltipUiMarkerAttribute = "data-bloom-ui"; |
| 11 | +const kTooltipUiMarkerValue = "page-hover-tooltip"; |
| 12 | +const kDefaultGutterTooltipText = |
| 13 | + "Page Gutter: space for staples or other binding."; |
| 14 | + |
| 15 | +let pageHoverTooltip: JQuery | undefined; |
| 16 | +let gutterTooltipText = kDefaultGutterTooltipText; |
| 17 | +let formatDialogTitleTooltipText = "Format"; |
| 18 | +let activeTooltipText: string | undefined; |
| 19 | +let tooltipLocalizationInitialized = false; |
| 20 | + |
| 21 | +interface MousePositionEvent { |
| 22 | + clientX: number; |
| 23 | + clientY: number; |
| 24 | +} |
| 25 | + |
| 26 | +// This module supports tooltips for page editing regions that may not have their own interactive DOM elements. |
| 27 | +// For those cases, we create temporary "target" elements (class bloom-page-tooltip-target) and position |
| 28 | +// them over the page region (currently, the paper gutter). These targets all get the bloom-ui class so they |
| 29 | +// are treated as edit-time markup. Also, when saving, bloomEditing.ts uses |
| 30 | +// getBodyInnerHtmlWithoutPageHoverTooltips() so these temporary elements are removed from the HTML that is |
| 31 | +// written to disk, even though they remain available in the live editing DOM. |
| 32 | + |
| 33 | +function hidePageHoverTooltip(): void { |
| 34 | + activeTooltipText = undefined; |
| 35 | + pageHoverTooltip?.hide(); |
| 36 | +} |
| 37 | + |
| 38 | +function ensurePageHoverTooltipBubble(): void { |
| 39 | + if (pageHoverTooltip) { |
| 40 | + return; |
| 41 | + } |
| 42 | + |
| 43 | + pageHoverTooltip = $(`<div class='bloom-ui ${kTooltipBubbleClass}'></div>`); |
| 44 | + pageHoverTooltip.attr(kTooltipUiMarkerAttribute, kTooltipUiMarkerValue); |
| 45 | + pageHoverTooltip.text(gutterTooltipText); |
| 46 | + $("body").append(pageHoverTooltip); |
| 47 | +} |
| 48 | + |
| 49 | +function removeTooltipTargets(): void { |
| 50 | + $(`.${kTooltipTargetClass}`).remove(); |
| 51 | +} |
| 52 | + |
| 53 | +function makeTooltipTarget( |
| 54 | + page: HTMLElement, |
| 55 | + extraClasses: string[], |
| 56 | + tooltipText: string, |
| 57 | +): void { |
| 58 | + const target = document.createElement("div"); |
| 59 | + target.classList.add("bloom-ui", kTooltipTargetClass, ...extraClasses); |
| 60 | + target.setAttribute(kTooltipTextAttribute, tooltipText); |
| 61 | + target.setAttribute(kTooltipUiMarkerAttribute, kTooltipUiMarkerValue); |
| 62 | + page.appendChild(target); |
| 63 | +} |
| 64 | + |
| 65 | +function addGutterTooltipTargets(): void { |
| 66 | + document.querySelectorAll("div.bloom-page").forEach((pageElement) => { |
| 67 | + const page = pageElement as HTMLElement; |
| 68 | + if ( |
| 69 | + page.classList.contains("outsideFrontCover") || |
| 70 | + page.classList.contains("outsideBackCover") |
| 71 | + ) { |
| 72 | + return; |
| 73 | + } |
| 74 | + |
| 75 | + if (page.classList.contains("side-left")) { |
| 76 | + makeTooltipTarget( |
| 77 | + page, |
| 78 | + [kGutterTargetClass, kGutterLeftClass], |
| 79 | + gutterTooltipText, |
| 80 | + ); |
| 81 | + return; |
| 82 | + } |
| 83 | + |
| 84 | + if (page.classList.contains("side-right")) { |
| 85 | + makeTooltipTarget( |
| 86 | + page, |
| 87 | + [kGutterTargetClass, kGutterRightClass], |
| 88 | + gutterTooltipText, |
| 89 | + ); |
| 90 | + } |
| 91 | + }); |
| 92 | +} |
| 93 | + |
| 94 | +function updateGutterTooltipTexts(): void { |
| 95 | + document |
| 96 | + .querySelectorAll(`.${kGutterTargetClass}`) |
| 97 | + .forEach((targetElement) => { |
| 98 | + targetElement.setAttribute( |
| 99 | + kTooltipTextAttribute, |
| 100 | + gutterTooltipText, |
| 101 | + ); |
| 102 | + }); |
| 103 | +} |
| 104 | + |
| 105 | +function getTooltipTextForTarget(target: HTMLElement): string | undefined { |
| 106 | + if (target.id === "formatButton") { |
| 107 | + return formatDialogTitleTooltipText; |
| 108 | + } |
| 109 | + |
| 110 | + const value = target.getAttribute(kTooltipTextAttribute); |
| 111 | + return value || undefined; |
| 112 | +} |
| 113 | + |
| 114 | +function setActiveTooltipText(tooltipText: string | undefined): void { |
| 115 | + activeTooltipText = tooltipText; |
| 116 | + if (!activeTooltipText) { |
| 117 | + hidePageHoverTooltip(); |
| 118 | + return; |
| 119 | + } |
| 120 | + |
| 121 | + pageHoverTooltip?.text(activeTooltipText).show(); |
| 122 | +} |
| 123 | + |
| 124 | +function moveTooltipBubble(event: MousePositionEvent): void { |
| 125 | + if (!activeTooltipText) { |
| 126 | + return; |
| 127 | + } |
| 128 | + |
| 129 | + pageHoverTooltip?.css({ |
| 130 | + left: event.clientX + 12, |
| 131 | + top: event.clientY + 12, |
| 132 | + }); |
| 133 | +} |
| 134 | + |
| 135 | +function setupTooltipLocalization(): void { |
| 136 | + if (tooltipLocalizationInitialized) { |
| 137 | + return; |
| 138 | + } |
| 139 | + |
| 140 | + tooltipLocalizationInitialized = true; |
| 141 | + |
| 142 | + theOneLocalizationManager |
| 143 | + .asyncGetText("EditTab.Tooltip.Gutter", kDefaultGutterTooltipText, "") |
| 144 | + .done((result) => { |
| 145 | + gutterTooltipText = result; |
| 146 | + updateGutterTooltipTexts(); |
| 147 | + }); |
| 148 | + |
| 149 | + theOneLocalizationManager |
| 150 | + .asyncGetText("EditTab.FormatDialog.Format", "Format", "") |
| 151 | + .done((result) => { |
| 152 | + formatDialogTitleTooltipText = result; |
| 153 | + }); |
| 154 | +} |
| 155 | + |
| 156 | +export function setupPageHoverTooltips(): void { |
| 157 | + ensurePageHoverTooltipBubble(); |
| 158 | + removeTooltipTargets(); |
| 159 | + addGutterTooltipTargets(); |
| 160 | + setupTooltipLocalization(); |
| 161 | + |
| 162 | + $(document) |
| 163 | + .off("mouseenter.bloomPageTooltip") |
| 164 | + .on( |
| 165 | + "mouseenter.bloomPageTooltip", |
| 166 | + `.${kTooltipTargetClass}, #formatButton`, |
| 167 | + function (e) { |
| 168 | + const target = this as HTMLElement; |
| 169 | + setActiveTooltipText(getTooltipTextForTarget(target)); |
| 170 | + moveTooltipBubble(e as unknown as MousePositionEvent); |
| 171 | + }, |
| 172 | + ) |
| 173 | + .off("mousemove.bloomPageTooltip") |
| 174 | + .on("mousemove.bloomPageTooltip", function (e) { |
| 175 | + moveTooltipBubble(e as unknown as MousePositionEvent); |
| 176 | + }) |
| 177 | + .off("mouseleave.bloomPageTooltip") |
| 178 | + .on( |
| 179 | + "mouseleave.bloomPageTooltip", |
| 180 | + `.${kTooltipTargetClass}, #formatButton`, |
| 181 | + () => { |
| 182 | + setActiveTooltipText(undefined); |
| 183 | + }, |
| 184 | + ); |
| 185 | +} |
| 186 | + |
| 187 | +export function cleanupPageHoverTooltips(): void { |
| 188 | + hidePageHoverTooltip(); |
| 189 | + $(document).off(".bloomPageTooltip"); |
| 190 | + removeTooltipTargets(); |
| 191 | + pageHoverTooltip?.remove(); |
| 192 | + pageHoverTooltip = undefined; |
| 193 | +} |
| 194 | + |
| 195 | +function removePageHoverTooltipMarkupFrom(root: ParentNode): void { |
| 196 | + root.querySelectorAll( |
| 197 | + `[${kTooltipUiMarkerAttribute}="${kTooltipUiMarkerValue}"]`, |
| 198 | + ).forEach((element) => { |
| 199 | + element.remove(); |
| 200 | + }); |
| 201 | +} |
| 202 | + |
| 203 | +export function getBodyInnerHtmlWithoutPageHoverTooltips(): string { |
| 204 | + const bodyClone = document.body.cloneNode(true) as HTMLElement; |
| 205 | + removePageHoverTooltipMarkupFrom(bodyClone); |
| 206 | + return bodyClone.innerHTML; |
| 207 | +} |
0 commit comments