Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: explains flyout position #11954

Merged
merged 3 commits into from
Jan 29, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/user/flyout-menu.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,30 @@ You can sort by:
You can also choose whether ``latest`` and ``stable`` should be sorted first,
as those are special versions that Read the Docs uses.

Position
^^^^^^^^

The flyout can be configured in the :term:`dashboard` with the following positions:

- :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.
Otherwise, the default position from Read the Docs will be used: ``Bottom right``.
- :guilabel:`Bottom left` - Show the flyout at the bottom left.
- :guilabel:`Bottom right` - Show the flyout at the bottom right.
- :guilabel:`Top left` - Show the flyout at the top left.
- :guilabel:`Top right` - Show the flyout at the top right.

.. note::

If you are a theme author and want to define a default flyout position for your theme,
you can explicitly define the flyout web component with the ``position`` attribute in your HTML:

.. code:: html

<readthedocs-flyout position="bottom-left"></readthedocs-flyout>


Available positions: ``bottom-left``, ``bottom-right``, ``top-left`` and ``top-right``.

Custom event integration
------------------------

Expand Down