Grapheme

Last updated on by

Grapheme image

In terminal-based applications, accurately determining the display width of Unicode characters is essential for proper text alignment and formatting. However, handling modern Unicode text presents challenges:

  • Emoji and East Asian (CJK) characters often occupy two cells in terminals.
  • Zero-width characters (e.g., joiners, marks) don't affect layout but can cause width calculation errors.
  • Complex text like emojis with skin tone modifiers or flags requires special handling.
  • PHP's built-in functions don't fully address these edge cases.

To address these issues, Aaron Francis created the Grapheme library which provides an accurate, performant, and thoroughly tested method to calculate the display width of any character or grapheme cluster in PHP applications.

Key Features:

  • Comprehensive Unicode Support: Handles CJK characters, emoji (including modifiers), zero-width characters, combining marks, regional indicators, and variation selectors.
  • High Performance: Optimized with early-return paths and smart caching mechanisms.
  • Minimal Dependencies: Requires PHP 8.2+ and an optional intl extension.
  • Terminal Compatibility: Aims to match the behavior of wcwidth() in modern terminal emulators.

To install this package, use composer:

composer require soloterm/grapheme

Then some examples of using the package are as follows:

use SoloTerm\Grapheme\Grapheme;
 
Grapheme::wcwidth('Я'); // Returns: 1
Grapheme::wcwidth('文'); // Returns: 2
Grapheme::wcwidth('😀'); // Returns: 2

For more information and to view the source code, visit the Grapheme GitHub repository.

Yannick Lyn Fatt photo

Staff Writer at Laravel News and Full stack web developer.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
SerpApi

The Web Search API for Your LLM and AI Applications

Visit SerpApi
PhpStorm logo

PhpStorm

The go-to PHP IDE with extensive out-of-the-box support for Laravel and its ecosystem.

PhpStorm
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Multi-tenant Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
Lucky Media logo

Lucky Media

Get Lucky Now - the ideal choice for Laravel Development, with over a decade of experience!

Lucky Media
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $9500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Laravel Cloud logo

Laravel Cloud

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Cloud
Harpoon: Next generation time tracking and invoicing logo

Harpoon: Next generation time tracking and invoicing

The next generation time-tracking and billing software that helps your agency plan and forecast a profitable future.

Harpoon: Next generation time tracking and invoicing
Acquaint Softtech logo

Acquaint Softtech

Acquaint Softtech offers AI-ready Laravel developers who onboard in 48 hours at $3000/Month with no lengthy sales process and a 100 percent money-back guarantee.

Acquaint Softtech

The latest

View all →
A Copy/Paste Detector CLI for PHP 8.5+ image

A Copy/Paste Detector CLI for PHP 8.5+

Read article
Commune: A Private Community for Founders and Builders image

Commune: A Private Community for Founders and Builders

Read article
 Laravel AI Tasks: An AI Orchestration Package for Queues, Logging, and Cost Control image

Laravel AI Tasks: An AI Orchestration Package for Queues, Logging, and Cost Control

Read article
Worker Metrics on the WorkerStopping Event in Laravel 13.18 image

Worker Metrics on the WorkerStopping Event in Laravel 13.18

Read article
Clonio CLI: Clone Production Databases With Anonymized Data image

Clonio CLI: Clone Production Databases With Anonymized Data

Read article
Ship AI with Laravel: Test Your AI System with Zero API Calls image

Ship AI with Laravel: Test Your AI System with Zero API Calls

Read article