Skip to content

JaydenYoonZK/whmcs-emoji-compatibility-guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

100 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WHMCS Emoji Compatibility Guide ✅

A searchable, conservative emoji shortlist for testing in WHMCS product names, email templates, and knowledge base articles. Runs entirely in your browser.

Open the live guide CI status MIT License

WHMCS Emoji Guide shown in light and dark themes, the hero with its illustration of an emoji that survives a product name and one that breaks

Open the live guide or jump to a search demo. Nothing is tracked or uploaded.

The problem

Emoji compatibility depends on storage, the WHMCS connection and filtering settings, fonts, templates, and mail clients. MySQL's three-byte UTF-8 character set stores Basic Multilingual Plane code points but not supplementary-plane characters used by most modern emoji. WHMCS documents utf8mb4 requirements for extended characters, while Unicode documents additional rendering behavior for variation, keycap, modifier, flag, and ZWJ sequences.

What this is

  • A 179-entry conservative shortlist drawn from older Unicode ranges. Every entry uses Basic Multilingual Plane code points, and the profile excludes ZWJ sequences, skin tone modifiers, regional flags, and supplementary-plane characters.
  • A smart copy board: search by name (heart), concept (love, danger, zodiac), or color (red, green), with typo tolerance (hart, chekc) and did-you-mean suggestions. Filter by category and click to copy. All in your browser, nothing sent anywhere.
  • A machine-readable dataset in JSON and CSV, enriched with Unicode CLDR keywords plus a curated color and concept layer. The JSON declares the compatibility profile; the CSV adds code points and sequence types.
  • Curated copy groups for hosting, billing, support, and security copy, using only emoji already in the conservative shortlist.
  • Plain-language notes on why emoji break in WHMCS and what tends to work.

Use it

No install: jaydenyoonzk.github.io/whmcs-emoji-compatibility-guide

It works offline once the page has loaded. Run locally:

git clone https://github.com/JaydenYoonZK/whmcs-emoji-compatibility-guide.git
cd whmcs-emoji-compatibility-guide
npm run serve   # http://localhost:8441

Tests

npm test

26 tests cover ranked search, punctuation, multi-term matching, typo suggestions, glyph lookups with and without variation selectors, bounded inputs, dataset-profile integrity, CSV export integrity, and curated copy groups.

Data contract

The JSON schema is version 4. compatibilityProfile records what the shortlist excludes and states that inclusion is a starting point, not a compatibility guarantee. The generated CSV labels entries usually_safer and includes sequence_type and code_points columns. Run npm run export:csv after any JSON change.

Usually safer vs often unsupported

Usually safer Often unsupported
Basic symbols and older Unicode emoji Country flags
Simple single-code-point emoji New emoji from recent Unicode releases
Emoji without skin tone modifiers Skin tone variations
Emoji without gender or family combinations Complex zero-width-joiner sequences

Even a safer emoji is worth a real test in your own stack before it goes into a billing-critical or support-critical message.

Sources

Contributing

Real test reports are the most valuable contribution. If an emoji works or breaks in your setup, open an emoji report with the emoji, your WHMCS and PHP versions, your database charset, and where you tested it. See CONTRIBUTING.md.

Screenshots are especially useful. Please redact customer names, domains, invoice numbers, and private ticket text before posting them, then include the WHMCS location where the emoji broke and whether the database uses utf8 or utf8mb4.

License

MIT. Built and maintained by Jayden Yoon ZK. Part of a small-business web toolkit alongside WP Serial Fix, WP Config Doctor, and WP Plugin Checkup.

About

A searchable, conservative emoji shortlist for testing in WHMCS product names, emails, and knowledge base articles. Runs in your browser.

Topics

Resources

License

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Sponsor this project

 

Packages

 
 
 

Contributors