class RatatuiRuby::Cell

Represents a single cell in the terminal buffer.

A terminal grid is made of cells. Each cell contains a character (symbol) and styling (colors, modifiers). When testing, you often need to verify that a specific cell renders correctly.

This object encapsulates that state. It provides predicate methods for modifiers, making assertions readable.

Use it to inspect the visual state of your application in tests.

Examples

cell = RatatuiRuby.get_cell_at(0, 0)
cell.char   # => "H"
cell.fg     # => :red
cell.bold?  # => true

Attributes

bg [R]

The background color of the cell (e.g., :black, nil).

char [R]

The character displayed in the cell.

Named to match Ratatui’s Cell::symbol() method.

fg [R]

The foreground color of the cell (e.g., :red, :blue, “#ff0000”).

modifiers [R]

The list of active modifiers (e.g., [“bold”, “italic”]).

symbol [R]

The character displayed in the cell.

Named to match Ratatui’s Cell::symbol() method.

Public Class Methods

char (char)

Source

# File lib/ratatui_ruby/cell.rb, line 108
def self.char(char)
  symbol(char)
end

Alias for Rubyists who prefer a shorter name.

default ()

Source

# File lib/ratatui_ruby/cell.rb, line 83
def self.default
  empty
end

Returns a default cell (alias for empty).

Example

Cell.default # => #<RatatuiRuby::Cell char=" ">

empty ()

Source

# File lib/ratatui_ruby/cell.rb, line 65
def self.empty
  new(symbol: " ", fg: nil, bg: nil, modifiers: [])
end

Returns an empty cell (space character, no styles).

Example

Cell.empty # => #<RatatuiRuby::Cell char=" ">

new (symbol: nil, char: nil, fg: nil, bg: nil, modifiers: [])

Source

# File lib/ratatui_ruby/cell.rb, line 118
def initialize(symbol: nil, char: nil, fg: nil, bg: nil, modifiers: [])
  @symbol = (symbol || char || " ").freeze
  @fg = fg&.freeze
  @bg = bg&.freeze
  @modifiers = modifiers.map(&:freeze).freeze
  freeze
end

Creates a new Cell.

symbol: String (single character). Aliased as char:.
fg: Symbol or String (nullable).
bg: Symbol or String (nullable).
modifiers: Array of Strings.

symbol (symbol)

Source

# File lib/ratatui_ruby/cell.rb, line 103
def self.symbol(symbol)
  new(symbol:, fg: nil, bg: nil, modifiers: [])
end

Returns a cell with a specific character and no styles.

symbol: String (single character).

Example

Cell.symbol("X") # => #<RatatuiRuby::Cell symbol="X">

Public Instance Methods

== (other)

Source

# File lib/ratatui_ruby/cell.rb, line 172
def ==(other)
  other.is_a?(Cell) &&
    char == other.char &&
    fg == other.fg &&
    bg == other.bg &&
    modifiers == other.modifiers
end

Checks equality with another Cell.

bold? ()

Source

# File lib/ratatui_ruby/cell.rb, line 127
def bold?
  modifiers.include?("bold")
end

Returns true if the cell has the bold modifier.

crossed_out? ()

Source

# File lib/ratatui_ruby/cell.rb, line 167
def crossed_out?
  modifiers.include?("crossed_out")
end

Returns true if the cell has the crossed_out modifier.

deconstruct_keys (keys)

Source

# File lib/ratatui_ruby/cell.rb, line 196
def deconstruct_keys(keys)
  { symbol:, char: symbol, fg:, bg:, modifiers: }
end

Support for pattern matching. Supports both :symbol and :char keys.

dim? ()

Source

# File lib/ratatui_ruby/cell.rb, line 132
def dim?
  modifiers.include?("dim")
end

Returns true if the cell has the dim modifier.

hidden? ()

Source

# File lib/ratatui_ruby/cell.rb, line 162
def hidden?
  modifiers.include?("hidden")
end

Returns true if the cell has the hidden modifier.

inspect ()

Source

# File lib/ratatui_ruby/cell.rb, line 181
def inspect
  parts = ["symbol=#{symbol.inspect}"]
  parts << "fg=#{fg.inspect}" if fg
  parts << "bg=#{bg.inspect}" if bg
  parts << "modifiers=#{modifiers.inspect}" unless modifiers.empty?
  "#<#{self.class} #{parts.join(' ')}>"
end

Returns a string representation of the cell.

italic? ()

Source

# File lib/ratatui_ruby/cell.rb, line 137
def italic?
  modifiers.include?("italic")
end

Returns true if the cell has the italic modifier.

rapid_blink? ()

Source

# File lib/ratatui_ruby/cell.rb, line 152
def rapid_blink?
  modifiers.include?("rapid_blink")
end

Returns true if the cell has the rapid_blink modifier.

reversed? ()

Source

# File lib/ratatui_ruby/cell.rb, line 157
def reversed?
  modifiers.include?("reversed")
end

Returns true if the cell has the reversed modifier.

slow_blink? ()

Source

# File lib/ratatui_ruby/cell.rb, line 147
def slow_blink?
  modifiers.include?("slow_blink")
end

Returns true if the cell has the slow_blink modifier.

to_s ()

Source

# File lib/ratatui_ruby/cell.rb, line 190
def to_s
  symbol
end

Returns the cell’s character.

underlined? ()

Source

# File lib/ratatui_ruby/cell.rb, line 142
def underlined?
  modifiers.include?("underlined")
end

Returns true if the cell has the underlined modifier.