github-mirror/discourse
2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2024-11-22 09:12:45 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

FIX: tooltip is no longer used

Browse Source 
It has been deprecated and now it's time to remove it.
This commit is contained in:
Robin Ward 2020-07-17 14:07:25 -04:00
parent edff796e87
commit 0ecca3a2d2
2 changed files with 0 additions and 169 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

109
app/assets/javascripts/discourse/app/lib/tooltip.js
View File

@ -1,109 +0,0 @@
import deprecated from "discourse-common/lib/deprecated";
import { escapeExpression } from "discourse/lib/utilities";
const fadeSpeed = 300;
const tooltipID = "#discourse-tooltip";
export function showTooltip(e) {
const $this = $(e.currentTarget),
$parent = $this.offsetParent();
// html tooltip are risky try your best to sanitize anything
// displayed as html to avoid XSS attacks
const content = $this.attr("data-tooltip")
? escapeExpression($this.attr("data-tooltip"))
: $this.attr("data-html-tooltip") || "";
const retina =
window.devicePixelRatio && window.devicePixelRatio > 1
? "class='retina'"
: "";
let pos = $this.offset();
const delta = $parent.offset();
pos.top -= delta.top;
pos.left -= delta.left;
hideTooltip();
$this.after(`
<div id="discourse-tooltip" ${retina}>
<div class="tooltip-pointer"></div>
<div class="tooltip-content">${content}</div>
</div>
`);
$(window).on("click.discourse", event => {
if ($(event.target).closest(tooltipID).length === 0) {
$(tooltipID).remove();
$(window).off("click.discourse");
}
return true;
});
const $tooltip = $(tooltipID);
$tooltip.css({ top: 0, left: 0 });
let left = pos.left - $tooltip.width() / 2 + $this.width() / 2;
if (left < 0) {
$tooltip.find(".tooltip-pointer").css({
"margin-left": left * 2 + "px"
});
left = 0;
}
// also do a right margin fix
const parentWidth = $parent.width();
if (left + $tooltip.width() > parentWidth) {
let oldLeft = left;
left = parentWidth - $tooltip.width();
$tooltip.find(".tooltip-pointer").css({
"margin-left": (oldLeft - left) * 2 + "px"
});
}
$tooltip.css({
top: pos.top + 5 + "px",
left: left + "px"
});
$tooltip.fadeIn(fadeSpeed);
return false;
}
export function hideTooltip() {
$(tooltipID)
.fadeOut(fadeSpeed)
.remove();
}
export function registerTooltip(jqueryContext) {
deprecated("tooltip is getting deprecated. Use d-popover instead");
if (jqueryContext.length) {
jqueryContext.off("click").on("click", event => showTooltip(event));
}
}
export function registerHoverTooltip(jqueryContext) {
deprecated("tooltip is getting deprecated. Use d-popover instead");
if (jqueryContext.length) {
jqueryContext
.off("mouseenter mouseleave click")
.on("mouseenter click", showTooltip)
.on("mouseleave", hideTooltip);
}
}
export function unregisterTooltip(jqueryContext) {
if (jqueryContext.length) {
jqueryContext.off("click");
}
}
export function unregisterHoverTooltip(jqueryContext) {
if (jqueryContext.length) {
jqueryContext.off("mouseenter mouseleave click");
}
}

60
test/javascripts/lib/tooltip-test.js
View File

@ -1,60 +0,0 @@
import { registerTooltip, registerHoverTooltip } from "discourse/lib/tooltip";
import { fixture } from "helpers/qunit-helpers";
// prettier-ignore
QUnit.module("lib:tooltip", {
beforeEach() {
fixture().html(
`
<a class='test-text-link' data-tooltip='XSS<s onmouseover\=alert(document.domain)>XSS'>test</a>
<a class='test-html-link' data-html-tooltip='<p>test</p>'>test</a>
`
);
}
});
QUnit.test("text support", async assert => {
const $testTextLink = fixture(".test-text-link");
registerTooltip($testTextLink);
await $testTextLink.click();
assert.equal(
fixture(".tooltip-content")
.html()
.trim(),
"XSS&lt;s onmouseover=alert(document.domain)&gt;XSS",
"it prevents XSS injection"
);
assert.equal(
fixture(".tooltip-content")
.text()
.trim(),
"XSS<s onmouseover=alert(document.domain)>XSS",
"it returns content as plain text"
);
});
QUnit.test("html support", async assert => {
const $testHtmlLink = fixture(".test-html-link");
registerHoverTooltip($testHtmlLink);
await $testHtmlLink.click();
assert.equal(
fixture(".tooltip-content")
.html()
.trim(),
"<p>test</p>",
"it doesn’t escape HTML"
);
assert.equal(
fixture(".tooltip-content")
.text()
.trim(),
"test",
"it returns content as plain text"
);
});