mirrors/rich
1
0
Fork 0
mirror of https://github.com/Textualize/rich.git synced 2025-08-04 18:18:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

box docs

Browse source
This commit is contained in:
Will McGugan 2022-08-02 16:33:14 +01:00
parent 2ee992b17e
commit 3fbf53acf0
2 changed files with 2 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

39
docs/source/appendix/box.rst
View file

@ -17,41 +17,4 @@ The following table is generated with this command::
python -m rich.box
.. raw:: html
<pre style="font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace"> <span style="color: #008000; text-decoration-color: #008000">╭───────────────╮</span>
<span style="color: #008000; text-decoration-color: #008000">│ </span><span style="color: #008000; text-decoration-color: #008000; font-weight: bold">Box Constants</span><span style="color: #008000; text-decoration-color: #008000"> │</span>
<span style="color: #008000; text-decoration-color: #008000">╰───────────────╯</span>
<span style="color: #800080; text-decoration-color: #800080"> box.ASCII </span> <span style="color: #800080; text-decoration-color: #800080"> box.ASCII2 </span> <span style="color: #800080; text-decoration-color: #800080"> box.ASCII_DOUBLE_HEAD </span> <span style="color: #800080; text-decoration-color: #800080"> box.DOUBLE </span> <span style="color: #800080; text-decoration-color: #800080"> box.DOUBLE_EDGE </span> <span style="color: #800080; text-decoration-color: #800080"> box.HEAVY </span> <span style="color: #800080; text-decoration-color: #800080"> box.HEAVY_EDGE </span>
+-----------------------+ +-----------+-----------+ +-----------+-----------+ ╔═══════════╦═══════════╗ ╔═══════════╤═══════════╗ ┏━━━━━━━━━━━┳━━━━━━━━━━━┓ ┏━━━━━━━━━━━┯━━━━━━━━━━┓
|<span style="font-weight: bold"> Header 1 </span>|<span style="font-weight: bold"> Header 2 </span>| |<span style="font-weight: bold"> Header 1 </span>|<span style="font-weight: bold"> Header 2 </span>| |<span style="font-weight: bold"> Header 1 </span>|<span style="font-weight: bold"> Header 2 </span>| ║<span style="font-weight: bold"> Header 1 </span>║<span style="font-weight: bold"> Header 2 </span>║ ║<span style="font-weight: bold"> Header 1 </span>│<span style="font-weight: bold"> Header 2 </span>║ ┃<span style="font-weight: bold"> Header 1 </span>┃<span style="font-weight: bold"> Header 2 </span>┃ ┃<span style="font-weight: bold"> Header 1 </span>│<span style="font-weight: bold"> Header 2 </span>┃
|-----------+-----------| +-----------+-----------+ +===========+===========+ ╠═══════════╬═══════════╣ ╟───────────┼───────────╢ ┣━━━━━━━━━━━╋━━━━━━━━━━━┫ ┠───────────┼──────────┨
| Cell | Cell | | Cell | Cell | | Cell | Cell | ║ Cell ║ Cell ║ ║ Cell │ Cell ║ ┃ Cell ┃ Cell ┃ ┃ Cell │ Cell ┃
| Cell | Cell | | Cell | Cell | | Cell | Cell | ║ Cell ║ Cell ║ ║ Cell │ Cell ║ ┃ Cell ┃ Cell ┃ ┃ Cell │ Cell ┃
|-----------+-----------| +-----------+-----------+ +-----------+-----------+ ╠═══════════╬═══════════╣ ╟───────────┼───────────╢ ┣━━━━━━━━━━━╋━━━━━━━━━━━┫ ┠───────────┼──────────┨
|<span style="font-weight: bold"> Footer 1 </span>|<span style="font-weight: bold"> Footer 2 </span>| |<span style="font-weight: bold"> Footer 1 </span>|<span style="font-weight: bold"> Footer 2 </span>| |<span style="font-weight: bold"> Footer 1 </span>|<span style="font-weight: bold"> Footer 2 </span>| ║<span style="font-weight: bold"> Footer 1 </span>║<span style="font-weight: bold"> Footer 2 </span>║ ║<span style="font-weight: bold"> Footer 1 </span>│<span style="font-weight: bold"> Footer 2 </span>║ ┃<span style="font-weight: bold"> Footer 1 </span>┃<span style="font-weight: bold"> Footer 2 </span>┃ ┃<span style="font-weight: bold"> Footer 1 </span>│<span style="font-weight: bold"> Footer 2 </span>┃
+-----------------------+ +-----------+-----------+ +-----------+-----------+ ╚═══════════╩═══════════╝ ╚═══════════╧═══════════╝ ┗━━━━━━━━━━━┻━━━━━━━━━━━┛ ┗━━━━━━━━━━━┷━━━━━━━━━━┛
<span style="color: #800080; text-decoration-color: #800080"> box.HEAVY_HEAD </span> <span style="color: #800080; text-decoration-color: #800080"> box.HORIZONTALS </span> <span style="color: #800080; text-decoration-color: #800080"> box.MARKDOWN </span> <span style="color: #800080; text-decoration-color: #800080"> box.MINIMAL </span> <span style="color: #800080; text-decoration-color: #800080"> box.MINIMAL_DOUBLE_HEAD </span> <span style="color: #800080; text-decoration-color: #800080"> box.MINIMAL_HEAVY_HEAD </span> <span style="color: #800080; text-decoration-color: #800080"> box.ROUNDED </span>
┏━━━━━━━━━━━┳━━━━━━━━━━━┓ ─────────────────────── ╷ ╷ ╷ ╭───────────┬──────────╮
┃<span style="font-weight: bold"> Header 1 </span>┃<span style="font-weight: bold"> Header 2 </span>┃ <span style="font-weight: bold"> Header 1 </span> <span style="font-weight: bold"> Header 2 </span> |<span style="font-weight: bold"> Header 1 </span>|<span style="font-weight: bold"> Header 2 </span>| <span style="font-weight: bold"> Header 1 </span>│<span style="font-weight: bold"> Header 2 </span> <span style="font-weight: bold"> Header 1 </span>│<span style="font-weight: bold"> Header 2 </span> <span style="font-weight: bold"> Header 1 </span>│<span style="font-weight: bold"> Header 2 </span> │<span style="font-weight: bold"> Header 1 </span>│<span style="font-weight: bold"> Header 2 </span>│
┡━━━━━━━━━━━╇━━━━━━━━━━━┩ ─────────────────────── |-----------|-----------| ╶───────────┼───────────╴ ═══════════╪═══════════ ╺━━━━━━━━━━━┿━━━━━━━━━━━╸ ├───────────┼──────────┤
│ Cell │ Cell │ Cell Cell | Cell | Cell | Cell │ Cell Cell │ Cell Cell │ Cell │ Cell │ Cell │
│ Cell │ Cell │ Cell Cell | Cell | Cell | Cell │ Cell Cell │ Cell Cell │ Cell │ Cell │ Cell │
├───────────┼───────────┤ ─────────────────────── |-----------|-----------| ╶───────────┼───────────╴ ───────────┼─────────── ╶───────────┼───────────╴ ├───────────┼──────────┤
│<span style="font-weight: bold"> Footer 1 </span>│<span style="font-weight: bold"> Footer 2 </span>│ <span style="font-weight: bold"> Footer 1 </span> <span style="font-weight: bold"> Footer 2 </span> |<span style="font-weight: bold"> Footer 1 </span>|<span style="font-weight: bold"> Footer 2 </span>| <span style="font-weight: bold"> Footer 1 </span>│<span style="font-weight: bold"> Footer 2 </span> <span style="font-weight: bold"> Footer 1 </span>│<span style="font-weight: bold"> Footer 2 </span> <span style="font-weight: bold"> Footer 1 </span>│<span style="font-weight: bold"> Footer 2 </span> │<span style="font-weight: bold"> Footer 1 </span>│<span style="font-weight: bold"> Footer 2 </span>│
└───────────┴───────────┘ ─────────────────────── ╵ ╵ ╵ ╰───────────┴──────────╯
<span style="color: #800080; text-decoration-color: #800080"> box.SIMPLE </span> <span style="color: #800080; text-decoration-color: #800080"> box.SIMPLE_HEAD </span> <span style="color: #800080; text-decoration-color: #800080"> box.SIMPLE_HEAVY </span> <span style="color: #800080; text-decoration-color: #800080"> box.SQUARE </span> <span style="color: #800080; text-decoration-color: #800080"> box.SQUARE_DOUBLE_HEAD </span>
┌───────────┬───────────┐ ┌───────────┬───────────┐
<span style="font-weight: bold"> Header 1 </span> <span style="font-weight: bold"> Header 2 </span> <span style="font-weight: bold"> Header 1 </span> <span style="font-weight: bold"> Header 2 </span> <span style="font-weight: bold"> Header 1 </span> <span style="font-weight: bold"> Header 2 </span> │<span style="font-weight: bold"> Header 1 </span>│<span style="font-weight: bold"> Header 2 </span>│ │<span style="font-weight: bold"> Header 1 </span>│<span style="font-weight: bold"> Header 2 </span>│
─────────────────────── ─────────────────────── ━━━━━━━━━━━━━━━━━━━━━━━ ├───────────┼───────────┤ ╞═══════════╪═══════════╡
Cell Cell Cell Cell Cell Cell │ Cell │ Cell │ │ Cell │ Cell │
Cell Cell Cell Cell Cell Cell │ Cell │ Cell │ │ Cell │ Cell │
─────────────────────── ━━━━━━━━━━━━━━━━━━━━━━━ ├───────────┼───────────┤ ├───────────┼───────────┤
<span style="font-weight: bold"> Footer 1 </span> <span style="font-weight: bold"> Footer 2 </span> <span style="font-weight: bold"> Footer 1 </span> <span style="font-weight: bold"> Footer 2 </span> <span style="font-weight: bold"> Footer 1 </span> <span style="font-weight: bold"> Footer 2 </span> │<span style="font-weight: bold"> Footer 1 </span>│<span style="font-weight: bold"> Footer 2 </span>│ │<span style="font-weight: bold"> Footer 1 </span>│<span style="font-weight: bold"> Footer 2 </span>│
└───────────┴───────────┘ └───────────┴───────────┘
</pre>
.. image:: ../../images/box.svg