Skip to content

Commit 2a6837d

Browse files
committed
Add HR bbcode info.
1 parent d316eac commit 2a6837d

File tree

1 file changed

+54
-1
lines changed

1 file changed

+54
-1
lines changed

tutorials/ui/bbcode_in_richtextlabel.rst

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,13 @@ Reference
282282
283283
- ``[br]``
284284

285+
* - | **hr**
286+
| Adds new a horizontal rule to separate content. Supports configuration options,
287+
see :ref:`doc_bbcode_in_richtextlabel_hr_options`.
288+
289+
- | ``[hr]``
290+
| ``[hr {options}]``
291+
285292
* - | **center**
286293
| Makes ``{text}`` horizontally centered.
287294
| Same as ``[p align=center]``.
@@ -601,6 +608,52 @@ For example:
601608
[url={"example": "value"}]JSON[/url]
602609
603610
611+
.. _doc_bbcode_in_richtextlabel_hr_options:
612+
613+
Horizontal rule options
614+
~~~~~~~~~~~~~~~~~~~~~~~
615+
616+
- **color**
617+
618+
+-----------+--------------------------------------------+
619+
| `Values` | Color name or color in HEX format |
620+
+-----------+--------------------------------------------+
621+
| `Default` | ``Color(1, 1, 1, 1)`` |
622+
+-----------+--------------------------------------------+
623+
624+
Color tint of the rule (modulation).
625+
626+
- **height**
627+
628+
+-----------+--------------------------------------------+
629+
| `Values` | Integer number |
630+
+-----------+--------------------------------------------+
631+
| `Default` | ``2`` |
632+
+-----------+--------------------------------------------+
633+
634+
Target height of the rule in pixels, add ``%`` to the end of value to specify it as percentages of the control width instead of pixels.
635+
636+
- **width**
637+
638+
+-----------+--------------------------------------------+
639+
| `Values` | Integer number |
640+
+-----------+--------------------------------------------+
641+
| `Default` | ``90%`` |
642+
+-----------+--------------------------------------------+
643+
644+
Target width of the rule in pixels, add ``%`` to the end of value to specify it as percentages of the control width instead of pixels.
645+
646+
- **align**
647+
648+
+-----------+----------------------------------------------------------------------------------------+
649+
| `Values` | ``left`` (or ``l``), ``center`` (or ``c``), ``right`` (or ``r``) |
650+
+-----------+----------------------------------------------------------------------------------------+
651+
| `Default` | ``left`` |
652+
+-----------+----------------------------------------------------------------------------------------+
653+
654+
Horizontal alignment.
655+
656+
604657
.. _doc_bbcode_in_richtextlabel_image_options:
605658

606659
Image options
@@ -634,7 +687,7 @@ Image options
634687
| `Default` | Inherit |
635688
+-----------+--------------------------------------------+
636689

637-
Target width of the image, add ``%`` to the end of value to specify it as percentages of the control width instead of pixels.
690+
Target width of the image in pixels, add ``%`` to the end of value to specify it as percentages of the control width instead of pixels.
638691

639692
- **region**
640693

0 commit comments

Comments
 (0)