rich/docs/source/panel.rst

24 lines
1018 B
ReStructuredText

Panel
=====
To draw a border around any content, construct a :class:`~rich.panel.Panel` with any *renderable* as the first positional argument. Here's an example::
from rich import print
from rich.panel import Panel
print(Panel("Hello, [red]World!"))
You can change the style of the panel by setting the ``box`` argument to the Panel constructor. See :ref:`appendix_box` for a list of available box styles.
Panels will extend to the full width of the terminal. You can make panel *fit* the content why setting ``fit=True`` on the constructor, or by creating the Panel with :meth:`~rich.panel.Panel.fit`. For example::
from rich import print
from rich.panel import Panel
print(Panel.fit("Hello, [red]World!"))
The Panel constructor accepts a ``title`` argument which will draw a title within the panel::
from rich import print
from rich.panel import Panel
print(Panel("Hello, [red]World!", title="Welcome"))
See :class:`~rich.panel.Panel` for details how to customize Panels.