'
+ var modal = container.querySelector('.DocSearch-Modal')
+ var input = container.querySelector('.DocSearch-Input')
+ var form = container.querySelector('.DocSearch-Form')
+ var reset = container.querySelector('.DocSearch-Reset')
+ var list = container.querySelector('.DocSearch-Dropdown-Container')
+ var dropdown = container.querySelector('.DocSearch-Dropdown')
+ container.addEventListener('mousedown', function (e) {
+ if (e.target === container) close()
+ })
+ // a click on a heading, the footer, or padding would otherwise move focus out of the dialog
+ container.addEventListener('click', function (e) {
+ if (ui && e.target.closest && !e.target.closest('a, button, input')) ui.input.focus({ preventScroll: true })
+ })
+ container.querySelector('.DocSearch-Cancel').addEventListener('click', close)
+ form.addEventListener('submit', function (e) {
+ e.preventDefault()
+ activate(e)
+ })
+ form.addEventListener('reset', function (e) {
+ e.preventDefault()
+ input.value = ''
+ reset.hidden = true
+ input.focus()
+ render()
+ })
+ input.addEventListener('input', function () {
+ reset.hidden = !input.value
+ schedule()
+ })
+ container.addEventListener('keydown', onModalKeydown)
+ var setHeight = function () {
+ modal.style.setProperty('--docsearch-vh', window.innerHeight * 0.01 + 'px')
+ }
+ setHeight()
+ return { container: container, input: input, list: list, dropdown: dropdown, setHeight: setHeight }
+ }
+
+ function schedule () {
+ clearTimeout(pendingTimer)
+ var query = ui.input.value.trim()
+ // a short prefix expands to many index terms; wait a little longer while the reader types
+ pendingTimer = setTimeout(render, query && query.length < 5 ? 150 : 60)
+ }
+
+ function setStalled (on) {
+ if (ui) ui.container.classList.toggle('DocSearch-Container--Stalled', !!on)
+ }
+
+ function render () {
+ if (!ui) return
+ clearTimeout(pendingTimer)
+ pendingTimer = null
+ var query = ui.input.value.trim()
+ if (!engine) {
+ if (!query) return renderStart()
+ // nothing to choose from until the index arrives (not even the recent searches)
+ lastRendered = null
+ resetList()
+ setStalled(true)
+ ensureIndex().then(render, renderError)
+ return
+ }
+ setStalled(false)
+ if (!query) return renderStart()
+ if (lastRendered === query) return
+ lastRendered = query
+ var res = search(query)
+ if (!res.pages.length) return renderNoResults(query)
+ renderResults(res)
+ }
+
+ function resetList () {
+ ui.list.innerHTML = ''
+ items = []
+ activeIndex = -1
+ ui.dropdown.scrollTop = 0
+ ui.input.removeAttribute('aria-activedescendant')
+ ui.input.setAttribute('aria-expanded', 'false')
+ ui.input.setAttribute('aria-controls', 'site-search-list')
+ }
+
+ // One listbox per group, labeled by the group heading, as DocSearch does
+ function groupList (label) {
+ var n = ui.list.querySelectorAll('.DocSearch-Hits').length
+ var section = el('section', 'DocSearch-Hits')
+ var source = el('div', 'DocSearch-Hit-source')
+ source.id = 'site-search-group-label-' + n
+ source.textContent = label
+ section.appendChild(source)
+ var ul = el('ul')
+ ul.id = 'site-search-group-' + n
+ ul.setAttribute('role', 'listbox')
+ ul.setAttribute('aria-labelledby', source.id)
+ section.appendChild(ul)
+ ui.list.appendChild(section)
+ ui.input.setAttribute('aria-controls', ui.input.getAttribute('aria-controls') + ' ' + ul.id)
+ return ul
+ }
+
+ function renderStart () {
+ lastRendered = null
+ resetList()
+ var recent = readRecent()
+ if (!recent.length) {
+ ui.list.appendChild(el('div', 'DocSearch-StartScreen', '
No recent searches
'))
+ return
+ }
+ var ul = groupList('Recent')
+ recent.forEach(function (r) {
+ var li = hitItem(siteHref(r.url), ICONS.recent, r.title, r.path, null, false, false)
+ li._entry.siteUrl = r.url
+ var action = el('div', 'DocSearch-Hit-action')
+ var remove = el('button', 'DocSearch-Hit-action-button', ICONS.remove)
+ remove.title = 'Remove this search from history'
+ remove.type = 'button'
+ remove.addEventListener('click', function (e) {
+ e.preventDefault()
+ e.stopPropagation()
+ forgetRecent(r.url)
+ renderStart()
+ ui.input.focus({ preventScroll: true }) // the button that had focus is gone
+ })
+ action.appendChild(remove)
+ li.querySelector('.DocSearch-Hit-Container').appendChild(action)
+ ul.appendChild(li)
+ })
+ setActive(0)
+ }
+
+ function renderNoResults (query) {
+ resetList()
+ var box = el('div', 'DocSearch-NoResults')
+ box.appendChild(el('div', 'DocSearch-Screen-Icon', ICONS.noResults))
+ var p = el('p', 'DocSearch-Title')
+ p.appendChild(document.createTextNode('No results for "'))
+ var strong = el('strong')
+ strong.textContent = query
+ p.appendChild(strong)
+ p.appendChild(document.createTextNode('"'))
+ box.appendChild(p)
+ ui.list.appendChild(box)
+ }
+
+ function renderError () {
+ if (!ui) return
+ setStalled(false)
+ resetList()
+ ui.list.appendChild(
+ el(
+ 'div',
+ 'DocSearch-ErrorScreen',
+ '
Unable to load search
' +
+ '
Check your network connection, then try again.
'
+ )
+ )
+ }
+
+ function hitItem (href, icon, title, path, rx, child, last) {
+ var li = el('li', 'DocSearch-Hit' + (child ? ' DocSearch-Hit--Child' : ''))
+ li.setAttribute('role', 'option')
+ li.setAttribute('aria-selected', 'false')
+ li.id = 'site-search-item-' + items.length
+ var a = el('a')
+ a.href = href
+ var box = el('div', 'DocSearch-Hit-Container')
+ if (child) box.insertAdjacentHTML('beforeend', last ? ICONS.treeLast : ICONS.tree)
+ box.appendChild(el('div', 'DocSearch-Hit-icon', icon))
+ var wrap = el('div', 'DocSearch-Hit-content-wrapper')
+ var t = el('span', 'DocSearch-Hit-title')
+ appendHighlighted(t, title, rx)
+ wrap.appendChild(t)
+ if (path) {
+ var p = el('span', 'DocSearch-Hit-path')
+ appendHighlighted(p, path, rx)
+ wrap.appendChild(p)
+ }
+ box.appendChild(wrap)
+ box.appendChild(el('div', 'DocSearch-Hit-action', ICONS.select))
+ a.appendChild(box)
+ li.appendChild(a)
+ li.addEventListener('mousemove', function () {
+ var i = items.indexOf(li)
+ if (i !== activeIndex) setActive(i, true)
+ })
+ a.addEventListener('click', function (e) {
+ remember(li)
+ // a plain click follows the link and closes the dialog (it matters for links into this page)
+ if (!(e.button || e.metaKey || e.ctrlKey || e.shiftKey || e.altKey)) close()
+ })
+ li._entry = { url: href, title: title, path: path || '' }
+ items.push(li)
+ return li
+ }
+
+ // Remembers the chosen hit for the start screen and announces the choice, so analytics can
+ // listen for 'site-search:select' (DocSearch fed Algolia Analytics; nothing is sent by default).
+ function remember (li) {
+ var e = li._entry
+ if (!e || !e.siteUrl) return
+ saveRecent({ url: e.siteUrl, title: e.title, path: e.path })
+ document.dispatchEvent(
+ new CustomEvent('site-search:select', { detail: { query: ui ? ui.input.value : '', url: e.siteUrl } })
+ )
+ }
+
+ function renderResults (res) {
+ resetList()
+ var rx = termRegExp(res.terms, res.typoWords)
+ var groups = []
+ var byLabel = {}
+ res.pages.forEach(function (page) {
+ var label = componentLabel(page.doc)
+ if (!byLabel[label]) {
+ byLabel[label] = { label: label, pages: [] }
+ groups.push(byLabel[label])
+ }
+ byLabel[label].pages.push(page)
+ })
+ groups.forEach(function (g) {
+ var ul = groupList(g.label)
+ g.pages.forEach(function (page) {
+ var doc = page.doc
+ var path = page.textMatch ? snippet(doc.text, rx) : ''
+ var li = hitItem(siteHref(doc.url), ICONS.page, doc.title, path, rx, false, false)
+ li._entry.siteUrl = doc.url
+ ul.appendChild(li)
+ var sections = page.sections.slice(0, MAX_SECTIONS)
+ sections.forEach(function (s, i) {
+ var href = siteHref(doc.url) + (s.heading.hash ? '#' + s.heading.hash : '')
+ var isLast = i === sections.length - 1
+ var child = hitItem(href, ICONS.section, headingTitle(s.heading), doc.title, rx, true, isLast)
+ child._entry.siteUrl = doc.url + (s.heading.hash ? '#' + s.heading.hash : '')
+ child._entry.path = doc.title
+ ul.appendChild(child)
+ })
+ })
+ })
+ setActive(0)
+ }
+
+ function setActive (i, fromMouse) {
+ if (activeIndex > -1 && items[activeIndex]) items[activeIndex].setAttribute('aria-selected', 'false')
+ activeIndex = i
+ var li = items[i]
+ if (!li) {
+ ui.input.removeAttribute('aria-activedescendant')
+ return
+ }
+ li.setAttribute('aria-selected', 'true')
+ ui.input.setAttribute('aria-activedescendant', li.id)
+ ui.input.setAttribute('aria-expanded', 'true')
+ if (!fromMouse) li.scrollIntoView({ block: 'nearest' })
+ }
+
+ function activate (e) {
+ if (pendingTimer) render() // act on what's typed now, not on the results of a keystroke ago
+ if (!engine && ui.input.value.trim()) return // results aren't ready yet
+ var li = items[activeIndex]
+ if (!li) return
+ var a = li.querySelector('a')
+ remember(li)
+ if (e && (e.metaKey || e.ctrlKey)) {
+ window.open(a.href, '_blank', 'noopener')
+ } else {
+ close()
+ window.location.assign(a.href)
+ }
+ }
+
+ function onModalKeydown (e) {
+ if (e.isComposing || e.keyCode === 229) return // the keystroke belongs to an input method
+ if (e.key === 'Escape') {
+ e.preventDefault()
+ close()
+ } else if (e.key === 'ArrowDown') {
+ e.preventDefault()
+ if (items.length) setActive((activeIndex + 1) % items.length)
+ } else if (e.key === 'ArrowUp') {
+ e.preventDefault()
+ if (items.length) setActive((activeIndex - 1 + items.length) % items.length)
+ } else if (e.key === 'Enter' && !(e.target.closest && e.target.closest('a, button'))) {
+ e.preventDefault()
+ activate(e)
+ } else if (e.key === 'Tab') {
+ keepFocusInside(e)
+ }
+ }
+
+ // Tab and Shift+Tab move among the dialog's controls that are showing, and wrap around at either
+ // end instead of leaving the dialog.
+ function keepFocusInside (e) {
+ var focusables = Array.prototype.filter.call(
+ ui.container.querySelectorAll('input, button:not([hidden]), a[href]'),
+ function (node) {
+ return node.getClientRects().length > 0
+ }
+ )
+ var at = focusables.indexOf(document.activeElement)
+ var next = e.shiftKey ? at - 1 : at + 1
+ if (at >= 0 && next >= 0 && next < focusables.length) return // the browser moves focus
+ e.preventDefault()
+ var target = e.shiftKey && at >= 0 ? focusables[focusables.length - 1] : focusables[0]
+ if (target) target.focus()
+ }
+
+ // While the dialog is open: Escape closes it wherever focus is, and focus can't stay on the
+ // page behind it.
+ function onDocumentKeydown (e) {
+ if (!ui || ui.container.contains(e.target)) return
+ if (e.key === 'Escape') {
+ e.preventDefault()
+ close()
+ } else if (/^(ArrowUp|ArrowDown|Enter|Tab)$/.test(e.key)) {
+ ui.input.focus({ preventScroll: true })
+ onModalKeydown(e)
+ }
+ }
+
+ function onDocumentFocusin (e) {
+ if (ui && !ui.container.contains(e.target)) ui.input.focus({ preventScroll: true })
+ }
+
+ function open (initialQuery) {
+ if (ui) return
+ lastFocus = document.activeElement
+ ui = buildModal()
+ document.body.appendChild(ui.container)
+ document.body.classList.add('DocSearch--active')
+ var selection = initialQuery || (window.getSelection ? String(window.getSelection()).slice(0, 64) : '')
+ if (selection && !/\n/.test(selection)) {
+ ui.input.value = selection
+ ui.container.querySelector('.DocSearch-Reset').hidden = false
+ }
+ ui.input.focus()
+ document.addEventListener('keydown', onDocumentKeydown, true)
+ document.addEventListener('focusin', onDocumentFocusin)
+ window.addEventListener('resize', ui.setHeight)
+ if (!engine) {
+ if (ui.input.value) setStalled(true)
+ ensureIndex().then(render, renderError)
+ }
+ render()
+ }
+
+ function close () {
+ if (!ui) return
+ clearTimeout(pendingTimer)
+ pendingTimer = null
+ document.removeEventListener('keydown', onDocumentKeydown, true)
+ document.removeEventListener('focusin', onDocumentFocusin)
+ window.removeEventListener('resize', ui.setHeight)
+ ui.container.remove()
+ ui = null
+ items = []
+ lastRendered = null
+ document.body.classList.remove('DocSearch--active')
+ if (lastFocus && lastFocus.focus) lastFocus.focus({ preventScroll: true })
+ }
+
+ function isEditable (target) {
+ var tag = target && target.tagName
+ return tag === 'INPUT' || tag === 'SELECT' || tag === 'TEXTAREA' || (target && target.isContentEditable)
+ }
+
+ function initButton () {
+ var button = document.querySelector('#docsearch .DocSearch-Button, #site-search-button')
+ if (!button) return
+ var keys = button.querySelectorAll('.DocSearch-Button-Key')
+ if (IS_MAC && keys[0]) {
+ keys[0].textContent = '⌘'
+ keys[0].classList.remove('DocSearch-Button-Key--text')
+ button.setAttribute('aria-label', 'Search (Command+K)')
+ }
+ var prefetch = function () {
+ ensureIndex().catch(function () {})
+ }
+ button.addEventListener('pointerenter', prefetch, { once: true })
+ button.addEventListener('focus', prefetch, { once: true })
+ button.addEventListener('touchstart', prefetch, { once: true, passive: true })
+ button.addEventListener('click', function () {
+ open()
+ })
+ window.addEventListener('keydown', function (e) {
+ var key = e.key && e.key.toLowerCase()
+ if ((e.metaKey || e.ctrlKey) && key === 'k') {
+ e.preventDefault()
+ ui ? close() : open()
+ } else if (!ui && key === '/' && !isEditable(e.target)) {
+ e.preventDefault()
+ open()
+ }
+ })
+ }
+
+ window.siteSearch = {
+ open: open,
+ close: close,
+ load: ensureIndex,
+ search: function (query) {
+ return ensureIndex().then(function () {
+ return search(query)
+ })
+ },
+ metrics: metrics,
+ }
+
+ if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', initButton)
+ else initButton()
+})()
diff --git a/src/partials/body-end-scripts.hbs b/src/partials/body-end-scripts.hbs
index f65917d4..8e979501 100644
--- a/src/partials/body-end-scripts.hbs
+++ b/src/partials/body-end-scripts.hbs
@@ -3,6 +3,9 @@
+{{#if env.SITE_SEARCH_PROVIDER}}
+{{> search-scripts}}
+{{else}}
{{#with site.keys}}
{{#if (and algoliaAppId algoliaIndexName algoliaApiKey)}}
@@ -17,4 +20,5 @@
{{/if}}
{{/with}}
+{{/if}}
{{> scarf}}
diff --git a/src/partials/navbar.hbs b/src/partials/navbar.hbs
index 338c13f4..26869d20 100644
--- a/src/partials/navbar.hbs
+++ b/src/partials/navbar.hbs
@@ -11,7 +11,19 @@
{{> logo}}
-
+
+ {{#if env.SITE_SEARCH_PROVIDER}}
+ {{!-- Rendered here rather than by script so the header doesn't shift when the page loads --}}
+
+ {{/if}}
+
{{> theme-toggle}}
{{> global-nav}}
diff --git a/src/partials/search-scripts.hbs b/src/partials/search-scripts.hbs
new file mode 100644
index 00000000..e60e64b2
--- /dev/null
+++ b/src/partials/search-scripts.hbs
@@ -0,0 +1,11 @@
+{{!-- Site search powered by @antora/lunr-extension. The extension sets env.SITE_SEARCH_PROVIDER,
+generates search-index.js at the site root, and vendors lunr.js into the UI. This partial replaces
+the extension's default one: site-search.js renders a DocSearch-style modal and downloads lunr.js
+and the index only when the reader starts to search. It supports English-language indexes only
+(it doesn't load lunr-languages). --}}
+