aad6d98aa5
* Change the title of some widget references to their class names The widget reference index had a slight mixture of widget title styles, some being their class name, others being "written English" type titles. This settles on the titles always being the class name. * Add a link to the ContentSwitcher to the widget gallery No screenshot for this, on purpose. By definition this widget isn't visible, except via other widgets that it's enclosing and handling. * Have mkdocs watch the main nav file * Mark the content switcher off the roadmap
4.0 KiB
hide
| hide | |
|---|---|
|
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 }
Footer
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 }