Skip to content

armgit / zulip

Public Imported from GitHub
0

Zulip server and web application. Open-source team chat that helps teams stay productive and focused.

tooltips: Show the enlarged emoji preview for user status emoji.

Aadyot15e11432a902a
diff --git a/web/src/emoji_tooltip.ts b/web/src/emoji_tooltip.ts
index 7aeb9c2b41f..3104a8532bf 100644
--- a/web/src/emoji_tooltip.ts
+++ b/web/src/emoji_tooltip.ts
@@ -7,10 +7,14 @@ import {parse_html} from "./ui_util.ts";
// Reads the canonical `:name:` an emoji carries in the DOM, so we
// never rebuild it from the human-friendly `title` (which has spaces,
-// not underscores): custom emoji (<img>) use `alt` and Unicode emoji
-// (<span>) use their text content.
+// not underscores): custom emoji (<img>) use `alt`, Unicode emoji
+// (<span>) use their text content, status emoji use `data-tippy-content`.
export function get_canonical_emoji_name(emoji_element: Element): string | undefined {
- const raw = emoji_element.getAttribute("alt") ?? emoji_element.textContent ?? "";
+ const raw =
+ emoji_element.getAttribute("alt") ??
+ emoji_element.getAttribute("data-tippy-content") ??
+ emoji_element.textContent ??
+ "";
if (raw.startsWith(":") && raw.endsWith(":") && raw.length > 2) {
return raw.slice(1, -1);
}
@@ -33,6 +37,10 @@ export function build_emoji_tooltip_content(
// can't show a tooltip of its own inside this one.
enlarged_emoji.removeAttribute("title");
enlarged_emoji.removeAttribute("aria-label");
+ // Status emoji keep their tooltip in data-tippy-content, and layout
+ // classes for sitting beside a name; neither suits the copy.
+ enlarged_emoji.removeAttribute("data-tippy-content");
+ enlarged_emoji.classList.remove("status-emoji", "status-emoji-name");
enlarged_emoji.classList.add("emoji-tooltip-enlarged");
const fragment = parse_html(render_emoji_tooltip({emoji_name}));
diff --git a/web/src/tippyjs.ts b/web/src/tippyjs.ts
index d25c9b46dba..f3f90bafb60 100644
--- a/web/src/tippyjs.ts
+++ b/web/src/tippyjs.ts
@@ -695,7 +695,7 @@ export function initialize(): void {
tippy.delegate("body", {
target: ".status-emoji-name:not(.typeahead-item .status-emoji-name)",
placement: "top",
- delay: INSTANT_HOVER_DELAY,
+ delay: LONG_HOVER_DELAY,
appendTo: () => document.body,
/*
@@ -707,6 +707,7 @@ export function initialize(): void {
*/
plugins: [hide_on_reference_removal_plugin],
+ onShow: show_emoji_tooltip,
onHidden(instance) {
instance.destroy();
},
diff --git a/web/tests/emoji_tooltip.test.cjs b/web/tests/emoji_tooltip.test.cjs
index 71743fa2a08..36868260c1c 100644
--- a/web/tests/emoji_tooltip.test.cjs
+++ b/web/tests/emoji_tooltip.test.cjs
@@ -4,6 +4,8 @@ const assert = require("node:assert/strict");
const {JSDOM} = require("jsdom");
+const render_status_emoji = require("../templates/status_emoji.hbs");
+
const {set_global, zrequire} = require("./lib/namespace.cjs");
const {run_test} = require("./lib/test.cjs");
@@ -45,6 +47,14 @@ function render_message_emoji(raw_content) {
return emoji_element;
}
+function render_status_emoji_element(status_emoji_info) {
+ const container = document.createElement("div");
+ container.innerHTML = render_status_emoji(status_emoji_info);
+ const emoji_element = container.querySelector(".status-emoji-name");
+ assert.ok(emoji_element !== null);
+ return emoji_element;
+}
+
run_test("get_canonical_emoji_name reads the name from the DOM", () => {
assert.equal(
emoji_tooltip.get_canonical_emoji_name(render_message_emoji(":heart_eyes:")),
@@ -56,6 +66,19 @@ run_test("get_canonical_emoji_name reads the name from the DOM", () => {
assert.equal(custom_emoji.getAttribute("title"), "green tick");
assert.equal(emoji_tooltip.get_canonical_emoji_name(custom_emoji), "green_tick");
+ // Status emoji carry the name only in `data-tippy-content`.
+ const unicode_status_emoji = render_status_emoji_element(
+ emoji.get_emoji_details_by_name("working_on_it"),
+ );
+ assert.equal(emoji_tooltip.get_canonical_emoji_name(unicode_status_emoji), "working_on_it");
+
+ const custom_status_emoji = render_status_emoji_element(
+ emoji.get_emoji_details_by_name("green_tick"),
+ );
+ assert.equal(custom_status_emoji.nodeName, "IMG");
+ assert.equal(custom_status_emoji.getAttribute("alt"), null);
+ assert.equal(emoji_tooltip.get_canonical_emoji_name(custom_status_emoji), "green_tick");
+
// Nothing we render omits the `:name:`, so build that case by hand.
const unnamed_emoji = document.createElement("span");
unnamed_emoji.classList.add("emoji");
@@ -84,6 +107,20 @@ run_test("build_emoji_tooltip_content renders an enlarged copy and :name:", () =
assert.equal(enlarged_emoji.getAttribute("aria-label"), null);
});
+run_test("build_emoji_tooltip_content strips status-emoji layout from the copy", () => {
+ const fragment = emoji_tooltip.build_emoji_tooltip_content(
+ render_status_emoji_element(emoji.get_emoji_details_by_name("working_on_it")),
+ "working_on_it",
+ );
+
+ const emoji_container = fragment.querySelector(".emoji-tooltip-emoji");
+ const enlarged_emoji = emoji_container.querySelector("span");
+ assert.ok(enlarged_emoji !== null);
+ assert.ok(!enlarged_emoji.classList.contains("status-emoji"));
+ assert.ok(!enlarged_emoji.classList.contains("status-emoji-name"));
+ assert.equal(enlarged_emoji.getAttribute("data-tippy-content"), null);
+});
+
run_test("build_emoji_tooltip_content does not mutate the original element", () => {
const emoji_element = render_message_emoji(":green_tick:");