Skip to content

feat: add kbd hint #1495

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add kbd hint #1495

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/overrides/partials/header.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,9 @@
<label class="md-header__button md-icon" for="__search">
{% include ".icons/material/magnify.svg" %}
</label>
{% if page and nav and page.url == nav.homepage.url %}
<span class="kbd-hint" aria-hidden="true">/</span>
{% endif %}
{% include "partials/search.html" %}
{% endif %}
{% if config.repo_url %}
Expand Down
52 changes: 52 additions & 0 deletions src/stylesheets/extra.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,56 @@ body[dir=rtl] .metadata.page-metadata .contributors-text{

.arithmatex{
overflow-y: hidden !important;
}

/* Keyboard hint for search ("/") */
.kbd-hint {
display: inline-flex;
align-items: center;
justify-content: center;
margin-left: 4px;
padding: 0 6px;
height: 22px;
border-radius: 4px;
border: 1px solid var(--md-default-fg-color--lightest, rgba(0,0,0,.2));
background: var(--md-default-bg-color, #fff);
color: var(--md-default-fg-color, rgba(0,0,0,.87));
font: 500 12px/1 var(--md-text-font, system-ui, -apple-system, Segoe UI, Roboto, Ubuntu, Cantarell, Noto Sans, sans-serif);
opacity: .72;
}

/* Show "/" hint inside the search input on desktop */
.md-search__form {
position: relative;
}

.md-search__form::after {
content: "/";
position: absolute;
right: 10px;
top: 50%;
transform: translateY(-50%);
display: inline-flex;
align-items: center;
justify-content: center;
height: 20px;
padding: 0 6px;
border-radius: 4px;
border: 1px solid var(--md-default-fg-color--lightest, rgba(0,0,0,.2));
background: var(--md-default-bg-color, #fff);
color: var(--md-default-fg-color, rgba(0,0,0,.87));
font: 500 12px/1 var(--md-text-font, system-ui, -apple-system, Segoe UI, Roboto, Ubuntu, Cantarell, Noto Sans, sans-serif);
opacity: .72;
Comment on lines +88 to +96
Copy link
Member

Choose a reason for hiding this comment

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

These seem to mostly repeat things that are already set in .kbd-hint. I'm not that well versed in CSS, is this really necessary? Why do we need them as two independent settings?

Copy link
Author

Choose a reason for hiding this comment

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

they’re separate because one is a DOM element and the other is a pseudo-element positioned inside the input. If we want both contexts covered (inside the field on desktop, next to the icon on mobile/when the field is hidden), we need both targets.

Copy link
Member

Choose a reason for hiding this comment

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

What do you mean by next to the icon on mobile / when the field is hidden? For me, when the field is hidden, the hint is hidden as well?

image

pointer-events: none;
}

/* Hide hint when typing/focused so it doesn't overlap text */
.md-search__form:focus-within::after,
.md-search__form input:not(:placeholder-shown) + .md-search__icon ~ *::after {
opacity: 0;
}

/* Only show on wider viewports where the inline search is visible */
@media (max-width: 959px) {
Copy link
Member

Choose a reason for hiding this comment

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

Where is this value defined? Can we somehow take it from the theme named constants?

Copy link
Author

Choose a reason for hiding this comment

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

not sure regd. that, can we take 60em instead?

.md-search__form::after { display: none; }
}