Skip to content
Merged
Changes from 1 commit
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 position can be configured as:

- :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``, ``top-right``, ``inline``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't explain what inline is in this PR?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just removed the mention to inline because I'm not 100% sure how it should behave yet -- so, I don't want to explain something that I'm not sure if it's correct.

We can come back here once we finish and merge readthedocs/addons#500


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

Expand Down
Loading