Skip to content
Textual
textual.app
Initializing search
GitHub
Home
Introduction
Tutorial
Guide
Widgets
Reference
API
How To
FAQ
Roadmap
Blog
Textual
GitHub
Home
Introduction
Introduction
Getting started
Help
Tutorial
Guide
Guide
Devtools
App Basics
Styles
Textual CSS
DOM Queries
Layout
Events and Messages
Input
Actions
Reactivity
Themes
Widgets
Content
Animation
Screens
Workers
Command Palette
Testing
Widgets
Reference
Reference
CSS Types
CSS Types
<border>
<color>
<hatch>
<horizontal>
<integer>
<keyline>
<name>
<number>
<overflow>
<position>
<percentage>
<scalar>
<text-align>
<text-style>
<vertical>
Events
Events
AppBlur
AppFocus
Blur
Click
DescendantBlur
DescendantFocus
Enter
Focus
Hide
Key
Leave
Load
Mount
MouseCapture
MouseDown
MouseMove
MouseRelease
MouseScrollDown
MouseScrollUp
MouseUp
Paste
Print
Resize
ScreenResume
ScreenSuspend
Show
Unmount
Styles
Styles
Align
Background
Background-tint
Border
Border-subtitle-align
Border-subtitle-background
Border-subtitle-color
Border-subtitle-style
Border-title-align
Border-title-background
Border-title-color
Border-title-style
Box-sizing
Color
Content-align
Display
Dock
Grid
Grid
Column-span
Grid-columns
Grid-gutter
Grid-rows
Grid-size
Row-span
Hatch
Height
Keyline
Layer
Layers
Layout
Links
Links
Link-background
Link-background-hover
Link-color
Link-color-hover
Link-style
Link-style-hover
Margin
Max-height
Max-width
Min-height
Min-width
Offset
Opacity
Outline
Overflow
Padding
Position
Scrollbar colors
Scrollbar colors
Scrollbar-background
Scrollbar-background-active
Scrollbar-background-hover
Scrollbar-color
Scrollbar-color-active
Scrollbar-color-hover
Scrollbar-corner-color
Scrollbar-gutter
Scrollbar-size
Scrollbar-visibility
Text-align
Text-opacity
Text-overflow
Text-wrap
Text-style
Tint
Visibility
Width
Widgets
Widgets
Button
Checkbox
Collapsible
ContentSwitcher
DataTable
Digits
DirectoryTree
Footer
Header
Input
Label
Link
ListItem
ListView
LoadingIndicator
Log
MarkdownViewer
Markdown
MaskedInput
OptionList
Placeholder
Pretty
ProgressBar
RadioButton
RadioSet
RichLog
Rule
Select
SelectionList
Sparkline
Static
Switch
TabbedContent
Tabs
TextArea
Toast
Tree
API
API
textual.app
textual.app
Table of contents
app
AutopilotCallbackType
CommandCallback
RenderResult
ScreenType
ActionError
ActiveModeError
App
driver_class
css_path
watch_css
ansi_color
ALLOW_IN_MAXIMIZED_VIEW
ALLOW_SELECT
AUTO_FOCUS
BINDINGS
BINDING_GROUP_TITLE
CLICK_CHAIN_TIME_THRESHOLD
CLOSE_TIMEOUT
COMMANDS
COMMAND_PALETTE_BINDING
COMMAND_PALETTE_DISPLAY
CSS
CSS_PATH
DEFAULT_MODE
ENABLE_COMMAND_PALETTE
ESCAPE_TO_MINIMIZE
HORIZONTAL_BREAKPOINTS
INLINE_PADDING
MODES
NOTIFICATION_TIMEOUT
SCREENS
SUB_TITLE
SUSPENDED_SCREEN_CLASS
TITLE
TOOLTIP_DELAY
VERTICAL_BREAKPOINTS
active_bindings
animation_level
animator
ansi_color
ansi_theme
ansi_theme_dark
ansi_theme_light
app_focus
app_resume_signal
app_suspend_signal
available_themes
children
clipboard
console_options
current_mode
cursor_position
debug
default_screen
escape_to_minimize
focused
hover_over
is_attached
is_dom_root
is_headless
is_inline
is_web
log
mouse_over
return_code
return_value
screen
screen_stack
scroll_sensitivity_x
scroll_sensitivity_y
size
sub_title
supports_smooth_scrolling
theme
theme_changed_signal
theme_variables
title
use_command_palette
viewport_size
workers
action_add_class
selector
class_name
action_back
action_bell
action_change_theme
action_command_palette
action_focus
widget_id
action_focus_next
action_focus_previous
action_help_quit
action_hide_help_panel
action_notify
action_pop_screen
action_push_screen
screen
action_quit
action_remove_class
selector
class_name
action_screenshot
filename
path
action_show_help_panel
action_simulate_key
key
action_suspend_process
action_switch_mode
action_switch_screen
screen
action_toggle_class
selector
class_name
action_toggle_dark
add_mode
mode
base_screen
animate
attribute
value
final_value
duration
speed
delay
easing
on_complete
level
batch_update
begin_capture_print
target
stdout
stderr
bell
bind
keys
action
description
show
key_display
call_from_thread
callback
*args
**kwargs
capture_mouse
widget
clear_notifications
clear_selection
compose
copy_to_clipboard
text
delay_update
delay
deliver_binary
path_or_file
save_directory
save_filename
open_method
mime_type
name
deliver_screenshot
filename
path
time_format
deliver_text
path_or_file
save_directory
save_filename
encoding
mime_type
name
end_capture_print
target
exit
result
return_code
message
export_screenshot
title
simplify
format_title
title
sub_title
get_child_by_id
id
expect_type
get_child_by_type
expect_type
get_css_variables
get_default_screen
get_driver_class
get_key_display
binding
get_line_filters
get_loading_widget
get_screen
screen
screen_class
get_system_commands
screen
get_theme
theme_name
get_theme_variable_defaults
get_widget_at
x
y
get_widget_by_id
id
expect_type
handle_bindings_clash
clashed_bindings
node
install_screen
screen
name
is_mounted
widget
is_screen_installed
screen
mount
*widgets
before
after
mount_all
widgets
before
after
notify
message
title
severity
timeout
markup
open_url
url
new_tab
panic
*renderables
pop_screen
post_display_hook
push_screen
screen
callback
wait_for_dismiss
push_screen_wait
screen
recompose
refresh
repaint
layout
recompose
refresh_css
animate
register_theme
theme
remove_mode
mode
render
run
headless
inline
inline_no_clear
mouse
size
auto_pilot
loop
run_action
action
default_namespace
namespaces
run_async
headless
inline
inline_no_clear
mouse
size
auto_pilot
run_test
headless
size
tooltips
notifications
message_hook
save_screenshot
filename
path
time_format
search_commands
commands
placeholder
search_themes
set_focus
widget
scroll_visible
set_keymap
keymap
simulate_key
key
stop_animation
attribute
complete
suspend
switch_mode
mode
switch_screen
screen
uninstall_screen
screen
unregister_theme
theme_name
update_keymap
keymap
update_styles
validate_sub_title
validate_title
AppError
InvalidModeError
InvalidThemeError
ModeError
ScreenError
ScreenStackError
SuspendNotSupported
SystemCommand
callback
discover
help
title
UnknownModeError
get_system_commands_provider
textual.await_complete
textual.await_remove
textual.binding
textual.cache
textual.color
textual.command
textual.constants
textual.containers
textual.compose
textual.content
textual.coordinate
textual.dom
textual.events
textual.errors
textual.filter
textual.fuzzy
textual.geometry
textual.getters
textual.highlight
textual.layout
textual.lazy
textual
textual.logging
textual.map_geometry
textual.markup
textual.message_pump
textual.message
textual.on
textual.pilot
textual.css.query
textual.reactive
textual.renderables
textual.screen
textual.scrollbar
textual.scroll_view
textual.signal
textual.strip
textual.suggester
textual.system_commands
textual.timer
textual.types
textual.validation
textual.walk
textual.widget
textual.work
textual.worker
textual.worker_manager
How To
How To
Center things
Design a Layout
Package a Textual app with Hatch
Render and compose
Style Inline Apps
Save time with Textual containers
FAQ
Roadmap
Blog
Blog
Archive
Archive
2025
2024
2023
2022
Categories
Categories
DevLog
News
Release
Table of contents
app
AutopilotCallbackType
CommandCallback
RenderResult
ScreenType
ActionError
ActiveModeError
App
driver_class
css_path
watch_css
ansi_color
ALLOW_IN_MAXIMIZED_VIEW
ALLOW_SELECT
AUTO_FOCUS
BINDINGS
BINDING_GROUP_TITLE
CLICK_CHAIN_TIME_THRESHOLD
CLOSE_TIMEOUT
COMMANDS
COMMAND_PALETTE_BINDING
COMMAND_PALETTE_DISPLAY
CSS
CSS_PATH
DEFAULT_MODE
ENABLE_COMMAND_PALETTE
ESCAPE_TO_MINIMIZE
HORIZONTAL_BREAKPOINTS
INLINE_PADDING
MODES
NOTIFICATION_TIMEOUT
SCREENS
SUB_TITLE
SUSPENDED_SCREEN_CLASS
TITLE
TOOLTIP_DELAY
VERTICAL_BREAKPOINTS