Input-class: Input widget
In termr: Modern Reactive Terminal Applications with Data Workflows
Input R Documentation
Input widget
Description
A single-line text input. See input().
Super class
Widget -> Input
Public fields
paint_statesCursor and selection changes only repaint.
focusableInputs can be focused.
placeholderText shown while the input is empty.
passwordShow bullets instead of the characters?
max_lengthMaximum number of characters, or NULL.
validateNULL or function(value) returning NULL (valid)
or an error message.
Active bindings
valueThe text (reactive). Assigning moves the cursor to the
end and sends "input.changed".
cursor_positionCursor position in characters (0 = start).
selectionThe selected text ("" if none).
validDoes the value pass validate?
errorThe validation message, or NULL.
Methods
Public methods
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Inherited methods
Widget$add_class()Widget$ancestors()Widget$animate()Widget$arrange_children()Widget$bind()Widget$bind_reactive()Widget$bindings()Widget$blur()Widget$capture_mouse()Widget$child_clip()Widget$computed_style()Widget$content_height()Widget$focus()Widget$format()Widget$get_state()Widget$has_class()Widget$invalidate()Widget$invalidate_paint()Widget$is_displayed()Widget$is_enabled()Widget$layout_descend()Widget$layout_differs()Widget$matches()Widget$mount()Widget$on()Widget$paint()Widget$post_message()Widget$print()Widget$query()Widget$query_one()Widget$refresh()Widget$release_mouse()Widget$remove()Widget$remove_children()Widget$remove_class()Widget$render()Widget$replace()Widget$run_action()Widget$run_process()Widget$run_worker()Widget$set()Widget$set_interval()Widget$set_state()Widget$set_timeout()Widget$toggle_class()Widget$walk()
Input$new()
Create an input.
Usage
Input$new(
value = "",
placeholder = "",
id = NULL,
classes = NULL,
style = NULL,
disabled = FALSE,
password = FALSE,
max_length = NULL,
validate = NULL
)
Arguments
valueInitial text.
placeholderPlaceholder text.
id, classes, style, disabledSee Widget.
passwordMask the characters?
max_lengthMaximum number of characters.
validateValidation function.
Input$default_style()
The built-in style.
Usage
Input$default_style()
Input$pseudo_states()
Active states: focus, hover, disabled and invalid.
Usage
Input$pseudo_states()
Input$default_bindings()
Editing key bindings.
Usage
Input$default_bindings()
Input$on_key()
Printable keys replace the selection or are inserted at
the cursor. Ctrl+C / Ctrl+X copy / cut when text is selected (otherwise
Ctrl+C keeps its app meaning).
Usage
Input$on_key(event)
Arguments
eventA KeyEvent.
Input$on_mouse_down()
Clicking places the cursor; shift+click and dragging
select.
Usage
Input$on_mouse_down(event)
Arguments
eventA MouseEvent.
Input$on_mouse_move()
Dragging with the left button extends the selection.
Usage
Input$on_mouse_move(event)
Arguments
eventA MouseEvent.
Input$on_paste()
Pasted text is inserted as one edit. An Input is a
single line, so line breaks in the paste become spaces.
Usage
Input$on_paste(event)
Arguments
eventA PasteEvent.
Input$insert()
Insert text at the cursor (replacing the selection).
Usage
Input$insert(text)
Arguments
textA string.
Input$clear()
Remove all text.
Usage
Input$clear()
Input$select_range()
Select a range of characters.
Usage
Input$select_range(start, end)
Arguments
start, endPositions (0 = before the first character).
Input$copy()
Copy the selection to the app clipboard (and, when
system = TRUE and supported, to the system clipboard via OSC 52).
Usage
Input$copy(system = TRUE)
Arguments
systemAlso write to the system clipboard?
Input$action_cursor_left()
Move one character left.
Usage
Input$action_cursor_left()
Input$action_cursor_right()
Move one character right.
Usage
Input$action_cursor_right()
Input$action_cursor_home()
Move to the start.
Usage
Input$action_cursor_home()
Input$action_cursor_end()
Move to the end.
Usage
Input$action_cursor_end()
Input$action_word_left()
Move to the previous word.
Usage
Input$action_word_left()
Input$action_word_right()
Move to the next word.
Usage
Input$action_word_right()
Input$action_select_left()
Extend the selection left.
Usage
Input$action_select_left()
Input$action_select_right()
Extend the selection right.
Usage
Input$action_select_right()
Input$action_select_home()
Select to the start.
Usage
Input$action_select_home()
Input$action_select_end()
Select to the end.
Usage
Input$action_select_end()
Input$action_select_word_left()
Select to the previous word.
Usage
Input$action_select_word_left()
Input$action_select_word_right()
Select to the next word.
Usage
Input$action_select_word_right()
Input$action_select_all()
Select everything.
Usage
Input$action_select_all()
Input$action_delete_left()
Delete the selection or the character before the cursor.
Usage
Input$action_delete_left()
Input$action_delete_right()
Delete the selection or the character at the cursor.
Usage
Input$action_delete_right()
Input$action_delete_word_left()
Delete the word before the cursor.
Usage
Input$action_delete_word_left()
Input$action_delete_word_right()
Delete the word after the cursor.
Usage
Input$action_delete_word_right()
Input$action_delete_to_start()
Delete everything before the cursor.
Usage
Input$action_delete_to_start()
Input$action_delete_to_end()
Delete everything after the cursor.
Usage
Input$action_delete_to_end()
Input$action_paste()
Insert the app clipboard.
Usage
Input$action_paste()
Input$action_submit()
Send an "input.submitted" message (Enter).
Usage
Input$action_submit()
Input$content_width()
Natural content width.
Usage
Input$content_width()
Input$render_lines()
The visible part of the text, scrolled so the cursor
is visible, with the cursor drawn in reverse video and the
selection highlighted when focused.
Usage
Input$render_lines(width = NA_integer_)
Arguments
widthContent width.
Input$clone()
The objects of this class are cloneable with this method.
Usage
Input$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
termr documentation built on Oct. 21, 2026, 5:13 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| Input | R Documentation |
Input widget
Description
A single-line text input. See input().
Super class
Widget -> Input
Public fields
paint_statesCursor and selection changes only repaint.
focusableInputs can be focused.
placeholderText shown while the input is empty.
passwordShow bullets instead of the characters?
max_lengthMaximum number of characters, or
NULL.validateNULLorfunction(value)returningNULL(valid) or an error message.
Active bindings
valueThe text (reactive). Assigning moves the cursor to the end and sends
"input.changed".cursor_positionCursor position in characters (0 = start).
selectionThe selected text (
""if none).validDoes the value pass
validate?errorThe validation message, or
NULL.
Methods
Public methods
Inherited methods
Widget$add_class()Widget$ancestors()Widget$animate()Widget$arrange_children()Widget$bind()Widget$bind_reactive()Widget$bindings()Widget$blur()Widget$capture_mouse()Widget$child_clip()Widget$computed_style()Widget$content_height()Widget$focus()Widget$format()Widget$get_state()Widget$has_class()Widget$invalidate()Widget$invalidate_paint()Widget$is_displayed()Widget$is_enabled()Widget$layout_descend()Widget$layout_differs()Widget$matches()Widget$mount()Widget$on()Widget$paint()Widget$post_message()Widget$print()Widget$query()Widget$query_one()Widget$refresh()Widget$release_mouse()Widget$remove()Widget$remove_children()Widget$remove_class()Widget$render()Widget$replace()Widget$run_action()Widget$run_process()Widget$run_worker()Widget$set()Widget$set_interval()Widget$set_state()Widget$set_timeout()Widget$toggle_class()Widget$walk()
Input$new()
Create an input.
Usage
Input$new( value = "", placeholder = "", id = NULL, classes = NULL, style = NULL, disabled = FALSE, password = FALSE, max_length = NULL, validate = NULL )
Arguments
valueInitial text.
placeholderPlaceholder text.
id, classes, style, disabledSee Widget.
passwordMask the characters?
max_lengthMaximum number of characters.
validateValidation function.
Input$default_style()
The built-in style.
Usage
Input$default_style()
Input$pseudo_states()
Active states: focus, hover, disabled and invalid.
Usage
Input$pseudo_states()
Input$default_bindings()
Editing key bindings.
Usage
Input$default_bindings()
Input$on_key()
Printable keys replace the selection or are inserted at the cursor. Ctrl+C / Ctrl+X copy / cut when text is selected (otherwise Ctrl+C keeps its app meaning).
Usage
Input$on_key(event)
Arguments
eventA
KeyEvent.
Input$on_mouse_down()
Clicking places the cursor; shift+click and dragging select.
Usage
Input$on_mouse_down(event)
Arguments
eventA
MouseEvent.
Input$on_mouse_move()
Dragging with the left button extends the selection.
Usage
Input$on_mouse_move(event)
Arguments
eventA
MouseEvent.
Input$on_paste()
Pasted text is inserted as one edit. An Input is a single line, so line breaks in the paste become spaces.
Usage
Input$on_paste(event)
Arguments
eventA
PasteEvent.
Input$insert()
Insert text at the cursor (replacing the selection).
Usage
Input$insert(text)
Arguments
textA string.
Input$clear()
Remove all text.
Usage
Input$clear()
Input$select_range()
Select a range of characters.
Usage
Input$select_range(start, end)
Arguments
start, endPositions (0 = before the first character).
Input$copy()
Copy the selection to the app clipboard (and, when
system = TRUE and supported, to the system clipboard via OSC 52).
Usage
Input$copy(system = TRUE)
Arguments
systemAlso write to the system clipboard?
Input$action_cursor_left()
Move one character left.
Usage
Input$action_cursor_left()
Input$action_cursor_right()
Move one character right.
Usage
Input$action_cursor_right()
Input$action_cursor_home()
Move to the start.
Usage
Input$action_cursor_home()
Input$action_cursor_end()
Move to the end.
Usage
Input$action_cursor_end()
Input$action_word_left()
Move to the previous word.
Usage
Input$action_word_left()
Input$action_word_right()
Move to the next word.
Usage
Input$action_word_right()
Input$action_select_left()
Extend the selection left.
Usage
Input$action_select_left()
Input$action_select_right()
Extend the selection right.
Usage
Input$action_select_right()
Input$action_select_home()
Select to the start.
Usage
Input$action_select_home()
Input$action_select_end()
Select to the end.
Usage
Input$action_select_end()
Input$action_select_word_left()
Select to the previous word.
Usage
Input$action_select_word_left()
Input$action_select_word_right()
Select to the next word.
Usage
Input$action_select_word_right()
Input$action_select_all()
Select everything.
Usage
Input$action_select_all()
Input$action_delete_left()
Delete the selection or the character before the cursor.
Usage
Input$action_delete_left()
Input$action_delete_right()
Delete the selection or the character at the cursor.
Usage
Input$action_delete_right()
Input$action_delete_word_left()
Delete the word before the cursor.
Usage
Input$action_delete_word_left()
Input$action_delete_word_right()
Delete the word after the cursor.
Usage
Input$action_delete_word_right()
Input$action_delete_to_start()
Delete everything before the cursor.
Usage
Input$action_delete_to_start()
Input$action_delete_to_end()
Delete everything after the cursor.
Usage
Input$action_delete_to_end()
Input$action_paste()
Insert the app clipboard.
Usage
Input$action_paste()
Input$action_submit()
Send an "input.submitted" message (Enter).
Usage
Input$action_submit()
Input$content_width()
Natural content width.
Usage
Input$content_width()
Input$render_lines()
The visible part of the text, scrolled so the cursor is visible, with the cursor drawn in reverse video and the selection highlighted when focused.
Usage
Input$render_lines(width = NA_integer_)
Arguments
widthContent width.
Input$clone()
The objects of this class are cloneable with this method.
Usage
Input$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.