-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Docs: explains flyout position #11954
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
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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``. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We don't explain what There was a problem hiding this comment. Choose a reason for hiding this commentThe 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
humitos marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Custom event integration | ||
------------------------ | ||
|
||
|
Uh oh!
There was an error while loading. Please reload this page.