@vuepress/theme-default 2.0.0-rc.5 → 2.0.0-rc.54

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.
Files changed (141) hide show
  1. package/lib/client/components/VPDarkIcon.vue +8 -0
  2. package/lib/client/components/VPDropdownTransition.vue +36 -0
  3. package/lib/client/components/VPEditIcon.vue +12 -0
  4. package/lib/client/components/VPHome.vue +38 -0
  5. package/lib/client/components/VPHomeFeatures.vue +66 -0
  6. package/lib/client/components/{HomeFooter.vue → VPHomeFooter.vue} +17 -2
  7. package/lib/client/components/{HomeHero.vue → VPHomeHero.vue} +113 -19
  8. package/lib/client/components/VPLightIcon.vue +28 -0
  9. package/lib/client/components/VPNavbar.vue +134 -0
  10. package/lib/client/components/{NavbarBrand.vue → VPNavbarBrand.vue} +40 -7
  11. package/lib/client/components/VPNavbarDropdown.vue +320 -0
  12. package/lib/client/components/VPNavbarItems.vue +111 -0
  13. package/lib/client/components/VPPage.vue +70 -0
  14. package/lib/client/components/VPPageMeta.vue +132 -0
  15. package/lib/client/components/VPPageNav.vue +118 -0
  16. package/lib/client/components/VPSidebar.vue +113 -0
  17. package/lib/client/components/VPSidebarItem.vue +174 -0
  18. package/lib/client/components/{SidebarItems.vue → VPSidebarItems.vue} +32 -7
  19. package/lib/client/components/VPToggleColorModeButton.vue +55 -0
  20. package/lib/client/components/VPToggleSidebarButton.vue +92 -0
  21. package/lib/client/components/global/Badge.vue +84 -18
  22. package/lib/client/components/global/index.d.ts +1 -3
  23. package/lib/client/components/global/index.js +1 -3
  24. package/lib/client/composables/index.d.ts +8 -0
  25. package/lib/client/composables/index.js +8 -0
  26. package/lib/client/composables/useContributors.d.ts +3 -0
  27. package/lib/client/composables/useContributors.js +14 -0
  28. package/lib/client/composables/useDarkMode.d.ts +0 -1
  29. package/lib/client/composables/useDarkMode.js +16 -13
  30. package/lib/client/composables/useEditLink.d.ts +3 -0
  31. package/lib/client/composables/useEditLink.js +31 -0
  32. package/lib/client/composables/useLastUpdated.d.ts +2 -0
  33. package/lib/client/composables/useLastUpdated.js +17 -0
  34. package/lib/client/composables/useNavbarConfig.d.ts +3 -0
  35. package/lib/client/composables/useNavbarConfig.js +27 -0
  36. package/lib/client/composables/useNavbarRepo.d.ts +6 -0
  37. package/lib/client/composables/useNavbarRepo.js +38 -0
  38. package/lib/client/composables/useNavbarSelectLanguage.d.ts +6 -0
  39. package/lib/client/composables/useNavbarSelectLanguage.js +59 -0
  40. package/lib/client/composables/useNavigate.d.ts +1 -0
  41. package/lib/client/composables/useNavigate.js +22 -0
  42. package/lib/client/composables/useRelatedLinks.d.ts +8 -0
  43. package/lib/client/composables/useRelatedLinks.js +91 -0
  44. package/lib/client/composables/useScrollPromise.js +3 -1
  45. package/lib/client/composables/useSidebarItems.d.ts +28 -23
  46. package/lib/client/composables/useSidebarItems.js +120 -84
  47. package/lib/client/composables/useUpdateDeviceStatus.d.ts +1 -1
  48. package/lib/client/composables/useUpdateDeviceStatus.js +10 -5
  49. package/lib/client/config.d.ts +3 -2
  50. package/lib/client/config.js +9 -22
  51. package/lib/client/index.d.ts +2 -1
  52. package/lib/client/index.js +0 -1
  53. package/lib/client/layouts/Layout.vue +139 -34
  54. package/lib/client/layouts/NotFound.vue +17 -5
  55. package/lib/client/shim.d.ts +12 -3
  56. package/lib/client/styles/_mixins.scss +4 -4
  57. package/lib/client/styles/_variables.module.scss +1 -1
  58. package/lib/client/styles/_variables.scss +1 -0
  59. package/lib/client/styles/arrow.scss +18 -24
  60. package/lib/client/styles/code-group.scss +35 -30
  61. package/lib/client/styles/content/code.scss +23 -0
  62. package/lib/client/styles/content/index.scss +3 -0
  63. package/lib/client/styles/content/normalize.scss +39 -0
  64. package/lib/client/styles/{toc.scss → content/toc.scss} +1 -1
  65. package/lib/client/styles/external-link-icon.scss +37 -0
  66. package/lib/client/styles/index.scss +3 -13
  67. package/lib/client/styles/layout.scss +3 -199
  68. package/lib/client/styles/normalize.scss +1 -194
  69. package/lib/client/styles/plugins.scss +28 -0
  70. package/lib/client/styles/vars-dark.scss +20 -58
  71. package/lib/client/styles/vars.scss +53 -129
  72. package/lib/client/typings.d.ts +13 -0
  73. package/lib/client/typings.js +1 -0
  74. package/lib/client/utils/getAutoLink.d.ts +9 -0
  75. package/lib/client/utils/getAutoLink.js +17 -0
  76. package/lib/client/utils/index.d.ts +3 -2
  77. package/lib/client/utils/index.js +3 -2
  78. package/lib/client/utils/isActiveSidebarItem.d.ts +3 -3
  79. package/lib/client/utils/isActiveSidebarItem.js +3 -3
  80. package/lib/client/utils/isLinkInternal.d.ts +1 -0
  81. package/lib/client/utils/isLinkInternal.js +2 -0
  82. package/lib/client/utils/resolveEditLink.d.ts +1 -1
  83. package/lib/client/utils/resolvePrefix.d.ts +1 -0
  84. package/lib/client/utils/resolvePrefix.js +4 -0
  85. package/lib/client/utils/resolveRepoType.d.ts +1 -1
  86. package/lib/client/utils/resolveRepoType.js +4 -4
  87. package/lib/node/defaultTheme.d.ts +2 -1
  88. package/lib/node/defaultTheme.js +72 -46
  89. package/lib/node/index.d.ts +2 -3
  90. package/lib/node/index.js +0 -3
  91. package/lib/node/typings.d.ts +58 -0
  92. package/lib/node/typings.js +1 -0
  93. package/lib/node/utils/assignDefaultLocaleOptions.js +3 -7
  94. package/lib/node/utils/index.d.ts +1 -1
  95. package/lib/node/utils/index.js +1 -1
  96. package/lib/node/utils/resolveMarkdownHintLocales.d.ts +9 -0
  97. package/lib/node/utils/resolveMarkdownHintLocales.js +19 -0
  98. package/lib/shared/index.d.ts +5 -3
  99. package/lib/shared/index.js +1 -3
  100. package/lib/shared/nav.d.ts +19 -30
  101. package/lib/shared/navbar.d.ts +21 -0
  102. package/lib/shared/navbar.js +1 -0
  103. package/lib/shared/options.d.ts +36 -60
  104. package/lib/shared/page.d.ts +9 -6
  105. package/lib/shared/sidebar.d.ts +26 -0
  106. package/lib/shared/sidebar.js +1 -0
  107. package/package.json +30 -26
  108. package/templates/build.html +23 -14
  109. package/lib/client/components/AutoLink.vue +0 -113
  110. package/lib/client/components/DropdownTransition.vue +0 -25
  111. package/lib/client/components/Home.vue +0 -15
  112. package/lib/client/components/HomeContent.vue +0 -5
  113. package/lib/client/components/HomeFeatures.vue +0 -22
  114. package/lib/client/components/Navbar.vue +0 -79
  115. package/lib/client/components/NavbarDropdown.vue +0 -126
  116. package/lib/client/components/NavbarItems.vue +0 -199
  117. package/lib/client/components/Page.vue +0 -31
  118. package/lib/client/components/PageMeta.vue +0 -124
  119. package/lib/client/components/PageNav.vue +0 -122
  120. package/lib/client/components/Sidebar.vue +0 -18
  121. package/lib/client/components/SidebarItem.vue +0 -87
  122. package/lib/client/components/ToggleColorModeButton.vue +0 -57
  123. package/lib/client/components/ToggleSidebarButton.vue +0 -24
  124. package/lib/client/components/global/CodeGroup.d.ts +0 -6
  125. package/lib/client/components/global/CodeGroup.js +0 -120
  126. package/lib/client/components/global/CodeGroupItem.vue +0 -27
  127. package/lib/client/styles/badge.scss +0 -36
  128. package/lib/client/styles/code.scss +0 -263
  129. package/lib/client/styles/custom-container.scss +0 -142
  130. package/lib/client/styles/home.scss +0 -168
  131. package/lib/client/styles/navbar-dropdown.scss +0 -183
  132. package/lib/client/styles/navbar.scss +0 -197
  133. package/lib/client/styles/page.scss +0 -87
  134. package/lib/client/styles/sidebar.scss +0 -134
  135. package/lib/client/styles/transitions.scss +0 -22
  136. package/lib/client/utils/getNavLink.d.ts +0 -15
  137. package/lib/client/utils/getNavLink.js +0 -18
  138. package/lib/client/utils/getResolveRouteWithRedirect.d.ts +0 -5
  139. package/lib/client/utils/getResolveRouteWithRedirect.js +0 -22
  140. package/lib/node/utils/resolveContainerPluginOptions.d.ts +0 -8
  141. package/lib/node/utils/resolveContainerPluginOptions.js +0 -17
@@ -1,30 +1,36 @@
1
1
  <script setup lang="ts">
2
- defineProps({
3
- type: {
4
- type: String,
5
- required: false,
6
- default: 'tip',
7
- },
8
- text: {
9
- type: String,
10
- required: false,
11
- default: '',
12
- },
13
- vertical: {
14
- type: String,
15
- required: false,
16
- default: undefined,
2
+ import type { VNode } from 'vue'
3
+
4
+ withDefaults(
5
+ defineProps<{
6
+ /**
7
+ * The type of the badge
8
+ */
9
+ type?: string
10
+ /**
11
+ * The text of the badge
12
+ */
13
+ text?: string
14
+ /**
15
+ * The vertical align of the badge
16
+ */
17
+ vertical?: string
18
+ }>(),
19
+ {
20
+ type: 'tip',
21
+ text: '',
22
+ vertical: undefined,
17
23
  },
18
- })
24
+ )
19
25
 
20
26
  defineSlots<{
21
- default?: () => any
27
+ default?: () => VNode | VNode[] | string | null
22
28
  }>()
23
29
  </script>
24
30
 
25
31
  <template>
26
32
  <span
27
- class="badge"
33
+ class="vp-badge"
28
34
  :class="type"
29
35
  :style="{
30
36
  verticalAlign: vertical,
@@ -33,3 +39,63 @@ defineSlots<{
33
39
  <slot>{{ text }}</slot>
34
40
  </span>
35
41
  </template>
42
+
43
+ <style lang="scss">
44
+ .vp-badge {
45
+ display: inline-block;
46
+ vertical-align: top;
47
+
48
+ height: 18px;
49
+ padding: 0 6px;
50
+ border-radius: 3px;
51
+
52
+ background: var(--vp-c-accent-soft);
53
+ color: var(--vp-c-accent);
54
+
55
+ font-size: 14px;
56
+ line-height: 18px;
57
+
58
+ transition:
59
+ background var(--vp-t-color),
60
+ color var(--vp-t-color);
61
+
62
+ & + & {
63
+ margin-inline-start: 5px;
64
+ }
65
+
66
+ &.tip {
67
+ background: var(--badge-c-tip-bg);
68
+ color: var(--badge-c-tip-text);
69
+ }
70
+
71
+ &.warning {
72
+ background: var(--badge-c-warning-bg);
73
+ color: var(--badge-c-warning-text);
74
+ }
75
+
76
+ &.danger {
77
+ background: var(--badge-c-danger-bg);
78
+ color: var(--badge-c-danger-text);
79
+ }
80
+
81
+ &.important {
82
+ background: var(--badge-c-important-bg);
83
+ color: var(--badge-c-important-text);
84
+ }
85
+
86
+ &.info {
87
+ background: var(--badge-c-info-bg);
88
+ color: var(--badge-c-info-text);
89
+ }
90
+
91
+ &.note {
92
+ background: var(--badge-c-note-bg);
93
+ color: var(--badge-c-note-text);
94
+ }
95
+
96
+ // update the vertical align for the badge in toc
97
+ .table-of-contents & {
98
+ vertical-align: middle;
99
+ }
100
+ }
101
+ </style>
@@ -1,4 +1,2 @@
1
1
  import Badge from './Badge.vue';
2
- import { CodeGroup } from './CodeGroup.js';
3
- import CodeGroupItem from './CodeGroupItem.vue';
4
- export { Badge, CodeGroup, CodeGroupItem };
2
+ export { Badge };
@@ -1,4 +1,2 @@
1
1
  import Badge from './Badge.vue';
2
- import { CodeGroup } from './CodeGroup.js';
3
- import CodeGroupItem from './CodeGroupItem.vue';
4
- export { Badge, CodeGroup, CodeGroupItem };
2
+ export { Badge };
@@ -1,4 +1,12 @@
1
+ export * from './useContributors.js';
1
2
  export * from './useDarkMode.js';
3
+ export * from './useEditLink.js';
4
+ export * from './useLastUpdated.js';
5
+ export * from './useNavigate.js';
6
+ export * from './useNavbarConfig.js';
7
+ export * from './useNavbarRepo.js';
8
+ export * from './useNavbarSelectLanguage.js';
9
+ export * from './useRelatedLinks.js';
2
10
  export * from './useScrollPromise.js';
3
11
  export * from './useSidebarItems.js';
4
12
  export * from './useThemeData.js';
@@ -1,4 +1,12 @@
1
+ export * from './useContributors.js';
1
2
  export * from './useDarkMode.js';
3
+ export * from './useEditLink.js';
4
+ export * from './useLastUpdated.js';
5
+ export * from './useNavigate.js';
6
+ export * from './useNavbarConfig.js';
7
+ export * from './useNavbarRepo.js';
8
+ export * from './useNavbarSelectLanguage.js';
9
+ export * from './useRelatedLinks.js';
2
10
  export * from './useScrollPromise.js';
3
11
  export * from './useSidebarItems.js';
4
12
  export * from './useThemeData.js';
@@ -0,0 +1,3 @@
1
+ import type { ComputedRef } from 'vue';
2
+ import type { DefaultThemePageData } from '../../shared/index.js';
3
+ export declare const useContributors: () => ComputedRef<Exclude<DefaultThemePageData["git"], undefined>["contributors"] | null>;
@@ -0,0 +1,14 @@
1
+ import { useThemeLocaleData } from '@theme/useThemeData';
2
+ import { computed } from 'vue';
3
+ import { usePageData, usePageFrontmatter } from 'vuepress/client';
4
+ export const useContributors = () => {
5
+ const themeLocale = useThemeLocaleData();
6
+ const page = usePageData();
7
+ const frontmatter = usePageFrontmatter();
8
+ return computed(() => {
9
+ const showContributors = frontmatter.value.contributors ?? themeLocale.value.contributors ?? true;
10
+ if (!showContributors)
11
+ return null;
12
+ return page.value.git?.contributors ?? null;
13
+ });
14
+ };
@@ -9,4 +9,3 @@ export declare const useDarkMode: () => DarkModeRef;
9
9
  * Create dark mode ref and provide as global computed in setup
10
10
  */
11
11
  export declare const setupDarkMode: () => void;
12
- export declare const updateHtmlDarkClass: (isDarkMode: DarkModeRef) => void;
@@ -1,7 +1,21 @@
1
+ import { useThemeLocaleData } from '@theme/useThemeData';
1
2
  import { usePreferredDark, useStorage } from '@vueuse/core';
2
3
  import { computed, inject, onMounted, onUnmounted, provide, watch } from 'vue';
3
- import { useThemeLocaleData } from './useThemeData.js';
4
4
  export const darkModeSymbol = Symbol(__VUEPRESS_DEV__ ? 'darkMode' : '');
5
+ const applyDarkmodeToHTML = (isDarkMode) => {
6
+ const update = (value = isDarkMode.value) => {
7
+ // set `class="dark"` on `<html>` element
8
+ const el = window.document.documentElement;
9
+ // set `data-theme="light|dark"` on `<html>` element
10
+ el.dataset.theme = value ? 'dark' : 'light';
11
+ };
12
+ onMounted(() => {
13
+ watch(isDarkMode, update, { immediate: true });
14
+ });
15
+ onUnmounted(() => {
16
+ update();
17
+ });
18
+ };
5
19
  /**
6
20
  * Inject dark mode global computed
7
21
  */
@@ -42,16 +56,5 @@ export const setupDarkMode = () => {
42
56
  },
43
57
  });
44
58
  provide(darkModeSymbol, isDarkMode);
45
- updateHtmlDarkClass(isDarkMode);
46
- };
47
- export const updateHtmlDarkClass = (isDarkMode) => {
48
- const update = (value = isDarkMode.value) => {
49
- // set `class="dark"` on `<html>` element
50
- const htmlEl = window?.document.querySelector('html');
51
- htmlEl?.classList.toggle('dark', value);
52
- };
53
- onMounted(() => {
54
- watch(isDarkMode, update, { immediate: true });
55
- });
56
- onUnmounted(() => update());
59
+ applyDarkmodeToHTML(isDarkMode);
57
60
  };
@@ -0,0 +1,3 @@
1
+ import type { ComputedRef } from 'vue';
2
+ import type { AutoLinkConfig } from 'vuepress/client';
3
+ export declare const useEditLink: () => ComputedRef<AutoLinkConfig | null>;
@@ -0,0 +1,31 @@
1
+ import { useThemeLocaleData } from '@theme/useThemeData';
2
+ import { computed } from 'vue';
3
+ import { usePageData, usePageFrontmatter } from 'vuepress/client';
4
+ import { resolveEditLink } from '../utils/index.js';
5
+ export const useEditLink = () => {
6
+ const themeLocale = useThemeLocaleData();
7
+ const page = usePageData();
8
+ const frontmatter = usePageFrontmatter();
9
+ return computed(() => {
10
+ const showEditLink = frontmatter.value.editLink ?? themeLocale.value.editLink ?? true;
11
+ if (!showEditLink) {
12
+ return null;
13
+ }
14
+ const { repo, docsRepo = repo, docsBranch = 'main', docsDir = '', editLinkText, } = themeLocale.value;
15
+ if (!docsRepo)
16
+ return null;
17
+ const editLink = resolveEditLink({
18
+ docsRepo,
19
+ docsBranch,
20
+ docsDir,
21
+ filePathRelative: page.value.filePathRelative,
22
+ editLinkPattern: frontmatter.value.editLinkPattern ?? themeLocale.value.editLinkPattern,
23
+ });
24
+ if (!editLink)
25
+ return null;
26
+ return {
27
+ text: editLinkText ?? 'Edit this page',
28
+ link: editLink,
29
+ };
30
+ });
31
+ };
@@ -0,0 +1,2 @@
1
+ import type { ComputedRef } from 'vue';
2
+ export declare const useLastUpdated: () => ComputedRef<string | null>;
@@ -0,0 +1,17 @@
1
+ import { useThemeLocaleData } from '@theme/useThemeData';
2
+ import { computed } from 'vue';
3
+ import { usePageData, usePageFrontmatter } from 'vuepress/client';
4
+ export const useLastUpdated = () => {
5
+ const themeLocale = useThemeLocaleData();
6
+ const page = usePageData();
7
+ const frontmatter = usePageFrontmatter();
8
+ return computed(() => {
9
+ const showLastUpdated = frontmatter.value.lastUpdated ?? themeLocale.value.lastUpdated ?? true;
10
+ if (!showLastUpdated)
11
+ return null;
12
+ if (!page.value.git?.updatedTime)
13
+ return null;
14
+ const updatedDate = new Date(page.value.git.updatedTime);
15
+ return updatedDate.toLocaleString();
16
+ });
17
+ };
@@ -0,0 +1,3 @@
1
+ import type { ComputedRef } from 'vue';
2
+ import type { NavbarItem } from '../typings.js';
3
+ export declare const useNavbarConfig: () => ComputedRef<NavbarItem[]>;
@@ -0,0 +1,27 @@
1
+ import { useThemeLocaleData } from '@theme/useThemeData';
2
+ import { computed } from 'vue';
3
+ import { isString } from 'vuepress/shared';
4
+ import { getAutoLink, isLinkInternal, resolvePrefix } from '../utils/index.js';
5
+ const resolveNavbarItem = (item, prefix = '') => {
6
+ if (isString(item)) {
7
+ return getAutoLink(resolvePrefix(prefix, item));
8
+ }
9
+ if ('children' in item) {
10
+ return {
11
+ ...item,
12
+ children: item.children.map((child) => resolveNavbarItem(child, resolvePrefix(prefix, item.prefix))),
13
+ };
14
+ }
15
+ return {
16
+ ...item,
17
+ link: isLinkInternal(item.link)
18
+ ? getAutoLink(resolvePrefix(prefix, item.link)).link
19
+ : item.link,
20
+ };
21
+ };
22
+ export const useNavbarConfig = () => {
23
+ const themeLocale = useThemeLocaleData();
24
+ return computed(() =>
25
+ // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
26
+ (themeLocale.value.navbar || []).map((item) => resolveNavbarItem(item)));
27
+ };
@@ -0,0 +1,6 @@
1
+ import type { ComputedRef } from 'vue';
2
+ import type { NavbarItem } from '../typings.js';
3
+ /**
4
+ * Get navbar config of repository link
5
+ */
6
+ export declare const useNavbarRepo: () => ComputedRef<NavbarItem[]>;
@@ -0,0 +1,38 @@
1
+ import { useThemeLocaleData } from '@theme/useThemeData';
2
+ import { computed } from 'vue';
3
+ import { isLinkHttp } from 'vuepress/shared';
4
+ import { resolveRepoType } from '../utils/index.js';
5
+ /**
6
+ * Get navbar config of repository link
7
+ */
8
+ export const useNavbarRepo = () => {
9
+ const themeLocale = useThemeLocaleData();
10
+ const repo = computed(() => themeLocale.value.repo);
11
+ const repoType = computed(() => repo.value ? resolveRepoType(repo.value) : null);
12
+ const repoLink = computed(() => {
13
+ if (repo.value && !isLinkHttp(repo.value)) {
14
+ return `https://github.com/${repo.value}`;
15
+ }
16
+ return repo.value;
17
+ });
18
+ const repoLabel = computed(() => {
19
+ if (!repoLink.value)
20
+ return null;
21
+ if (themeLocale.value.repoLabel)
22
+ return themeLocale.value.repoLabel;
23
+ if (repoType.value === null)
24
+ return 'Source';
25
+ return repoType.value;
26
+ });
27
+ return computed(() => {
28
+ if (!repoLink.value || !repoLabel.value) {
29
+ return [];
30
+ }
31
+ return [
32
+ {
33
+ text: repoLabel.value,
34
+ link: repoLink.value,
35
+ },
36
+ ];
37
+ });
38
+ };
@@ -0,0 +1,6 @@
1
+ import type { ComputedRef } from 'vue';
2
+ import type { NavbarItem } from '../typings.js';
3
+ /**
4
+ * Get navbar config of select language dropdown
5
+ */
6
+ export declare const useNavbarSelectLanguage: () => ComputedRef<NavbarItem[]>;
@@ -0,0 +1,59 @@
1
+ import { useThemeData, useThemeLocaleData } from '@theme/useThemeData';
2
+ import { useRoutePaths } from '@vuepress/helper/client';
3
+ import { computed } from 'vue';
4
+ import { useRoute, useRouteLocale, useSiteData, useSiteLocaleData, } from 'vuepress/client';
5
+ /**
6
+ * Get navbar config of select language dropdown
7
+ */
8
+ export const useNavbarSelectLanguage = () => {
9
+ const route = useRoute();
10
+ const routePaths = useRoutePaths();
11
+ const routeLocale = useRouteLocale();
12
+ const site = useSiteData();
13
+ const siteLocale = useSiteLocaleData();
14
+ const theme = useThemeData();
15
+ const themeLocale = useThemeLocaleData();
16
+ return computed(() => {
17
+ const localePaths = Object.keys(site.value.locales);
18
+ // do not display language selection dropdown if there is only one language
19
+ if (localePaths.length < 2) {
20
+ return [];
21
+ }
22
+ const currentPath = route.path;
23
+ const currentFullPath = route.fullPath;
24
+ const languageDropdown = {
25
+ text: `${themeLocale.value.selectLanguageText}`,
26
+ ariaLabel: `${themeLocale.value.selectLanguageAriaLabel ??
27
+ themeLocale.value.selectLanguageText}`,
28
+ children: localePaths.map((targetLocalePath) => {
29
+ // target locale config of this language link
30
+ // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
31
+ const targetSiteLocale = site.value.locales?.[targetLocalePath] ?? {};
32
+ const targetThemeLocale = theme.value.locales?.[targetLocalePath] ?? {};
33
+ const targetLang = `${targetSiteLocale.lang}`;
34
+ const text = targetThemeLocale.selectLanguageName ?? targetLang;
35
+ // if the target language is current language
36
+ // stay at current link
37
+ if (targetLang === siteLocale.value.lang) {
38
+ return {
39
+ text,
40
+ activeMatch: '.',
41
+ link: route.fullPath,
42
+ };
43
+ }
44
+ // if the target language is not current language
45
+ // try to link to the corresponding page of current page
46
+ // or fallback to homepage
47
+ const targetLocalePage = currentPath.replace(routeLocale.value, targetLocalePath);
48
+ return {
49
+ text,
50
+ // try to keep current hash and params across languages
51
+ link: routePaths.value.some((item) => item === targetLocalePage)
52
+ ? currentFullPath.replace(currentPath, targetLocalePage)
53
+ : (targetThemeLocale.home ?? targetLocalePath),
54
+ };
55
+ }),
56
+ };
57
+ return [languageDropdown];
58
+ });
59
+ };
@@ -0,0 +1 @@
1
+ export declare const useNavigate: () => ((url: string) => void);
@@ -0,0 +1,22 @@
1
+ import { isLinkAbsolute, isLinkWithProtocol } from '@vuepress/helper/client';
2
+ import { useRoute, useRouter } from 'vuepress/client';
3
+ export const useNavigate = () => {
4
+ const router = useRouter();
5
+ const route = useRoute();
6
+ return (url) => {
7
+ if (url)
8
+ if (isLinkAbsolute(url)) {
9
+ // Inner absolute path
10
+ if (route.path !== url)
11
+ router.push(url);
12
+ }
13
+ else if (isLinkWithProtocol(url)) {
14
+ // external url
15
+ window.open(url);
16
+ }
17
+ else {
18
+ // relative url
19
+ router.push(encodeURI(url));
20
+ }
21
+ };
22
+ };
@@ -0,0 +1,8 @@
1
+ import type { ComputedRef } from 'vue';
2
+ import type { AutoLinkOptions } from '../../shared/index.js';
3
+ interface RelatedLinks {
4
+ prevLink: ComputedRef<AutoLinkOptions | null>;
5
+ nextLink: ComputedRef<AutoLinkOptions | null>;
6
+ }
7
+ export declare const useRelatedLinks: () => RelatedLinks;
8
+ export {};
@@ -0,0 +1,91 @@
1
+ import { useSidebarItems } from '@theme/useSidebarItems';
2
+ import { useThemeLocaleData } from '@theme/useThemeData';
3
+ import { computed } from 'vue';
4
+ import { resolveRoute, usePageFrontmatter, useRoute } from 'vuepress/client';
5
+ import { isPlainObject, isString } from 'vuepress/shared';
6
+ import { getAutoLink } from '../utils/index.js';
7
+ const resolveFromFrontmatterConfig = (config, currentPath) => {
8
+ if (config === false) {
9
+ return false;
10
+ }
11
+ if (isString(config)) {
12
+ return getAutoLink(config, currentPath);
13
+ }
14
+ if (isPlainObject(config)) {
15
+ return {
16
+ ...config,
17
+ link: getAutoLink(config.link, currentPath).link,
18
+ };
19
+ }
20
+ return null;
21
+ };
22
+ /**
23
+ * Resolve `prev` or `next` config from sidebar items
24
+ */
25
+ const resolveFromSidebarItems = (sidebarItems, currentPath, offset) => {
26
+ const linkIndex = sidebarItems.findIndex((item) => item.link === currentPath);
27
+ if (linkIndex !== -1) {
28
+ const targetItem = sidebarItems[linkIndex + offset];
29
+ if (!targetItem)
30
+ return null;
31
+ if (targetItem.link)
32
+ return targetItem;
33
+ if ('prefix' in targetItem && !resolveRoute(targetItem.prefix).notFound)
34
+ return {
35
+ ...targetItem,
36
+ link: targetItem.prefix,
37
+ };
38
+ return null;
39
+ }
40
+ for (const item of sidebarItems) {
41
+ if ('children' in item) {
42
+ const childResult = resolveFromSidebarItems(item.children, currentPath, offset);
43
+ if (childResult) {
44
+ return childResult;
45
+ }
46
+ }
47
+ }
48
+ const prefixIndex = sidebarItems.findIndex((item) => 'prefix' in item && item.prefix === currentPath);
49
+ if (prefixIndex !== -1) {
50
+ const targetItem = sidebarItems[prefixIndex + offset];
51
+ if (!targetItem)
52
+ return null;
53
+ if (targetItem.link)
54
+ return targetItem;
55
+ if ('prefix' in targetItem && !resolveRoute(targetItem.prefix).notFound)
56
+ return {
57
+ ...targetItem,
58
+ link: targetItem.prefix,
59
+ };
60
+ return null;
61
+ }
62
+ return null;
63
+ };
64
+ export const useRelatedLinks = () => {
65
+ const frontmatter = usePageFrontmatter();
66
+ const themeLocale = useThemeLocaleData();
67
+ const sidebarItems = useSidebarItems();
68
+ const route = useRoute();
69
+ const prevLink = computed(() => {
70
+ const prevConfig = resolveFromFrontmatterConfig(frontmatter.value.prev, route.path);
71
+ return prevConfig === false
72
+ ? null
73
+ : (prevConfig ??
74
+ (themeLocale.value.prev === false
75
+ ? null
76
+ : resolveFromSidebarItems(sidebarItems.value, route.path, -1)));
77
+ });
78
+ const nextLink = computed(() => {
79
+ const nextConfig = resolveFromFrontmatterConfig(frontmatter.value.next, route.path);
80
+ return nextConfig === false
81
+ ? null
82
+ : (nextConfig ??
83
+ (themeLocale.value.next === false
84
+ ? null
85
+ : resolveFromSidebarItems(sidebarItems.value, route.path, 1)));
86
+ });
87
+ return {
88
+ prevLink,
89
+ nextLink,
90
+ };
91
+ };
@@ -3,7 +3,9 @@ let promiseResolve = null;
3
3
  const scrollPromise = {
4
4
  wait: () => promise,
5
5
  pending: () => {
6
- promise = new Promise((resolve) => (promiseResolve = resolve));
6
+ promise = new Promise((resolve) => {
7
+ promiseResolve = resolve;
8
+ });
7
9
  },
8
10
  resolve: () => {
9
11
  promiseResolve?.();
@@ -1,37 +1,42 @@
1
- import type { ComputedRef, InjectionKey } from 'vue';
2
- import type { Router } from 'vue-router';
3
- import type { PageData, PageHeader } from 'vuepress/client';
4
- import type { DefaultThemeData, DefaultThemeNormalPageFrontmatter, ResolvedSidebarItem, SidebarConfigArray, SidebarConfigObject } from '../../shared/index.js';
5
- export type SidebarItemsRef = ComputedRef<ResolvedSidebarItem[]>;
6
- export declare const sidebarItemsSymbol: InjectionKey<SidebarItemsRef>;
1
+ import type { MenuItem } from '@vuepress/helper/client';
2
+ import type { ComputedRef, InjectionKey, Ref } from 'vue';
3
+ import type { PageData } from 'vuepress/client';
4
+ import type { SidebarArrayOptions, SidebarObjectOptions, SidebarOptions } from '../../shared/index.js';
5
+ import type { SidebarHeaderItem, SidebarItem } from '../typings.js';
6
+ export type HeadersRef = Ref<MenuItem[]>;
7
+ export declare const headersRef: HeadersRef;
8
+ export declare const setupHeaders: () => void;
9
+ export declare const useHeaders: () => HeadersRef;
7
10
  /**
8
- * Inject sidebar items global computed
11
+ * Util to transform page header to sidebar item
9
12
  */
10
- export declare const useSidebarItems: () => SidebarItemsRef;
13
+ export declare const resolveSidebarHeaderItem: (header: MenuItem) => SidebarHeaderItem;
14
+ export declare const resolveSidebarHeaderItems: (headers?: MenuItem[]) => SidebarHeaderItem[];
11
15
  /**
12
- * Create sidebar items ref and provide as global computed in setup
16
+ * Resolve current page and its header to sidebar items if the config is `heading`
13
17
  */
14
- export declare const setupSidebarItems: () => void;
18
+ export declare const resolveSidebarHeadingItem: (page: PageData, headers: MenuItem[]) => SidebarItem[];
15
19
  /**
16
- * Resolve sidebar items global computed
17
- *
18
- * It should only be resolved and provided once
20
+ * Resolve sidebar items if the config is an array
19
21
  */
20
- export declare const resolveSidebarItems: (frontmatter: DefaultThemeNormalPageFrontmatter, themeLocale: DefaultThemeData, page: PageData, router: Router, path: string) => ResolvedSidebarItem[];
22
+ export declare const resolveArraySidebarItems: (sidebarConfig: SidebarArrayOptions, headers: MenuItem[], path: string, prefix?: string) => SidebarItem[];
21
23
  /**
22
- * Util to transform page header to sidebar item
24
+ * Resolve sidebar items if the config is a key -> value (path-prefix -> array) object
23
25
  */
24
- export declare const headerToSidebarItem: (header: PageHeader, sidebarDepth: number) => ResolvedSidebarItem;
25
- export declare const headersToSidebarItemChildren: (headers: PageHeader[], sidebarDepth: number) => ResolvedSidebarItem[];
26
+ export declare const resolveMultiSidebarItems: (sidebarConfig: SidebarObjectOptions, page: PageData, headers: MenuItem[], path: string) => SidebarItem[];
27
+ export type SidebarItemsRef = ComputedRef<SidebarItem[]>;
28
+ export declare const sidebarItemsSymbol: InjectionKey<SidebarItemsRef>;
26
29
  /**
27
- * Resolve sidebar items if the config is `auto`
30
+ * Inject sidebar items global computed
28
31
  */
29
- export declare const resolveAutoSidebarItems: (page: PageData, sidebarDepth: number) => ResolvedSidebarItem[];
32
+ export declare const useSidebarItems: () => SidebarItemsRef;
30
33
  /**
31
- * Resolve sidebar items if the config is an array
34
+ * Resolve sidebar items global computed
35
+ *
36
+ * It should only be resolved and provided once
32
37
  */
33
- export declare const resolveArraySidebarItems: (page: PageData, router: Router, path: string, sidebarConfig: SidebarConfigArray, sidebarDepth: number) => ResolvedSidebarItem[];
38
+ export declare const resolveSidebarItems: (sidebarConfig: SidebarOptions | false, page: PageData, path: string, routeLocale: string, headers: MenuItem[]) => SidebarItem[];
34
39
  /**
35
- * Resolve sidebar items if the config is a key -> value (path-prefix -> array) object
40
+ * Create sidebar items ref and provide as global computed in setup
36
41
  */
37
- export declare const resolveMultiSidebarItems: (page: PageData, router: Router, path: string, sidebarConfig: SidebarConfigObject, sidebarDepth: number) => ResolvedSidebarItem[];
42
+ export declare const setupSidebarItems: () => void;