Skip to content
pubscout

ruby_text

3.0.3, released 3 years ago by yeungkc.com

A Flutter widget to display text with furigana ruby annotations.

WASM-ready
$ flutter pub add ruby_text
Source repository

What it does

Provides a RubyText widget and RubyTextData models to render text accompanied by smaller ruby text annotations, typically used for furigana in Japanese. Supports custom text styles, spacing, overflow, and alignment.

AI-written summary of version 3.0.3, based on the package's README and metadata. Report an inaccuracy

Use it when

  • You need to display Japanese furigana or similar phonetic annotations above base text.
  • You want a dedicated widget for rendering ruby text inline with standard Flutter text properties.

Skip it when

  • You only need standard plain text without ruby annotations.
  • You require complex interactive features attached to individual ruby spans.

Strengths

  • Easy to use API with RubyText and RubyTextData.
  • Supports performance caching introduced in recent versions.
  • Cross-platform support including Android, iOS, web, Windows, macOS, and Linux.

Weaknesses

  • onTap functionality was removed in version 3.0.0.
  • Limited to furigana-style ruby text rendering.

Setup

Kind
Flutter widgets
Effort
Low
Code generation
No
Direct dependencies
3
RubyText(
  [
    RubyTextData(
      '検査',
      ruby: 'けんさ',
    ),
  ],
);

Alternatives

Packages that do the same job and could replace ruby_text.

Works with

Packages commonly used together with ruby_text: ones it builds on, ones built on it, and its own family.