alihan/textual
1
0
Fork 0
mirror of https://github.com/Textualize/textual.git synced 2025-10-17 02:38:12 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
879c985296d1aa72194593b445e3ffaa1d1543f0
textual/docs/widgets/rich_log.md
Will McGugan 879c985296 Rich log (#3046) 
* log

* tests

* snapshot tests

* change to richlog

* keep raw lines

* disable highlighting by default

* simplify

* superfluous test

* optimization

* update cell length

* add refresh

* write method

* version bump

* doc fix link

* makes lines private

* docstring

* relax dev dependancy

* remove superfluous code [skip ci]

* added FAQ [skipci]

* fix code in faq [skipci]

* fix typo

* max lines fix
2023-08-03 10:11:17 +01:00

1.6 KiB
Raw Blame History

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 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.
  • 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 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.

::: textual.widgets.RichLog options: heading_level: 2