textual-router 0.2.3

A view router for Textual projects

Textual Router

A view router for Textual inspired by Solid-Router.

Usage

Create Views from Static widgets.

Use the Router object in your App's compose() and provide links and their Views:

    yield Router(
        [
            Route(path="link_to_view_a", view=ViewA()),
            Route(path="link_to_view_b", view=ViewB()),
        ]
    )

Within in your View, use RouterLinks to navigate to other views.

    yield RouterLink(path="link_to_view_b",label="ViewB")

To use links outside the Router, you can use its "route_to" method:

    async def action_main_menu(self) -> None:
        cast(RouterType, self.query_one("#router")).route_to("link_to_view_a")

The Router's identifier defaults to "router", but can be customized:

    yield Router(
        routes=[
            Route(path="link_to_view_a", view=ViewA()),
            Route(path="link_to_view_b", view=ViewB()),
        ],
        identifier="app_router"
    )

Full Example

from textual.app import App, ComposeResult
from textual.widgets import Footer, Header, Static

from textual_router import Route, Router, RouterLink

class Home(Static):

    def compose(self):
        yield RouterLink(path="about", label="About")


class About(Static):
    
    def compose(self):
        yield RouterLink(path="home", label="Home")

class BasicApp(App):
    TITLE = "Basic app"

    def compose(self) -> ComposeResult:
        yield Header()
        yield Router(
            [
                Route(path="home", view=Home()),
                Route(path="about", view=About()),
            ]
        )
        yield Footer()