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.

Sign up for GitHub

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

Jump to bottom

fix: allow user to control the back-to-top button presence #1616

Merged
merged 6 commits into from Jan 18, 2024
Merged

fix: allow user to control the back-to-top button presence #1616

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b8e6bf8
fix: put the btt button closer to age bottom
12rambau Jan 3, 2024
9b37a2d
test: remove the btt button to check
12rambau Jan 3, 2024
9bace24
test: fallback to default behaviour
12rambau Jan 3, 2024
1048c2e
refactor: rollback to previous state
12rambau Jan 3, 2024
e3bdfe5
use proper variable name
12rambau Jan 18, 2024
fc1e51f
Update src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html
drammock Jan 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/conf.py
View file
Open in desktop
Expand Up @@ -189,6 +189,7 @@
"version_match": version_match,
},
"navigation_with_keys": False,
# "back_to_top_button": False,
# "search_bar_position": "navbar", # TODO: Deprecated - remove in future version
}

Expand Down
2 changes: 1 addition & 1 deletion src/pydata_sphinx_theme/assets/styles/base/_base.scss
View file
Open in desktop
Expand Up @@ -172,7 +172,7 @@ pre {
z-index: $zindex-tooltip;
position: fixed;
display: none;
top: 80vh;
top: 90vh;
left: 50vw;
transform: translate(-50%);
color: var(--pst-color-secondary-text);
Expand Down
2 changes: 2 additions & 0 deletions src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html
View file
Open in desktop
Expand Up @@ -43,11 +43,13 @@
{# A tiny helper pixel to detect if we've scrolled #}
<div id="pst-scroll-pixel-helper"></div>

{%- if back_to_top_button %}
12rambau marked this conversation as resolved.
Show resolved Hide resolved
{# the scroll to top button #}
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>
{{ _("Back to top") }}
</button>
{%- endif %}

{# checkbox to toggle primary sidebar #}
<input type="checkbox"
Expand Down
1 change: 1 addition & 0 deletions src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf
View file
Open in desktop
Expand Up @@ -37,6 +37,7 @@ pygment_light_style = a11y-high-contrast-light
pygment_dark_style = a11y-high-contrast-dark
logo =
surface_warnings = True
back_to_top_button = True

# Template placement in theme layouts
navbar_start = navbar-logo
Expand Down