textual/docs/widgets/text_log.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

1.5 KiB

TextLog

A TextLog is a widget which displays scrollable content that may be appended to in realtime.

Call [TextLog.write][textual.widgets.TextLog.write] with a string or Rich Renderable to write content to the end of the TextLog. Call [TextLog.clear][textual.widgets.TextLog.clear] to clear the content.

  • Focusable
  • Container

Example

The example below shows an application showing a TextLog with different kinds of data logged.

=== "Output"

```{.textual path="docs/examples/widgets/text_log.py" press="H,i"}
```

=== "text_log.py"

```python
--8<-- "docs/examples/widgets/text_log.py"
```

Reactive Attributes

Name Type Default Description
highlight bool False Automatically highlight content.
markup bool False Apply Rich console markup.
max_lines int None Maximum number of lines in the log or None for no maximum.
min_width int 78 Minimum width of renderables.
wrap bool False Enable word wrapping.

Messages

This widget sends no messages.

See Also