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

show ⌘ on Mac in both search button and search input field #1449

Merged
merged 1 commit into from
Sep 18, 2023
Merged

show ⌘ on Mac in both search button and search input field #1449

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 20 additions & 4 deletions src/pydata_sphinx_theme/assets/scripts/pydata-sphinx-theme.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,14 +249,30 @@ var addEventListenerForSearchKeyboard = () => {
);
};

/**
* Find out if we're on a Mac
*/
var isMac = (navigator) => {
var platform = "";
if (
typeof navigator.userAgentData !== "undefined" &&
navigator.userAgentData != null
) {
platform = navigator.userAgentData.platform;
} else if (typeof navigator.platform !== "undefined") {
platform = navigator.platform;
}
return /mac.?os/.test(platform.toLowerCase());
};

/**
* Change the search hint to `meta key` if we are a Mac
*/

var changeSearchShortcutKey = () => {
let forms = document.querySelectorAll("form.bd-search");
var isMac = window.navigator.platform.toUpperCase().indexOf("MAC") >= 0;
if (isMac) {
forms.forEach(
let shortcuts = document.querySelectorAll(".search-button__kbd-shortcut");
if (isMac(window.navigator)) {
shortcuts.forEach(
(f) => (f.querySelector("kbd.kbd-shortcut__modifier").innerText = "⌘")
);
}
Expand Down
2 changes: 1 addition & 1 deletion src/pydata_sphinx_theme/assets/styles/components/_search.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@
}

// The keyboard shotcut text
.search-button__kbd-shortcut {
.search-button__default-text {
font-size: var(--bs-nav-link-font-size);
font-weight: var(--bs-nav-link-font-weight);
margin-right: 0.5em;
Expand Down
4 changes: 2 additions & 2 deletions src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/search-button-field.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
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>
<span class="search-button__default-text">{{ _('Search') }}</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
`);
</script>