Skip to content

Fix docs search visual quality #2381

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

Merged
niemyjski merged 2 commits into from
Jul 16, 2026
+161 −43
Merged

Fix docs search visual quality #2381

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8362a7c
Polish docs search experience
niemyjski Jul 16, 2026
8e71342
Apply suggestion from @niemyjski
niemyjski Jul 16, 2026
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
6 changes: 6 additions & 0 deletions docs/_config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,15 @@ site.data("docsNavHtml", docsNavHtml)
site.data("siteDataJson", siteDataJson)
site.data("copyrightYear", new Date().getFullYear())
site.data("exceptionlessClientScriptSrc", exceptionlessClientScriptSrc())
site.data("siteAssetVersionQuery", siteAssetVersionQuery())

export default site

function siteAssetVersionQuery(): string {
const version = (Deno.env.get("EXCEPTIONLESS_SITE_VERSION") ?? "").trim()
return version ? `?v=${encodeURIComponent(version)}` : ""
}

function exceptionlessClientScriptSrc(): string {
const apiKey = (Deno.env.get("EXCEPTIONLESS_SITE_API_KEY") ?? "").trim()
if (!apiKey) {
Expand Down
19 changes: 13 additions & 6 deletions docs/_includes/layouts/base.vto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
{{ for style of extraStyles || [] }}
<link rel="stylesheet" href="{{ style }}">
{{ /for }}
<link rel="stylesheet" href="/assets/css/custom.css">
<link rel="stylesheet" href="/assets/css/custom.css{{ siteAssetVersionQuery }}">
</head>
<body class="{{ bodyClass || "home page custom-background top-navbar" }}">
<header id="banner" class="topnavbar navbar navbar-fixed-top" role="banner">
Expand Down Expand Up @@ -79,7 +79,14 @@
{{ content }}
</main>

<dialog id="site-search-modal" class="modal site-search-dialog" aria-label="Search Exceptionless" data-search-ignore>
<dialog id="site-search-modal" class="modal site-search-dialog" aria-labelledby="site-search-title" data-search-ignore>
<div class="modal-header site-search-header">
<div>
<p class="site-search-eyebrow">Exceptionless Docs</p>
<h2 id="site-search-title">Search documentation</h2>
</div>
<button class="site-search-close" type="button" data-site-search-close aria-label="Close search">&times;</button>
</div>
<div class="modal-body site-search-body">
<form id="site-search-form" class="site-search-form" role="search">
<div class="site-search-input-row">
Expand All @@ -88,7 +95,7 @@
id="site-search-input"
type="search"
role="combobox"
placeholder="Search docs, clients, self-hosting..."
placeholder="Search docs, clients, and self-hosting..."
autocomplete="off"
spellcheck="false"
aria-label="Search Exceptionless"
Expand All @@ -103,9 +110,9 @@
<ol id="site-search-results" class="site-search-results" role="listbox" aria-label="Search results"></ol>
</div>
<div class="modal-footer site-search-footer" aria-hidden="true">
<span>Up/Down to move</span>
<span>Enter to open</span>
<span>Esc to close</span>
<span><kbd>&uarr;</kbd><kbd>&darr;</kbd> Navigate</span>
<span><kbd>Enter</kbd> Open</span>
<span><kbd>Esc</kbd> Close</span>
</div>
</dialog>

Expand Down
175 changes: 139 additions & 36 deletions docs/public/assets/css/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,27 +436,31 @@ body.site-search-open {
align-items: center;
box-sizing: border-box;
width: 100%;
min-height: 30px;
margin-bottom: 10px;
padding: 4px 8px;
border: 1px solid #cccccc;
border-radius: 4px;
background: #ffffff;
color: #777777;
min-height: 40px;
margin-bottom: 16px;
padding: 8px 9px 8px 11px;
border: 1px solid #d4dacd;
border-radius: 6px;
background: linear-gradient(to bottom, #ffffff, #f7f9f4);
color: #555555;
font: inherit;
font-weight: 600;
text-align: left;
box-shadow: 0 1px 2px rgba(35, 48, 24, 0.08);
transition: border-color 120ms ease, box-shadow 120ms ease, color 120ms ease;
}

.docs-search-trigger:hover,
.docs-search-trigger:focus {
border-color: #598e0e;
color: #333333;
outline: none;
box-shadow: 0 0 6px rgba(89, 142, 14, 0.35);
box-shadow: 0 0 0 3px rgba(89, 142, 14, 0.14), 0 1px 2px rgba(35, 48, 24, 0.1);
}

.docs-search-trigger i {
margin-right: 7px;
margin-right: 9px;
color: #598e0e;
}

.docs-search-trigger span {
Expand All @@ -465,22 +469,28 @@ body.site-search-open {

.docs-search-trigger kbd {
flex: 0 0 auto;
min-width: 18px;
padding: 1px 4px;
border: 1px solid #cccccc;
border-bottom-color: #aaaaaa;
border-radius: 3px;
background: #f7f7f7;
color: #777777;
min-width: 19px;
padding: 2px 5px;
border: 1px solid #d2d7cb;
border-bottom-color: #b8beb0;
border-radius: 4px;
background: #ffffff;
color: #666666;
font: 11px/1.4 "Open Sans", Arial, sans-serif;
text-align: center;
}

.site-search-dialog {
box-sizing: border-box;
max-height: min(calc(100vh - 128px), 900px);
width: min(calc(100vw - 48px), 760px);
max-width: none;
max-height: min(calc(100vh - 144px), 720px);
padding: 0;
border: 1px solid rgba(40, 52, 30, 0.22);
border-radius: 10px;
background: #ffffff;
overflow: hidden;
box-shadow: 0 24px 80px rgba(17, 24, 12, 0.34), 0 3px 10px rgba(17, 24, 12, 0.18);
}

.site-search-dialog[open] {
Expand All @@ -494,15 +504,66 @@ body.site-search-open {

@media (min-width: 768px) {
.site-search-dialog {
top: 64px;
width: min(calc(100vw - 64px), 1328px);
top: 12vh;
margin: 0;
transform: translateX(-50%);
}
}

.site-search-dialog::backdrop {
background: rgba(0, 0, 0, 0.8);
background: rgba(13, 17, 10, 0.72);
backdrop-filter: blur(2px);
}

.site-search-header {
display: flex;
align-items: flex-start;
justify-content: space-between;
padding: 18px 20px 15px;
border-bottom: 1px solid #e4e8df;
background: #fbfcfa;
}

.site-search-eyebrow {
margin: 0 0 2px;
color: #598e0e;
font-size: 10px;
font-weight: 700;
letter-spacing: 0.12em;
line-height: 1.4;
text-transform: uppercase;
}

.site-search-header h2 {
margin: 0;
color: #2f342b;
font-size: 21px;
font-weight: 600;
line-height: 1.25;
}

.site-search-close {
flex: 0 0 auto;
width: 32px;
height: 32px;
margin: 0;
padding: 0;
border: 1px solid transparent;
border-radius: 50%;
background: transparent;
color: #777777;
font-size: 24px;
font-weight: 300;
line-height: 28px;
text-align: center;
}

.site-search-close:hover,
.site-search-close:focus {
border-color: #d8ddd2;
background: #f0f3ed;
color: #333333;
outline: none;
}

.site-search-form {
Expand All @@ -516,42 +577,45 @@ body.site-search-open {
flex-direction: column;
min-height: 0;
max-height: none;
padding: 15px 15px 0;
padding: 18px 20px 0;
overflow: hidden;
}

.site-search-input-row {
display: flex;
align-items: center;
min-width: 0;
border: 1px solid #b9b9b9;
border-radius: 4px;
background: #fff;
border: 1px solid #c6ccbf;
border-radius: 7px;
background: #fbfcfa;
transition: border-color 120ms ease, box-shadow 120ms ease, background 120ms ease;
}

.site-search-input-row:focus-within {
border-color: #598e0e;
box-shadow: 0 0 6px rgba(89, 142, 14, 0.35);
background: #ffffff;
box-shadow: 0 0 0 3px rgba(89, 142, 14, 0.14);
}

.site-search-input-row i {
flex: 0 0 auto;
margin-left: 12px;
color: #777;
margin-left: 14px;
color: #598e0e;
}

#site-search-input {
box-sizing: border-box;
flex: 1 1 auto;
min-width: 0;
width: auto;
height: 42px;
height: 48px;
margin: 0;
border: 0;
box-shadow: none;
color: #333;
font-size: 18px;
line-height: 42px;
background: transparent;
font-size: 17px;
line-height: 48px;
}

#site-search-input:focus {
Expand Down Expand Up @@ -585,16 +649,17 @@ body.site-search-open {
.site-search-status {
flex: 0 0 auto;
min-height: 20px;
margin: 0 -15px;
padding: 10px 15px;
border-bottom: 1px solid #eeeeee;
margin: 0 -20px;
padding: 11px 20px;
border-bottom: 1px solid #e8ebe4;
color: #777;
font-size: 12px;
}

.site-search-results {
flex: 1 1 auto;
min-height: 0;
margin: 0 -15px;
margin: 0 -20px;
overflow-x: hidden;
overflow-y: auto;
overscroll-behavior: contain;
Expand Down Expand Up @@ -687,12 +752,30 @@ body.site-search-open {
}

.site-search-footer {
display: flex;
align-items: center;
justify-content: flex-end;
gap: 14px;
padding: 10px 18px;
border-top: 1px solid #e1e5dc;
background: #f6f8f3;
color: #777;
font-size: 12px;
box-shadow: none;
}

.site-search-footer span + span {
margin-left: 12px;
.site-search-footer kbd {
display: inline-block;
min-width: 17px;
margin-right: 3px;
padding: 1px 4px;
border: 1px solid #d0d5c9;
border-bottom-color: #b5bcad;
border-radius: 3px;
background: #ffffff;
color: #555555;
font: 10px/1.5 "Open Sans", Arial, sans-serif;
text-align: center;
}

@media (max-width: 767px) {
Expand All @@ -709,6 +792,25 @@ body.site-search-open {
transform: none;
}

.site-search-header {
padding: 15px 16px 13px;
}

.site-search-body {
padding: 15px 16px 0;
}

.site-search-status,
.site-search-results {
margin-right: -16px;
margin-left: -16px;
}

.site-search-status {
padding-right: 16px;
padding-left: 16px;
}

#site-search-input {
font-size: 16px;
}
Expand All @@ -718,6 +820,7 @@ body.site-search-open {
}

.site-search-footer {
justify-content: flex-start;
overflow-x: auto;
white-space: nowrap;
}
Expand Down
4 changes: 3 additions & 1 deletion docs/public/assets/js/site-search.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
export function initializeSiteSearch(modal) {
const input = modal.querySelector("#site-search-input")
const clearButton = modal.querySelector("#site-search-clear")
const closeButton = modal.querySelector("[data-site-search-close]")
const form = modal.querySelector("#site-search-form")
const resultsList = modal.querySelector("#site-search-results")
const status = modal.querySelector("#site-search-status")
Expand Down Expand Up @@ -115,6 +116,8 @@ export function initializeSiteSearch(modal) {
clearResults()
})

closeButton?.addEventListener("click", closeSearch)

resultsList.addEventListener("mousemove", (event) => {
const item = event.target instanceof Element ? event.target.closest("[data-site-search-result-index]") : null
if (!(item instanceof HTMLElement)) {
Expand Down Expand Up @@ -308,7 +311,6 @@ export function initializeSiteSearch(modal) {
function setStatus(message) {
status.textContent = message
}

}

export function createSearchIndexLoader(request = fetch) {
Expand Down
Loading