Emoji reactions native picker for notes#78129
Merged
adamsilverstein merged 5 commits intoMay 11, 2026
Merged
Conversation
Build the full emoji picker from WordPress components (SearchControl
+ Composite) instead of pulling in Frimousse, while still sourcing
emoji data from Emojibase. The previous implementation showed all UI
chrome in English regardless of the site language because Frimousse
draws its strings from Emojibase's .po files, which are not on
GlotPress and don't cover every WordPress locale.
The new picker:
- Uses __() for all UI chrome strings ("Search emoji", "Loading…",
"No emoji found.") so GlotPress can translate them for every
WordPress locale.
- Detects the site language from `<html lang>` and fetches the
matching Emojibase locale (28 supported), falling back to English
for locales Emojibase doesn't translate. Emoji labels and category
names come from those per-locale data.json/messages.json files.
- Ships all 28 Emojibase locales via build/emojibase-data/; only the
active locale is fetched per editor session (~85KB gzipped).
- Drops the frimousse npm dependency.
Replicates Frimousse's surface: search, sticky-header categorized
grid, 8-column layout, loading/empty states, keyboard navigation
(via Composite). All 38 block-notes E2E tests pass against the new
picker.
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Warning: Type of PR label mismatch To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.
Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task. |
|
Size Change: 0 B Total Size: 7.83 MB ℹ️ View Unchanged
|
Lets sites and plugins translate per-emoji labels for locales the upstream Emojibase dataset has not translated yet, without taking on the burden of a full ~5,700-string overlay through GlotPress. Seeded with the curated reaction emojis (Heart, Celebration, Smile, Eyes, Rocket) so the full picker shows the same translated label as the curated quick-row in any WordPress locale — closes a small UX gap where the curated five fell back to the Emojibase English label in the full picker even when the curated row showed a translation. The PHP filter accepts a `hexcode => label` map keyed by uppercase Emojibase hex codes (with U+FE0F stripped). The JS picker reads it from `window.gutenbergEmojiLabelOverrides`, applies the override to the rendered label and accessible name, and includes both the override and the original Emojibase label in search matches so a user typing either spelling still finds the emoji.
- 20 Jest tests cover the four pure helpers exported from emoji-picker.js: locale resolution (with the Traditional Chinese-variant special case), category bucketing, row chunking, and search (label, tag, override, both-match, empty-state). - 7 PHPUnit tests cover gutenberg_emoji_to_hexcode (basic codepoints, VS-16 stripping, ZWJ sequences, invalid input) and the gutenberg_emoji_picker_label_overrides filter (default seeding, extension, full replacement). - Adds an E2E test for the search empty state path the existing suite did not exercise. Also fixes resolveEmojibaseLocale: the Traditional Chinese variants special case now runs before the language-portion fallback so zh-TW / zh-HK / zh-MO actually map to zh-hant instead of being swallowed by the supported zh locale.
Two follow-ups from review on the picker swap: - gutenberg_emoji_picker_label_overrides now drops non-string values and coerces a non-array filter return to an empty array. Prevents a misbehaving plugin filter from crashing the picker's JS-side label.toLowerCase() call. Two PHPUnit tests pin the new behavior. - EMOJIBASE_LOCALES is now exported from emoji-picker.js, and a Jest test asserts it stays in sync with the parallel LOCALES array in bin/copy-emojibase-data.mjs. Catches drift in either direction at test time instead of as a broken picker at runtime.
The PR removed frimousse from packages/editor/package.json but the lockfile still pinned it. CI's check-local-changes step caught the divergence and failed Static Analysis. Re-running 'npm install' removes the orphaned 'node_modules/frimousse' subtree and the 'frimousse' peer pin under @wordpress/editor.
96ad388
into
add-notes-emoji-reactions-try-addditional-comment-type
30 of 31 checks passed
16 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Alternative to #76767 that drops the Frimousse dependency and builds the full emoji picker from existing WordPress components. Same UX, same Emojibase data, full GlotPress translation coverage for the chrome.
This PR is opened against the Frimousse branch so the diff highlights only the picker swap. Easy to compare: same feature, two implementations.
Why
Per @t-hamano's review on #76767: Frimousse's UI text comes from Emojibase's
.pofiles, which aren't on GlotPress and don't cover every WordPress locale. Users on locales Emojibase doesn't translate would see chrome strings in English.What changed
frimoussenpm packageSearchControl+Compositefrom@wordpress/componentsSearch emoji,Loading…,No emoji found.)__()→ GlotPress, every WP locale<html lang>frimoussedependencybuild/emojibase-data/en/build/emojibase-data/{28 locales}/Per-session network cost stays at one locale (~85KB gzipped), only fetched when the user opens the + picker for the first time in a session.
Architecture
packages/editor/src/components/collab-sidebar/emoji-picker.js(new):resolveEmojibaseLocale()maps a BCP-47 / WordPress locale string (pt-BR,fr_FR,zh-TW) to the closest of Emojibase's 28 locales, falling back toen.useEmojibaseData(baseUrl, locale)fetchesdata.json+messages.jsononce per locale, with module-level cache and abort-on-unmount.<EmojiPicker>rendersSearchControlover aCompositegrid grouped by Emojibase category, with sticky headers andcontent-visibility: autoper-row so all ~1949 emojis render quickly.The PHP shim (
lib/compat/wordpress-7.1/emojibase-data.php) and thewindow.gutenbergEmojibaseUrlmechanism are unchanged.Tradeoffs
Pros
packages/editor/, no new build steps.Cons
build/emojibase-data/(still ~7MB on disk, none of it shipped to the browser per session).content-visibility: auto. Acceptable for ~250 rows; can revisit if it shows up in profiles.Test plan
npm run test:e2e -- test/e2e/specs/editor/various/block-notes.spec.js)lint:jscleannpm run buildclean; copy script populates 28 locale directoriesComparison
Reviewers who want to A/B the implementations:
add-notes-emoji-reactions-try-addditional-comment-type(PR Notes: Add emoji reactions - stored as custom comment type #76767)The diff between them is exactly the contents of this PR.