Skip to content

Commit 03f73a6

Browse files
Docs: explains flyout position (#11954)
- Small explanation of how to set the flyout position from the webui - Note for theme authors on how to explicitly define it from their themes Closes readthedocs/addons#498 <!-- readthedocs-preview docs start --> --- :books: Documentation previews :books: - User's documentation (`docs`): https://docs--11954.org.readthedocs.build/en/11954/ <!-- readthedocs-preview docs end --> <!-- readthedocs-preview dev start --> - Developer's documentation (`dev`): https://dev--11954.org.readthedocs.build/en/11954/ <!-- readthedocs-preview dev end --> --------- Co-authored-by: Eric Holscher <[email protected]>
1 parent 3b1b62e commit 03f73a6

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/user/flyout-menu.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,30 @@ You can sort by:
5252
You can also choose whether ``latest`` and ``stable`` should be sorted first,
5353
as those are special versions that Read the Docs uses.
5454

55+
Position
56+
^^^^^^^^
57+
58+
The flyout can be configured in the :term:`dashboard` with the following positions:
59+
60+
- :guilabel:`Default (from theme or Read the Docs)` - **Default**. If the theme author defines a specific position for the flyout, that position will be used.
61+
Otherwise, the default position from Read the Docs will be used: ``Bottom right``.
62+
- :guilabel:`Bottom left` - Show the flyout at the bottom left.
63+
- :guilabel:`Bottom right` - Show the flyout at the bottom right.
64+
- :guilabel:`Top left` - Show the flyout at the top left.
65+
- :guilabel:`Top right` - Show the flyout at the top right.
66+
67+
.. note::
68+
69+
If you are a theme author and want to define a default flyout position for your theme,
70+
you can explicitly define the flyout web component with the ``position`` attribute in your HTML:
71+
72+
.. code:: html
73+
74+
<readthedocs-flyout position="bottom-left"></readthedocs-flyout>
75+
76+
77+
Available positions: ``bottom-left``, ``bottom-right``, ``top-left`` and ``top-right``.
78+
5579
Custom event integration
5680
------------------------
5781

0 commit comments

Comments
 (0)