Module textual.containers
Expand source code
from .widget import Widget
class Container(Widget):
"""Simple container widget, with vertical layout."""
DEFAULT_CSS = """
Container {
layout: vertical;
overflow: auto;
}
"""
class Vertical(Widget):
"""A container widget which aligns children vertically."""
DEFAULT_CSS = """
Vertical {
layout: vertical;
overflow-y: auto;
}
"""
class Horizontal(Widget):
"""A container widget which aligns children horizontally."""
DEFAULT_CSS = """
Horizontal {
layout: horizontal;
overflow-x: hidden;
}
"""
class Grid(Widget):
"""A container widget with grid alignment."""
DEFAULT_CSS = """
Grid {
layout: grid;
}
"""
class Content(Widget, can_focus=True, can_focus_children=False):
"""A container for content such as text."""
DEFAULT_CSS = """
Vertical {
layout: vertical;
overflow-y: auto;
}
"""
Classes
class Container (*children: Widget, name: str | None = None, id: str | None = None, classes: str | None = None)-
Simple container widget, with vertical layout.
Expand source code
class Container(Widget): """Simple container widget, with vertical layout.""" DEFAULT_CSS = """ Container { layout: vertical; overflow: auto; } """Ancestors
Subclasses
Class variables
var COMPONENT_CLASSES : ClassVar[set[str]]var DEFAULT_CSS
Inherited members
Widget:actionadd_classallow_horizontal_scrollallow_vertical_scrollancestorsanimateappauto_heightauto_linksauto_widthbackground_colorscall_latercan_focuscan_focus_childrencapture_mousecheck_idleclassescolorscomposecontainer_sizecontainer_viewportcontent_offsetcontent_regioncontent_sizecss_identifiercss_identifier_styledcss_path_nodesdisable_messagesdispatch_keydisplaydisplayed_childrenemitemit_no_waitenable_messagesexpandfocusfocusable_childrenget_childget_component_rich_styleget_component_stylesget_content_heightget_content_widthget_default_cssget_pseudo_classesget_style_atgutterhas_classhas_focushas_pseudo_classhighlight_link_idhorizontal_scrollbarhover_styleidis_containeris_scrollableis_transparentlayerlayerslink_hover_stylelink_stylelogmax_scroll_xmax_scroll_ymountmouse_overoffseton_eventouter_sizeparentpost_messagepost_message_no_waitpost_renderpseudo_classesqueryquery_onerefreshregionrelease_mouseremoveremove_classrenderrender_linerender_linesreset_focusreset_stylesrich_stylescreenscroll_downscroll_endscroll_homescroll_leftscroll_offsetscroll_page_downscroll_page_leftscroll_page_rightscroll_page_upscroll_relativescroll_rightscroll_target_xscroll_target_yscroll_toscroll_to_regionscroll_to_widgetscroll_upscroll_visiblescroll_xscroll_yscrollbar_cornerscrollbar_gutterscrollbar_size_horizontalscrollbar_size_verticalscrollbars_enabledset_classset_intervalset_stylesset_timershow_horizontal_scrollbarshow_vertical_scrollbarshrinksiblingssizetext_styletoggle_classtreevertical_scrollbarvirtual_regionvirtual_region_with_marginvirtual_sizevisiblevisible_siblingswalk_childrenwatch_has_focuswatch_mouse_overwindow_region
class Content (*children: Widget, name: str | None = None, id: str | None = None, classes: str | None = None)-
A container for content such as text.
Expand source code
class Content(Widget, can_focus=True, can_focus_children=False): """A container for content such as text.""" DEFAULT_CSS = """ Vertical { layout: vertical; overflow-y: auto; } """Ancestors
Class variables
var COMPONENT_CLASSES : ClassVar[set[str]]var DEFAULT_CSS
Inherited members
Widget:actionadd_classallow_horizontal_scrollallow_vertical_scrollancestorsanimateappauto_heightauto_linksauto_widthbackground_colorscall_latercan_focuscan_focus_childrencapture_mousecheck_idleclassescolorscomposecontainer_sizecontainer_viewportcontent_offsetcontent_regioncontent_sizecss_identifiercss_identifier_styledcss_path_nodesdisable_messagesdispatch_keydisplaydisplayed_childrenemitemit_no_waitenable_messagesexpandfocusfocusable_childrenget_childget_component_rich_styleget_component_stylesget_content_heightget_content_widthget_default_cssget_pseudo_classesget_style_atgutterhas_classhas_focushas_pseudo_classhighlight_link_idhorizontal_scrollbarhover_styleidis_containeris_scrollableis_transparentlayerlayerslink_hover_stylelink_stylelogmax_scroll_xmax_scroll_ymountmouse_overoffseton_eventouter_sizeparentpost_messagepost_message_no_waitpost_renderpseudo_classesqueryquery_onerefreshregionrelease_mouseremoveremove_classrenderrender_linerender_linesreset_focusreset_stylesrich_stylescreenscroll_downscroll_endscroll_homescroll_leftscroll_offsetscroll_page_downscroll_page_leftscroll_page_rightscroll_page_upscroll_relativescroll_rightscroll_target_xscroll_target_yscroll_toscroll_to_regionscroll_to_widgetscroll_upscroll_visiblescroll_xscroll_yscrollbar_cornerscrollbar_gutterscrollbar_size_horizontalscrollbar_size_verticalscrollbars_enabledset_classset_intervalset_stylesset_timershow_horizontal_scrollbarshow_vertical_scrollbarshrinksiblingssizetext_styletoggle_classtreevertical_scrollbarvirtual_regionvirtual_region_with_marginvirtual_sizevisiblevisible_siblingswalk_childrenwatch_has_focuswatch_mouse_overwindow_region
class Grid (*children: Widget, name: str | None = None, id: str | None = None, classes: str | None = None)-
A container widget with grid alignment.
Expand source code
class Grid(Widget): """A container widget with grid alignment.""" DEFAULT_CSS = """ Grid { layout: grid; } """Ancestors
Class variables
var COMPONENT_CLASSES : ClassVar[set[str]]var DEFAULT_CSS
Inherited members
Widget:actionadd_classallow_horizontal_scrollallow_vertical_scrollancestorsanimateappauto_heightauto_linksauto_widthbackground_colorscall_latercan_focuscan_focus_childrencapture_mousecheck_idleclassescolorscomposecontainer_sizecontainer_viewportcontent_offsetcontent_regioncontent_sizecss_identifiercss_identifier_styledcss_path_nodesdisable_messagesdispatch_keydisplaydisplayed_childrenemitemit_no_waitenable_messagesexpandfocusfocusable_childrenget_childget_component_rich_styleget_component_stylesget_content_heightget_content_widthget_default_cssget_pseudo_classesget_style_atgutterhas_classhas_focushas_pseudo_classhighlight_link_idhorizontal_scrollbarhover_styleidis_containeris_scrollableis_transparentlayerlayerslink_hover_stylelink_stylelogmax_scroll_xmax_scroll_ymountmouse_overoffseton_eventouter_sizeparentpost_messagepost_message_no_waitpost_renderpseudo_classesqueryquery_onerefreshregionrelease_mouseremoveremove_classrenderrender_linerender_linesreset_focusreset_stylesrich_stylescreenscroll_downscroll_endscroll_homescroll_leftscroll_offsetscroll_page_downscroll_page_leftscroll_page_rightscroll_page_upscroll_relativescroll_rightscroll_target_xscroll_target_yscroll_toscroll_to_regionscroll_to_widgetscroll_upscroll_visiblescroll_xscroll_yscrollbar_cornerscrollbar_gutterscrollbar_size_horizontalscrollbar_size_verticalscrollbars_enabledset_classset_intervalset_stylesset_timershow_horizontal_scrollbarshow_vertical_scrollbarshrinksiblingssizetext_styletoggle_classtreevertical_scrollbarvirtual_regionvirtual_region_with_marginvirtual_sizevisiblevisible_siblingswalk_childrenwatch_has_focuswatch_mouse_overwindow_region
class Horizontal (*children: Widget, name: str | None = None, id: str | None = None, classes: str | None = None)-
A container widget which aligns children horizontally.
Expand source code
class Horizontal(Widget): """A container widget which aligns children horizontally.""" DEFAULT_CSS = """ Horizontal { layout: horizontal; overflow-x: hidden; } """Ancestors
Subclasses
Class variables
var COMPONENT_CLASSES : ClassVar[set[str]]var DEFAULT_CSS
Inherited members
Widget:actionadd_classallow_horizontal_scrollallow_vertical_scrollancestorsanimateappauto_heightauto_linksauto_widthbackground_colorscall_latercan_focuscan_focus_childrencapture_mousecheck_idleclassescolorscomposecontainer_sizecontainer_viewportcontent_offsetcontent_regioncontent_sizecss_identifiercss_identifier_styledcss_path_nodesdisable_messagesdispatch_keydisplaydisplayed_childrenemitemit_no_waitenable_messagesexpandfocusfocusable_childrenget_childget_component_rich_styleget_component_stylesget_content_heightget_content_widthget_default_cssget_pseudo_classesget_style_atgutterhas_classhas_focushas_pseudo_classhighlight_link_idhorizontal_scrollbarhover_styleidis_containeris_scrollableis_transparentlayerlayerslink_hover_stylelink_stylelogmax_scroll_xmax_scroll_ymountmouse_overoffseton_eventouter_sizeparentpost_messagepost_message_no_waitpost_renderpseudo_classesqueryquery_onerefreshregionrelease_mouseremoveremove_classrenderrender_linerender_linesreset_focusreset_stylesrich_stylescreenscroll_downscroll_endscroll_homescroll_leftscroll_offsetscroll_page_downscroll_page_leftscroll_page_rightscroll_page_upscroll_relativescroll_rightscroll_target_xscroll_target_yscroll_toscroll_to_regionscroll_to_widgetscroll_upscroll_visiblescroll_xscroll_yscrollbar_cornerscrollbar_gutterscrollbar_size_horizontalscrollbar_size_verticalscrollbars_enabledset_classset_intervalset_stylesset_timershow_horizontal_scrollbarshow_vertical_scrollbarshrinksiblingssizetext_styletoggle_classtreevertical_scrollbarvirtual_regionvirtual_region_with_marginvirtual_sizevisiblevisible_siblingswalk_childrenwatch_has_focuswatch_mouse_overwindow_region
class Vertical (*children: Widget, name: str | None = None, id: str | None = None, classes: str | None = None)-
A container widget which aligns children vertically.
Expand source code
class Vertical(Widget): """A container widget which aligns children vertically.""" DEFAULT_CSS = """ Vertical { layout: vertical; overflow-y: auto; } """Ancestors
Subclasses
Class variables
var COMPONENT_CLASSES : ClassVar[set[str]]var DEFAULT_CSS
Inherited members
Widget:actionadd_classallow_horizontal_scrollallow_vertical_scrollancestorsanimateappauto_heightauto_linksauto_widthbackground_colorscall_latercan_focuscan_focus_childrencapture_mousecheck_idleclassescolorscomposecontainer_sizecontainer_viewportcontent_offsetcontent_regioncontent_sizecss_identifiercss_identifier_styledcss_path_nodesdisable_messagesdispatch_keydisplaydisplayed_childrenemitemit_no_waitenable_messagesexpandfocusfocusable_childrenget_childget_component_rich_styleget_component_stylesget_content_heightget_content_widthget_default_cssget_pseudo_classesget_style_atgutterhas_classhas_focushas_pseudo_classhighlight_link_idhorizontal_scrollbarhover_styleidis_containeris_scrollableis_transparentlayerlayerslink_hover_stylelink_stylelogmax_scroll_xmax_scroll_ymountmouse_overoffseton_eventouter_sizeparentpost_messagepost_message_no_waitpost_renderpseudo_classesqueryquery_onerefreshregionrelease_mouseremoveremove_classrenderrender_linerender_linesreset_focusreset_stylesrich_stylescreenscroll_downscroll_endscroll_homescroll_leftscroll_offsetscroll_page_downscroll_page_leftscroll_page_rightscroll_page_upscroll_relativescroll_rightscroll_target_xscroll_target_yscroll_toscroll_to_regionscroll_to_widgetscroll_upscroll_visiblescroll_xscroll_yscrollbar_cornerscrollbar_gutterscrollbar_size_horizontalscrollbar_size_verticalscrollbars_enabledset_classset_intervalset_stylesset_timershow_horizontal_scrollbarshow_vertical_scrollbarshrinksiblingssizetext_styletoggle_classtreevertical_scrollbarvirtual_regionvirtual_region_with_marginvirtual_sizevisiblevisible_siblingswalk_childrenwatch_has_focuswatch_mouse_overwindow_region