Skip to content

armgit / macro

Public Imported from GitHub
0

Macro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — @-linked together with shared AI memory.

fix(emoji): render only visible rows in the emoji picker (#9389)

Eric Hayesda2e689c7cff
diff --git a/apps/web/AGENTS.md b/apps/web/AGENTS.md
index 9ddd5b1e38..ff935ff001 100644
--- a/apps/web/AGENTS.md
+++ b/apps/web/AGENTS.md
@@ -78,6 +78,11 @@ backend-free phone and tablet regression:
Keep the zoomed image laid out at its zoomed size, translating only: WebKit
rasterizes an `<img>` at its layout size, so a `scale()` transform blurs it.
+The emoji reaction picker renders only the rows in view (about 1,900 emojis
+otherwise); its backend-free regression opens it, scrolls to the last group,
+searches, and picks by keyboard:
+`bunx playwright test --config src/lib/core/component/Emoji/browser-test/playwright.config.ts`.
+
Discussion link scrolling has a backend-free browser regression:
`bunx playwright test --config src/lib/core/messages/browser-test/playwright.config.ts`.
diff --git a/apps/web/src/features/channel/Message/tests/action-menu.test.tsx b/apps/web/src/features/channel/Message/tests/action-menu.test.tsx
index aa025be7f8..012affbe60 100644
--- a/apps/web/src/features/channel/Message/tests/action-menu.test.tsx
+++ b/apps/web/src/features/channel/Message/tests/action-menu.test.tsx
@@ -4,7 +4,7 @@
import type { MessageData } from '@core/messages/types';
import { fireEvent, render } from '@solidjs/testing-library';
-import { describe, expect, it, vi } from 'vitest';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { ActionMenu } from '../ActionMenu';
import { Root } from '../Root';
@@ -18,6 +18,22 @@ const message: MessageData = {
reactions: [],
};
+// The emoji picker's virtual list measures its rows, which jsdom can't.
+beforeEach(() => {
+ vi.stubGlobal(
+ 'ResizeObserver',
+ class {
+ observe() {}
+ unobserve() {}
+ disconnect() {}
+ }
+ );
+});
+
+afterEach(() => {
+ vi.unstubAllGlobals();
+});
+
describe('ActionMenu', () => {
it('mounts only while its message is hovered', () => {
const onPointerEnter = vi.fn();
diff --git a/apps/web/src/lib/core/component/Emoji/EmojiSelector.tsx b/apps/web/src/lib/core/component/Emoji/EmojiSelector.tsx
index 97f0b84f57..a86c6698d0 100644
--- a/apps/web/src/lib/core/component/Emoji/EmojiSelector.tsx
+++ b/apps/web/src/lib/core/component/Emoji/EmojiSelector.tsx
@@ -6,11 +6,13 @@ import {
createSignal,
For,
Match,
+ on,
onCleanup,
onMount,
- Show,
Switch,
} from 'solid-js';
+import { type VirtualizerHandle, VList } from 'virtua/solid';
+import { emojiRows } from './emoji-rows';
import { type SimpleEmoji, useEmojiData } from './emojis';
import { recordEmojiUsage } from './emojiUsage';
@@ -41,72 +43,72 @@ interface EmojiOptionProps {
isSelected: boolean;
}
+function EmojiOption(props: EmojiOptionProps): JSX.Element {
+ return (
+ <button
+ type="button"
+ class={cn(
+ 'hover:bg-hover hover-transition-bg rounded-md p-1 aspect-square w-full flex items-center justify-center',
+ props.isSelected && 'bg-hover'
+ )}
+ style={{ 'container-type': 'inline-size' }}
+ onClick={() => props.onEmojiClick(props.emoji)}
+ title={props.emoji.slug}
+ role="option"
+ aria-selected={props.isSelected}
+ >
+ {renderEmoji(props.emoji.emoji, '90cqi')}
+ </button>
+ );
+}
+
+function validFilter(filter: string | undefined): filter is string {
+ return Boolean(filter && filter.trim().length > 0);
+}
+
export function EmojiSelector(props: EmojiPickerProps): JSX.Element {
const { groups, emojis: filteredEmojis, filter } = useEmojiData();
- let scrollEl!: HTMLDivElement;
-
- const groupOffsets = createMemo(() => {
- let offset = 0;
- return groups().map((group) => {
- const start = offset;
- offset += group.emojis.length;
- return start;
- });
- });
+ const [virtualizer, setVirtualizer] = createSignal<VirtualizerHandle>();
const columns = () => props.columns ?? 6;
+ // Every emoji at once is about 1,900 buttons, enough that some browsers left
+ // the picker blank, so only the rows in view are rendered.
+ const sections = createMemo(() =>
+ validFilter(props.nameFilter)
+ ? [{ name: 'Search Results', emojis: filteredEmojis() }]
+ : groups()
+ );
+ const layout = createMemo(() => emojiRows(sections(), columns()));
+ const flatEmojis = createMemo(() =>
+ sections().flatMap((section) => section.emojis)
+ );
+
const selectEmoji = (emoji: SimpleEmoji) => {
recordEmojiUsage(emoji.emoji);
props.onEmojiClick(emoji);
};
- function EmojiOption(props: EmojiOptionProps): JSX.Element {
- let buttonEl!: HTMLButtonElement;
-
- createEffect(() => {
- if (props.isSelected) {
- buttonEl.scrollIntoView({ block: 'nearest' });
- }
- });
-
- return (
- <button
- ref={buttonEl}
- type="button"
- class={cn(
- 'hover:bg-hover hover-transition-bg rounded-md p-1 aspect-square w-full flex items-center justify-center',
- props.isSelected && 'bg-hover'
- )}
- style={{ 'container-type': 'inline-size' }}
- onClick={() => props.onEmojiClick(props.emoji)}
- title={props.emoji.slug}
- role="option"
- aria-selected={props.isSelected}
- >
- {renderEmoji(props.emoji.emoji, '90cqi')}
- </button>
- );
- }
-
const [selectedIndex, setSelectedIndex] = createSignal(-1);
createEffect(() => {
setSelectedIndex(-1);
if (!props.nameFilter) return;
filter(props.nameFilter);
- scrollEl.scrollTop = 0;
+ virtualizer()?.scrollTo(0);
});
- function validFilter(filter: string | undefined) {
- return filter && filter.trim().length > 0;
- }
+ createEffect(
+ on(selectedIndex, (index) => {
+ const row = layout().rowOfEmoji[index];
+ if (row === undefined) return;
+ virtualizer()?.scrollToIndex(row, { align: 'nearest' });
+ })
+ );
const handleKeyDown = (e: KeyboardEvent) => {
- const emojisToUse = validFilter(props.nameFilter)
- ? filteredEmojis()
- : groups().flatMap((g) => g.emojis);
- if (!emojisToUse || emojisToUse.length === 0) return;
+ const emojisToUse = flatEmojis();
+ if (emojisToUse.length === 0) return;
const totalEmojis = emojisToUse.length;
@@ -162,62 +164,42 @@ export function EmojiSelector(props: EmojiPickerProps): JSX.Element {
});
return (
- <div
- ref={scrollEl}
- class="size-full overflow-y-auto [overflow-anchor:none]"
+ <VList
+ ref={setVirtualizer}
+ data={layout().rows}
+ class="overscroll-none [overflow-anchor:none]"
+ style={{ width: '100%', height: '100%' }}
role="listbox"
aria-label="Emoji Selector"
>
- <Switch>
- <Match
- when={
- !validFilter(props.nameFilter) || filteredEmojis() === undefined
- }
- >
- <For each={groups()}>
- {(group, groupIndex): JSX.Element => (
- <Show when={group.emojis.length > 0}>
- <div class="mt-2 w-full">
- <p class="pl-1 text-ink-extra-muted text-xs">{group.name}</p>
- <div style={gridStyle()}>
- <For each={group.emojis}>
- {(emojiItem, index): JSX.Element => (
- <EmojiOption
- emoji={emojiItem}
- onEmojiClick={selectEmoji}
- isSelected={
- selectedIndex() ===
- groupOffsets()[groupIndex()] + index()
- }
- />
- )}
- </For>
- </div>
- </div>
- </Show>
+ {(row): JSX.Element => (
+ <Switch>
+ <Match when={row.kind === 'header' && row}>
+ {(header) => (
+ <p class="mt-2 pl-1 text-ink-extra-muted text-xs">
+ {header().name}
+ </p>
+ )}
+ </Match>
+ <Match when={row.kind === 'emojis' && row}>
+ {(emojiRow) => (
+ <div style={gridStyle()}>
+ <For each={emojiRow().emojis}>
+ {(emojiItem, index): JSX.Element => (
+ <EmojiOption
+ emoji={emojiItem}
+ onEmojiClick={selectEmoji}
+ isSelected={
+ selectedIndex() === emojiRow().start + index()
+ }
+ />
+ )}
+ </For>
+ </div>
)}
- </For>
- </Match>
- <Match when={filteredEmojis() !== undefined}>
- <div class="mt-2">
- <span class="pl-1 text-ink-extra-muted text-xs">
- Search Results
- </span>
- </div>
-
- <div style={gridStyle()}>
- <For each={filteredEmojis()}>
- {(emojiItem, index): JSX.Element => (
- <EmojiOption
- emoji={emojiItem}
- onEmojiClick={selectEmoji}
- isSelected={selectedIndex() === index()}
- />
- )}
- </For>
- </div>
- </Match>
- </Switch>
- </div>
+ </Match>
+ </Switch>
+ )}
+ </VList>
);
}
diff --git a/apps/web/src/lib/core/component/Emoji/browser-test/emoji-picker.browser.e2e.ts b/apps/web/src/lib/core/component/Emoji/browser-test/emoji-picker.browser.e2e.ts
new file mode 100644
index 0000000000..57184f7fe2
--- /dev/null
+++ b/apps/web/src/lib/core/component/Emoji/browser-test/emoji-picker.browser.e2e.ts
@@ -0,0 +1,62 @@
+import { expect, type Page, test } from '@playwright/test';
+
+const fixture = '/src/lib/core/component/Emoji/browser-test/emoji-picker.html';
+
+async function openPicker(page: Page) {
+ await page.goto(fixture);
+ await page.getByRole('button', { name: 'React' }).click();
+ const picker = page.getByRole('listbox', { name: 'Emoji Selector' });
+ await expect(picker.getByRole('option').first()).toBeVisible({
+ timeout: 30_000,
+ });
+ return picker;
+}
+
+test('opens with emojis on screen and renders only the rows in view', async ({
+ page,
+}) => {
+ const picker = await openPicker(page);
+
+ await expect(picker.getByText('Smileys & Emotion')).toBeVisible();
+ await expect(picker.getByRole('option', { name: '😀' })).toBeVisible();
+ // The catalog has about 1,900 emojis; a virtual list mounts a few rows.
+ expect(await picker.getByRole('option').count()).toBeLessThan(300);
+});
+
+test('scrolling reaches the last group', async ({ page }) => {
+ const picker = await openPicker(page);
+ const zimbabwe = picker.getByRole('option', { name: '🇿🇼' });
+
+ // Rows are measured as they mount, so the end moves until it settles.
+ await expect(async () => {
+ await picker.evaluate((el) => {
+ el.scrollTop = el.scrollHeight;
+ });
+ await expect(zimbabwe).toBeVisible({ timeout: 500 });
+ }).toPass();
+});
+
+test('search shows matches and a click picks one', async ({ page }) => {
+ const picker = await openPicker(page);
+
+ await page.getByRole('searchbox', { name: 'Search emojis' }).fill('rocket');
+ await expect(picker.getByText('Search Results')).toBeVisible();
+ await picker.getByRole('option', { name: '🚀' }).first().click();
+
+ await expect(page.getByTestId('picked')).toHaveText('🚀');
+});
+
+test('arrow keys scroll the selection into view and Enter picks it', async ({
+ page,
+}) => {
+ const picker = await openPicker(page);
+
+ await page.keyboard.press('ArrowUp');
+ const selected = picker.locator('[aria-selected="true"]');
+ await expect(selected).toBeVisible();
+ const last = await selected.getAttribute('title');
+ await page.keyboard.press('Enter');
+
+ await expect(page.getByTestId('picked')).not.toHaveText('');
+ expect(last).toBeTruthy();
+});
diff --git a/apps/web/src/lib/core/component/Emoji/browser-test/emoji-picker.html b/apps/web/src/lib/core/component/Emoji/browser-test/emoji-picker.html
new file mode 100644
index 0000000000..6237e6d662
--- /dev/null
+++ b/apps/web/src/lib/core/component/Emoji/browser-test/emoji-picker.html
@@ -0,0 +1,5 @@
+<!doctype html>
+<html lang="en">
+ <head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1"><title>Emoji picker fixture</title></head>
+ <body><div id="root"></div><script type="module" src="./emoji-picker.tsx"></script></body>
+</html>
diff --git a/apps/web/src/lib/core/component/Emoji/browser-test/emoji-picker.tsx b/apps/web/src/lib/core/component/Emoji/browser-test/emoji-picker.tsx
new file mode 100644
index 0000000000..90e98dd551
--- /dev/null
+++ b/apps/web/src/lib/core/component/Emoji/browser-test/emoji-picker.tsx
@@ -0,0 +1,24 @@
+import '@app/index.css';
+import { EmojiReactionPopover } from '@app/features/channel/Message/EmojiReactionPopover';
+import { createSignal } from 'solid-js';
+import { render } from 'solid-js/web';
+
+function Fixture() {
+ const [open, setOpen] = createSignal(false);
+ const [picked, setPicked] = createSignal('');
+ return (
+ <div class="p-40">
+ <EmojiReactionPopover
+ open={open()}
+ onOpenChange={setOpen}
+ onEmojiSelect={setPicked}
+ placement="bottom"
+ trigger={<span>React</span>}
+ />
+ <output data-testid="picked">{picked()}</output>
+ </div>
+ );
+}
+
+const root = document.getElementById('root');
+if (root) render(() => <Fixture />, root);
diff --git a/apps/web/src/lib/core/component/Emoji/browser-test/playwright.config.ts b/apps/web/src/lib/core/component/Emoji/browser-test/playwright.config.ts
new file mode 100644
index 0000000000..6e2e94a614
--- /dev/null
+++ b/apps/web/src/lib/core/component/Emoji/browser-test/playwright.config.ts
@@ -0,0 +1,39 @@
+import { fileURLToPath } from 'node:url';
+import { defineConfig } from '@playwright/test';
+
+const webDirectory = fileURLToPath(
+ new URL('../../../../../../', import.meta.url)
+);
+const port = process.env.EMOJI_PICKER_TEST_PORT ?? '3052';
+
+export default defineConfig({
+ testDir: fileURLToPath(new URL('.', import.meta.url)),
+ testMatch: '*.browser.e2e.ts',
+ workers: 1,
+ timeout: 60_000,
+ use: {
+ baseURL: `http://localhost:${port}`,
+ headless: true,
+ launchOptions: {
+ executablePath: process.env.PLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH,
+ },
+ },
+ projects: [
+ { name: 'desktop', use: { viewport: { width: 1280, height: 900 } } },
+ {
+ name: 'phone',
+ use: {
+ viewport: { width: 390, height: 844 },
+ hasTouch: true,
+ isMobile: true,
+ },
+ },
+ ],
+ webServer: {
+ command: `MACRO_DEV_HTTPS=false bunx vite --port ${port} --strictPort`,
+ cwd: webDirectory,
+ url: `http://localhost:${port}/app/`,
+ reuseExistingServer: false,
+ timeout: 60_000,
+ },
+});
diff --git a/apps/web/src/lib/core/component/Emoji/emoji-rows.test.ts b/apps/web/src/lib/core/component/Emoji/emoji-rows.test.ts
new file mode 100644
index 0000000000..7d6ee8aa8e
--- /dev/null
+++ b/apps/web/src/lib/core/component/Emoji/emoji-rows.test.ts
@@ -0,0 +1,60 @@
+import { describe, expect, it } from 'vitest';
+import type { SimpleEmoji } from './emoji-catalog';
+import { emojiRows } from './emoji-rows';
+
+const emoji = (char: string): SimpleEmoji => ({
+ emoji: char,
+ slug: char,
+ shortcodes: [char],
+ terms: [],
+});
+
+describe('emojiRows', () => {
+ it('puts each section name above its emojis, a row per `columns`', () => {
+ const { rows } = emojiRows(
+ [
+ { name: 'Frequently used', emojis: ['a', 'b', 'c'].map(emoji) },
+ { name: 'Smileys', emojis: ['d', 'e'].map(emoji) },
+ ],
+ 2
+ );
+
+ expect(
+ rows.map((row) =>
+ row.kind === 'header'
+ ? row.name
+ : `${row.start}:${row.emojis.map(({ emoji }) => emoji).join('')}`
+ )
+ ).toEqual(['Frequently used', '0:ab', '2:c', 'Smileys', '3:de']);
+ });
+
+ it('skips empty sections', () => {
+ const { rows } = emojiRows(
+ [
+ { name: 'Frequently used', emojis: [] },
+ { name: 'Smileys', emojis: [emoji('a')] },
+ ],
+ 6
+ );
+
+ expect(rows.map((row) => row.kind)).toEqual(['header', 'emojis']);
+ });
+
+ it('maps every emoji to the row that shows it', () => {
+ const { rows, rowOfEmoji } = emojiRows(
+ [
+ { name: 'One', emojis: ['a', 'b', 'c'].map(emoji) },
+ { name: 'Two', emojis: ['d'].map(emoji) },
+ ],
+ 2
+ );
+
+ expect(rowOfEmoji).toEqual([1, 1, 2, 4]);
+ for (const [index, row] of rowOfEmoji.entries()) {
+ const shown = rows[row];
+ expect(shown.kind).toBe('emojis');
+ if (shown.kind !== 'emojis') continue;
+ expect(index - shown.start).toBeLessThan(shown.emojis.length);
+ }
+ });
+});
diff --git a/apps/web/src/lib/core/component/Emoji/emoji-rows.ts b/apps/web/src/lib/core/component/Emoji/emoji-rows.ts
new file mode 100644
index 0000000000..2f8dcc7a5e
--- /dev/null
+++ b/apps/web/src/lib/core/component/Emoji/emoji-rows.ts
@@ -0,0 +1,32 @@
+import type { SimpleEmoji } from './emoji-catalog';
+
+export type EmojiRow =
+ | { kind: 'header'; name: string }
+ /** `start` is the first emoji's index across every section. */
+ | { kind: 'emojis'; emojis: SimpleEmoji[]; start: number };
+
+/**
+ * Lays the picker's sections out as rows for its virtual list: each non-empty
+ * section's name, then its emojis `columns` to a row. `rowOfEmoji` maps an
+ * emoji's index across every section to its row, for scrolling the keyboard
+ * selection into view.
+ */
+export function emojiRows(
+ sections: readonly { name: string; emojis: readonly SimpleEmoji[] }[],
+ columns: number
+): { rows: EmojiRow[]; rowOfEmoji: number[] } {
+ const rows: EmojiRow[] = [];
+ const rowOfEmoji: number[] = [];
+ let start = 0;
+ for (const { name, emojis } of sections) {
+ if (emojis.length === 0) continue;
+ rows.push({ kind: 'header', name });
+ for (let offset = 0; offset < emojis.length; offset += columns) {
+ const row = emojis.slice(offset, offset + columns);
+ for (let i = 0; i < row.length; i++) rowOfEmoji.push(rows.length);
+ rows.push({ kind: 'emojis', emojis: row, start: start + offset });
+ }
+ start += emojis.length;
+ }
+ return { rows, rowOfEmoji };
+}