Module textual.demo

Expand source code 
from __future__ import annotations

from importlib_metadata import version
from pathlib import Path

from rich import box
from rich.console import RenderableType
from rich.json import JSON
from rich.markdown import Markdown
from rich.pretty import Pretty
from rich.syntax import Syntax
from rich.table import Table
from rich.text import Text

from textual.app import App, ComposeResult
from textual.binding import Binding
from textual.containers import Container, Horizontal
from textual.reactive import reactive, watch
from textual.widgets import (
    Button,
    Checkbox,
    DataTable,
    Footer,
    Header,
    Input,
    Static,
    TextLog,
)

from_markup = Text.from_markup

example_table = Table(
    show_edge=False,
    show_header=True,
    expand=True,
    row_styles=["none", "dim"],
    box=box.SIMPLE,
)
example_table.add_column(from_markup("[green]Date"), style="green", no_wrap=True)
example_table.add_column(from_markup("[blue]Title"), style="blue")

example_table.add_column(
    from_markup("[magenta]Box Office"),
    style="magenta",
    justify="right",
    no_wrap=True,
)
example_table.add_row(
    "Dec 20, 2019",
    "Star Wars: The Rise of Skywalker",
    "$375,126,118",
)
example_table.add_row(
    "May 25, 2018",
    from_markup("[b]Solo[/]: A Star Wars Story"),
    "$393,151,347",
)
example_table.add_row(
    "Dec 15, 2017",
    "Star Wars Ep. VIII: The Last Jedi",
    from_markup("[bold]$1,332,539,889[/bold]"),
)
example_table.add_row(
    "May 19, 1999",
    from_markup("Star Wars Ep. [b]I[/b]: [i]The phantom Menace"),
    "$1,027,044,677",
)


WELCOME_MD = """

## Textual Demo

**Welcome**! Textual is a framework for creating sophisticated applications with the terminal.

"""


RICH_MD = """

Textual is built on **Rich**, the popular Python library for advanced terminal output.

Add content to your Textual App with Rich *renderables* (this text is written in Markdown and formatted with Rich's Markdown class).

Here are some examples:


"""

CSS_MD = """

Textual uses Cascading Stylesheets (CSS) to create Rich interactive User Interfaces.

- **Easy to learn** - much simpler than browser CSS
- **Live editing** - see your changes without restarting the app!

Here's an example of some CSS used in this app:

"""


EXAMPLE_CSS = """\
Screen {
    layers: base overlay notes;
    overflow: hidden;  
}

Sidebar {    
    width: 40;
    background: $panel;   
    transition: offset 500ms in_out_cubic;    
    layer: overlay;
    
}

Sidebar.-hidden {
    offset-x: -100%;
}"""

DATA = {
    "foo": [
        3.1427,
        (
            "Paul Atreides",
            "Vladimir Harkonnen",
            "Thufir Hawat",
            "Gurney Halleck",
            "Duncan Idaho",
        ),
    ],
}

WIDGETS_MD = """

Textual widgets are powerful interactive components.

Build your own or use the builtin widgets.

- **Input** Text / Password input.
- **Button** Clickable button with a number of styles.
- **Checkbox** A checkbox to toggle between states.
- **DataTable** A spreadsheet-like widget for navigating data. Cells may contain text or Rich renderables.
- **TreeControl** An generic tree with expandable nodes.
- **DirectoryTree** A tree of file and folders.
- *... many more planned ...* 

"""


MESSAGE = """
We hope you enjoy using Textual.

Here are some links. You can click these!

[@click="app.open_link('https://textual.textualize.io')"]Textual Docs[/]

[@click="app.open_link('https://github.com/Textualize/textual')"]Textual GitHub Repository[/]

[@click="app.open_link('https://github.com/Textualize/rich')"]Rich GitHub Repository[/]


Built with ♥  by [@click="app.open_link(https://www.textualize.io)"]Textualize.io[/]

"""


JSON_EXAMPLE = """{
    "glossary": {
        "title": "example glossary",
                "GlossDiv": {
            "title": "S",
                        "GlossList": {
                "GlossEntry": {
                    "ID": "SGML",
                                        "SortAs": "SGML",
                                        "GlossTerm": "Standard Generalized Markup Language",
                                        "Acronym": "SGML",
                                        "Abbrev": "ISO 8879:1986",
                                        "GlossDef": {
                        "para": "A meta-markup language, used to create markup languages such as DocBook.",
                                                "GlossSeeAlso": ["GML", "XML"]
                    },
                                        "GlossSee": "markup"
                }
            }
        }
    }
}
"""


class Body(Container):
    pass


class Title(Static):
    pass


class DarkSwitch(Horizontal):
    def compose(self) -> ComposeResult:
        yield Checkbox(value=self.app.dark)
        yield Static("Dark mode toggle", classes="label")

    def on_mount(self) -> None:
        watch(self.app, "dark", self.on_dark_change)

    def on_dark_change(self, dark: bool) -> None:
        self.query_one(Checkbox).value = self.app.dark

    def on_checkbox_changed(self, event: Checkbox.Changed) -> None:
        self.app.dark = event.value


class Welcome(Container):
    def compose(self) -> ComposeResult:
        yield Static(Markdown(WELCOME_MD))
        yield Button("Start", variant="success")

    def on_button_pressed(self, event: Button.Pressed) -> None:
        self.app.add_note("[b magenta]Start!")
        self.app.query_one(".location-first").scroll_visible(speed=50, top=True)


class OptionGroup(Container):
    pass


class SectionTitle(Static):
    pass


class Message(Static):
    pass


class Version(Static):
    def render(self) -> RenderableType:
        return f"[b]v{version('textual')}"


class Sidebar(Container):
    def compose(self) -> ComposeResult:
        yield Title("Textual Demo")
        yield OptionGroup(Message(MESSAGE), Version())
        yield DarkSwitch()


class AboveFold(Container):
    pass


class Section(Container):
    pass


class Column(Container):
    pass


class TextContent(Static):
    pass


class QuickAccess(Container):
    pass


class LocationLink(Static):
    def __init__(self, label: str, reveal: str) -> None:
        super().__init__(label)
        self.reveal = reveal

    def on_click(self) -> None:
        self.app.query_one(self.reveal).scroll_visible(top=True)
        self.app.add_note(f"Scrolling to [b]{self.reveal}[/b]")


class LoginForm(Container):
    def compose(self) -> ComposeResult:
        yield Static("Username", classes="label")
        yield Input(placeholder="Username")
        yield Static("Password", classes="label")
        yield Input(placeholder="Password", password=True)
        yield Static()
        yield Button("Login", variant="primary")


class Window(Container):
    pass


class SubTitle(Static):
    pass


class Notification(Static):
    def on_mount(self) -> None:
        self.set_timer(3, self.remove)

    def on_click(self) -> None:
        self.remove()


class DemoApp(App):
    CSS_PATH = "demo.css"
    TITLE = "Textual Demo"
    BINDINGS = [
        ("ctrl+b", "toggle_sidebar", "Sidebar"),
        ("ctrl+t", "app.toggle_dark", "Toggle Dark mode"),
        ("ctrl+s", "app.screenshot()", "Screenshot"),
        ("f1", "app.toggle_class('TextLog', '-hidden')", "Notes"),
        Binding("ctrl+c,ctrl+q", "app.quit", "Quit", show=True),
    ]

    show_sidebar = reactive(False)

    def add_note(self, renderable: RenderableType) -> None:
        self.query_one(TextLog).write(renderable)

    def compose(self) -> ComposeResult:
        example_css = "\n".join(Path(self.css_path).read_text().splitlines()[:50])
        yield Container(
            Sidebar(classes="-hidden"),
            Header(show_clock=True),
            TextLog(classes="-hidden", wrap=False, highlight=True, markup=True),
            Body(
                QuickAccess(
                    LocationLink("TOP", ".location-top"),
                    LocationLink("Widgets", ".location-widgets"),
                    LocationLink("Rich content", ".location-rich"),
                    LocationLink("CSS", ".location-css"),
                ),
                AboveFold(Welcome(), classes="location-top"),
                Column(
                    Section(
                        SectionTitle("Widgets"),
                        TextContent(Markdown(WIDGETS_MD)),
                        LoginForm(),
                        DataTable(),
                    ),
                    classes="location-widgets location-first",
                ),
                Column(
                    Section(
                        SectionTitle("Rich"),
                        TextContent(Markdown(RICH_MD)),
                        SubTitle("Pretty Printed data (try resizing the terminal)"),
                        Static(Pretty(DATA, indent_guides=True), classes="pretty pad"),
                        SubTitle("JSON"),
                        Window(Static(JSON(JSON_EXAMPLE), expand=True), classes="pad"),
                        SubTitle("Tables"),
                        Static(example_table, classes="table pad"),
                    ),
                    classes="location-rich",
                ),
                Column(
                    Section(
                        SectionTitle("CSS"),
                        TextContent(Markdown(CSS_MD)),
                        Window(
                            Static(
                                Syntax(
                                    example_css,
                                    "css",
                                    theme="material",
                                    line_numbers=True,
                                ),
                                expand=True,
                            )
                        ),
                    ),
                    classes="location-css",
                ),
            ),
        )
        yield Footer()

    def action_open_link(self, link: str) -> None:
        self.app.bell()
        import webbrowser

        webbrowser.open(link)

    def action_toggle_sidebar(self) -> None:
        sidebar = self.query_one(Sidebar)
        self.set_focus(None)
        if sidebar.has_class("-hidden"):
            sidebar.remove_class("-hidden")
        else:
            if sidebar.query("*:focus"):
                self.screen.set_focus(None)
            sidebar.add_class("-hidden")

    def on_mount(self) -> None:
        self.add_note("Textual Demo app is running")
        table = self.query_one(DataTable)
        table.add_column("Foo", width=20)
        table.add_column("Bar", width=20)
        table.add_column("Baz", width=20)
        table.add_column("Foo", width=20)
        table.add_column("Bar", width=20)
        table.add_column("Baz", width=20)
        table.zebra_stripes = True
        for n in range(20):
            table.add_row(*[f"Cell ([b]{n}[/b], {col})" for col in range(6)])
        self.query_one("Welcome Button", Button).focus()

    def action_screenshot(self, filename: str | None = None, path: str = "./") -> None:
        """Save an SVG "screenshot". This action will save an SVG file containing the current contents of the screen.

        Args:
            filename (str | None, optional): Filename of screenshot, or None to auto-generate. Defaults to None.
            path (str, optional): Path to directory. Defaults to "./".
        """
        self.bell()
        path = self.save_screenshot(filename, path)
        message = Text.assemble("Screenshot saved to ", (f"'{path}'", "bold green"))
        self.add_note(message)
        self.screen.mount(Notification(message))


app = DemoApp()
if __name__ == "__main__":
    app.run()

Classes

class AboveFold (*children: Widget, name: str | None = None, id: str | None = None, classes: str | None = None)

Simple container widget, with vertical layout.

Expand source code 
class AboveFold(Container):
    pass

Ancestors

Class variables

var COMPONENT_CLASSES : ClassVar[set[str]]

Inherited members

class Body (*children: Widget, name: str | None = None, id: str | None = None, classes: str | None = None)

Simple container widget, with vertical layout.

Expand source code 
class Body(Container):
    pass

Ancestors

Class variables

var COMPONENT_CLASSES : ClassVar[set[str]]

Inherited members

class Column (*children: Widget, name: str | None = None, id: str | None = None, classes: str | None = None)

Simple container widget, with vertical layout.

Expand source code 
class Column(Container):
    pass

Ancestors

Class variables

var COMPONENT_CLASSES : ClassVar[set[str]]

Inherited members

class DarkSwitch (*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 DarkSwitch(Horizontal):
    def compose(self) -> ComposeResult:
        yield Checkbox(value=self.app.dark)
        yield Static("Dark mode toggle", classes="label")

    def on_mount(self) -> None:
        watch(self.app, "dark", self.on_dark_change)

    def on_dark_change(self, dark: bool) -> None:
        self.query_one(Checkbox).value = self.app.dark

    def on_checkbox_changed(self, event: Checkbox.Changed) -> None:
        self.app.dark = event.value

Ancestors

Class variables

var COMPONENT_CLASSES : ClassVar[set[str]]

Methods

def on_checkbox_changed(self, event: Checkbox.Changed) ‑> None
Expand source code 
def on_checkbox_changed(self, event: Checkbox.Changed) -> None:
    self.app.dark = event.value
def on_dark_change(self, dark: bool) ‑> None
Expand source code 
def on_dark_change(self, dark: bool) -> None:
    self.query_one(Checkbox).value = self.app.dark
def on_mount(self) ‑> None
Expand source code 
def on_mount(self) -> None:
    watch(self.app, "dark", self.on_dark_change)

Inherited members

class DemoApp (driver_class: Type[Driver] | None = None, css_path: CSSPathType = None, watch_css: bool = False)

The base class for Textual Applications.

Args

driver_class (Type[Driver] | None, optional): Driver class or None to auto-detect. Defaults to None.
title (str | None, optional): Title of the application. If None, the title is set to the name of the App subclass. Defaults to None.
css_path (str | PurePath | None, optional): Path to CSS or None for no CSS file. Defaults to None.
watch_css : bool, optional
Watch CSS for changes. Defaults to False.
Expand source code 
class DemoApp(App):
    CSS_PATH = "demo.css"
    TITLE = "Textual Demo"
    BINDINGS = [
        ("ctrl+b", "toggle_sidebar", "Sidebar"),
        ("ctrl+t", "app.toggle_dark", "Toggle Dark mode"),
        ("ctrl+s", "app.screenshot()", "Screenshot"),
        ("f1", "app.toggle_class('TextLog', '-hidden')", "Notes"),
        Binding("ctrl+c,ctrl+q", "app.quit", "Quit", show=True),
    ]

    show_sidebar = reactive(False)

    def add_note(self, renderable: RenderableType) -> None:
        self.query_one(TextLog).write(renderable)

    def compose(self) -> ComposeResult:
        example_css = "\n".join(Path(self.css_path).read_text().splitlines()[:50])
        yield Container(
            Sidebar(classes="-hidden"),
            Header(show_clock=True),
            TextLog(classes="-hidden", wrap=False, highlight=True, markup=True),
            Body(
                QuickAccess(
                    LocationLink("TOP", ".location-top"),
                    LocationLink("Widgets", ".location-widgets"),
                    LocationLink("Rich content", ".location-rich"),
                    LocationLink("CSS", ".location-css"),
                ),
                AboveFold(Welcome(), classes="location-top"),
                Column(
                    Section(
                        SectionTitle("Widgets"),
                        TextContent(Markdown(WIDGETS_MD)),
                        LoginForm(),
                        DataTable(),
                    ),
                    classes="location-widgets location-first",
                ),
                Column(
                    Section(
                        SectionTitle("Rich"),
                        TextContent(Markdown(RICH_MD)),
                        SubTitle("Pretty Printed data (try resizing the terminal)"),
                        Static(Pretty(DATA, indent_guides=True), classes="pretty pad"),
                        SubTitle("JSON"),
                        Window(Static(JSON(JSON_EXAMPLE), expand=True), classes="pad"),
                        SubTitle("Tables"),
                        Static(example_table, classes="table pad"),
                    ),
                    classes="location-rich",
                ),
                Column(
                    Section(
                        SectionTitle("CSS"),
                        TextContent(Markdown(CSS_MD)),
                        Window(
                            Static(
                                Syntax(
                                    example_css,
                                    "css",
                                    theme="material",
                                    line_numbers=True,
                                ),
                                expand=True,
                            )
                        ),
                    ),
                    classes="location-css",
                ),
            ),
        )
        yield Footer()

    def action_open_link(self, link: str) -> None:
        self.app.bell()
        import webbrowser

        webbrowser.open(link)

    def action_toggle_sidebar(self) -> None:
        sidebar = self.query_one(Sidebar)
        self.set_focus(None)
        if sidebar.has_class("-hidden"):
            sidebar.remove_class("-hidden")
        else:
            if sidebar.query("*:focus"):
                self.screen.set_focus(None)
            sidebar.add_class("-hidden")

    def on_mount(self) -> None:
        self.add_note("Textual Demo app is running")
        table = self.query_one(DataTable)
        table.add_column("Foo", width=20)
        table.add_column("Bar", width=20)
        table.add_column("Baz", width=20)
        table.add_column("Foo", width=20)
        table.add_column("Bar", width=20)
        table.add_column("Baz", width=20)
        table.zebra_stripes = True
        for n in range(20):
            table.add_row(*[f"Cell ([b]{n}[/b], {col})" for col in range(6)])
        self.query_one("Welcome Button", Button).focus()

    def action_screenshot(self, filename: str | None = None, path: str = "./") -> None:
        """Save an SVG "screenshot". This action will save an SVG file containing the current contents of the screen.

        Args:
            filename (str | None, optional): Filename of screenshot, or None to auto-generate. Defaults to None.
            path (str, optional): Path to directory. Defaults to "./".
        """
        self.bell()
        path = self.save_screenshot(filename, path)
        message = Text.assemble("Screenshot saved to ", (f"'{path}'", "bold green"))
        self.add_note(message)
        self.screen.mount(Notification(message))

Ancestors

Class variables

var BINDINGS
var CSS_PATH : CSSPathType
var SCREENS : dict[str, Screen]
var SUB_TITLE : str | None
var TITLE : str | None

Instance variables

var show_sidebar : ReactiveType

Create a reactive attribute.

Args

default (ReactiveType | Callable[[], ReactiveType]): A default value or callable that returns a default.
layout : bool, optional
Perform a layout on change. Defaults to False.
repaint : bool, optional
Perform a repaint on change. Defaults to True.
init : bool, optional
Call watchers on initialize (post mount). Defaults to True.
Expand source code 
def __get__(self, obj: Reactable, obj_type: type[object]) -> ReactiveType:
    value: _NotSet | ReactiveType = getattr(obj, self.internal_name, _NOT_SET)
    if isinstance(value, _NotSet):
        # No value present, we need to set the default
        init_name = f"_default_{self.name}"
        default = getattr(obj, init_name)
        default_value = default() if callable(default) else default
        # Set and return the value
        setattr(obj, self.internal_name, default_value)
        if self._init:
            self._check_watchers(obj, self.name, default_value, first_set=True)
        return default_value
    return value

Methods

Expand source code 
def action_open_link(self, link: str) -> None:
    self.app.bell()
    import webbrowser

    webbrowser.open(link)
def action_screenshot(self, filename: str | None = None, path: str = './') ‑> None

Save an SVG "screenshot". This action will save an SVG file containing the current contents of the screen.

Args

filename (str | None, optional): Filename of screenshot, or None to auto-generate. Defaults to None.
path : str, optional
Path to directory. Defaults to "./".
Expand source code 
def action_screenshot(self, filename: str | None = None, path: str = "./") -> None:
    """Save an SVG "screenshot". This action will save an SVG file containing the current contents of the screen.

    Args:
        filename (str | None, optional): Filename of screenshot, or None to auto-generate. Defaults to None.
        path (str, optional): Path to directory. Defaults to "./".
    """
    self.bell()
    path = self.save_screenshot(filename, path)
    message = Text.assemble("Screenshot saved to ", (f"'{path}'", "bold green"))
    self.add_note(message)
    self.screen.mount(Notification(message))
def action_toggle_sidebar(self) ‑> None
Expand source code 
def action_toggle_sidebar(self) -> None:
    sidebar = self.query_one(Sidebar)
    self.set_focus(None)
    if sidebar.has_class("-hidden"):
        sidebar.remove_class("-hidden")
    else:
        if sidebar.query("*:focus"):
            self.screen.set_focus(None)
        sidebar.add_class("-hidden")
def add_note(self, renderable: RenderableType) ‑> None
Expand source code 
def add_note(self, renderable: RenderableType) -> None:
    self.query_one(TextLog).write(renderable)
def on_mount(self) ‑> None
Expand source code 
def on_mount(self) -> None:
    self.add_note("Textual Demo app is running")
    table = self.query_one(DataTable)
    table.add_column("Foo", width=20)
    table.add_column("Bar", width=20)
    table.add_column("Baz", width=20)
    table.add_column("Foo", width=20)
    table.add_column("Bar", width=20)
    table.add_column("Baz", width=20)
    table.zebra_stripes = True
    for n in range(20):
        table.add_row(*[f"Cell ([b]{n}[/b], {col})" for col in range(6)])
    self.query_one("Welcome Button", Button).focus()

Inherited members

A widget to display simple static content, or use as a base class for more complex widgets.

Args

renderable : RenderableType, optional
A Rich renderable, or string containing console markup. Defaults to "".
expand : bool, optional
Expand content if required to fill container. Defaults to False.
shrink : bool, optional
Shrink content if required to fill container. Defaults to False.
markup : bool, optional
True if markup should be parsed and rendered. Defaults to True.

name (str | None, optional): Name of widget. Defaults to None. id (str | None, optional): ID of Widget. Defaults to None. classes (str | None, optional): Space separated list of class names. Defaults to None.

Expand source code 
class LocationLink(Static):
    def __init__(self, label: str, reveal: str) -> None:
        super().__init__(label)
        self.reveal = reveal

    def on_click(self) -> None:
        self.app.query_one(self.reveal).scroll_visible(top=True)
        self.app.add_note(f"Scrolling to [b]{self.reveal}[/b]")

Ancestors

Methods

def on_click(self) ‑> None
Expand source code 
def on_click(self) -> None:
    self.app.query_one(self.reveal).scroll_visible(top=True)
    self.app.add_note(f"Scrolling to [b]{self.reveal}[/b]")

Inherited members

class LoginForm (*children: Widget, name: str | None = None, id: str | None = None, classes: str | None = None)

Simple container widget, with vertical layout.

Expand source code 
class LoginForm(Container):
    def compose(self) -> ComposeResult:
        yield Static("Username", classes="label")
        yield Input(placeholder="Username")
        yield Static("Password", classes="label")
        yield Input(placeholder="Password", password=True)
        yield Static()
        yield Button("Login", variant="primary")

Ancestors

Class variables

var COMPONENT_CLASSES : ClassVar[set[str]]

Inherited members

class Message (renderable: RenderableType = '', *, expand: bool = False, shrink: bool = False, markup: bool = True, name: str | None = None, id: str | None = None, classes: str | None = None)

A widget to display simple static content, or use as a base class for more complex widgets.

Args

renderable : RenderableType, optional
A Rich renderable, or string containing console markup. Defaults to "".
expand : bool, optional
Expand content if required to fill container. Defaults to False.
shrink : bool, optional
Shrink content if required to fill container. Defaults to False.
markup : bool, optional
True if markup should be parsed and rendered. Defaults to True.

name (str | None, optional): Name of widget. Defaults to None. id (str | None, optional): ID of Widget. Defaults to None. classes (str | None, optional): Space separated list of class names. Defaults to None.

Expand source code 
class Message(Static):
    pass

Ancestors

Inherited members

class Notification (renderable: RenderableType = '', *, expand: bool = False, shrink: bool = False, markup: bool = True, name: str | None = None, id: str | None = None, classes: str | None = None)

A widget to display simple static content, or use as a base class for more complex widgets.

Args

renderable : RenderableType, optional
A Rich renderable, or string containing console markup. Defaults to "".
expand : bool, optional
Expand content if required to fill container. Defaults to False.
shrink : bool, optional
Shrink content if required to fill container. Defaults to False.
markup : bool, optional
True if markup should be parsed and rendered. Defaults to True.

name (str | None, optional): Name of widget. Defaults to None. id (str | None, optional): ID of Widget. Defaults to None. classes (str | None, optional): Space separated list of class names. Defaults to None.

Expand source code 
class Notification(Static):
    def on_mount(self) -> None:
        self.set_timer(3, self.remove)

    def on_click(self) -> None:
        self.remove()

Ancestors

Methods

def on_click(self) ‑> None
Expand source code 
def on_click(self) -> None:
    self.remove()
def on_mount(self) ‑> None
Expand source code 
def on_mount(self) -> None:
    self.set_timer(3, self.remove)

Inherited members

class OptionGroup (*children: Widget, name: str | None = None, id: str | None = None, classes: str | None = None)

Simple container widget, with vertical layout.

Expand source code 
class OptionGroup(Container):
    pass

Ancestors

Class variables

var COMPONENT_CLASSES : ClassVar[set[str]]

Inherited members

class QuickAccess (*children: Widget, name: str | None = None, id: str | None = None, classes: str | None = None)

Simple container widget, with vertical layout.

Expand source code 
class QuickAccess(Container):
    pass

Ancestors

Class variables

var COMPONENT_CLASSES : ClassVar[set[str]]

Inherited members

class Section (*children: Widget, name: str | None = None, id: str | None = None, classes: str | None = None)

Simple container widget, with vertical layout.

Expand source code 
class Section(Container):
    pass

Ancestors

Class variables

var COMPONENT_CLASSES : ClassVar[set[str]]

Inherited members

class SectionTitle (renderable: RenderableType = '', *, expand: bool = False, shrink: bool = False, markup: bool = True, name: str | None = None, id: str | None = None, classes: str | None = None)

A widget to display simple static content, or use as a base class for more complex widgets.

Args

renderable : RenderableType, optional
A Rich renderable, or string containing console markup. Defaults to "".
expand : bool, optional
Expand content if required to fill container. Defaults to False.
shrink : bool, optional
Shrink content if required to fill container. Defaults to False.
markup : bool, optional
True if markup should be parsed and rendered. Defaults to True.

name (str | None, optional): Name of widget. Defaults to None. id (str | None, optional): ID of Widget. Defaults to None. classes (str | None, optional): Space separated list of class names. Defaults to None.

Expand source code 
class SectionTitle(Static):
    pass

Ancestors

Inherited members

class Sidebar (*children: Widget, name: str | None = None, id: str | None = None, classes: str | None = None)

Simple container widget, with vertical layout.

Expand source code 
class Sidebar(Container):
    def compose(self) -> ComposeResult:
        yield Title("Textual Demo")
        yield OptionGroup(Message(MESSAGE), Version())
        yield DarkSwitch()

Ancestors

Class variables

var COMPONENT_CLASSES : ClassVar[set[str]]

Inherited members

class SubTitle (renderable: RenderableType = '', *, expand: bool = False, shrink: bool = False, markup: bool = True, name: str | None = None, id: str | None = None, classes: str | None = None)

A widget to display simple static content, or use as a base class for more complex widgets.

Args

renderable : RenderableType, optional
A Rich renderable, or string containing console markup. Defaults to "".
expand : bool, optional
Expand content if required to fill container. Defaults to False.
shrink : bool, optional
Shrink content if required to fill container. Defaults to False.
markup : bool, optional
True if markup should be parsed and rendered. Defaults to True.

name (str | None, optional): Name of widget. Defaults to None. id (str | None, optional): ID of Widget. Defaults to None. classes (str | None, optional): Space separated list of class names. Defaults to None.

Expand source code 
class SubTitle(Static):
    pass

Ancestors

Inherited members

class TextContent (renderable: RenderableType = '', *, expand: bool = False, shrink: bool = False, markup: bool = True, name: str | None = None, id: str | None = None, classes: str | None = None)

A widget to display simple static content, or use as a base class for more complex widgets.

Args

renderable : RenderableType, optional
A Rich renderable, or string containing console markup. Defaults to "".
expand : bool, optional
Expand content if required to fill container. Defaults to False.
shrink : bool, optional
Shrink content if required to fill container. Defaults to False.
markup : bool, optional
True if markup should be parsed and rendered. Defaults to True.

name (str | None, optional): Name of widget. Defaults to None. id (str | None, optional): ID of Widget. Defaults to None. classes (str | None, optional): Space separated list of class names. Defaults to None.

Expand source code 
class TextContent(Static):
    pass

Ancestors

Inherited members

class Title (renderable: RenderableType = '', *, expand: bool = False, shrink: bool = False, markup: bool = True, name: str | None = None, id: str | None = None, classes: str | None = None)

A widget to display simple static content, or use as a base class for more complex widgets.

Args

renderable : RenderableType, optional
A Rich renderable, or string containing console markup. Defaults to "".
expand : bool, optional
Expand content if required to fill container. Defaults to False.
shrink : bool, optional
Shrink content if required to fill container. Defaults to False.
markup : bool, optional
True if markup should be parsed and rendered. Defaults to True.

name (str | None, optional): Name of widget. Defaults to None. id (str | None, optional): ID of Widget. Defaults to None. classes (str | None, optional): Space separated list of class names. Defaults to None.

Expand source code 
class Title(Static):
    pass

Ancestors

Inherited members

class Version (renderable: RenderableType = '', *, expand: bool = False, shrink: bool = False, markup: bool = True, name: str | None = None, id: str | None = None, classes: str | None = None)

A widget to display simple static content, or use as a base class for more complex widgets.

Args

renderable : RenderableType, optional
A Rich renderable, or string containing console markup. Defaults to "".
expand : bool, optional
Expand content if required to fill container. Defaults to False.
shrink : bool, optional
Shrink content if required to fill container. Defaults to False.
markup : bool, optional
True if markup should be parsed and rendered. Defaults to True.

name (str | None, optional): Name of widget. Defaults to None. id (str | None, optional): ID of Widget. Defaults to None. classes (str | None, optional): Space separated list of class names. Defaults to None.

Expand source code 
class Version(Static):
    def render(self) -> RenderableType:
        return f"[b]v{version('textual')}"

Ancestors

Methods

def render(self) ‑> Union[rich.console.ConsoleRenderable, rich.console.RichCast, str]

Get a rich renderable for the widget's content.

Returns

RenderableType
A rich renderable.
Expand source code 
def render(self) -> RenderableType:
    return f"[b]v{version('textual')}"

Inherited members

class Welcome (*children: Widget, name: str | None = None, id: str | None = None, classes: str | None = None)

Simple container widget, with vertical layout.

Expand source code 
class Welcome(Container):
    def compose(self) -> ComposeResult:
        yield Static(Markdown(WELCOME_MD))
        yield Button("Start", variant="success")

    def on_button_pressed(self, event: Button.Pressed) -> None:
        self.app.add_note("[b magenta]Start!")
        self.app.query_one(".location-first").scroll_visible(speed=50, top=True)

Ancestors

Class variables

var COMPONENT_CLASSES : ClassVar[set[str]]

Methods

def on_button_pressed(self, event: Button.Pressed) ‑> None
Expand source code 
def on_button_pressed(self, event: Button.Pressed) -> None:
    self.app.add_note("[b magenta]Start!")
    self.app.query_one(".location-first").scroll_visible(speed=50, top=True)

Inherited members

class Window (*children: Widget, name: str | None = None, id: str | None = None, classes: str | None = None)

Simple container widget, with vertical layout.

Expand source code 
class Window(Container):
    pass

Ancestors

Class variables

var COMPONENT_CLASSES : ClassVar[set[str]]

Inherited members