Document undocumented methods; deprecate on_clicked and add on_click

Author: marcheiligers

CHANGELOG.md

@@ -1,7 +1,10 @@
 # v0.0.23 - 16 February 2025
 
-* Made `@text_keys` instance variable instead of local
-* Wrote up notes on special keyboard handling with filtering example
+* Exposed `@text_keys` as an instance variable instead of a local.
+* Wrote up notes on custom keyboard handling with a filtering example.
+* Documented `#delete_forward` and `#delete_back` methods.
+* Deprecated `on_clicked` and added `on_click` in it's place.
+* Documented `focused` argument and `#focused?` aliases for `focussed` and `#focussed?`
 
 # v0.0.22 - 9 February 2025
 

README.md

@@ -82,7 +82,9 @@ The argument list below will list `prompt_color` but not the individual `prompt_
 * `word_wrap` - if the control should wrap (Boolean), default false
 * `readonly` - initial input read only state (Boolean), default false
 * `focussed` - initial input focus (Boolean), default false
-* `on_clicked` - on click callback, receives 2 parameters, the click and the `Input` control instance, default NOOP
+* `focused` - Alias for `focussed`
+* `on_clicked` - Deprecated - use `on_click`
+* `on_click` - on click callback, receives 2 parameters, the click and the `Input` control instance, default `NOOP`
 * `on_unhandled_key` - on unhandle key pressed callback, receives 2 parameters, the key and the `Input` control instance, default NOOP. This callback receives keys like `[tab]` and `[enter]`
 * `max_length` - maximum allowed length (Integer), default `false` which disables length checks
 * `fill_from_bottom` - fill the text from the bottom, like for a log or game terminal, default `false`
@@ -112,6 +114,9 @@ The argument list below will list `prompt_color` but not the individual `prompt_
 * `#replace(text)` - Alias for `#insert(text)`
 * `#replace_at(text, start, end = start)` - Alias for `#insert_at(text, start, end = start)`
 * `#append(text)` - Appends text the end of the value, without changing the selection
+* `#delete_forward` - Deletes selection or the character to the right of the cursor location if the selection is empty (typically in response to the `Delete` key)
+* `#delete_back` - Deletes selection or the character to the left of the cursor location if the selection is empty (typically in response to the `Backspace` key)
+* `#current_selection` - Returns the currently selected text
 * `#current_selection` - Returns the currently selected text
 * `#current_line` - Returns the currently selected line object
 * `#current_word` - Returns the word currently under the cursor
@@ -146,11 +151,12 @@ The argument list below will list `prompt_color` but not the individual `prompt_
 * `#focus` - Focusses the instance. Note the instance will only receive the focus after it's rendered. This prevents multiple instances from handling the keyboard and mouse events in the same tick.
 * `#blur` - Removes the focus from the instance. This happens immediately and the instance will not process keyboard and some mouse events after being blurred.
 * `#focussed?` - Returns true if the input is focussed, false otherwise
+* `#focused?` - Alias for `#focussed?`
 * `#value_changed?` - Returns true if the input value changed in the last tick, false otherwise
 
-## Special keyboard handling
+## Custom keyboard handling
 
-There may be cases where you want to do some special keyboard handling, like filtering out certain characters. In order to do this, create a subclass of `Input::Text` or `Input::Multiline` and override the `handle_keyboard` method, calling `super` when your special handling is done. The following instance variables are available:
+There may be cases where you want to do some custom keyboard handling, like filtering out certain characters. In order to do this, create a subclass of `Input::Text` or `Input::Multiline` and override the `handle_keyboard` method, calling `super` when your special handling is done. The following instance variables are available:
 
 * `@meta` - true if the Meta key is down (the Command key on a Mac, or Windows key on Windows)
 * `@alt` - true if the Alt key is down

lib/base.rb

@@ -73,7 +73,7 @@ def initialize(**params) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticCo
       @focussed = params[:focussed] || params[:focused] || false
       @will_focus = false # Get the focus at the end of the tick
 
-      @on_clicked = params[:on_clicked] || NOOP
+      @on_click = params[:on_click] || params[:on_clicked] || NOOP
       # @on_handled_key = params[:on_handled_key] || NOOP
       @on_unhandled_key = params[:on_unhandled_key] || NOOP
 

lib/multiline.rb

@@ -302,7 +302,7 @@ def handle_mouse # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
         @selection_end = index
         @mouse_down = false if mouse.up
       else # clicking
-        @on_clicked.call(mouse, self)
+        @on_click.call(mouse, self)
         return unless (@focussed || @will_focus) && mouse.button_left
 
         if @shift

lib/text.rb

@@ -108,7 +108,7 @@ def handle_mouse # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
         @selection_end = index
         @mouse_down = false if mouse.up
       else
-        @on_clicked.call(mouse, self)
+        @on_click.call(mouse, self)
         return unless @focussed || @will_focus
 
         @mouse_down = true