@vuepress/theme-default 2.0.0-rc.8 → 2.0.0-rc.80
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/client/components/VPAutoLink.vue +32 -0
- package/lib/client/components/VPDarkIcon.vue +8 -0
- package/lib/client/components/VPDropdownTransition.vue +43 -0
- package/lib/client/components/VPEditIcon.vue +12 -0
- package/lib/client/components/VPFadeSlideYTransition.vue +43 -0
- package/lib/client/components/VPHome.vue +38 -0
- package/lib/client/components/VPHomeFeatures.vue +65 -0
- package/lib/client/components/{HomeFooter.vue → VPHomeFooter.vue} +16 -3
- package/lib/client/components/VPHomeHero.vue +185 -0
- package/lib/client/components/VPLightIcon.vue +28 -0
- package/lib/client/components/VPNavbar.vue +134 -0
- package/lib/client/components/{NavbarBrand.vue → VPNavbarBrand.vue} +41 -16
- package/lib/client/components/VPNavbarDropdown.vue +331 -0
- package/lib/client/components/VPNavbarItems.vue +111 -0
- package/lib/client/components/VPPage.vue +69 -0
- package/lib/client/components/VPPageMeta.vue +134 -0
- package/lib/client/components/VPPageNav.vue +125 -0
- package/lib/client/components/VPSidebar.vue +113 -0
- package/lib/client/components/VPSidebarItem.vue +186 -0
- package/lib/client/components/{SidebarItems.vue → VPSidebarItems.vue} +27 -7
- package/lib/client/components/VPToggleColorModeButton.vue +55 -0
- package/lib/client/components/VPToggleSidebarButton.vue +92 -0
- package/lib/client/components/global/Badge.vue +84 -18
- package/lib/client/components/global/index.d.ts +1 -3
- package/lib/client/components/global/index.js +1 -3
- package/lib/client/composables/index.d.ts +9 -1
- package/lib/client/composables/index.js +9 -1
- package/lib/client/composables/useContributors.d.ts +3 -0
- package/lib/client/composables/useContributors.js +11 -0
- package/lib/client/composables/useDarkMode.d.ts +0 -1
- package/lib/client/composables/useDarkMode.js +19 -16
- package/lib/client/composables/useData.d.ts +13 -0
- package/lib/client/composables/useData.js +15 -0
- package/lib/client/composables/useEditLink.d.ts +3 -0
- package/lib/client/composables/useEditLink.js +28 -0
- package/lib/client/composables/useHeaders.d.ts +9 -0
- package/lib/client/composables/useHeaders.js +38 -0
- package/lib/client/composables/useLastUpdated.d.ts +2 -0
- package/lib/client/composables/useLastUpdated.js +14 -0
- package/lib/client/composables/useNavbarConfig.d.ts +3 -0
- package/lib/client/composables/useNavbarConfig.js +29 -0
- package/lib/client/composables/useNavbarRepo.d.ts +6 -0
- package/lib/client/composables/useNavbarRepo.js +38 -0
- package/lib/client/composables/useNavbarSelectLanguage.d.ts +6 -0
- package/lib/client/composables/useNavbarSelectLanguage.js +55 -0
- package/lib/client/composables/useNavigate.d.ts +1 -0
- package/lib/client/composables/useNavigate.js +22 -0
- package/lib/client/composables/useRelatedLinks.d.ts +8 -0
- package/lib/client/composables/useRelatedLinks.js +90 -0
- package/lib/client/composables/useScrollPromise.js +3 -1
- package/lib/client/composables/useSidebarItems.d.ts +21 -21
- package/lib/client/composables/useSidebarItems.js +96 -86
- package/lib/client/composables/useUpdateDeviceStatus.d.ts +1 -1
- package/lib/client/composables/useUpdateDeviceStatus.js +10 -5
- package/lib/client/config.d.ts +3 -2
- package/lib/client/config.js +8 -23
- package/lib/client/index.d.ts +2 -1
- package/lib/client/index.js +0 -1
- package/lib/client/layouts/Layout.vue +127 -54
- package/lib/client/layouts/NotFound.vue +25 -11
- package/lib/client/shim.d.ts +6 -5
- package/lib/client/styles/_mixins.scss +4 -4
- package/lib/client/styles/_variables.module.scss +1 -1
- package/lib/client/styles/_variables.scss +2 -1
- package/lib/client/styles/arrow.scss +18 -24
- package/lib/client/styles/code-group.scss +35 -30
- package/lib/client/styles/content/code.scss +23 -0
- package/lib/client/styles/content/index.scss +3 -0
- package/lib/client/styles/content/normalize.scss +39 -0
- package/lib/client/styles/{toc.scss → content/toc.scss} +1 -1
- package/lib/client/styles/external-link-icon.scss +36 -0
- package/lib/client/styles/index.scss +3 -13
- package/lib/client/styles/layout.scss +5 -197
- package/lib/client/styles/normalize.scss +1 -194
- package/lib/client/styles/plugins.scss +28 -0
- package/lib/client/styles/vars-dark.scss +20 -58
- package/lib/client/styles/vars.scss +54 -129
- package/lib/client/typings.d.ts +13 -0
- package/lib/client/typings.js +1 -0
- package/lib/client/utils/index.d.ts +2 -2
- package/lib/client/utils/index.js +2 -2
- package/lib/client/utils/isActiveSidebarItem.d.ts +3 -3
- package/lib/client/utils/isActiveSidebarItem.js +1 -1
- package/lib/client/utils/resolveAutoLink.d.ts +9 -0
- package/lib/client/utils/resolveAutoLink.js +17 -0
- package/lib/client/utils/resolveEditLink.d.ts +3 -3
- package/lib/client/utils/resolveEditLink.js +3 -3
- package/lib/client/utils/resolvePrefix.d.ts +1 -0
- package/lib/client/utils/resolvePrefix.js +4 -0
- package/lib/client/utils/resolveRepoType.d.ts +1 -1
- package/lib/client/utils/resolveRepoType.js +4 -4
- package/lib/node/defaultTheme.d.ts +2 -1
- package/lib/node/defaultTheme.js +50 -56
- package/lib/node/index.d.ts +2 -3
- package/lib/node/index.js +0 -3
- package/lib/node/typings.d.ts +58 -0
- package/lib/node/typings.js +1 -0
- package/lib/node/utils/assignDefaultLocaleOptions.js +3 -7
- package/lib/node/utils/index.d.ts +1 -1
- package/lib/node/utils/index.js +1 -1
- package/lib/node/utils/resolveMarkdownHintLocales.d.ts +9 -0
- package/lib/node/utils/resolveMarkdownHintLocales.js +19 -0
- package/lib/shared/index.d.ts +5 -3
- package/lib/shared/index.js +1 -3
- package/lib/shared/nav.d.ts +19 -30
- package/lib/shared/navbar.d.ts +21 -0
- package/lib/shared/navbar.js +1 -0
- package/lib/shared/options.d.ts +36 -65
- package/lib/shared/page.d.ts +9 -6
- package/lib/shared/sidebar.d.ts +26 -0
- package/lib/shared/sidebar.js +1 -0
- package/package.json +29 -27
- package/templates/build.html +16 -10
- package/lib/client/components/AutoLink.vue +0 -113
- package/lib/client/components/DropdownTransition.vue +0 -25
- package/lib/client/components/Home.vue +0 -15
- package/lib/client/components/HomeContent.vue +0 -5
- package/lib/client/components/HomeFeatures.vue +0 -22
- package/lib/client/components/HomeHero.vue +0 -97
- package/lib/client/components/Navbar.vue +0 -79
- package/lib/client/components/NavbarDropdown.vue +0 -126
- package/lib/client/components/NavbarItems.vue +0 -199
- package/lib/client/components/Page.vue +0 -31
- package/lib/client/components/PageMeta.vue +0 -124
- package/lib/client/components/PageNav.vue +0 -122
- package/lib/client/components/Sidebar.vue +0 -18
- package/lib/client/components/SidebarItem.vue +0 -87
- package/lib/client/components/ToggleColorModeButton.vue +0 -57
- package/lib/client/components/ToggleSidebarButton.vue +0 -24
- package/lib/client/components/global/CodeGroup.d.ts +0 -6
- package/lib/client/components/global/CodeGroup.js +0 -120
- package/lib/client/components/global/CodeGroupItem.vue +0 -27
- package/lib/client/composables/useThemeData.d.ts +0 -4
- package/lib/client/composables/useThemeData.js +0 -3
- package/lib/client/styles/badge.scss +0 -36
- package/lib/client/styles/code.scss +0 -263
- package/lib/client/styles/custom-container.scss +0 -142
- package/lib/client/styles/home.scss +0 -168
- package/lib/client/styles/navbar-dropdown.scss +0 -183
- package/lib/client/styles/navbar.scss +0 -197
- package/lib/client/styles/page.scss +0 -87
- package/lib/client/styles/sidebar.scss +0 -134
- package/lib/client/styles/transitions.scss +0 -22
- package/lib/client/utils/getNavLink.d.ts +0 -15
- package/lib/client/utils/getNavLink.js +0 -18
- package/lib/client/utils/getResolveRouteWithRedirect.d.ts +0 -5
- package/lib/client/utils/getResolveRouteWithRedirect.js +0 -22
- package/lib/node/utils/resolveContainerPluginOptions.d.ts +0 -8
- package/lib/node/utils/resolveContainerPluginOptions.js +0 -17
|
@@ -1,97 +0,0 @@
|
|
|
1
|
-
<script setup lang="ts">
|
|
2
|
-
import AutoLink from '@theme/AutoLink.vue'
|
|
3
|
-
import type { FunctionalComponent } from 'vue'
|
|
4
|
-
import { computed, h } from 'vue'
|
|
5
|
-
import {
|
|
6
|
-
ClientOnly,
|
|
7
|
-
usePageFrontmatter,
|
|
8
|
-
useSiteLocaleData,
|
|
9
|
-
withBase,
|
|
10
|
-
} from 'vuepress/client'
|
|
11
|
-
import type { DefaultThemeHomePageFrontmatter } from '../../shared/index.js'
|
|
12
|
-
import { useDarkMode } from '../composables/index.js'
|
|
13
|
-
|
|
14
|
-
const frontmatter = usePageFrontmatter<DefaultThemeHomePageFrontmatter>()
|
|
15
|
-
const siteLocale = useSiteLocaleData()
|
|
16
|
-
const isDarkMode = useDarkMode()
|
|
17
|
-
|
|
18
|
-
const heroImage = computed(() => {
|
|
19
|
-
if (isDarkMode.value && frontmatter.value.heroImageDark !== undefined) {
|
|
20
|
-
return frontmatter.value.heroImageDark
|
|
21
|
-
}
|
|
22
|
-
return frontmatter.value.heroImage
|
|
23
|
-
})
|
|
24
|
-
const heroAlt = computed(
|
|
25
|
-
() => frontmatter.value.heroAlt || heroText.value || 'hero',
|
|
26
|
-
)
|
|
27
|
-
const heroHeight = computed(() => frontmatter.value.heroHeight || 280)
|
|
28
|
-
|
|
29
|
-
const heroText = computed(() => {
|
|
30
|
-
if (frontmatter.value.heroText === null) {
|
|
31
|
-
return null
|
|
32
|
-
}
|
|
33
|
-
return frontmatter.value.heroText || siteLocale.value.title || 'Hello'
|
|
34
|
-
})
|
|
35
|
-
|
|
36
|
-
const tagline = computed(() => {
|
|
37
|
-
if (frontmatter.value.tagline === null) {
|
|
38
|
-
return null
|
|
39
|
-
}
|
|
40
|
-
return (
|
|
41
|
-
frontmatter.value.tagline ||
|
|
42
|
-
siteLocale.value.description ||
|
|
43
|
-
'Welcome to your VuePress site'
|
|
44
|
-
)
|
|
45
|
-
})
|
|
46
|
-
|
|
47
|
-
const actions = computed(() => {
|
|
48
|
-
if (!Array.isArray(frontmatter.value.actions)) {
|
|
49
|
-
return []
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
return frontmatter.value.actions.map(({ text, link, type = 'primary' }) => ({
|
|
53
|
-
text,
|
|
54
|
-
link,
|
|
55
|
-
type,
|
|
56
|
-
}))
|
|
57
|
-
})
|
|
58
|
-
|
|
59
|
-
const HomeHeroImage: FunctionalComponent = () => {
|
|
60
|
-
if (!heroImage.value) return null
|
|
61
|
-
const img = h('img', {
|
|
62
|
-
src: withBase(heroImage.value),
|
|
63
|
-
alt: heroAlt.value,
|
|
64
|
-
height: heroHeight.value,
|
|
65
|
-
})
|
|
66
|
-
if (frontmatter.value.heroImageDark === undefined) {
|
|
67
|
-
return img
|
|
68
|
-
}
|
|
69
|
-
// wrap hero image with <ClientOnly> to avoid ssr-mismatch
|
|
70
|
-
// when using a different hero image in dark mode
|
|
71
|
-
return h(ClientOnly, () => img)
|
|
72
|
-
}
|
|
73
|
-
</script>
|
|
74
|
-
|
|
75
|
-
<template>
|
|
76
|
-
<header class="hero">
|
|
77
|
-
<HomeHeroImage />
|
|
78
|
-
|
|
79
|
-
<h1 v-if="heroText" id="main-title">
|
|
80
|
-
{{ heroText }}
|
|
81
|
-
</h1>
|
|
82
|
-
|
|
83
|
-
<p v-if="tagline" class="description">
|
|
84
|
-
{{ tagline }}
|
|
85
|
-
</p>
|
|
86
|
-
|
|
87
|
-
<p v-if="actions.length" class="actions">
|
|
88
|
-
<AutoLink
|
|
89
|
-
v-for="action in actions"
|
|
90
|
-
:key="action.text"
|
|
91
|
-
class="action-button"
|
|
92
|
-
:class="[action.type]"
|
|
93
|
-
:item="action"
|
|
94
|
-
/>
|
|
95
|
-
</p>
|
|
96
|
-
</header>
|
|
97
|
-
</template>
|
|
@@ -1,79 +0,0 @@
|
|
|
1
|
-
<script setup lang="ts">
|
|
2
|
-
import NavbarBrand from '@theme/NavbarBrand.vue'
|
|
3
|
-
import NavbarItems from '@theme/NavbarItems.vue'
|
|
4
|
-
import ToggleColorModeButton from '@theme/ToggleColorModeButton.vue'
|
|
5
|
-
import ToggleSidebarButton from '@theme/ToggleSidebarButton.vue'
|
|
6
|
-
import { computed, ref } from 'vue'
|
|
7
|
-
import {
|
|
8
|
-
DeviceType,
|
|
9
|
-
useThemeLocaleData,
|
|
10
|
-
useUpdateDeviceStatus,
|
|
11
|
-
} from '../composables/index.js'
|
|
12
|
-
|
|
13
|
-
defineEmits<(e: 'toggle-sidebar') => void>()
|
|
14
|
-
|
|
15
|
-
defineSlots<{
|
|
16
|
-
before?: (props: Record<never, never>) => any
|
|
17
|
-
after?: (props: Record<never, never>) => any
|
|
18
|
-
}>()
|
|
19
|
-
|
|
20
|
-
const themeLocale = useThemeLocaleData()
|
|
21
|
-
|
|
22
|
-
const navbar = ref<HTMLElement | null>(null)
|
|
23
|
-
const navbarBrand = ref<HTMLElement | null>(null)
|
|
24
|
-
|
|
25
|
-
const linksWrapperMaxWidth = ref(0)
|
|
26
|
-
const linksWrapperStyle = computed(() => {
|
|
27
|
-
if (!linksWrapperMaxWidth.value) {
|
|
28
|
-
return {}
|
|
29
|
-
}
|
|
30
|
-
return {
|
|
31
|
-
maxWidth: linksWrapperMaxWidth.value + 'px',
|
|
32
|
-
}
|
|
33
|
-
})
|
|
34
|
-
|
|
35
|
-
useUpdateDeviceStatus(
|
|
36
|
-
DeviceType.MOBILE,
|
|
37
|
-
(mobileDesktopBreakpoint: number): void => {
|
|
38
|
-
// avoid overlapping of long title and long navbar links
|
|
39
|
-
const navbarHorizontalPadding =
|
|
40
|
-
getCssValue(navbar.value, 'paddingLeft') +
|
|
41
|
-
getCssValue(navbar.value, 'paddingRight')
|
|
42
|
-
if (window.innerWidth < mobileDesktopBreakpoint) {
|
|
43
|
-
linksWrapperMaxWidth.value = 0
|
|
44
|
-
} else {
|
|
45
|
-
linksWrapperMaxWidth.value =
|
|
46
|
-
navbar.value!.offsetWidth -
|
|
47
|
-
navbarHorizontalPadding -
|
|
48
|
-
(navbarBrand.value?.offsetWidth || 0)
|
|
49
|
-
}
|
|
50
|
-
},
|
|
51
|
-
)
|
|
52
|
-
|
|
53
|
-
function getCssValue(el: HTMLElement | null, property: string): number {
|
|
54
|
-
// NOTE: Known bug, will return 'auto' if style value is 'auto'
|
|
55
|
-
const val = el?.ownerDocument?.defaultView?.getComputedStyle(el, null)?.[
|
|
56
|
-
property
|
|
57
|
-
]
|
|
58
|
-
const num = Number.parseInt(val, 10)
|
|
59
|
-
return Number.isNaN(num) ? 0 : num
|
|
60
|
-
}
|
|
61
|
-
</script>
|
|
62
|
-
|
|
63
|
-
<template>
|
|
64
|
-
<header ref="navbar" class="navbar">
|
|
65
|
-
<ToggleSidebarButton @toggle="$emit('toggle-sidebar')" />
|
|
66
|
-
|
|
67
|
-
<span ref="navbarBrand">
|
|
68
|
-
<NavbarBrand />
|
|
69
|
-
</span>
|
|
70
|
-
|
|
71
|
-
<div class="navbar-items-wrapper" :style="linksWrapperStyle">
|
|
72
|
-
<slot name="before" />
|
|
73
|
-
<NavbarItems class="can-hide" />
|
|
74
|
-
<slot name="after" />
|
|
75
|
-
<ToggleColorModeButton v-if="themeLocale.colorModeSwitch" />
|
|
76
|
-
<NavbarSearch />
|
|
77
|
-
</div>
|
|
78
|
-
</header>
|
|
79
|
-
</template>
|
|
@@ -1,126 +0,0 @@
|
|
|
1
|
-
<script setup lang="ts">
|
|
2
|
-
import AutoLink from '@theme/AutoLink.vue'
|
|
3
|
-
import DropdownTransition from '@theme/DropdownTransition.vue'
|
|
4
|
-
import { computed, ref, toRefs, watch } from 'vue'
|
|
5
|
-
import type { PropType } from 'vue'
|
|
6
|
-
import { useRoute } from 'vue-router'
|
|
7
|
-
import type { NavbarItem, ResolvedNavbarItem } from '../../shared/index.js'
|
|
8
|
-
|
|
9
|
-
const props = defineProps({
|
|
10
|
-
item: {
|
|
11
|
-
type: Object as PropType<Exclude<ResolvedNavbarItem, NavbarItem>>,
|
|
12
|
-
required: true,
|
|
13
|
-
},
|
|
14
|
-
})
|
|
15
|
-
|
|
16
|
-
const { item } = toRefs(props)
|
|
17
|
-
|
|
18
|
-
const dropdownAriaLabel = computed(
|
|
19
|
-
() => item.value.ariaLabel || item.value.text,
|
|
20
|
-
)
|
|
21
|
-
|
|
22
|
-
const open = ref(false)
|
|
23
|
-
const route = useRoute()
|
|
24
|
-
watch(
|
|
25
|
-
() => route.path,
|
|
26
|
-
() => {
|
|
27
|
-
open.value = false
|
|
28
|
-
},
|
|
29
|
-
)
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
* Open the dropdown when user tab and click from keyboard.
|
|
33
|
-
*
|
|
34
|
-
* Use event.detail to detect tab and click from keyboard.
|
|
35
|
-
* The Tab + Click is UIEvent > KeyboardEvent, so the detail is 0.
|
|
36
|
-
*
|
|
37
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/UIEvent/detail
|
|
38
|
-
*/
|
|
39
|
-
const handleDropdown = (e): void => {
|
|
40
|
-
const isTriggerByTab = e.detail === 0
|
|
41
|
-
if (isTriggerByTab) {
|
|
42
|
-
open.value = !open.value
|
|
43
|
-
} else {
|
|
44
|
-
open.value = false
|
|
45
|
-
}
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
const isLastItemOfArray = (item: unknown, arr: unknown[]): boolean =>
|
|
49
|
-
arr[arr.length - 1] === item
|
|
50
|
-
</script>
|
|
51
|
-
|
|
52
|
-
<template>
|
|
53
|
-
<div class="navbar-dropdown-wrapper" :class="{ open }">
|
|
54
|
-
<button
|
|
55
|
-
class="navbar-dropdown-title"
|
|
56
|
-
type="button"
|
|
57
|
-
:aria-label="dropdownAriaLabel"
|
|
58
|
-
@click="handleDropdown"
|
|
59
|
-
>
|
|
60
|
-
<span class="title">{{ item.text }}</span>
|
|
61
|
-
<span class="arrow down" />
|
|
62
|
-
</button>
|
|
63
|
-
|
|
64
|
-
<button
|
|
65
|
-
class="navbar-dropdown-title-mobile"
|
|
66
|
-
type="button"
|
|
67
|
-
:aria-label="dropdownAriaLabel"
|
|
68
|
-
@click="open = !open"
|
|
69
|
-
>
|
|
70
|
-
<span class="title">{{ item.text }}</span>
|
|
71
|
-
<span class="arrow" :class="open ? 'down' : 'right'" />
|
|
72
|
-
</button>
|
|
73
|
-
|
|
74
|
-
<DropdownTransition>
|
|
75
|
-
<ul v-show="open" class="navbar-dropdown">
|
|
76
|
-
<li
|
|
77
|
-
v-for="child in item.children"
|
|
78
|
-
:key="child.text"
|
|
79
|
-
class="navbar-dropdown-item"
|
|
80
|
-
>
|
|
81
|
-
<template v-if="child.children">
|
|
82
|
-
<h4 class="navbar-dropdown-subtitle">
|
|
83
|
-
<AutoLink
|
|
84
|
-
v-if="child.link"
|
|
85
|
-
:item="child"
|
|
86
|
-
@focusout="
|
|
87
|
-
isLastItemOfArray(child, item.children) &&
|
|
88
|
-
child.children.length === 0 &&
|
|
89
|
-
(open = false)
|
|
90
|
-
"
|
|
91
|
-
/>
|
|
92
|
-
|
|
93
|
-
<span v-else>{{ child.text }}</span>
|
|
94
|
-
</h4>
|
|
95
|
-
|
|
96
|
-
<ul class="navbar-dropdown-subitem-wrapper">
|
|
97
|
-
<li
|
|
98
|
-
v-for="grandchild in child.children"
|
|
99
|
-
:key="grandchild.link"
|
|
100
|
-
class="navbar-dropdown-subitem"
|
|
101
|
-
>
|
|
102
|
-
<AutoLink
|
|
103
|
-
:item="grandchild"
|
|
104
|
-
@focusout="
|
|
105
|
-
isLastItemOfArray(grandchild, child.children) &&
|
|
106
|
-
isLastItemOfArray(child, item.children) &&
|
|
107
|
-
(open = false)
|
|
108
|
-
"
|
|
109
|
-
/>
|
|
110
|
-
</li>
|
|
111
|
-
</ul>
|
|
112
|
-
</template>
|
|
113
|
-
|
|
114
|
-
<template v-else>
|
|
115
|
-
<AutoLink
|
|
116
|
-
:item="child"
|
|
117
|
-
@focusout="
|
|
118
|
-
isLastItemOfArray(child, item.children) && (open = false)
|
|
119
|
-
"
|
|
120
|
-
/>
|
|
121
|
-
</template>
|
|
122
|
-
</li>
|
|
123
|
-
</ul>
|
|
124
|
-
</DropdownTransition>
|
|
125
|
-
</div>
|
|
126
|
-
</template>
|
|
@@ -1,199 +0,0 @@
|
|
|
1
|
-
<script setup lang="ts">
|
|
2
|
-
import AutoLink from '@theme/AutoLink.vue'
|
|
3
|
-
import NavbarDropdown from '@theme/NavbarDropdown.vue'
|
|
4
|
-
import { computed, ref } from 'vue'
|
|
5
|
-
import type { ComputedRef } from 'vue'
|
|
6
|
-
import { useRouter } from 'vue-router'
|
|
7
|
-
import type { Router } from 'vue-router'
|
|
8
|
-
import { useRouteLocale, useSiteData, useSiteLocaleData } from 'vuepress/client'
|
|
9
|
-
import { isLinkHttp, isString } from 'vuepress/shared'
|
|
10
|
-
import type {
|
|
11
|
-
NavbarGroup,
|
|
12
|
-
NavbarItem,
|
|
13
|
-
ResolvedNavbarItem,
|
|
14
|
-
} from '../../shared/index.js'
|
|
15
|
-
import {
|
|
16
|
-
DeviceType,
|
|
17
|
-
useThemeData,
|
|
18
|
-
useThemeLocaleData,
|
|
19
|
-
useUpdateDeviceStatus,
|
|
20
|
-
} from '../composables/index.js'
|
|
21
|
-
import { getNavLink, resolveRepoType } from '../utils/index.js'
|
|
22
|
-
|
|
23
|
-
/**
|
|
24
|
-
* Get navbar config of select language dropdown
|
|
25
|
-
*/
|
|
26
|
-
const useNavbarSelectLanguage = (): ComputedRef<ResolvedNavbarItem[]> => {
|
|
27
|
-
const router = useRouter()
|
|
28
|
-
const routeLocale = useRouteLocale()
|
|
29
|
-
const site = useSiteData()
|
|
30
|
-
const siteLocale = useSiteLocaleData()
|
|
31
|
-
const theme = useThemeData()
|
|
32
|
-
const themeLocale = useThemeLocaleData()
|
|
33
|
-
|
|
34
|
-
return computed<ResolvedNavbarItem[]>(() => {
|
|
35
|
-
const localePaths = Object.keys(site.value.locales)
|
|
36
|
-
// do not display language selection dropdown if there is only one language
|
|
37
|
-
if (localePaths.length < 2) {
|
|
38
|
-
return []
|
|
39
|
-
}
|
|
40
|
-
const currentPath = router.currentRoute.value.path
|
|
41
|
-
const currentFullPath = router.currentRoute.value.fullPath
|
|
42
|
-
|
|
43
|
-
const languageDropdown: ResolvedNavbarItem = {
|
|
44
|
-
text: `${themeLocale.value.selectLanguageText}`,
|
|
45
|
-
ariaLabel: `${
|
|
46
|
-
themeLocale.value.selectLanguageAriaLabel ??
|
|
47
|
-
themeLocale.value.selectLanguageText
|
|
48
|
-
}`,
|
|
49
|
-
children: localePaths.map((targetLocalePath) => {
|
|
50
|
-
// target locale config of this language link
|
|
51
|
-
const targetSiteLocale = site.value.locales?.[targetLocalePath] ?? {}
|
|
52
|
-
const targetThemeLocale = theme.value.locales?.[targetLocalePath] ?? {}
|
|
53
|
-
const targetLang = `${targetSiteLocale.lang}`
|
|
54
|
-
|
|
55
|
-
const text = targetThemeLocale.selectLanguageName ?? targetLang
|
|
56
|
-
let link
|
|
57
|
-
|
|
58
|
-
if (targetLang === siteLocale.value.lang) {
|
|
59
|
-
// if the target language is current language
|
|
60
|
-
// stay at current link
|
|
61
|
-
link = currentFullPath
|
|
62
|
-
} else {
|
|
63
|
-
// if the target language is not current language
|
|
64
|
-
// try to link to the corresponding page of current page
|
|
65
|
-
// or fallback to homepage
|
|
66
|
-
const targetLocalePage = currentPath.replace(
|
|
67
|
-
routeLocale.value,
|
|
68
|
-
targetLocalePath,
|
|
69
|
-
)
|
|
70
|
-
if (
|
|
71
|
-
router.getRoutes().some((item) => item.path === targetLocalePage)
|
|
72
|
-
) {
|
|
73
|
-
// try to keep current hash and params across languages
|
|
74
|
-
link = currentFullPath.replace(currentPath, targetLocalePage)
|
|
75
|
-
} else {
|
|
76
|
-
link = targetThemeLocale.home ?? targetLocalePath
|
|
77
|
-
}
|
|
78
|
-
}
|
|
79
|
-
|
|
80
|
-
return {
|
|
81
|
-
text,
|
|
82
|
-
link,
|
|
83
|
-
}
|
|
84
|
-
}),
|
|
85
|
-
}
|
|
86
|
-
|
|
87
|
-
return [languageDropdown]
|
|
88
|
-
})
|
|
89
|
-
}
|
|
90
|
-
|
|
91
|
-
/**
|
|
92
|
-
* Get navbar config of repository link
|
|
93
|
-
*/
|
|
94
|
-
const useNavbarRepo = (): ComputedRef<ResolvedNavbarItem[]> => {
|
|
95
|
-
const themeLocale = useThemeLocaleData()
|
|
96
|
-
|
|
97
|
-
const repo = computed(() => themeLocale.value.repo)
|
|
98
|
-
const repoType = computed(() =>
|
|
99
|
-
repo.value ? resolveRepoType(repo.value) : null,
|
|
100
|
-
)
|
|
101
|
-
|
|
102
|
-
const repoLink = computed(() => {
|
|
103
|
-
if (repo.value && !isLinkHttp(repo.value)) {
|
|
104
|
-
return `https://github.com/${repo.value}`
|
|
105
|
-
}
|
|
106
|
-
|
|
107
|
-
return repo.value
|
|
108
|
-
})
|
|
109
|
-
|
|
110
|
-
const repoLabel = computed(() => {
|
|
111
|
-
if (!repoLink.value) return null
|
|
112
|
-
if (themeLocale.value.repoLabel) return themeLocale.value.repoLabel
|
|
113
|
-
if (repoType.value === null) return 'Source'
|
|
114
|
-
return repoType.value
|
|
115
|
-
})
|
|
116
|
-
|
|
117
|
-
return computed(() => {
|
|
118
|
-
if (!repoLink.value || !repoLabel.value) {
|
|
119
|
-
return []
|
|
120
|
-
}
|
|
121
|
-
|
|
122
|
-
return [
|
|
123
|
-
{
|
|
124
|
-
text: repoLabel.value,
|
|
125
|
-
link: repoLink.value,
|
|
126
|
-
},
|
|
127
|
-
]
|
|
128
|
-
})
|
|
129
|
-
}
|
|
130
|
-
|
|
131
|
-
const resolveNavbarItem = (
|
|
132
|
-
router: Router,
|
|
133
|
-
item: NavbarItem | NavbarGroup | string,
|
|
134
|
-
): ResolvedNavbarItem => {
|
|
135
|
-
if (isString(item)) {
|
|
136
|
-
return getNavLink(router, item)
|
|
137
|
-
}
|
|
138
|
-
if ((item as NavbarGroup).children) {
|
|
139
|
-
return {
|
|
140
|
-
...item,
|
|
141
|
-
children: (item as NavbarGroup).children.map((item) =>
|
|
142
|
-
resolveNavbarItem(router, item),
|
|
143
|
-
),
|
|
144
|
-
}
|
|
145
|
-
}
|
|
146
|
-
return item as ResolvedNavbarItem
|
|
147
|
-
}
|
|
148
|
-
|
|
149
|
-
const useNavbarConfig = (): ComputedRef<ResolvedNavbarItem[]> => {
|
|
150
|
-
const router = useRouter()
|
|
151
|
-
const themeLocale = useThemeLocaleData()
|
|
152
|
-
|
|
153
|
-
return computed(() =>
|
|
154
|
-
(themeLocale.value.navbar || []).map((item) =>
|
|
155
|
-
resolveNavbarItem(router, item),
|
|
156
|
-
),
|
|
157
|
-
)
|
|
158
|
-
}
|
|
159
|
-
|
|
160
|
-
const isMobile = ref(false)
|
|
161
|
-
const navbarConfig = useNavbarConfig()
|
|
162
|
-
const navbarSelectLanguage = useNavbarSelectLanguage()
|
|
163
|
-
const navbarRepo = useNavbarRepo()
|
|
164
|
-
const navbarLinks = computed(() => [
|
|
165
|
-
...navbarConfig.value,
|
|
166
|
-
...navbarSelectLanguage.value,
|
|
167
|
-
...navbarRepo.value,
|
|
168
|
-
])
|
|
169
|
-
|
|
170
|
-
useUpdateDeviceStatus(
|
|
171
|
-
DeviceType.MOBILE,
|
|
172
|
-
(mobileDesktopBreakpoint: number): void => {
|
|
173
|
-
// avoid overlapping of long title and long navbar links
|
|
174
|
-
if (window.innerWidth < mobileDesktopBreakpoint) {
|
|
175
|
-
isMobile.value = true
|
|
176
|
-
} else {
|
|
177
|
-
isMobile.value = false
|
|
178
|
-
}
|
|
179
|
-
},
|
|
180
|
-
)
|
|
181
|
-
|
|
182
|
-
const navbarLabel = computed(() => {
|
|
183
|
-
const themeLocale = useThemeLocaleData()
|
|
184
|
-
return themeLocale.value.navbarLabel ?? 'site navigation'
|
|
185
|
-
})
|
|
186
|
-
</script>
|
|
187
|
-
|
|
188
|
-
<template>
|
|
189
|
-
<nav v-if="navbarLinks.length" class="navbar-items" :aria-label="navbarLabel">
|
|
190
|
-
<div v-for="item in navbarLinks" :key="item.text" class="navbar-item">
|
|
191
|
-
<NavbarDropdown
|
|
192
|
-
v-if="item.children"
|
|
193
|
-
:item="item"
|
|
194
|
-
:class="isMobile ? 'mobile' : ''"
|
|
195
|
-
/>
|
|
196
|
-
<AutoLink v-else :item="item" />
|
|
197
|
-
</div>
|
|
198
|
-
</nav>
|
|
199
|
-
</template>
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
<script setup lang="ts">
|
|
2
|
-
import PageMeta from '@theme/PageMeta.vue'
|
|
3
|
-
import PageNav from '@theme/PageNav.vue'
|
|
4
|
-
|
|
5
|
-
defineSlots<{
|
|
6
|
-
'top'?: (props: Record<never, never>) => any
|
|
7
|
-
'bottom'?: (props: Record<never, never>) => any
|
|
8
|
-
'content-top'?: (props: Record<never, never>) => any
|
|
9
|
-
'content-bottom'?: (props: Record<never, never>) => any
|
|
10
|
-
}>()
|
|
11
|
-
</script>
|
|
12
|
-
|
|
13
|
-
<template>
|
|
14
|
-
<main class="page">
|
|
15
|
-
<slot name="top" />
|
|
16
|
-
|
|
17
|
-
<div class="theme-default-content">
|
|
18
|
-
<slot name="content-top" />
|
|
19
|
-
|
|
20
|
-
<Content />
|
|
21
|
-
|
|
22
|
-
<slot name="content-bottom" />
|
|
23
|
-
</div>
|
|
24
|
-
|
|
25
|
-
<PageMeta />
|
|
26
|
-
|
|
27
|
-
<PageNav />
|
|
28
|
-
|
|
29
|
-
<slot name="bottom" />
|
|
30
|
-
</main>
|
|
31
|
-
</template>
|
|
@@ -1,124 +0,0 @@
|
|
|
1
|
-
<script setup lang="ts">
|
|
2
|
-
import AutoLink from '@theme/AutoLink.vue'
|
|
3
|
-
import { computed } from 'vue'
|
|
4
|
-
import type { ComputedRef } from 'vue'
|
|
5
|
-
import { usePageData, usePageFrontmatter } from 'vuepress/client'
|
|
6
|
-
import type {
|
|
7
|
-
DefaultThemeNormalPageFrontmatter,
|
|
8
|
-
DefaultThemePageData,
|
|
9
|
-
NavLink,
|
|
10
|
-
} from '../../shared/index.js'
|
|
11
|
-
import { useThemeLocaleData } from '../composables/index.js'
|
|
12
|
-
import { resolveEditLink } from '../utils/index.js'
|
|
13
|
-
|
|
14
|
-
const useEditNavLink = (): ComputedRef<null | NavLink> => {
|
|
15
|
-
const themeLocale = useThemeLocaleData()
|
|
16
|
-
const page = usePageData<DefaultThemePageData>()
|
|
17
|
-
const frontmatter = usePageFrontmatter<DefaultThemeNormalPageFrontmatter>()
|
|
18
|
-
|
|
19
|
-
return computed(() => {
|
|
20
|
-
const showEditLink =
|
|
21
|
-
frontmatter.value.editLink ?? themeLocale.value.editLink ?? true
|
|
22
|
-
if (!showEditLink) {
|
|
23
|
-
return null
|
|
24
|
-
}
|
|
25
|
-
|
|
26
|
-
const {
|
|
27
|
-
repo,
|
|
28
|
-
docsRepo = repo,
|
|
29
|
-
docsBranch = 'main',
|
|
30
|
-
docsDir = '',
|
|
31
|
-
editLinkText,
|
|
32
|
-
} = themeLocale.value
|
|
33
|
-
|
|
34
|
-
if (!docsRepo) return null
|
|
35
|
-
|
|
36
|
-
const editLink = resolveEditLink({
|
|
37
|
-
docsRepo,
|
|
38
|
-
docsBranch,
|
|
39
|
-
docsDir,
|
|
40
|
-
filePathRelative: page.value.filePathRelative,
|
|
41
|
-
editLinkPattern:
|
|
42
|
-
frontmatter.value.editLinkPattern ?? themeLocale.value.editLinkPattern,
|
|
43
|
-
})
|
|
44
|
-
|
|
45
|
-
if (!editLink) return null
|
|
46
|
-
|
|
47
|
-
return {
|
|
48
|
-
text: editLinkText ?? 'Edit this page',
|
|
49
|
-
link: editLink,
|
|
50
|
-
}
|
|
51
|
-
})
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
const useLastUpdated = (): ComputedRef<null | string> => {
|
|
55
|
-
const themeLocale = useThemeLocaleData()
|
|
56
|
-
const page = usePageData<DefaultThemePageData>()
|
|
57
|
-
const frontmatter = usePageFrontmatter<DefaultThemeNormalPageFrontmatter>()
|
|
58
|
-
|
|
59
|
-
return computed(() => {
|
|
60
|
-
const showLastUpdated =
|
|
61
|
-
frontmatter.value.lastUpdated ?? themeLocale.value.lastUpdated ?? true
|
|
62
|
-
|
|
63
|
-
if (!showLastUpdated) return null
|
|
64
|
-
|
|
65
|
-
if (!page.value.git?.updatedTime) return null
|
|
66
|
-
|
|
67
|
-
const updatedDate = new Date(page.value.git?.updatedTime)
|
|
68
|
-
|
|
69
|
-
return updatedDate.toLocaleString()
|
|
70
|
-
})
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
const useContributors = (): ComputedRef<
|
|
74
|
-
null | Required<DefaultThemePageData['git']>['contributors']
|
|
75
|
-
> => {
|
|
76
|
-
const themeLocale = useThemeLocaleData()
|
|
77
|
-
const page = usePageData<DefaultThemePageData>()
|
|
78
|
-
const frontmatter = usePageFrontmatter<DefaultThemeNormalPageFrontmatter>()
|
|
79
|
-
|
|
80
|
-
return computed(() => {
|
|
81
|
-
const showContributors =
|
|
82
|
-
frontmatter.value.contributors ?? themeLocale.value.contributors ?? true
|
|
83
|
-
|
|
84
|
-
if (!showContributors) return null
|
|
85
|
-
|
|
86
|
-
return page.value.git?.contributors ?? null
|
|
87
|
-
})
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
const themeLocale = useThemeLocaleData()
|
|
91
|
-
const editNavLink = useEditNavLink()
|
|
92
|
-
const lastUpdated = useLastUpdated()
|
|
93
|
-
const contributors = useContributors()
|
|
94
|
-
</script>
|
|
95
|
-
|
|
96
|
-
<template>
|
|
97
|
-
<footer class="page-meta">
|
|
98
|
-
<div v-if="editNavLink" class="meta-item edit-link">
|
|
99
|
-
<AutoLink class="meta-item-label" :item="editNavLink" />
|
|
100
|
-
</div>
|
|
101
|
-
|
|
102
|
-
<div v-if="lastUpdated" class="meta-item last-updated">
|
|
103
|
-
<span class="meta-item-label">{{ themeLocale.lastUpdatedText }}: </span>
|
|
104
|
-
<ClientOnly>
|
|
105
|
-
<span class="meta-item-info">{{ lastUpdated }}</span>
|
|
106
|
-
</ClientOnly>
|
|
107
|
-
</div>
|
|
108
|
-
|
|
109
|
-
<div
|
|
110
|
-
v-if="contributors && contributors.length"
|
|
111
|
-
class="meta-item contributors"
|
|
112
|
-
>
|
|
113
|
-
<span class="meta-item-label">{{ themeLocale.contributorsText }}: </span>
|
|
114
|
-
<span class="meta-item-info">
|
|
115
|
-
<template v-for="(contributor, index) in contributors" :key="index">
|
|
116
|
-
<span class="contributor" :title="`email: ${contributor.email}`">
|
|
117
|
-
{{ contributor.name }}
|
|
118
|
-
</span>
|
|
119
|
-
<template v-if="index !== contributors.length - 1">, </template>
|
|
120
|
-
</template>
|
|
121
|
-
</span>
|
|
122
|
-
</div>
|
|
123
|
-
</footer>
|
|
124
|
-
</template>
|