Skip to content
Textual
textual.widget
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.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.widget
Table of contents
widget
AwaitMount
BadWidgetName
MountError
PseudoClasses
enabled
focus
hover
Widget
*children
name
id
classes
disabled
markup
ALLOW_MAXIMIZE
ALLOW_SELECT
BORDER_SUBTITLE
BORDER_TITLE
FOCUS_ON_CLICK
absolute_offset
allow_horizontal_scroll
allow_maximize
allow_select
allow_vertical_scroll
auto_links
border_subtitle
border_title
can_focus
can_focus_children
container_scroll_offset
container_size
container_viewport
content_offset
content_region
content_size
disabled
dock_gutter
expand
first_child
first_of_type
focusable
gutter
has_focus
has_focus_within
highlight_link_id
horizontal_scrollbar
hover_style
is_anchored
is_container
is_disabled
is_even
is_horizontal_scroll_end
is_horizontal_scrollbar_grabbed
is_in_maximized_view
is_maximized
is_mounted
is_mouse_over
is_odd
is_on_screen
is_scrollable
is_scrolling
is_vertical_scroll_end
is_vertical_scrollbar_grabbed
last_child
last_of_type
layer
layers
layout
link_style
link_style_hover
loading
lock
max_scroll_x
max_scroll_y
mouse_hover
offset
opacity
outer_size
region
scroll_offset
scroll_target_x
scroll_target_y
scroll_x
scroll_y
scrollable_content_region
scrollable_size
scrollbar_corner
scrollbar_gutter
scrollbar_size_horizontal
scrollbar_size_vertical
scrollbars_enabled
scrollbars_space
select_container
show_horizontal_scrollbar
show_vertical_scrollbar
shrink
siblings
size
text_selection
tooltip
vertical_scrollbar
virtual_region
virtual_region_with_margin
virtual_size
visible_siblings
window_region
allow_focus
allow_focus_children
anchor
anchor
animate
attribute
value
final_value
duration
speed
delay
easing
on_complete
level
arrange
size
optimal
batch
begin_capture_print
stdout
stderr
blur
can_view_entire
widget
can_view_partial
widget
capture_mouse
capture
check_message_enabled
message
clear_cached_dimensions
compose
compose_add_child
widget
end_capture_print
focus
scroll_visible
focus_on_click
get_child_by_id
id
expect_type
get_child_by_type
expect_type
get_component_rich_style
names
partial
get_content_height
container
viewport
width
get_content_width
container
viewport
get_line_filters
get_loading_widget
get_pseudo_class_state
get_selection
get_style_at
x
y
get_visual_style
component_classes
partial
get_widget_by_id
id
expect_type
mount
*widgets
before
after
mount_all
widgets
before
after
mount_compose
compose_result
before
after
mount_composed_widgets
widgets
move_child
child
before
after
notify
message
title
severity
timeout
markup
on_prune
post_message
message
post_render
pre_layout
layout
pre_render
preflight_checks
process_layout
placements
recompose
refresh
*regions
repaint
layout
recompose
release_anchor
release_mouse
remove
remove_children
selector
render
render_line
y
render_lines
crop
render_str
text_content
run_action
action
namespaces
scroll_down
animate
speed
duration
easing
force
on_complete
level
immediate
scroll_end
animate
speed
duration
easing
force
on_complete
level
immediate
x_axis
y_axis
scroll_home
animate
speed
duration
easing
force
on_complete
level
immediate
x_axis
y_axis
scroll_left
animate
speed
duration
easing
force
on_complete
level
immediate
scroll_page_down
animate
speed
duration
easing
force
on_complete
level
scroll_page_left
animate
speed
duration
easing
force
on_complete
level
scroll_page_right
animate
speed
duration
easing
force
on_complete
level
scroll_page_up
animate
speed
duration
easing
force
on_complete
level
scroll_relative
x
y
animate
speed
duration
easing
force
on_complete
level
immediate
scroll_right
animate
speed
duration
easing
force
on_complete
level
immediate
scroll_to
x
y
animate
speed
duration
easing
force
on_complete
level
immediate
release_anchor
scroll_to_center
widget
animate
speed
duration
easing
force
origin_visible
on_complete
level
immediate
scroll_to_region
region
spacing
animate
speed
duration
easing
top
origin_visible
force
on_complete
level
x_axis
y_axis
immediate
scroll_to_widget
widget
animate
speed
duration
easing
top
origin_visible
force
on_complete
level
immediate
scroll_up
animate
speed
duration
easing
force
on_complete
level
immediate
scroll_visible
animate
speed
duration
top
easing
force
on_complete
level
immediate
selection_updated
selection
set_loading
loading
set_scroll
x
y
stop_animation
attribute
complete
suppress_click
text_select_all
watch_disabled
watch_has_focus
with_tooltip
tooltip
WidgetError
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
widget
AwaitMount
BadWidgetName
MountError
PseudoClasses
enabled
focus
hover
Widget
*children
name
id
classes
disabled
markup
ALLOW_MAXIMIZE
ALLOW_SELECT
BORDER_SUBTITLE
BORDER_TITLE
FOCUS_ON_CLICK
absolute_offset
allow_horizontal_scroll
allow_maximize
allow_select
allow_vertical_scroll
auto_links
border_subtitle
border_title
can_focus
can_focus_children
container_scroll_offset
container_size
container_viewport
content_offset
content_region
content_size
disabled
dock_gutter
expand
first_child
first_of_type
focusable
gutter
has_focus
has_focus_within
highlight_link_id
horizontal_scrollbar
hover_style
is_anchored
is_container
is_disabled
is_even
is_horizontal_scroll_end
is_horizontal_scrollbar_grabbed
is_in_maximized_view
is_maximized
is_mounted
is_mouse_over
is_odd
is_on_screen
is_scrollable
is_scrolling
is_vertical_scroll_end
is_vertical_scrollbar_grabbed
last_child
last_of_type
layer
layers
layout
link_style
link_style_hover
loading
lock
max_scroll_x
max_scroll_y
mouse_hover
offset
opacity
outer_size
region
scroll_offset
scroll_target_x
scroll_target_y
scroll_x
scroll_y
scrollable_content_region
scrollable_size
scrollbar_corner
scrollbar_gutter
scrollbar_size_horizontal
scrollbar_size_vertical
scrollbars_enabled
scrollbars_space
select_container
show_horizontal_scrollbar
show_vertical_scrollbar
shrink
siblings
size
text_selection
tooltip
vertical_scrollbar
virtual_region
virtual_region_with_margin
virtual_size
visible_siblings
window_region
allow_focus
allow_focus_children
anchor
anchor
animate
attribute
value
final_value
duration
speed
delay
easing
on_complete
level
arrange
size
optimal
batch
begin_capture_print
stdout
stderr
blur
can_view_entire
widget
can_view_partial
widget
capture_mouse
capture
check_message_enabled
message
clear_cached_dimensions
compose
compose_add_child
widget
end_capture_print
focus
scroll_visible
focus_on_click
get_child_by_id
id
expect_type
get_child_by_type
expect_type
get_component_rich_style
names
partial
get_content_height
container
viewport
width
get_content_width
container
viewport
get_line_filters
get_loading_widget
get_pseudo_class_state
get_selection
get_style_at
x
y
get_visual_style
component_classes
partial
get_widget_by_id
id
expect_type
mount
*widgets
before
after
mount_all
widgets
before
after
mount_compose
compose_result
before
after
mount_composed_widgets
widgets
move_child
child
before
after
notify
message
title
severity
timeout
markup
on_prune
post_message
message
post_render
pre_layout
layout
pre_render
preflight_checks
process_layout
placements
recompose
refresh
*regions
repaint
layout
recompose
release_anchor
release_mouse
remove
remove_children
selector
render
render_line
y
render_lines
crop
render_str
text_content
run_action
action
namespaces
scroll_down
animate
speed
duration
easing
force
on_complete
level
immediate
scroll_end
animate
speed
duration
easing
force
on_complete
level
immediate
x_axis
y_axis
scroll_home
animate
speed
duration
easing
force
on_complete
level
immediate
x_axis
y_axis
scroll_left
animate
speed
duration
easing
force
on_complete
level
immediate
scroll_page_down
animate
speed
duration
easing
force
on_complete
level
scroll_page_left
animate
speed
duration
easing
force
on_complete
level
scroll_page_right
animate
speed
duration
easing
force
on_complete
level
scroll_page_up
animate
speed
duration
easing
force
on_complete
level
scroll_relative
x
y
animate
speed
duration
easing
force
on_complete
level
immediate
scroll_right
animate
speed
duration
easing
force
on_complete
level
immediate
scroll_to
x
y
animate
speed
duration
easing
force
on_complete
level
immediate
release_anchor
scroll_to_center
widget
animate
speed
duration
easing
force
origin_visible
on_complete
level
immediate
scroll_to_region
region
spacing
animate
speed
duration
easing
top
origin_visible
force
on_complete
level
x_axis