Files
textual/docs/widgets/placeholder.md
Will McGugan 2244b1161e api docs (#2240)
* api docs

* more docstrings

* logs

* docs shakeup

* fix notes, added intro to all apis

* Remove defaults to

* add note to events

* note

* use fira code
2023-04-08 15:35:49 +01:00

1.1 KiB

Placeholder

!!! tip "Added in version 0.6.0"

A widget that is meant to have no complex functionality. Use the placeholder widget when studying the layout of your app before having to develop your custom widgets.

The placeholder widget has variants that display different bits of useful information. Clicking a placeholder will cycle through its variants.

  • Focusable
  • Container

Example

The example below shows each placeholder variant.

=== "Output"

```{.textual path="docs/examples/widgets/placeholder.py"}
```

=== "placeholder.py"

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

=== "placeholder.css"

```sass
--8<-- "docs/examples/widgets/placeholder.css"
```

Reactive Attributes

Name Type Default Description
variant str "default" Styling variant. One of default, size, text.

Messages

This widget sends no messages.


::: textual.widgets.Placeholder options: heading_level: 2