module RatatuiRuby::Event::Key::Dwim

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 54
def alphanumeric?
  letter? || digit?
end

Returns true if the key is alphanumeric.

Event::Key.new(code: "a").alphanumeric? # => true

arrow? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 136
def arrow?
  ARROW_KEYS.include?(@code) && @modifiers.empty?
end

Returns true if key is an arrow key.

Event::Key.new(code: "up").arrow? # => true

cancel? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 90
def cancel?
  (@code == "esc" && @modifiers.empty?) || interrupt?
end

Returns true for cancel (Esc or Ctrl+C).

event.cancel? # => true for Esc or Ctrl+C

carriagereturn? ()

Alias for: cr?

cr? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 28
def cr?
  @code == "enter" && @modifiers.empty?
end

Returns true if the key is Enter. Alias for carriage return.

event.cr? # => true for enter

Also aliased as: carriagereturn?, linefeed?, newline?, lf?

digit? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 47
def digit?
  @code.length == 1 && @code.match?(/\A[0-9]\z/)
end

Returns true if the key is a digit (0-9).

Event::Key.new(code: "5").digit? # => true

eof? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 83
def eof?
  @code == "d" && @modifiers == ["ctrl"]
end

Returns true for end-of-file (Ctrl+D).

event.eof? # => true for Ctrl+D

int? ()

Alias for: sigint?

interrupt? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 76
def interrupt?
  @code == "c" && @modifiers == ["ctrl"]
end

Returns true for interrupt (Ctrl+C).

event.interrupt? # => true for Ctrl+C

letter? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 40
def letter?
  @code.length == 1 && @code.match?(/\A[A-Za-z]\z/)
end

Returns true if the key is a single letter (a-z, A-Z).

Event::Key.new(code: "a").letter? # => true

lf? ()

Alias for: cr?

linefeed? ()

Alias for: cr?

navigation? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 127
def navigation?
  NAVIGATION_KEYS.include?(@code) && @modifiers.empty?
end

Returns true if key is a navigation key.

Event::Key.new(code: "up").navigation? # => true

newline? ()

Alias for: cr?

punctuation? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 61
def punctuation?
  return false unless @code.length == 1
  !letter? && !digit? && !whitespace?
end

Returns true if the key is punctuation.

Event::Key.new(code: "@", modifiers: ["shift"]).punctuation? # => true

quit? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 116
def quit?
  @code == "\\" && @modifiers == ["ctrl"]
end

Returns true for SIGQUIT (Ctrl+).

event.quit? # => true for Ctrl+\

Also aliased as: sigquit?

sigint? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 97
def sigint?
  interrupt?
end

Returns true for SIGINT (Ctrl+C).

event.sigint? # => true for Ctrl+C

Also aliased as: int?

sigquit? ()

Alias for: quit?

sigtstp? ()

Alias for: suspend?

space? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 19
def space?
  @code == " " && @modifiers.empty?
end

Returns true if the key is a space character.

event.space? # => true for " "

Also aliased as: spacebar?

spacebar? ()

Alias for: space?

suspend? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 106
def suspend?
  @code == "z" && @modifiers == ["ctrl"]
end

Returns true for SIGTSTP (Ctrl+Z) - suspend/stop.

event.suspend? # => true for Ctrl+Z

Also aliased as: sigtstp?, tstp?

tstp? ()

Alias for: suspend?

vim? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 145
def vim?
  return true if VIM_MOVEMENT_KEYS.include?(@code) && @modifiers.empty?
  @code == "G" && @modifiers == ["shift"]
end

Returns true if key is a Vim movement key.

Event::Key.new(code: "j").vim? # => true

vim_bottom? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 186
def vim_bottom?
  @code == "G" && @modifiers == ["shift"]
end

Returns true for Vim go to bottom (G).

vim_down? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 156
def vim_down?
  @code == "j" && @modifiers.empty?
end

Returns true for Vim down (j).

vim_left? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 151
def vim_left?
  @code == "h" && @modifiers.empty?
end

Returns true for Vim left (h).

vim_right? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 166
def vim_right?
  @code == "l" && @modifiers.empty?
end

Returns true for Vim right (l).

vim_top? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 181
def vim_top?
  @code == "g" && @modifiers.empty?
end

Returns true for Vim go to top (gg pattern, here just g).

vim_up? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 161
def vim_up?
  @code == "k" && @modifiers.empty?
end

Returns true for Vim up (k).

vim_word_backward? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 176
def vim_word_backward?
  @code == "b" && @modifiers.empty?
end

Returns true for Vim word backward (b).

vim_word_forward? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 171
def vim_word_forward?
  @code == "w" && @modifiers.empty?
end

Returns true for Vim word forward (w).

whitespace? ()

Source

# File lib/ratatui_ruby/event/key/dwim.rb, line 69
def whitespace?
  @code == " " || @code == "enter" || @code == "tab"
end

Returns true if the key is whitespace (space, enter, tab).

Event::Key.new(code: " ").whitespace? # => true