Modern Reactive Terminal Applications with Data Workflows


[Up] [Top]

Documentation for package ‘termr’ version 1.0.1

Help Pages

A B C D E F G H I J K L M O P R S T U V W

-- A --

alert_dialog Modal screens and dialogs
animate Animate a widget field
Animation Animation handle
App Application
app Create an application

-- B --

batch Reactive values, computed values and watchers
bind Key bindings
BlurEvent Events
browse_data Browse a data frame in the terminal
Button Button widget
button Button

-- C --

c.termr_text Styled text
cell A single terminal cell
Checkbox Checkbox widget
checkbox Checkbox
column Column options for data tables
command Commands
computed Reactive values, computed values and watchers
confirm_dialog Modal screens and dialogs
current_app The running app

-- D --

DataProfile DataProfile widget
DataTable DataTable widget
data_browser Browse a data frame in the terminal
data_profile Compact vector profile
data_table Data table
db_connection Wrap a DBI connection for use by termr SQL widgets
db_explorer Database explorer widget
db_metadata Create a DBI metadata interface
db_query_source Create a lazy DBI query source
db_table_source Create a lazy source for a SQLite table
diff_screen Compare two screen buffers
dispose Reactive values, computed values and watchers
dropdown Drop-down select

-- E --

Event Events

-- F --

FocusEvent Events

-- G --

Grid Grid container
grid_layout Grid container

-- H --

Horizontal Horizontal container
horizontal Layout containers

-- I --

Input Input widget
input Single-line text input
inspect_signal Inspect one node in the experimental signal graph
inspect_widget Inspect a widget

-- J --

json_view Collapsible viewer for R list-like data

-- K --

KeyEvent Events
KeyValue KeyValue widget
key_event Create a key event
key_value Key/value list
knit_termr Render a static representation for knitr or Quarto

-- L --

Label Label widget
label Text label
LogView LogView widget
log_view Log view

-- M --

MarkdownView MarkdownView widget
markdown_view Markdown view
MessageEvent Events
Metric Metric widget
metric Metric
modal Modal screens and dialogs
ModalScreen Modal screen
motion_reduced Reduced motion
MountEvent Events
MouseEvent Events

-- O --

on Event handlers
OptionList OptionList widget
option_list Option list

-- P --

Panel Panel widget
panel Panel
PasteEvent Events
patch_to_ansi Convert a screen patch to ANSI escape sequences
peek Reactive values, computed values and watchers
ProcessView ProcessView widget
process_view Process view
ProgressBar ProgressBar widget
progress_bar Progress bar
PropertyGrid PropertyGrid widget
property_grid Key/value property inspector

-- R --

RadioButton RadioButton widget
RadioSet RadioSet widget
radio_button Radio buttons
radio_set Radio buttons
reactive Reactive state fields
record_view View one record
region Screen regions
register_layout Register an experimental custom container layout
render_html Render a styled HTML fragment
render_lines Render a widget tree as plain text
render_markdown Render a terminal frame as a Markdown code block
render_svg Render a static frame as SVG
render_text Render a widget tree as plain text
render_widget Render widgets to a virtual screen
ResizeEvent Events
Rule Rule widget
rule Rule (separator)
run Run an application
run_example Run a bundled example app
run_process Background workers and subprocesses
run_worker Background workers and subprocesses
r_highlighter Lightweight R syntax highlighter

-- S --

Screen Screen widget
ScreenBuffer Virtual screen (framebuffer)
screen_buffer Create a virtual screen buffer
screen_snapshot Create a deterministic screen snapshot
screen_snapshot_json Serialize a screen snapshot as JSON
ScrollView ScrollView widget
scroll_view Scrollable container
Select Select widget
set_interval Timers
set_timeout Timers
signal Reactive values, computed values and watchers
signals Reactive values, computed values and watchers
span Styled text
Sparkline Sparkline widget
sparkline Sparkline
Spinner Spinner widget
spinner Spinner
SplitPane SplitPane widget
split_pane Split pane
sql_editor SQL editor widget
sql_highlighter SQL syntax highlighter
StatusBar StatusBar widget
status_bar One-line status bar
strip_ansi Remove ANSI escape sequences from a string
style Widget styles
stylesheet Stylesheets
stylesheet_file Stylesheets

-- T --

tab Tabs
table_filter Create a DataTable column filter
table_source Create an experimental lazy table source
TabPane TabPane widget
Tabs Tabs widget
tabs Tabs
terminal_capabilities Terminal capabilities
termr_theme Themes
test_app Test an app without a terminal
TextArea TextArea widget
text_area Multi-line text editor
Timer Timer handle
Toast Toast widget
TreeNode Tree node
TreeView TreeView widget
tree_node Tree nodes
tree_view Tree view

-- U --

UnmountEvent Events
unregister_layout Remove an experimental custom layout
untracked Reactive values, computed values and watchers
update_signal Reactive values, computed values and watchers

-- V --

Vertical Vertical container
vertical Layout containers

-- W --

watch Reactive values, computed values and watchers
Widget Widget base class
widget Define a custom widget type
widget_snapshot Snapshot the safe, structural parts of a widget tree
widget_snapshot_json Serialize a structural widget snapshot as JSON
Worker Worker handle
write_rendered Write a static rendering to a UTF-8 file