Files
textual/docs/widget_gallery.md
Dave Pearson e6f620db44 Remove underscore pauses from (hopefully) all snapshots
This seeks to remove the "_" from the key presses of snapshots and inline
runs in the documentation. The "_" no longer does anything, but got legacy
reasons at the moment we can't actually allow "_" to be an input to a
"faked" keypress in the docs and snapshots.

Removing these clears the way to letting "_" have the same status as any
other character.

See #1994.
2023-03-09 20:32:27 +00:00

4.0 KiB

hide
hide
navigation

Widgets

Welcome to the Textual widget gallery.

We have many more widgets planned, or you can build your own.

!!! info

Textual is a **TUI** framework. Everything below runs in the *terminal*.

Button

A simple button with a variety of semantic styles.

Button reference{ .md-button .md-button--primary }

Checkbox

A classic checkbox control.

Checkbox reference{ .md-button .md-button--primary }

ContentSwitcher

A widget for containing and switching display between multiple child widgets.

ContentSwitcher reference{ .md-button .md-button--primary }

DataTable

A powerful data table, with configurable cursors.

DataTable reference{ .md-button .md-button--primary }

DirectoryTree

A tree view of files and folders.

DirectoryTree reference{ .md-button .md-button--primary }

A footer to display and interact with key bindings.

Footer reference{ .md-button .md-button--primary }

Header

A header to display the app's title and subtitle.

Header reference{ .md-button .md-button--primary }

Input

A control to enter text.

Input reference{ .md-button .md-button--primary }

Label

A simple text label.

Label reference{ .md-button .md-button--primary }

ListView

Display a list of items (items may be other widgets).

ListView reference{ .md-button .md-button--primary }

MarkdownViewer

Display and interact with a Markdown document (adds a table of contents and browser-like navigation to Markdown).

MarkdownViewer reference{ .md-button .md-button--primary }

Markdown

Display a markdown document.

Markdown reference{ .md-button .md-button--primary }

Placeholder

Display placeholder content while you are designing a UI.

Placeholder reference{ .md-button .md-button--primary }

RadioButton

A simple radio button.

RadioButton reference{ .md-button .md-button--primary }

RadioSet

A collection of radio buttons, that enforces uniqueness.

RadioSet reference{ .md-button .md-button--primary }

Static

Displays simple static content. Typically used as a base class.

Static reference{ .md-button .md-button--primary }

Switch

A on / off control, inspired by toggle buttons.

Switch reference{ .md-button .md-button--primary }

TextLog

Display and update text in a scrolling panel.

TextLog reference{ .md-button .md-button--primary }

Tree

A tree control with expandable nodes.

Tree reference{ .md-button .md-button--primary }