1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
|
# RichLog
A RichLog is a widget which displays scrollable content that may be appended to in realtime.
Call [RichLog.write][textual.widgets.RichLog.write] with a string or [Rich Renderable](https://rich.readthedocs.io/en/latest/protocol.html) to write content to the end of the RichLog. Call [RichLog.clear][textual.widgets.RichLog.clear] to clear the content.
!!! tip
See also [Log](../widgets/log.md) which is an alternative to `RichLog` but specialized for simple text.
- [X] Focusable
- [ ] Container
## Example
The example below shows an application showing a `RichLog` with different kinds of data logged.
=== "Output"
```{.textual path="docs/examples/widgets/rich_log.py" press="H,i"}
```
=== "rich_log.py"
```python
--8<-- "docs/examples/widgets/rich_log.py"
```
## Reactive Attributes
| Name | Type | Default | Description |
| ----------- | ------ | ------- | ------------------------------------------------------------ |
| `highlight` | `bool` | `False` | Automatically highlight content. |
| `markup` | `bool` | `False` | Apply 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.
## Bindings
This widget has no bindings.
## Component Classes
This widget has no component classes.
---
::: textual.widgets.RichLog
options:
heading_level: 2
|