Skip to content

Add client-side search/filter to Glossary sidebar term list #704

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
richarddushime merged 3 commits into from
Mar 19, 2026
+40 −0
Merged

Add client-side search/filter to Glossary sidebar term list #704

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
03690d3
Initial plan
Copilot Mar 18, 2026
c32ed9c
Add quick search/filter to Glossary pages for faster navigation
Copilot Mar 18, 2026
06d2262
Merge branch 'master' into copilot/add-quick-search-to-glossary
richarddushime Mar 19, 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
20 changes: 20 additions & 0 deletions layouts/glossary/list.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,33 @@
}
</style>

<script>
document.addEventListener("DOMContentLoaded", function() {
const searchInput = document.getElementById('glossary-search');
if (searchInput) {
searchInput.addEventListener('input', function() {
const query = this.value.toLowerCase();
document.querySelectorAll('#TableOfContents .nav-item').forEach(function(item) {
const link = item.querySelector('.nav-link');
const text = link ? link.textContent.toLowerCase() : '';
item.style.display = text.includes(query) ? '' : 'none';
});
});
}
});
</script>

<div class="container-fluid docs">
<div class="row flex-xl-nowrap">
<div class="col-12 col-xl-3 docs-toc glossary-toc">
<ul class="nav toc-top">
<li><a href="#" id="back_to_top" class="docs-toc-title">List of terms</a></li>
</ul>

<input type="text" id="glossary-search" class="form-control form-control-sm mb-2"
placeholder="Filter terms..."
aria-label="Filter terms">

<nav id="TableOfContents" class="nav flex-column">
<ul>
{{ $currentSection := .File.Dir }}
Expand Down
20 changes: 20 additions & 0 deletions layouts/glossary/single.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
{{ $dictionary := dict
"english" (dict
"list_of_terms" "List of terms"
"filter_terms" "Filter terms..."
"definition" "Definition"
"alt_definition" "Alternative definition"
"related_term" "Related term"
Expand All @@ -18,6 +19,7 @@
)
"german" (dict
"list_of_terms" "Liste der Begriffe"
"filter_terms" "Begriffe filtern..."
"definition" "Definition"
"alt_definition" "Alternative Definition"
"related_term" "Verwandter Begriff"
Expand All @@ -32,6 +34,7 @@
)
"arabic" (dict
"list_of_terms" "قائمة المصطلحات"
"filter_terms" "تصفية المصطلحات..."
"definition" "تعريف"
"alt_definition" "تعريف بديل"
"related_term" "مصطلح ذو صلة"
Expand All @@ -46,6 +49,7 @@
)
"turkish" (dict
"list_of_terms" "Terimler listesi"
"filter_terms" "Terimleri filtrele..."
"definition" "Tanım"
"alt_definition" "Alternatif tanım"
"related_term" "İlgili terim"
Expand Down Expand Up @@ -117,6 +121,18 @@
}
}
});

const searchInput = document.getElementById('glossary-search');
if (searchInput) {
searchInput.addEventListener('input', function() {
const query = this.value.toLowerCase();
document.querySelectorAll('#TableOfContents .nav-item').forEach(function(item) {
const link = item.querySelector('.nav-link');
const text = link ? link.textContent.toLowerCase() : '';
item.style.display = text.includes(query) ? '' : 'none';
});
});
}
});
</script>

Expand All @@ -128,6 +144,10 @@
<li><a href="#" id="back_to_top" class="docs-toc-title">{{ index (index $dictionary $lang) "list_of_terms" }}</a></li>
</ul>

<input type="text" id="glossary-search" class="form-control form-control-sm mb-2"
placeholder="{{ index (index $dictionary $lang) "filter_terms" }}"
aria-label="{{ index (index $dictionary $lang) "filter_terms" }}">

<nav id="TableOfContents" class="nav flex-column">
<ul>
{{ $currentSection := .File.Dir }}
Expand Down
Loading