Rooba
/
rich
mirror of https://github.com/Textualize/rich.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

words

This commit is contained in:
Will McGugan 2020-08-02 15:05:42 +01:00
parent 1ffbd44377
commit 1d591e388d
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/source/text.rst
View File

@ -32,14 +32,14 @@ You can apply a style to given words in the text with :meth:`~rich.text.Text.hig
Text attributes Text attributes
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
The Text class has a number of parameters you can set on the constructor to modify how the text is display. The Text class has a number of parameters you can set on the constructor to modify how the text is displayed.
- ``justify`` should be "left", "center", "right", or "full", and will override default justify behaviour if set. - ``justify`` should be "left", "center", "right", or "full", and will override default justify behaviour.
- ``overflow`` should be "fold", "crop", or "ellipsis" and will override default overflow if set. - ``overflow`` should be "fold", "crop", or "ellipsis", and will override default overflow.
- ``no_wrap`` prevents wrapping if the text is longer then the available width. - ``no_wrap`` prevents wrapping if the text is longer then the available width.
- ``tab_size`` Sets the number of characters in a tab. - ``tab_size`` Sets the number of characters in a tab.
A Text instance may be used in place of a plain string virtually everywhere in the Rich API, which gives you a lot of control in how text is displays within other Rich renderables. For instance, the following right aligns text within a :class:`rich.panel.Panel`:: A Text instance may be used in place of a plain string virtually everywhere in the Rich API, which gives you a lot of control in how text renders within other Rich renderables. For instance, the following example right aligns text within a :class:`rich.panel.Panel`::
from rich import print from rich import print
from rich.panel import Panel from rich.panel import Panel