textual-test-patterns
Testing recipes for specific Textual TUI scenarios. Provides "how do I test X?" patterns for common testing needs. Use when: testing keyboard shortcuts, screen transitions, focus management, reactive attributes, custom messages/events, CSS styling effects, data tables, scrolling, input validation, error/loading states, or background workers. Each pattern shows the complete test with proper async handling and assertions.
What this skill does
# Textual Test Patterns
Testing recipes for specific Textual scenarios. Each pattern shows complete, working test code.
## Pattern Index
| Scenario | Pattern |
|----------|---------|
| Keyboard shortcuts | [Test Keyboard Shortcuts](#test-keyboard-shortcuts) |
| Screen transitions | [Test Screen Transitions](#test-screen-transitions) |
| Focus management | [Test Focus Management](#test-focus-management) |
| Reactive attributes | [Test Reactive Attributes](#test-reactive-attributes) |
| Custom messages | [Test Custom Messages](#test-custom-messages) |
| CSS styling | [Test CSS Styling](#test-css-styling) |
| Data tables | [Test Data Tables](#test-data-tables) |
| Scrolling | [Test Scrolling](#test-scrolling) |
| Input validation | [Test Input Validation](#test-input-validation) |
| Error states | [Test Error States](#test-error-states) |
| Loading states | [Test Loading States](#test-loading-states) |
| Background workers | [Test Background Workers](#test-background-workers) |
## Test Keyboard Shortcuts
```python
async def test_keyboard_shortcuts():
"""Test keyboard binding triggers action."""
class MyApp(App):
BINDINGS = [("ctrl+s", "save", "Save")]
saved = False
def action_save(self) -> None:
self.saved = True
async with MyApp().run_test() as pilot:
await pilot.press("ctrl+s")
await pilot.pause()
assert pilot.app.saved is True
```
## Test Screen Transitions
```python
from textual.screen import Screen
class MainScreen(Screen):
pass
class SettingsScreen(Screen):
pass
async def test_screen_navigation():
"""Test navigating between screens."""
class MyApp(App):
SCREENS = {"settings": SettingsScreen}
def compose(self):
yield Static("Main")
def key_s(self):
self.push_screen("settings")
async with MyApp().run_test() as pilot:
# Start on default screen
assert not isinstance(pilot.app.screen, SettingsScreen)
# Navigate to settings
await pilot.press("s")
await pilot.pause()
assert isinstance(pilot.app.screen, SettingsScreen)
# Navigate back
await pilot.press("escape")
await pilot.pause()
assert not isinstance(pilot.app.screen, SettingsScreen)
```
## Test Focus Management
```python
from textual.widgets import Input
async def test_focus_order():
"""Test Tab moves focus through widgets."""
class MyApp(App):
def compose(self):
yield Input(id="name")
yield Input(id="email")
yield Input(id="phone")
async with MyApp().run_test() as pilot:
name = pilot.app.query_one("#name", Input)
email = pilot.app.query_one("#email", Input)
# First input focused by default
assert name.has_focus
# Tab to next
await pilot.press("tab")
await pilot.pause()
assert email.has_focus
assert not name.has_focus
# Shift+Tab back
await pilot.press("shift+tab")
await pilot.pause()
assert name.has_focus
```
## Test Reactive Attributes
```python
from textual.reactive import reactive
from textual.widgets import Static
class StatusWidget(Static):
status: reactive[str] = reactive("idle")
def watch_status(self, new_status: str) -> None:
self.add_class(f"status-{new_status}")
self.remove_class(f"status-{self._previous_status}")
self._previous_status = new_status
def __init__(self):
super().__init__()
self._previous_status = "idle"
async def test_reactive_attribute():
"""Test reactive attribute triggers watcher."""
class TestApp(App):
def compose(self):
yield StatusWidget(id="status")
async with TestApp().run_test() as pilot:
widget = pilot.app.query_one("#status", StatusWidget)
assert widget.status == "idle"
assert widget.has_class("status-idle")
widget.status = "loading"
await pilot.pause()
assert widget.has_class("status-loading")
assert not widget.has_class("status-idle")
```
## Test Custom Messages
```python
from textual.message import Message
class ItemSelected(Message):
def __init__(self, item_id: str) -> None:
super().__init__()
self.item_id = item_id
async def test_custom_message():
"""Test custom message is received by handler."""
class MyApp(App):
selected_items: list[str] = []
def compose(self):
yield Static("Item", id="item")
def on_item_selected(self, message: ItemSelected) -> None:
self.selected_items.append(message.item_id)
async with MyApp().run_test() as pilot:
# Post message
pilot.app.post_message(ItemSelected("item-1"))
await pilot.pause()
assert pilot.app.selected_items == ["item-1"]
# Post another
pilot.app.post_message(ItemSelected("item-2"))
await pilot.pause()
assert pilot.app.selected_items == ["item-1", "item-2"]
```
## Test CSS Styling
```python
from textual.color import Color
async def test_css_class_application():
"""Test CSS class changes styling."""
class MyApp(App):
CSS = """
.error { background: red; }
.success { background: green; }
"""
def compose(self):
yield Static("Status", id="status")
async with MyApp().run_test() as pilot:
status = pilot.app.query_one("#status")
# Add error class
status.add_class("error")
await pilot.pause()
assert status.has_class("error")
# Switch to success
status.remove_class("error")
status.add_class("success")
await pilot.pause()
assert status.has_class("success")
assert not status.has_class("error")
```
## Test Data Tables
```python
from textual.widgets import DataTable
async def test_data_table():
"""Test data table row selection."""
class MyApp(App):
def compose(self):
yield DataTable(id="table")
def on_mount(self):
table = self.query_one("#table", DataTable)
table.add_columns("Name", "Value")
table.add_rows([
("Alice", "100"),
("Bob", "200"),
("Carol", "300"),
])
async with MyApp().run_test() as pilot:
table = pilot.app.query_one("#table", DataTable)
assert table.row_count == 3
# Navigate and select
await pilot.click(DataTable)
await pilot.press("down", "down")
await pilot.pause()
assert table.cursor_row == 2
```
## Test Scrolling
```python
from textual.containers import ScrollableContainer
async def test_scrolling():
"""Test scroll position changes."""
class MyApp(App):
def compose(self):
with ScrollableContainer(id="container"):
for i in range(100):
yield Static(f"Line {i}")
async with MyApp().run_test(size=(80, 10)) as pilot:
container = pilot.app.query_one("#container", ScrollableContainer)
# Start at top
assert container.scroll_y == 0
# Scroll down
await pilot.press("pagedown")
await pilot.pause()
assert container.scroll_y > 0
# Scroll to end
await pilot.press("end")
await pilot.pause()
assert container.scroll_y == container.max_scroll_y
```
## Test Input Validation
```python
from textual.widgets import Input
from textual.validation import Validator, ValidationResult
class EmailValidator(Validator):
def validate(self, value: str) -> ValidationResult:
if "@" in value and "." in value.split("@")[-1]:
return self.success()
return self.failure("Invalid email")
async def test_input_validation():
"""Test input field validates correctly."""
class MyApp(App):
def compose(self):
Related in Web Dev
generating-lwc-components
IncludedLightning Web Components with PICKLES methodology and 165-point scoring. Use this skill when the user creates or edits LWC components, builds wire service patterns, or writes Jest tests for LWC. TRIGGER when: user creates/edits LWC components, touches lwc/**/*.js, .html, .css, .js-meta.xml files, or asks about wire service, SLDS, or Jest LWC tests. DO NOT TRIGGER when: Apex classes (use generating-apex), Aura components, or Visualforce.
tanstack-query
IncludedManage server state in React with TanStack Query v5. Set up queries with useQuery, mutations with useMutation, configure QueryClient caching strategies, implement optimistic updates, and handle infinite scroll with useInfiniteQuery. Use when: setting up data fetching in React projects, migrating from v4 to v5, or fixing object syntax required errors, query callbacks removed issues, cacheTime renamed to gcTime, isPending vs isLoading confusion, keepPreviousData removed problems.
document-processor-api
IncludedProcess documents with Nutrient DWS. Use when the user wants to generate PDFs from HTML or URLs, convert Office/images/PDFs, assemble or split packets, OCR scans, extract text/tables/key-value pairs, redact PII, watermark, sign, fill forms, optimize PDFs, or produce compliance outputs like PDF/A or PDF/UA. Triggers include convert to PDF, merge these PDFs, OCR this scan, extract tables, redact PII, sign this PDF, make this PDF/A, or linearize for web delivery.
nutrient-document-processing
IncludedProcess documents with Nutrient DWS. Use when the user wants to generate PDFs from HTML or URLs, convert Office/images/PDFs, assemble or split packets, OCR scans, extract text/tables/key-value pairs, redact PII, watermark, sign, fill forms, optimize PDFs, or produce compliance outputs like PDF/A or PDF/UA. Triggers include convert to PDF, merge these PDFs, OCR this scan, extract tables, redact PII, sign this PDF, make this PDF/A, or linearize for web delivery.
tanstack-query
IncludedManage server state in React with TanStack Query v5. Covers useMutationState, simplified optimistic updates, throwOnError, network mode (offline/PWA), and infiniteQueryOptions. Use when setting up data fetching, fixing v4→v5 migration errors (object syntax, gcTime, isPending, keepPreviousData), or debugging SSR/hydration issues with streaming server components.
accelint-nextjs-best-practices
IncludedNext.js performance optimization and best practices. Use when writing Next.js code (App Router or Pages Router); implementing Server Components, Server Actions, or API routes; optimizing RSC serialization, data fetching, or server-side rendering; reviewing Next.js code for performance issues; fixing authentication in Server Actions; or implementing Suspense boundaries, parallel data fetching, or request deduplication.