https://textual.textualize.io/

[ ] [ ]
Skip to content
 
Textual
Introduction
( ) ( )
[                    ]
Initializing search

 
GitHub

  * Introduction
  * Tutorial
  * Guide
  * Widgets
  * Reference
  * API
  * Roadmap
  * Blog

 Textual
 
GitHub

  * [*]
    Introduction
    Introduction
      + Getting started
      + Help
  * Tutorial
  * [ ]
    Guide
    Guide
      + Devtools
      + App Basics
      + Styles
      + Textual CSS
      + Design System
      + DOM Queries
      + Layout
      + Events and Messages
      + Input
      + Actions
      + Reactivity
      + Widgets
      + Animation
      + Screens
  * Widgets
  * [ ]
    Reference
    Reference
      + [ ]
        CSS Types
        CSS Types
          o <border>
          o <color>
          o <horizontal>
          o <integer>
          o <name>
          o <number>
          o <overflow>
          o <percentage>
          o <scalar>
          o <text-align>
          o <text-style>
          o <vertical>
      + [ ]
        Events
        Events
          o Blur
          o DescendantBlur
          o DescendantFocus
          o Enter
          o Focus
          o Hide
          o Key
          o Leave
          o Load
          o Mount
          o MouseCapture
          o Click
          o MouseDown
          o MouseMove
          o MouseRelease
          o MouseScrollDown
          o MouseScrollUp
          o MouseUp
          o Paste
          o Resize
          o ScreenResume
          o ScreenSuspend
          o Show
      + [ ]
        Styles
        Styles
          o Align
          o Background
          o Border
          o Box-sizing
          o Color
          o Content-align
          o Display
          o Dock
          o [ ]
            Grid
            Grid
              # Column-span
              # Grid-columns
              # Grid-gutter
              # Grid-rows
              # Grid-size
              # Row-span
          o Height
          o Layer
          o Layers
          o Layout
          o [ ]
            Links
            Links
              # Link-background
              # Link-color
              # Link-hover-background
              # Link-hover-color
              # Link-hover-style
              # Link-style
          o Margin
          o Max-height
          o Max-width
          o Min-height
          o Min-width
          o Offset
          o Opacity
          o Outline
          o Overflow
          o Padding
          o [ ]
            Scrollbar colors
            Scrollbar colors
              # Scrollbar-background
              # Scrollbar-background-active
              # Scrollbar-background-hover
              # Scrollbar-color
              # Scrollbar-color-active
              # Scrollbar-color-hover
              # Scrollbar-corner-color
          o Scrollbar-gutter
          o Scrollbar-size
          o Text-align
          o Text-opacity
          o Text-style
          o Tint
          o Visibility
          o Width
      + [ ]
        Widgets
        Widgets
          o Button
          o Checkbox
          o ContentSwitcher
          o DataTable
          o DirectoryTree
          o Footer
          o Header
          o Input
          o Label
          o ListItem
          o ListView
          o MarkdownViewer
          o Markdown
          o Placeholder
          o RadioButton
          o RadioSet
          o Static
          o Switch
          o TextLog
          o Tree
  * [ ]
    API
    API
      + App
      + Await remove
      + Binding
      + Button
      + Checkbox
      + Color
      + Containers
      + Content switcher
      + Coordinate
      + Data table
      + Directory tree
      + Dom node
      + Events
      + Footer
      + Geometry
      + Header
      + Input
      + Label
      + List item
      + List view
      + Markdown viewer
      + Markdown
      + Message pump
      + Message
      + Pilot
      + Placeholder
      + Query
      + Radiobutton
      + Radioset
      + Reactive
      + Screen
      + Scroll view
      + Static
      + Strip
      + Switch
      + Text log
      + Toggle button
      + Timer
      + Tree
      + Walk
      + Welcome
      + Widget
  * Roadmap
  * [ ]
    Blog
    Blog
      + [ ] Archive Archive
          o 2023
          o 2022
      + [ ] Categories Categories
          o DevLog
          o News
          o Release

Table of contents

  * What is Textual?

IntroductionP

Welcome to the Textual framework documentation.

Tip

See the navigation links in the header or side-bars. Click the button
(top left) on mobile.

Get started or go straight to the Tutorial

What is Textual?P

Textual is a Rapid Application Development framework for Python,
built by Textualize.io.

Build sophisticated user interfaces with a simple Python API. Run
your apps in the terminal and (coming soon) a web browser.

  * Rapid development

    -----------------------------------------------------------------
   
    Uses your existing Python skills to build beautiful user
    interfaces.

  * Low requirements

    -----------------------------------------------------------------
   
    Run Textual on a single board computer if you want to.

  * Cross platform

    -----------------------------------------------------------------
   
    Textual runs just about everywhere.

  * Remote

    -----------------------------------------------------------------
   
    Textual apps can run over SSH.

  * CLI Integration

    -----------------------------------------------------------------
   
    Textual apps can be launched and run from the command prompt.

  * Open Source

    -----------------------------------------------------------------
   
    Textual is licensed under MIT.

CalculatorApp 3.14592
------------------------------------------------------------------------------------------
C+/-%/
##########################################################################################
------------------------------------------------------------------------------------------
789x
##########################################################################################
------------------------------------------------------------------------------------------
456-
##########################################################################################
------------------------------------------------------------------------------------------
123+
##########################################################################################
--------------------------------------------------------------------------------------------
0.=
############################################################################################

PrideApp

StopwatchApp StopwatchApp ---------------- Stop00:00:01.08
################ --------------------------------
Start00:00:00.00Reset ################################
-------------------------------- Start00:00:00.00Reset
################################
 D  Toggle dark mode  A  Add  R  Remove 

CombiningLayoutsExample CombiningLayoutsExample
+------------------------------------------------++------------------------------------------------+
|||HorizontallyPositionedChildrenHere| |Vertical layout, child 0|||
|||| |||| |||| |Vertical layout, child 1||| |||| |||| ||||
|Vertical layout, child 2||| |||| ||||
|##|+------------------------------------------------+
|Vertical layout, child 3|+------------------------------------------------+
|||Thispanelis| |||| |||| |Vertical layout, child 4||| |||| |||| ||||
|Vertical layout, child 5||usinggrid layout!| |||| |||| ||||
|Vertical layout, child 6||| ||||
+------------------------------------------------++------------------------------------------------+

WelcomeApp
+--------------------------------------------------------------------------+
|Welcome!|
+--------------------------------------------------------------------------+
Textual is a TUI, or Text User Interface, framework for Python inspired by 
modern web development. We hope you enjoy using Textual! Dune quote
# "I must not fear.Fear is the mind-killer.Fear is the little-death that
# brings total obliteration.I will face my fear.I will permit it to pass
# over me and through me.And when it has gone past, I will turn the inner
# eye to see its path.Where the fear has gone there will be nothing. Only
# I will remain."
--------------------------------------------------------------------------------
OK
################################################################################

 
Next Getting started
Copyright (c) Textualize, Inc
Made with Material for MkDocs Insiders