From bfe2410515850e48d006c985f102c4ce86ee6787 Mon Sep 17 00:00:00 2001
From: Sam James <sam@samdjames.uk>
Date: Fri, 1 Nov 2024 00:46:45 +0000
Subject: [PATCH] feat(theme): introduce independent search page

---
 src/client/app/router.ts                      | 13 +++-
 src/client/theme-default/Search.vue           | 69 +++++++++++++++++++
 .../theme-default/components/VPContent.vue    |  4 +-
 .../components/VPLocalSearchBox.vue           | 32 ++++++---
 .../theme-default/components/VPNavBar.vue     |  6 +-
 src/shared/shared.ts                          | 15 +++-
 types/shared.d.ts                             |  1 +
 7 files changed, 125 insertions(+), 15 deletions(-)
 create mode 100644 src/client/theme-default/Search.vue

diff --git a/src/client/app/router.ts b/src/client/app/router.ts
index 3c6fb4f7f42f..9e06d8a95181 100644
--- a/src/client/app/router.ts
+++ b/src/client/app/router.ts
@@ -1,7 +1,7 @@
 import type { Component, InjectionKey } from 'vue'
 import { inject, markRaw, nextTick, reactive, readonly } from 'vue'
 import type { Awaitable, PageData, PageDataPayload } from '../shared'
-import { notFoundPageData, treatAsHtml } from '../shared'
+import { notFoundPageData, searchPageData, treatAsHtml } from '../shared'
 import { siteDataRef } from './data'
 import { getScrollOffset, inBrowser, withBase } from './utils'
 
@@ -58,7 +58,8 @@ interface PageModule {
 
 export function createRouter(
   loadPageModule: (path: string) => Awaitable<PageModule | null>,
-  fallbackComponent?: Component
+  fallbackComponent?: Component,
+  searchComponent?: Component
 ): Router {
   const route = reactive(getDefaultRoute())
 
@@ -85,6 +86,14 @@ export function createRouter(
     if ((await router.onBeforePageLoad?.(href)) === false) return
     const targetLoc = new URL(href, fakeHost)
     const pendingPath = (latestPendingPath = targetLoc.pathname)
+
+    if (pendingPath === '/search') {
+      route.path = inBrowser ? pendingPath : withBase(pendingPath)
+      route.component = searchComponent ? markRaw(searchComponent) : null
+      route.data = searchPageData
+      return
+    }
+
     try {
       let page = await loadPageModule(pendingPath)
       if (!page) {
diff --git a/src/client/theme-default/Search.vue b/src/client/theme-default/Search.vue
new file mode 100644
index 000000000000..56761d003c9b
--- /dev/null
+++ b/src/client/theme-default/Search.vue
@@ -0,0 +1,69 @@
+<script setup lang="ts">
+import {
+  defineAsyncComponent,
+  ref
+} from 'vue'
+import { useData } from './composables/data'
+const { theme, site } = useData()
+
+const VPLocalSearchBox = __VP_LOCAL_SEARCH__
+  ? defineAsyncComponent(() => import('./components/VPLocalSearchBox.vue'))
+  : () => null
+
+const VPAlgoliaSearchBox = __ALGOLIA__
+  ? defineAsyncComponent(() => import('./components/VPAlgoliaSearchBox.vue'))
+  : () => null
+
+const provider = __ALGOLIA__ ? 'algolia' : __VP_LOCAL_SEARCH__ ? 'local' : ''
+
+const filterText = ref('');
+const handleFilterTextChange = (text: string) => {
+  filterText.value = text;
+  const newUrl = (new URL(window.location.href));
+  if (text) {
+    newUrl.searchParams.set('q', text)
+  } else {
+    newUrl.searchParams.delete('q');
+  }
+  history.replaceState({}, '', newUrl.href)
+}
+
+const title = site.value.title;
+</script>
+
+<template>
+  <div class="Search">
+    
+    <div class="search-wrapper">
+        <h1 class="title">{{ filterText ? `Search Results For "${filterText}"` : `Search ${title}` }}</h1>
+
+        <template v-if="provider === 'local'">
+            <VPLocalSearchBox @filter-change="handleFilterTextChange"/>
+        </template>
+
+        <template v-else-if="provider === 'algolia'">
+            <VPAlgoliaSearchBox
+                :algolia="theme.search?.options ?? theme.algolia"
+            />
+        </template>
+    </div>
+
+  </div>
+</template>
+
+<style scoped>
+  .search-wrapper {
+    position: relative;
+    padding: 12px;
+    margin: 32px auto 0;
+    width: min(100vw - 60px, 900px);
+  }
+  .title {
+    margin-bottom: 12px;
+    letter-spacing: -0.02em;
+    line-height: 40px;
+    font-size: 32px;
+    font-weight: 600;
+    outline: none;
+  }
+</style>
diff --git a/src/client/theme-default/components/VPContent.vue b/src/client/theme-default/components/VPContent.vue
index 3b2dbdf6e0ff..6e2e522b9f05 100644
--- a/src/client/theme-default/components/VPContent.vue
+++ b/src/client/theme-default/components/VPContent.vue
@@ -1,5 +1,6 @@
 <script setup lang="ts">
 import NotFound from '../NotFound.vue'
+import Search from '../Search.vue'
 import { useData } from '../composables/data'
 import { useSidebar } from '../composables/sidebar'
 import VPDoc from './VPDoc.vue'
@@ -19,7 +20,8 @@ const { hasSidebar } = useSidebar()
       'is-home': frontmatter.layout === 'home'
     }"
   >
-    <slot name="not-found" v-if="page.isNotFound"><NotFound /></slot>
+    <slot name="search" v-if="page.isSearch"><Search /></slot>
+    <slot name="not-found" v-else-if="page.isNotFound"><NotFound /></slot>
 
     <VPPage v-else-if="frontmatter.layout === 'page'">
       <template #page-top><slot name="page-top" /></template>
diff --git a/src/client/theme-default/components/VPLocalSearchBox.vue b/src/client/theme-default/components/VPLocalSearchBox.vue
index 951a7536c420..20c20d25d02e 100644
--- a/src/client/theme-default/components/VPLocalSearchBox.vue
+++ b/src/client/theme-default/components/VPLocalSearchBox.vue
@@ -34,7 +34,8 @@ import { LRUCache } from '../support/lru'
 import { createSearchTranslate } from '../support/translation'
 
 const emit = defineEmits<{
-  (e: 'close'): void
+  (e: 'close'): void,
+  (e: 'filter-change', text: string): void
 }>()
 
 const el = shallowRef<HTMLElement>()
@@ -60,6 +61,7 @@ interface Result {
 }
 
 const vitePressData = useData()
+const isSearchPage = vitePressData.page.value.isSearch;
 const { activate } = useFocusTrap(el, {
   immediate: true,
   allowOutsideClick: true,
@@ -135,6 +137,7 @@ const enableNoResults = ref(false)
 
 watch(filterText, () => {
   enableNoResults.value = false
+  emit('filter-change', filterText.value);
 })
 
 const mark = computedAsync(async () => {
@@ -270,6 +273,8 @@ function focusSearchInput(select = true) {
 
 onMounted(() => {
   focusSearchInput()
+  filterText.value = (new URL(window.location.href)).searchParams.get('q') ?? ''
+  emit('filter-change', filterText.value);
 })
 
 function onSearchBarClick(event: PointerEvent) {
@@ -377,7 +382,7 @@ const isLocked = useScrollLock(inBrowser ? document.body : null)
 
 onMounted(() => {
   nextTick(() => {
-    isLocked.value = true
+    isLocked.value = !isSearchPage
     nextTick().then(() => activate())
   })
 })
@@ -413,7 +418,7 @@ function onMouseMove(e: MouseEvent) {
 </script>
 
 <template>
-  <Teleport to="body">
+  <Teleport to="body" :disabled="isSearchPage">
     <div
       ref="el"
       role="button"
@@ -421,7 +426,10 @@ function onMouseMove(e: MouseEvent) {
       aria-expanded="true"
       aria-haspopup="listbox"
       aria-labelledby="localsearch-label"
-      class="VPLocalSearchBox"
+      :class="{
+        'VPLocalSearchBox': true,
+        'overlay': !isSearchPage
+      }"
     >
       <div class="backdrop" @click="$emit('close')" />
 
@@ -569,7 +577,7 @@ function onMouseMove(e: MouseEvent) {
             </kbd>
             {{ translate('modal.footer.selectText') }}
           </span>
-          <span>
+          <span v-if="!isSearchPage">
             <kbd :aria-label="translate('modal.footer.closeKeyAriaLabel')">esc</kbd>
             {{ translate('modal.footer.closeText') }}
           </span>
@@ -580,32 +588,38 @@ function onMouseMove(e: MouseEvent) {
 </template>
 
 <style scoped>
-.VPLocalSearchBox {
+.VPLocalSearchBox.overlay {
   position: fixed;
   z-index: 100;
   inset: 0;
   display: flex;
 }
 
-.backdrop {
+.VPLocalSearchBox.overlay .backdrop {
   position: absolute;
   inset: 0;
   background: var(--vp-backdrop-bg-color);
   transition: opacity 0.5s;
 }
 
+.VPLocalSearchBox.overlay .shell {
+  margin-top: 64px;
+  max-height: min(100vh - 128px, 900px);
+  z-index: unset;
+}
+
 .shell {
   position: relative;
   padding: 12px;
-  margin: 64px auto;
+  margin: 0 auto 64px;
   display: flex;
   flex-direction: column;
   gap: 16px;
   background: var(--vp-local-search-bg);
   width: min(100vw - 60px, 900px);
   height: min-content;
-  max-height: min(100vh - 128px, 900px);
   border-radius: 6px;
+  z-index: 0;
 }
 
 @media (max-width: 767px) {
diff --git a/src/client/theme-default/components/VPNavBar.vue b/src/client/theme-default/components/VPNavBar.vue
index d1fbe3626ca5..7d165bbda221 100644
--- a/src/client/theme-default/components/VPNavBar.vue
+++ b/src/client/theme-default/components/VPNavBar.vue
@@ -22,7 +22,9 @@ defineEmits<{
 
 const { y } = useWindowScroll()
 const { hasSidebar } = useSidebar()
-const { frontmatter } = useData()
+const { frontmatter, page } = useData()
+
+const isSearchPage = page.value.isSearch
 
 const classes = ref<Record<string, boolean>>({})
 
@@ -50,7 +52,7 @@ watchPostEffect(() => {
         <div class="content">
           <div class="content-body">
             <slot name="nav-bar-content-before" />
-            <VPNavBarSearch class="search" />
+            <VPNavBarSearch class="search" v-if="!isSearchPage"/>
             <VPNavBarMenu class="menu" />
             <VPNavBarTranslations class="translations" />
             <VPNavBarAppearance class="appearance" />
diff --git a/src/shared/shared.ts b/src/shared/shared.ts
index 051c5d094d5c..75b0cfb8c9e6 100644
--- a/src/shared/shared.ts
+++ b/src/shared/shared.ts
@@ -31,7 +31,20 @@ export const notFoundPageData: PageData = {
   headers: [],
   frontmatter: { sidebar: false, layout: 'page' },
   lastUpdated: 0,
-  isNotFound: true
+  isNotFound: true,
+  isSearch: false
+}
+
+export const searchPageData: PageData = {
+  relativePath: 'search.md',
+  filePath: '',
+  title: 'Search',
+  description: 'Search Page',
+  headers: [],
+  frontmatter: { sidebar: false, layout: 'page' },
+  lastUpdated: 0,
+  isNotFound: false,
+  isSearch: true
 }
 
 export function isActive(
diff --git a/types/shared.d.ts b/types/shared.d.ts
index 0ea216538a73..66a8db3a3d71 100644
--- a/types/shared.d.ts
+++ b/types/shared.d.ts
@@ -19,6 +19,7 @@ export interface PageData {
   frontmatter: Record<string, any>
   params?: Record<string, any>
   isNotFound?: boolean
+  isSearch?: boolean
   lastUpdated?: number
 }