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

ENH: Add search button that looks like field #1233

Merged
merged 9 commits into from Jun 30, 2023
Merged

ENH: Add search button that looks like field #1233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
b8a2d76
ENH: Add search button that looks like field
choldgraf Mar 4, 2023
79780d5
refactor: make the button field the default search
12rambau Apr 18, 2023
9992a67
fstyle: resize search-field-button
12rambau Apr 19, 2023
1ac5a04
style: use same class for ctrl and k
12rambau Apr 19, 2023
75a0ccc
reroll package-lock.json
12rambau Apr 19, 2023
9e1d32e
align package and pakage-lock on main
12rambau Apr 21, 2023
691a79b
Restore package.json
12rambau May 21, 2023
fb3f120
restore package-lock.json
12rambau May 21, 2023
fca2378
Fix search field button padding on mobile screens
choldgraf Jun 30, 2023
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
40 changes: 40 additions & 0 deletions src/pydata_sphinx_theme/assets/styles/components/_search.scss
View file
Open in desktop
Expand Up @@ -119,3 +119,43 @@
font-size: var(--pst-font-size-icon);
}
}

/**
* The search button component that looks like a field.
* Lives at components/search-button-field.html
*/
.search-button-field {
display: inline-flex;
align-items: center;
border: var(--pst-color-border) solid 1px;
border-radius: 1.5em;
color: var(--pst-color-text-muted);
padding: 0.5em;

&:hover,
&:focus {
background-color: var(--pst-color-surface);
border-color: var(--pst-color-primary);
}

// The keyboard shotcut text
.search-button__kbd-shortcut {
font-size: var(--bs-nav-link-font-size);
font-weight: var(--bs-nav-link-font-weight);
margin-right: 0.5em;
margin-left: 0.5em;
}

.kbd-shortcut__modifier {
font-size: 0.75em;
}

// Only the icon should be visible on narrow screens
:not(i) {
display: none;

@include media-breakpoint-up(lg) {
display: flex;
}
}
}
13 changes: 13 additions & 0 deletions src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/search-button-field.html
View file
Open in desktop
@@ -0,0 +1,13 @@
{# Behaves the same as `search-button.html` but looks more like a search field.
#
# As this function will only work when JavaScript is enabled, we add it through JavaScript.
#}
<script>
document.write(`
<button class="btn navbar-btn search-button-field search-button__button" title="{{ _('Search') }}" aria-label="{{ _('Search') }}" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__kbd-shortcut">{{ _('Search') }}</span>
<span><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
`);
</script>
2 changes: 1 addition & 1 deletion src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf
View file
Open in desktop
Expand Up @@ -40,7 +40,7 @@ logo =
navbar_start = navbar-logo.html
navbar_center = navbar-nav.html
navbar_end = theme-switcher.html, navbar-icon-links.html
navbar_persistent = search-button.html
navbar_persistent = search-button-field.html
article_header_start = breadcrumbs.html
article_header_end =
primary_sidebar_end = sidebar-ethical-ads.html
Expand Down