API for termr
Modern Reactive Terminal Applications with Data Workflows

Global functions
Animation Man page
App Man page
BlurEvent Man page
Button Man page
Checkbox Man page
DataProfile Man page
DataTable Man page
Event Man page
FocusEvent Man page
Grid Man page
Horizontal Man page
Input Man page
KeyEvent Man page
KeyValue Man page
Label Man page
LogView Man page
MarkdownView Man page
MessageEvent Man page
Metric Man page
ModalScreen Man page
MountEvent Man page
MouseEvent Man page
OptionList Man page
Panel Man page
PasteEvent Man page
ProcessView Man page
ProgressBar Man page
PropertyGrid Man page
RadioButton Man page
RadioSet Man page
ResizeEvent Man page
Rule Man page
Screen Man page
ScreenBuffer Man page
ScrollView Man page
Select Man page
Sparkline Man page
Spinner Man page
SplitHandle Man page
SplitPane Man page
StatusBar Man page
TabPane Man page
Tabs Man page
TextArea Man page
Timer Man page
Toast Man page
TreeNode Man page
TreeView Man page
UnmountEvent Man page
Vertical Man page
Widget Man page
Worker Man page
`%||%` Source code
alert_dialog Man page Source code
animate Man page Source code
ansi_alt_screen Source code
ansi_autowrap Source code
ansi_bracketed_paste Source code
ansi_clear_screen Source code
ansi_cursor_home Source code
ansi_cursor_to Source code
ansi_cursor_visible Source code
ansi_hyperlink_close Source code
ansi_hyperlink_open Source code
ansi_mouse Source code
ansi_osc52 Source code
ansi_reset Source code
ansi_sgr Source code
ansi_sync Source code
app Man page Source code
arrange_grid Source code
arrange_horizontal Source code
arrange_vertical Source code
as.character.termr_text Source code
as_bindings Source code
as_choices Source code
as_edges Source code
as_reactive Source code
as_style Source code
as_stylesheet Source code
as_table_data Source code
as_text Source code
as_theme Source code
attrs_decode Source code
attrs_encode Source code
base64_decode Source code
base64_encode Source code
batch Man page Source code
bind Man page Source code
border_chars Source code
border_width Source code
browse_data Man page Source code
buffer_color Source code
builtin_theme_colors Source code
bump_epoch Source code
button Man page Source code
c.termr_text Man page Source code
call_flex Source code
cell Man page Source code
cells_to_line Source code
char_width Source code
check_app Source code
check_choice Source code
check_count Source code
check_flag Source code
check_function Source code
check_key_values Source code
check_member_names Source code
check_named_functions Source code
check_named_list Source code
check_numbers Source code
check_optional_flag Source code
check_progress Source code
check_scalar_character Source code
check_terminal Source code
check_text Source code
check_unique_ids Source code
check_unique_ids_batch Source code
check_worker_options Source code
checkbox Man page Source code
chrome_edges Source code
clamp_size Source code
clean_input_value Source code
clean_paste Source code
clear_regions Source code
clear_size_caches Source code
collect_commands Source code
color_sgr Source code
color_sgr_one Source code
column Man page Source code
column_summary Source code
command Man page Source code
command_enabled Source code
command_text Source code
compose_frame Source code
computed Man page Source code
confirm_dialog Man page Source code
content_rect Source code
cross_size Source code
css_kind Source code
css_property Source code
current_app Man page Source code
current_theme Source code
data_browser Man page Source code
data_profile Man page Source code
data_table Man page Source code
db_connection Man page Source code
db_explorer Man page Source code
db_get_query Source code
db_metadata Man page Source code
db_query_source Man page Source code
db_table_source Man page Source code
debug_report Source code
decimals_needed Source code
decode_input_utf8 Source code
default_app_bindings Source code
default_driver Source code
default_formatter Source code
detect_color_mode Source code
diff_screen Man page Source code
dim_buffer Source code
dirty_rects Source code
dispose Man page Source code
dispose_node Source code
distribute Source code
draw_background Source code
draw_border Source code
draw_lines Source code
draw_scrollbar Source code
drivers Man page
dropdown Man page Source code
edit_text Source code
editor_wrap_starts Source code
effect_is_stale Source code
env_value Source code
export_buffer Source code
export_css_color Source code
filter_commands Source code
find_binding Source code
fit_columns Source code
flatten_style Source code
flatten_widgets Source code
flush_effects Source code
format.termr_binding Source code
format.termr_cell Source code
format.termr_command Source code
format.termr_patch Source code
format.termr_reactive Source code
format.termr_rect Source code
format.termr_size Source code
format.termr_style Source code
format.termr_stylesheet Source code
format.termr_text Source code
format.termr_theme Source code
format_compact_value Source code
format_metric Source code
format_value Source code
generator_inherits Source code
grapheme_count Source code
grapheme_prefix Source code
grapheme_slice Source code
grapheme_suffix Source code
grapheme_width Source code
grid_layout Man page Source code
grid_placement Source code
grid_plan Source code
grid_row_specs Source code
grid_track_sizes Source code
handler_matches Source code
handler_method_name Source code
headless_capabilities Source code
help_markdown Source code
hex_to_rgb Source code
hit_test Source code
horizontal Man page Source code
html_escape Source code
indexed_layout_tree Source code
input Man page Source code
input_chars Source code
inspect_signal Man page Source code
inspect_widget Man page Source code
invalidate_subs Source code
is_ascii Source code
is_binding Source code
is_command Source code
is_grapheme Source code
is_handler Source code
is_scalar_character Source code
is_scalar_number Source code
is_style Source code
is_table_source Source code
is_widget Source code
json_container Source code
json_scalar Source code
json_view Man page Source code
keep_background Source code
key_char Source code
key_event Man page Source code
key_value Man page Source code
knit_termr Man page Source code
label Man page Source code
layout_snapshot Source code
layout_tree Source code
line_width Source code
log_view Man page Source code
main_sizes Source code
make_key Source code
make_method Source code
markdown_blocks Source code
markdown_lines Source code
markdown_view Man page Source code
match_compound Source code
match_selector Source code
match_steps Source code
max_column_offset Source code
md_collect_links Source code
md_inline Source code
md_is_rule Source code
md_is_table_sep Source code
md_list_item Source code
md_parse_lines Source code
md_protect Source code
md_restore Source code
md_seg Source code
md_styles Source code
md_table_cells Source code
measure_grid Source code
measure_horizontal Source code
measure_vertical Source code
merge_rects Source code
merge_styles Source code
metric Man page Source code
modal Man page Source code
motion_reduced Man page Source code
natural_height Source code
natural_width Source code
nearest_color Source code
new_node Source code
new_patch Source code
new_style Source code
next_worker_name Source code
node_data Source code
normalize_color Source code
normalize_key Source code
normalize_property_data Source code
normalize_text Source code
now_seconds Source code
offset_for Source code
on Man page Source code
open_command_palette Source code
open_help Source code
option_list Man page Source code
pad_cells Source code
paint_layers Source code
paint_tree Source code
panel Man page Source code
parse_cell Source code
parse_classes Source code
parse_complex_selector Source code
parse_compound Source code
parse_declarations Source code
parse_gap Source code
parse_selector Source code
parse_size Source code
parse_span Source code
parse_style_props Source code
parse_stylesheet Source code
parse_tracks Source code
parse_uint32 Source code
parse_windows_integer Source code
parse_windows_number Source code
patch_to_ansi Man page Source code
peek Man page Source code
pos_equal Source code
pos_less Source code
pos_order Source code
posix_path_is_openable Source code
posix_select_terminal_path Source code
posix_stdin_is_tty Source code
print.termr_binding Source code
print.termr_capabilities Source code
print.termr_cell Source code
print.termr_command Source code
print.termr_computed Source code
print.termr_inspection Source code
print.termr_patch Source code
print.termr_reactive Source code
print.termr_rect Source code
print.termr_signal Source code
print.termr_style Source code
print.termr_stylesheet Source code
print.termr_text Source code
print.termr_theme Source code
print.termr_watch Source code
print.termr_widget_type Source code
process_view Man page Source code
profile_add Source code
profile_histogram Source code
profile_sample Source code
profile_start Source code
profile_summary Source code
progress_bar Man page Source code
property_grid Man page Source code
query_line_matches Source code
query_matches Source code
r_highlighter Man page Source code
radio_button Man page Source code
radio_set Man page Source code
reactive Man page Source code
read_only Source code
record_data Source code
record_view Man page Source code
rect Source code
rect_area Source code
rect_bottom Source code
rect_contains Source code
rect_intersect Source code
rect_is_empty Source code
rect_right Source code
rect_should_merge Source code
rect_shrink Source code
rect_union Source code
refresh_computed Source code
region Man page Source code
register_layout Man page Source code
render_children Source code
render_html Man page Source code
render_lines Man page Source code
render_markdown Man page Source code
render_svg Man page Source code
render_text Man page Source code
render_walk Source code
render_widget Man page Source code
resolve_fr Source code
resolve_style Source code
reveal_offset Source code
reveal_widget Source code
rgb_to_256 Source code
rule Man page Source code
run Man page Source code
run_css Source code
run_effect Source code
run_example Man page Source code
run_process Man page Source code
run_validator Source code
run_worker Man page Source code
safe_url Source code
sample_rows Source code
sanitize_markdown Source code
sanitize_text Source code
screen_buffer Man page Source code
screen_snapshot Man page Source code
screen_snapshot_json Man page Source code
scroll_view Man page Source code
search_chunks Source code
search_query Source code
search_rows Source code
selector_specificity Source code
set_interval Man page Source code
set_timeout Man page Source code
severity_style Source code
sgr_mouse_event Source code
signal Man page Source code
signals Man page
signed_high_word Source code
size_cache_get Source code
size_cache_set Source code
size_limits Source code
size_spec Source code
snapshot_changes Source code
snapshot_runs Source code
span Man page Source code
span_size Source code
sparkline Man page Source code
sparkline_text Source code
spinner Man page Source code
split_graphemes Source code
split_key Source code
split_lines Source code
split_pane Man page Source code
sql_editor Man page Source code
sql_highlighter Man page Source code
sqlite_query_adapter Source code
start_command Source code
start_worker Source code
state_binding Source code
stats_quantiles Source code
status_bar Man page Source code
status_text Source code
str_align Source code
str_truncate Source code
str_width Source code
strip_ansi Man page Source code
style Man page Source code
style_layout_signature Source code
stylesheet Man page Source code
stylesheet_error Source code
stylesheet_file Man page Source code
stylesheet_style Source code
tab Man page Source code
table_column_spec Source code
table_filter Man page Source code
table_join Source code
table_row_labels Source code
table_row_name_spec Source code
table_source Man page Source code
tabs Man page Source code
terminal_capabilities Man page Source code
termr Man page
termr-package Man page
termr_theme Man page Source code
test_app Man page Source code
text_area Man page Source code
text_cells Source code
text_lines Source code
text_pos Source code
theme_color Source code
toggle_debug_overlay Source code
track Source code
track_offsets Source code
tree_lines Source code
tree_node Man page Source code
tree_view Man page Source code
unicode_ok Source code
unlink_deps Source code
unregister_layout Man page Source code
untracked Man page Source code
update_signal Man page Source code
validate_id Source code
vertical Man page Source code
visible_area Source code
visible_children Source code
visible_range Source code
watch Man page Source code
widget Man page Source code
widget_cache_get Source code
widget_cache_set Source code
widget_node_snapshot Source code
widget_private Source code
widget_root Source code
widget_snapshot Man page Source code
widget_snapshot_json Man page Source code
windows_key_event Source code
windows_mouse_events Source code
worker_binding_env Source code
worker_copy_formula Source code
worker_copy_function Source code
worker_environment_chain Source code
worker_environment_summary Source code
worker_prepare_payload Source code
wrap_breaks Source code
wrap_line Source code
wrap_text_lines Source code
write_rendered Man page Source code
write_stdout Source code
write_windows_stdout Source code
xml_escape Source code
xterm256_rgb Source code
termr documentation built on Oct. 21, 2026, 5:13 p.m.