Man pages for termr
Modern Reactive Terminal Applications with Data Workflows

animateAnimate a widget field
AnimationAnimation handle
appCreate an application
App-classApplication
bindKey bindings
browse_dataBrowse a data frame in the terminal
buttonButton
Button-classButton widget
cellA single terminal cell
checkboxCheckbox
Checkbox-classCheckbox widget
columnColumn options for data tables
commandCommands
current_appThe running app
data_profileCompact vector profile
DataProfile-classDataProfile widget
data_tableData table
DataTable-classDataTable widget
db_connectionWrap a DBI connection for use by termr SQL widgets
db_explorerDatabase explorer widget
db_metadataCreate a DBI metadata interface
db_query_sourceCreate a lazy DBI query source
db_table_sourceCreate a lazy source for a SQLite table
diff_screenCompare two screen buffers
driversTerminal drivers
dropdownDrop-down select
EventEvents
GridGrid container
grid_layoutGrid container
Horizontal-classHorizontal container
inputSingle-line text input
Input-classInput widget
inspect_signalInspect one node in the experimental signal graph
inspect_widgetInspect a widget
json_viewCollapsible viewer for R list-like data
key_eventCreate a key event
key_valueKey/value list
KeyValue-classKeyValue widget
knit_termrRender a static representation for knitr or Quarto
labelText label
Label-classLabel widget
log_viewLog view
LogView-classLogView widget
markdown_viewMarkdown view
MarkdownView-classMarkdownView widget
metricMetric
Metric-classMetric widget
modalModal screens and dialogs
ModalScreenModal screen
motion_reducedReduced motion
onEvent handlers
option_listOption list
OptionList-classOptionList widget
panelPanel
Panel-classPanel widget
patch_to_ansiConvert a screen patch to ANSI escape sequences
process_viewProcess view
ProcessView-classProcessView widget
progress_barProgress bar
ProgressBar-classProgressBar widget
property_gridKey/value property inspector
PropertyGrid-classPropertyGrid widget
RadioButtonRadioButton widget
radio_setRadio buttons
RadioSet-classRadioSet widget
reactiveReactive state fields
record_viewView one record
regionScreen regions
register_layoutRegister an experimental custom container layout
render_htmlRender a styled HTML fragment
render_markdownRender a terminal frame as a Markdown code block
render_svgRender a static frame as SVG
render_textRender a widget tree as plain text
render_widgetRender widgets to a virtual screen
r_highlighterLightweight R syntax highlighter
ruleRule (separator)
Rule-classRule widget
runRun an application
run_exampleRun a bundled example app
run_workerBackground workers and subprocesses
ScreenScreen widget
screen_bufferCreate a virtual screen buffer
ScreenBufferVirtual screen (framebuffer)
screen_snapshotCreate a deterministic screen snapshot
screen_snapshot_jsonSerialize a screen snapshot as JSON
scroll_viewScrollable container
ScrollView-classScrollView widget
Select-classSelect widget
set_timeoutTimers
signalsReactive values, computed values and watchers
spanStyled text
sparklineSparkline
Sparkline-classSparkline widget
spinnerSpinner
Spinner-classSpinner widget
SplitHandle-classSplit handle
split_paneSplit pane
SplitPane-classSplitPane widget
sql_editorSQL editor widget
sql_highlighterSQL syntax highlighter
status_barOne-line status bar
StatusBar-classStatusBar widget
strip_ansiRemove ANSI escape sequences from a string
styleWidget styles
stylesheetStylesheets
table_filterCreate a DataTable column filter
table_sourceCreate an experimental lazy table source
TabPaneTabPane widget
tabsTabs
Tabs-classTabs widget
terminal_capabilitiesTerminal capabilities
termr-packagetermr: modern reactive terminal applications for R
termr_themeThemes
test_appTest an app without a terminal
text_areaMulti-line text editor
TextArea-classTextArea widget
TimerTimer handle
ToastToast widget
tree_nodeTree nodes
TreeNodeTree node
tree_viewTree view
TreeView-classTreeView widget
unregister_layoutRemove an experimental custom layout
verticalLayout containers
Vertical-classVertical container
widgetDefine a custom widget type
Widget-classWidget base class
widget_snapshotSnapshot the safe, structural parts of a widget tree
widget_snapshot_jsonSerialize a structural widget snapshot as JSON
WorkerWorker handle
write_renderedWrite a static rendering to a UTF-8 file
termr documentation built on Oct. 21, 2026, 5:13 p.m.