Laravel Packages

Grapheme

Published
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.

Sponsored

laravelcloud logo
Laravel Cloud

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

Visit Laravel Cloud

The latest

View all →
NativePHP v4: Build Native iOS and Android UI in Blade image

NativePHP v4: Build Native iOS and Android UI in Blade

Read article
Laravel Lock: Distributed Locks for Models and Routes image

Laravel Lock: Distributed Locks for Models and Routes

Read article
Laravel Image Responses: Serve Resized Images From Routes image

Laravel Image Responses: Serve Resized Images From Routes

Read article
Pause All Laravel Queues During a Deploy image

Pause All Laravel Queues During a Deploy

Read article
Laravel Terminal UI for the artisan dev Command image

Laravel Terminal UI for the artisan dev Command

Read article
Pause All Queues and a New artisan dev UI in Laravel 13.25 image

Pause All Queues and a New artisan dev UI in Laravel 13.25

Read article