Package index • termr

All functions

Animation: Animation handle
App: Application
Button: Button widget
Checkbox: Checkbox widget
DataProfile: DataProfile widget
DataTable: DataTable widget
Event KeyEvent ResizeEvent PasteEvent FocusEvent BlurEvent MountEvent UnmountEvent MessageEvent MouseEvent: Events
Grid: Grid container
Horizontal: Horizontal container
Input: Input widget
KeyValue: KeyValue widget
Label: Label widget
LogView: LogView widget
MarkdownView: MarkdownView widget
Metric: Metric widget
ModalScreen: Modal screen
OptionList: OptionList widget
Panel: Panel widget
ProcessView: ProcessView widget
ProgressBar: ProgressBar widget
PropertyGrid: PropertyGrid widget
RadioButton: RadioButton widget
RadioSet: RadioSet widget
Rule: Rule widget
Screen: Screen widget
ScreenBuffer: Virtual screen (framebuffer)
ScrollView: ScrollView widget
Select: Select widget
Sparkline: Sparkline widget
Spinner: Spinner widget
SplitPane: SplitPane widget
StatusBar: StatusBar widget
TabPane: TabPane widget
Tabs: Tabs widget
TextArea: TextArea widget
Timer: Timer handle
Toast: Toast widget
TreeNode: Tree node
TreeView: TreeView widget
Vertical: Vertical container
Widget: Widget base class
Worker: Worker handle
animate(): Animate a widget field
app(): Create an application
bind(): Key bindings
browse_data() data_browser(): Browse a data frame in the terminal
button(): Button
cell(): A single terminal cell
checkbox(): Checkbox
column(): Column options for data tables
command(): Commands
current_app(): The running app
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
dropdown(): Drop-down select
grid_layout(): Grid container
input(): Single-line text input
inspect_signal(): Inspect one node in the experimental signal graph
inspect_widget(): Inspect a widget
json_view(): Collapsible viewer for R list-like data
key_event(): Create a key event
key_value(): Key/value list
knit_termr(): Render a static representation for knitr or Quarto
label(): Text label
log_view(): Log view
markdown_view(): Markdown view
metric(): Metric
modal() confirm_dialog() alert_dialog(): Modal screens and dialogs
motion_reduced(): Reduced motion
on(): Event handlers
option_list(): Option list
panel(): Panel
patch_to_ansi(): Convert a screen patch to ANSI escape sequences
process_view(): Process view
progress_bar(): Progress bar
property_grid(): Key/value property inspector
r_highlighter(): Lightweight R syntax highlighter
radio_set() radio_button(): 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_markdown(): Render a terminal frame as a Markdown code block
render_svg(): Render a static frame as SVG
render_text() render_lines(): Render a widget tree as plain text
render_widget(): Render widgets to a virtual screen
rule(): Rule (separator)
run(): Run an application
run_example(): Run a bundled example app
run_worker() run_process(): Background workers and subprocesses
screen_buffer(): Create a virtual screen buffer
screen_snapshot(): Create a deterministic screen snapshot
screen_snapshot_json(): Serialize a screen snapshot as JSON
scroll_view(): Scrollable container
set_timeout() set_interval(): Timers
signal() computed() watch() dispose() batch() peek() untracked() update_signal(): Reactive values, computed values and watchers
span() c(<termr_text>): Styled text
sparkline(): Sparkline
spinner(): Spinner
split_pane(): Split pane
sql_editor(): SQL editor widget
sql_highlighter(): SQL syntax highlighter
status_bar(): One-line status bar
strip_ansi(): Remove ANSI escape sequences from a string
style(): Widget styles
stylesheet() stylesheet_file(): Stylesheets
table_filter(): Create a DataTable column filter
table_source(): Create an experimental lazy table source
tabs() tab(): Tabs
terminal_capabilities(): Terminal capabilities
termr_theme(): Themes
test_app(): Test an app without a terminal
text_area(): Multi-line text editor
tree_node(): Tree nodes
tree_view(): Tree view
unregister_layout(): Remove an experimental custom layout
vertical() horizontal(): Layout containers
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
write_rendered(): Write a static rendering to a UTF-8 file