vitepress 0.22.3 → 1.0.0-draft.2

package/dist/client/theme-default/components/VPNavBar.vue

@@ -0,0 +1,110 @@
+<script lang="ts" setup>
+import VPNavBarTitle from './VPNavBarTitle.vue'
+import VPNavBarSearch from './VPNavBarSearch.vue'
+import VPNavBarMenu from './VPNavBarMenu.vue'
+import VPNavBarTranslations from './VPNavBarTranslations.vue'
+import VPNavBarAppearance from './VPNavBarAppearance.vue'
+import VPNavBarSocialLinks from './VPNavBarSocialLinks.vue'
+import VPNavBarExtra from './VPNavBarExtra.vue'
+import VPNavBarHamburger from './VPNavBarHamburger.vue'
+
+defineProps<{
+  isScreenOpen: boolean
+}>()
+
+defineEmits<{
+  (e: 'toggle-screen'): void
+}>()
+</script>
+
+<template>
+  <div class="VPNavBar">
+    <div class="container">
+      <VPNavBarTitle />
+
+      <div class="content">
+        <VPNavBarSearch class="search" />
+        <VPNavBarMenu class="menu" />
+        <VPNavBarTranslations class="translations" />
+        <VPNavBarAppearance class="appearance" />
+        <VPNavBarSocialLinks class="social-links" />
+        <VPNavBarExtra class="extra" />
+        <VPNavBarHamburger
+          class="hamburger"
+          :active="isScreenOpen"
+          @click="$emit('toggle-screen')"
+        />
+      </div>
+    </div>
+  </div>
+</template>
+
+<style scoped>
+.VPNavBar {
+  position: relative;
+  border-bottom: 1px solid var(--vp-c-divider-light);
+  padding: 0 8px 0 24px;
+  height: var(--vp-nav-height-mobile);
+  background-color: var(--vt-c-bg);
+  transition: border-color 0.5s, background-color 0.5s;
+}
+
+@media (min-width: 768px) {
+  .VPNavBar {
+    padding: 0 32px;
+  }
+}
+
+@media (min-width: 960px) {
+  .VPNavBar {
+    height: var(--vp-nav-height-desktop);
+    border-bottom: 0;
+  }
+}
+
+.container {
+  display: flex;
+  justify-content: space-between;
+  margin: 0 auto;
+  max-width: var(--vp-layout-max-width);
+}
+
+.content {
+  display: flex;
+  justify-content: flex-end;
+  align-items: center;
+  flex-grow: 1;
+}
+
+@media (min-width: 960px) {
+  .content {
+    backdrop-filter: saturate(50%) blur(8px);
+  }
+}
+
+.menu + .translations::before,
+.menu + .appearance::before,
+.menu + .social-links::before,
+.translations + .appearance::before,
+.appearance + .social-links::before {
+  margin-right: 8px;
+  margin-left: 8px;
+  width: 1px;
+  height: 24px;
+  background-color: var(--vp-c-divider-light);
+  content: "";
+}
+
+.menu + .appearance::before,
+.translations + .appearance::before {
+  margin-right: 16px;
+}
+
+.appearance + .social-links::before {
+  margin-left: 16px;
+}
+
+.social-links {
+  margin-right: -8px;
+}
+</style>

package/dist/client/theme-default/components/VPNavBarAppearance.vue

@@ -0,0 +1,25 @@
+<script lang="ts" setup>
+import { useData } from 'vitepress'
+import VPSwitchAppearance from './VPSwitchAppearance.vue'
+
+const { site } = useData()
+</script>
+
+<template>
+  <div v-if="site.appearance" class="VPNavBarAppearance">
+    <VPSwitchAppearance />
+  </div>
+</template>
+
+<style scoped>
+.VPNavBarAppearance {
+  display: none;
+}
+
+@media (min-width: 1280px) {
+  .VPNavBarAppearance {
+    display: flex;
+    align-items: center;
+  }
+}
+</style>

package/dist/client/theme-default/components/VPNavBarExtra.vue

@@ -0,0 +1,107 @@
+<script lang="ts" setup>
+import { useData } from 'vitepress'
+import VPFlyout from './VPFlyout.vue'
+import VPSwitchAppearance from './VPSwitchAppearance.vue'
+import VPSocialLinks from './VPSocialLinks.vue'
+
+const { site, theme } = useData()
+</script>
+
+<template>
+  <VPFlyout class="VPNavBarExtra" label="extra navigation">
+    <div v-if="theme.localeLinks" class="group">
+      <div class="trans">
+        <p class="trans-title">
+          {{ theme.localeLinks.text }}
+        </p>
+
+        <ul class="trans-list">
+          <li v-for="locale in theme.localeLinks.items" :key="locale.link" class="trans-item">
+            <a class="trans-link" :href="locale.link">{{ locale.text }}</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+
+    <div v-if="site.appearance" class="group">
+      <div class="item">
+        <p class="label">Appearance</p>
+        <div class="appearance-action">
+          <VPSwitchAppearance />
+        </div>
+      </div>
+    </div>
+
+    <div v-if="theme.socialLinks" class="group">
+      <div class="item">
+        <VPSocialLinks class="social-links" :links="theme.socialLinks" />
+      </div>
+    </div>
+  </VPFlyout>
+</template>
+
+<style scoped>
+.VPNavBarExtra {
+  display: none;
+  margin-right: -12px;
+}
+
+@media (min-width: 768px) {
+  .VPNavBarExtra {
+    display: block;
+  }
+}
+
+@media (min-width: 1280px) {
+  .VPNavBarExtra {
+    display: none;
+  }
+}
+
+.trans {
+  padding: 2px 16px 0;
+}
+
+.trans-title {
+  display: flex;
+  align-items: center;
+  font-size: 13px;
+  font-weight: 600;
+  color: var(--vp-c-text-1);
+}
+
+.trans-icon {
+  margin-right: 12px;
+  width: 16px;
+  height: 16px;
+  fill: currentColor;
+}
+
+.trans-list {
+  padding: 2px 0 0 0;
+}
+
+.trans-link {
+  line-height: 28px;
+  font-size: 13px;
+  color: var(--vp-c-text-1);
+  transition: color 0.25s;
+}
+
+.trans-link:hover {
+  color: var(--vp-c-brand);
+}
+
+.item {
+  display: flex;
+  align-items: center;
+}
+
+.appearance-action {
+  margin-right: -2px;
+}
+
+.social-links {
+  margin: -4px -8px;
+}
+</style>

package/dist/client/theme-default/components/VPNavBarHamburger.vue

@@ -0,0 +1,79 @@
+<script lang="ts" setup>
+defineProps<{
+  active: boolean
+}>()
+
+defineEmits<{
+  (e: 'click'): void
+}>()
+</script>
+
+<template>
+  <button
+    type="button"
+    class="VPNavBarHamburger"
+    :class="{ active }"
+    aria-label="mobile navigation"
+    :aria-expanded="active"
+    aria-controls="VPNavScreen"
+    @click="$emit('click')"
+  >
+    <span class="container">
+      <span class="top" />
+      <span class="middle" />
+      <span class="bottom" />
+    </span>
+  </button>
+</template>
+
+<style scoped>
+.VPNavBarHamburger {
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  width: 48px;
+  height: var(--vp-nav-height);
+}
+
+@media (min-width: 768px) {
+  .VPNavBarHamburger {
+    display: none;
+  }
+}
+
+.container {
+  position: relative;
+  width: 16px;
+  height: 14px;
+  overflow: hidden;
+}
+
+.container:hover .top    { top: 0; left: 0; transform: translateX(4px); }
+.container:hover .middle { top: 6; left: 0; transform: translateX(0); }
+.container:hover .bottom { top: 12px; left: 0; transform: translateX(8px); }
+
+.container.active .top    { top: 6px; transform: translateX(0) rotate(225deg); }
+.container.active .middle { top: 6px; transform: translateX(16px); }
+.container.active .bottom { top: 6px; transform: translateX(0) rotate(135deg); }
+
+.container.active:hover .top,
+.container.active:hover .middle,
+.container.active:hover .bottom {
+  background-color: var(--vt-c-text-2);
+  transition: top .25s, background-color .25s, transform .25s;
+}
+
+.top,
+.middle,
+.bottom {
+  position: absolute;
+  width: 16px;
+  height: 2px;
+  background-color: var(--vp-c-text-1);
+  transition: top .25s, background-color .5s, transform .25s;
+}
+
+.top    { top: 0; left: 0; transform: translateX(0); }
+.middle { top: 6px; left: 0; transform: translateX(8px); }
+.bottom { top: 12px; left: 0; transform: translateX(4px); }
+</style>

package/dist/client/theme-default/components/VPNavBarMenu.vue

@@ -0,0 +1,29 @@
+<script lang="ts" setup>
+import { useData } from 'vitepress'
+import VPNavBarMenuLink from './VPNavBarMenuLink.vue'
+import VPNavBarMenuGroup from './VPNavBarMenuGroup.vue'
+
+const { theme } = useData()
+</script>
+
+<template>
+  <nav v-if="theme.nav" aria-labelledby="main-nav-aria-label" class="VPNavBarMenu">
+    <span id="main-nav-aria-label" class="visually-hidden">Main Navigation</span>
+    <template v-for="item in theme.nav" :key="item.text">
+      <VPNavBarMenuLink v-if="'link' in item" :item="item" />
+      <VPNavBarMenuGroup v-else :item="item" />
+    </template>
+  </nav>
+</template>
+
+<style scoped>
+.VPNavBarMenu {
+  display: none;
+}
+
+@media (min-width: 768px) {
+  .VPNavBarMenu {
+    display: flex;
+  }
+}
+</style>

package/dist/client/theme-default/components/VPNavBarMenuGroup.vue

@@ -0,0 +1,18 @@
+<script lang="ts" setup>
+import { DefaultTheme, useData } from 'vitepress'
+import { isActive } from '../support/utils'
+import VPFlyout from './VPFlyout.vue'
+
+defineProps<{
+  item: DefaultTheme.NavItemWithChildren
+}>()
+
+const { page } = useData()
+</script>
+
+<template>
+  <VPFlyout
+    :button="item.text"
+    :items="item.items"
+  />
+</template>

package/dist/client/theme-default/components/VPNavBarMenuLink.vue

@@ -0,0 +1,56 @@
+<script lang="ts" setup>
+import { DefaultTheme, useData } from 'vitepress'
+import { isActive } from '../support/utils'
+import { NavItemWithLink } from '../config'
+import VPLink from './VPLink.vue'
+
+defineProps<{
+  item: DefaultTheme.NavItemWithLink
+}>()
+
+const { page } = useData()
+</script>
+
+<template>
+  <VPLink
+    :class="{
+      VPNavBarMenuLink: true,
+      active: isActive(
+        page.relativePath,
+        item.activeMatch || item.link,
+        !!item.activeMatch
+      )
+    }"
+    :href="item.link"
+    :noIcon="true"
+  >
+    {{ item.text }}
+  </VPLink>
+</template>
+
+<style scoped>
+.VPNavBarMenuLink {
+  display: flex;
+  align-items: center;
+  padding: 0 12px;
+  line-height: var(--vp-nav-height-mobile);
+  font-size: 13px;
+  font-weight: 500;
+  color: var(--vp-c-text-1);
+  transition: color 0.25s;
+}
+
+.VPNavBarMenuLink.active {
+  color: var(--vp-c-brand);
+}
+
+.VPNavBarMenuLink:hover {
+  color: var(--vp-c-brand);
+}
+
+@media (min-width: 1280px) {
+  .VPNavBarMenuLink {
+    line-height: var(--vp-nav-height-desktop);
+  }
+}
+</style>

package/dist/client/theme-default/components/VPNavBarSearch.vue

@@ -0,0 +1,269 @@
+<script lang="ts" setup>
+import '@docsearch/css'
+import { useData } from 'vitepress'
+import { defineAsyncComponent, ref, onMounted, onUnmounted } from 'vue'
+
+const VPAlgoliaSearchBox = defineAsyncComponent(() => {
+  return import('./VPAlgoliaSearchBox.vue')
+})
+
+const { theme } = useData()
+
+// to avoid loading the docsearch js upfront (which is more than 1/3 of the
+// payload), we delay initializing it until the user has actually clicked or
+// hit the hotkey to invoke it.
+const loaded = ref(false)
+
+const metaKey = ref()
+
+onMounted(() => {
+  if (!theme.value.algolia) {
+    return
+  }
+
+  // meta key detect (same logic as in @docsearch/js)
+  metaKey.value.textContent = /(Mac|iPhone|iPod|iPad)/i.test(navigator.platform)
+    ? '⌘'
+    : 'Ctrl'
+
+  const handleSearchHotKey = (e: KeyboardEvent) => {
+    if (e.key === 'k' && (e.ctrlKey || e.metaKey)) {
+      e.preventDefault()
+      load()
+      remove()
+    }
+  }
+
+  const remove = () => {
+    window.removeEventListener('keydown', handleSearchHotKey)
+  }
+
+  window.addEventListener('keydown', handleSearchHotKey)
+
+  onUnmounted(remove)
+})
+
+function load() {
+  if (!loaded.value) {
+    loaded.value = true
+  }
+}
+</script>
+
+<template>
+  <div v-if="theme.algolia" class="VPNavBarSearch">
+    <VPAlgoliaSearchBox v-if="loaded" />
+
+    <div v-else id="docsearch" @click="load">
+      <button
+        type="button"
+        class="DocSearch DocSearch-Button"
+        aria-label="Search"
+      >
+        <span class="DocSearch-Button-Container">
+          <svg
+            class="DocSearch-Search-Icon"
+            width="20"
+            height="20"
+            viewBox="0 0 20 20"
+          >
+            <path
+              d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z"
+              stroke="currentColor"
+              fill="none"
+              fill-rule="evenodd"
+              stroke-linecap="round"
+              stroke-linejoin="round"
+            />
+          </svg>
+          <span class="DocSearch-Button-Placeholder">Search</span>
+        </span>
+        <span class="DocSearch-Button-Keys">
+          <span class="DocSearch-Button-Key" ref="metaKey">Meta</span>
+          <span class="DocSearch-Button-Key">K</span>
+        </span>
+      </button>
+    </div>
+  </div>
+</template>
+
+<style>
+.VPNavBarSearch {
+  display: flex;
+  align-items: center;
+}
+
+@media (min-width: 768px) {
+  .VPNavBarSearch {
+    flex-grow: 1;
+    padding-left: 24px;
+  }
+}
+
+@media (min-width: 960px) {
+  .VPNavBarSearch {
+    padding-left: 32px;
+  }
+}
+
+.DocSearch {
+  --docsearch-primary-color: var(--vp-c-brand);
+  --docsearch-highlight-color: var(--docsearch-primary-color);
+  --docsearch-text-color: var(--vp-c-text-1);
+  --docsearch-muted-color: var(--vp-c-text-2);
+  --docsearch-searchbox-shadow: none;
+  --docsearch-searchbox-focus-background: transparent;
+  --docsearch-key-gradient: transparent;
+  --docsearch-key-shadow: none;
+  --docsearch-modal-background: var(--vp-c-bg-soft);
+  --docsearch-footer-background: var(--vp-c-bg);
+}
+
+.dark .DocSearch {
+  --docsearch-modal-shadow: none;
+  --docsearch-footer-shadow: none;
+  --docsearch-logo-color: var(--vp-c-text-2);
+  --docsearch-hit-background: var(--vp-c-bg-mute);
+  --docsearch-hit-color: var(--vp-c-text-2);
+  --docsearch-hit-shadow: none;
+}
+
+.DocSearch-Button {
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  margin: 0;
+  padding: 0;
+  width: 32px;
+  height: 55px;
+  background: transparent;
+  transition: border-color 0.25s;
+}
+
+.DocSearch-Button:hover {
+  background: transparent;
+}
+
+.DocSearch-Button:focus {
+  outline: 1px dotted;
+  outline: 5px auto -webkit-focus-ring-color;
+}
+
+.DocSearch-Button:focus:not(:focus-visible) {
+  outline: none !important;
+}
+
+@media (min-width: 768px) {
+  .DocSearch-Button {
+    justify-content: flex-start;
+    border: 1px solid transparent;
+    border-radius: 8px;
+    padding: 0 10px 0 12px;
+    width: 100%;
+    height: 40px;
+    background-color: var(--vp-c-bg-sidebar);
+  }
+
+  .DocSearch-Button:hover {
+    border-color: var(--vp-c-brand);
+    background: var(--vp-c-bg-sidebar);
+  }
+}
+
+.DocSearch-Button .DocSearch-Button-Container {
+  display: flex;
+  align-items: center;
+}
+
+.DocSearch-Button .DocSearch-Search-Icon {
+  position: relative;
+  width: 16px;
+  height: 16px;
+  color: var(--vp-c-text-1);
+  fill: currentColor;
+  transition: color 0.5s;
+}
+
+.DocSearch-Button:hover .DocSearch-Search-Icon {
+  color: var(--vp-c-text-1);
+}
+
+@media (min-width: 768px) {
+  .DocSearch-Button .DocSearch-Search-Icon {
+    top: 1px;
+    margin-right: 8px;
+    width: 14px;
+    height: 14px;
+    color: var(--vp-c-text-2);
+  }
+}
+
+.DocSearch-Button .DocSearch-Button-Placeholder {
+  display: none;
+  margin-top: 2px;
+  padding: 0 16px 0 0;
+  font-size: 13px;
+  font-weight: 500;
+  color: var(--vp-c-text-2);
+  transition: color 0.5s;
+}
+
+.DocSearch-Button:hover .DocSearch-Button-Placeholder {
+  color: var(--vp-c-text-1);
+}
+
+@media (min-width: 768px) {
+  .DocSearch-Button .DocSearch-Button-Placeholder {
+    display: inline-block;
+  }
+}
+
+.DocSearch-Button .DocSearch-Button-Keys {
+  display: none;
+  min-width: auto;
+}
+
+@media (min-width: 768px) {
+  .DocSearch-Button .DocSearch-Button-Keys {
+    display: flex;
+    align-items: center;
+  }
+}
+
+.DocSearch-Button .DocSearch-Button-Key {
+  display: block;
+  margin: 2px 0 0 0;
+  border: 1px solid var(--vp-c-divider);
+  border-right: none;
+  border-radius: 4px 0 0 4px;
+  padding-left: 6px;
+  min-width: 0;
+  width: auto;
+  height: 22px;
+  line-height: 22px;
+  font-size: 12px;
+  font-weight: 500;
+  transition: color 0.5s, border-color 0.5s;
+}
+
+.DocSearch-Button .DocSearch-Button-Key + .DocSearch-Button-Key {
+  border-right: 1px solid var(--vp-c-divider);
+  border-left: none;
+  border-radius: 0 4px 4px 0;
+  padding-left: 2px;
+  padding-right: 6px;
+}
+
+.dark .DocSearch-Footer {
+  border-top: 1px solid var(--vp-c-divider);
+}
+
+.DocSearch-Form {
+  border: 1px solid var(--vp-c-brand);
+  background-color: var(--vp-c-white);
+}
+
+.dark .DocSearch-Form {
+  background-color: var(--vp-c-bg-mute);
+}
+</style>