@vuepress/theme-default 2.0.0-rc.11 → 2.0.0-rc.111

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 (142) hide show
  1. package/lib/client/components/VPAutoLink.vue +32 -0
  2. package/lib/client/components/VPDarkIcon.vue +8 -0
  3. package/lib/client/components/VPDropdownTransition.vue +43 -0
  4. package/lib/client/components/VPEditIcon.vue +12 -0
  5. package/lib/client/components/VPFadeSlideYTransition.vue +23 -0
  6. package/lib/client/components/VPHome.vue +37 -0
  7. package/lib/client/components/VPHomeFeatures.vue +65 -0
  8. package/lib/client/components/VPHomeFooter.vue +30 -0
  9. package/lib/client/components/VPHomeHero.vue +186 -0
  10. package/lib/client/components/VPLightIcon.vue +28 -0
  11. package/lib/client/components/VPNavbar.vue +138 -0
  12. package/lib/client/components/{NavbarBrand.vue → VPNavbarBrand.vue} +39 -15
  13. package/lib/client/components/VPNavbarDropdown.vue +329 -0
  14. package/lib/client/components/VPNavbarItems.vue +111 -0
  15. package/lib/client/components/VPPage.vue +69 -0
  16. package/lib/client/components/VPPageMeta.vue +139 -0
  17. package/lib/client/components/VPPageNav.vue +123 -0
  18. package/lib/client/components/VPSidebar.vue +120 -0
  19. package/lib/client/components/VPSidebarItem.vue +185 -0
  20. package/lib/client/components/{SidebarItems.vue → VPSidebarItems.vue} +27 -7
  21. package/lib/client/components/VPToggleColorModeButton.vue +55 -0
  22. package/lib/client/components/VPToggleSidebarButton.vue +92 -0
  23. package/lib/client/components/global/Badge.vue +83 -22
  24. package/lib/client/components/global/index.d.ts +1 -3
  25. package/lib/client/components/global/index.js +1 -3
  26. package/lib/client/composables/index.d.ts +7 -1
  27. package/lib/client/composables/index.js +7 -1
  28. package/lib/client/composables/useDarkMode.d.ts +1 -3
  29. package/lib/client/composables/useDarkMode.js +20 -17
  30. package/lib/client/composables/useData.d.ts +8 -0
  31. package/lib/client/composables/useData.js +7 -0
  32. package/lib/client/composables/useEditLink.d.ts +3 -0
  33. package/lib/client/composables/useEditLink.js +28 -0
  34. package/lib/client/composables/useHeaders.d.ts +9 -0
  35. package/lib/client/composables/useHeaders.js +38 -0
  36. package/lib/client/composables/useNavbarConfig.d.ts +3 -0
  37. package/lib/client/composables/useNavbarConfig.js +29 -0
  38. package/lib/client/composables/useNavbarRepo.d.ts +6 -0
  39. package/lib/client/composables/useNavbarRepo.js +38 -0
  40. package/lib/client/composables/useNavbarSelectLanguage.d.ts +6 -0
  41. package/lib/client/composables/useNavbarSelectLanguage.js +59 -0
  42. package/lib/client/composables/useNavigate.d.ts +1 -0
  43. package/lib/client/composables/useNavigate.js +22 -0
  44. package/lib/client/composables/useRelatedLinks.d.ts +8 -0
  45. package/lib/client/composables/useRelatedLinks.js +90 -0
  46. package/lib/client/composables/useScrollPromise.js +3 -1
  47. package/lib/client/composables/useSidebarItems.d.ts +21 -20
  48. package/lib/client/composables/useSidebarItems.js +96 -85
  49. package/lib/client/composables/useUpdateDeviceStatus.d.ts +1 -1
  50. package/lib/client/composables/useUpdateDeviceStatus.js +10 -5
  51. package/lib/client/config.d.ts +3 -2
  52. package/lib/client/config.js +8 -23
  53. package/lib/client/index.d.ts +1 -0
  54. package/lib/client/layouts/Layout.vue +126 -56
  55. package/lib/client/layouts/NotFound.vue +59 -12
  56. package/lib/client/shim.d.ts +6 -5
  57. package/lib/client/styles/_mixins.scss +4 -4
  58. package/lib/client/styles/_variables.module.scss +1 -1
  59. package/lib/client/styles/_variables.scss +2 -1
  60. package/lib/client/styles/arrow.scss +24 -22
  61. package/lib/client/styles/code-group.scss +34 -30
  62. package/lib/client/styles/content/code.scss +43 -0
  63. package/lib/client/styles/content/index.scss +3 -0
  64. package/lib/client/styles/content/normalize.scss +39 -0
  65. package/lib/client/styles/{toc.scss → content/toc.scss} +1 -1
  66. package/lib/client/styles/external-link-icon.scss +36 -0
  67. package/lib/client/styles/index.scss +3 -13
  68. package/lib/client/styles/layout.scss +5 -197
  69. package/lib/client/styles/normalize.scss +1 -194
  70. package/lib/client/styles/plugins.scss +28 -0
  71. package/lib/client/styles/vars-dark.scss +20 -58
  72. package/lib/client/styles/vars.scss +54 -150
  73. package/lib/client/typings.d.ts +13 -0
  74. package/lib/client/typings.js +1 -0
  75. package/lib/client/utils/index.d.ts +2 -1
  76. package/lib/client/utils/index.js +2 -1
  77. package/lib/client/utils/isActiveSidebarItem.d.ts +3 -3
  78. package/lib/client/utils/isActiveSidebarItem.js +1 -1
  79. package/lib/client/utils/resolveAutoLink.d.ts +9 -0
  80. package/lib/client/utils/{getNavLink.js → resolveAutoLink.js} +3 -3
  81. package/lib/client/utils/resolveEditLink.d.ts +3 -3
  82. package/lib/client/utils/resolveEditLink.js +3 -3
  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 +57 -64
  89. package/lib/node/index.d.ts +1 -3
  90. package/lib/node/index.js +0 -3
  91. package/lib/node/typings.d.ts +59 -0
  92. package/lib/node/typings.js +1 -0
  93. package/lib/node/utils/assignDefaultLocaleOptions.js +3 -8
  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 -66
  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 +34 -27
  108. package/templates/build.html +16 -10
  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/HomeFooter.vue +0 -17
  115. package/lib/client/components/HomeHero.vue +0 -97
  116. package/lib/client/components/Navbar.vue +0 -79
  117. package/lib/client/components/NavbarDropdown.vue +0 -126
  118. package/lib/client/components/NavbarItems.vue +0 -194
  119. package/lib/client/components/Page.vue +0 -31
  120. package/lib/client/components/PageMeta.vue +0 -124
  121. package/lib/client/components/PageNav.vue +0 -122
  122. package/lib/client/components/Sidebar.vue +0 -18
  123. package/lib/client/components/SidebarItem.vue +0 -87
  124. package/lib/client/components/ToggleColorModeButton.vue +0 -57
  125. package/lib/client/components/ToggleSidebarButton.vue +0 -24
  126. package/lib/client/components/global/CodeGroup.d.ts +0 -6
  127. package/lib/client/components/global/CodeGroup.js +0 -120
  128. package/lib/client/components/global/CodeGroupItem.vue +0 -27
  129. package/lib/client/composables/useThemeData.d.ts +0 -4
  130. package/lib/client/composables/useThemeData.js +0 -3
  131. package/lib/client/styles/badge.scss +0 -36
  132. package/lib/client/styles/code.scss +0 -263
  133. package/lib/client/styles/custom-container.scss +0 -142
  134. package/lib/client/styles/home.scss +0 -168
  135. package/lib/client/styles/navbar-dropdown.scss +0 -183
  136. package/lib/client/styles/navbar.scss +0 -197
  137. package/lib/client/styles/page.scss +0 -87
  138. package/lib/client/styles/sidebar.scss +0 -134
  139. package/lib/client/styles/transitions.scss +0 -22
  140. package/lib/client/utils/getNavLink.d.ts +0 -9
  141. package/lib/node/utils/resolveContainerPluginOptions.d.ts +0 -8
  142. package/lib/node/utils/resolveContainerPluginOptions.js +0 -17
@@ -1,35 +1,96 @@
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,
17
- },
18
- })
2
+ import type { Slot } from '@vuepress/helper/client'
3
+
4
+ const {
5
+ type = 'tip',
6
+ text = '',
7
+ vertical = '',
8
+ } = defineProps<{
9
+ /**
10
+ * The type of the badge
11
+ */
12
+ type?: string
13
+ /**
14
+ * The text of the badge
15
+ */
16
+ text?: string
17
+ /**
18
+ * The vertical align of the badge
19
+ */
20
+ vertical?: string
21
+ }>()
19
22
 
20
23
  defineSlots<{
21
- default?: () => any
24
+ default?: Slot
22
25
  }>()
23
26
  </script>
24
27
 
25
28
  <template>
26
29
  <span
27
- class="badge"
30
+ class="vp-badge"
28
31
  :class="type"
29
- :style="{
30
- verticalAlign: vertical,
31
- }"
32
+ :style="vertical ? { verticalAlign: vertical } : ''"
32
33
  >
33
34
  <slot>{{ text }}</slot>
34
35
  </span>
35
36
  </template>
37
+
38
+ <style lang="scss">
39
+ .vp-badge {
40
+ display: inline-block;
41
+ vertical-align: top;
42
+
43
+ height: 1.3em;
44
+ padding: 0 6px;
45
+ border-radius: 3px;
46
+
47
+ background: var(--vp-c-accent-soft);
48
+ color: var(--vp-c-accent);
49
+
50
+ font-size: 0.875em;
51
+ line-height: 1.3;
52
+
53
+ transition:
54
+ background var(--vp-t-color),
55
+ color var(--vp-t-color);
56
+
57
+ & + & {
58
+ margin-inline-start: 5px;
59
+ }
60
+
61
+ &.tip {
62
+ background: var(--badge-c-tip-bg);
63
+ color: var(--badge-c-tip-text);
64
+ }
65
+
66
+ &.warning {
67
+ background: var(--badge-c-warning-bg);
68
+ color: var(--badge-c-warning-text);
69
+ }
70
+
71
+ &.danger {
72
+ background: var(--badge-c-danger-bg);
73
+ color: var(--badge-c-danger-text);
74
+ }
75
+
76
+ &.important {
77
+ background: var(--badge-c-important-bg);
78
+ color: var(--badge-c-important-text);
79
+ }
80
+
81
+ &.info {
82
+ background: var(--badge-c-info-bg);
83
+ color: var(--badge-c-info-text);
84
+ }
85
+
86
+ &.note {
87
+ background: var(--badge-c-note-bg);
88
+ color: var(--badge-c-note-text);
89
+ }
90
+
91
+ // update the vertical align for the badge in toc
92
+ .table-of-contents & {
93
+ vertical-align: middle;
94
+ }
95
+ }
96
+ </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,5 +1,11 @@
1
1
  export * from './useDarkMode.js';
2
+ export * from './useData.js';
3
+ export * from './useEditLink.js';
4
+ export * from './useNavigate.js';
5
+ export * from './useNavbarConfig.js';
6
+ export * from './useNavbarRepo.js';
7
+ export * from './useNavbarSelectLanguage.js';
8
+ export * from './useRelatedLinks.js';
2
9
  export * from './useScrollPromise.js';
3
10
  export * from './useSidebarItems.js';
4
- export * from './useThemeData.js';
5
11
  export * from './useUpdateDeviceStatus.js';
@@ -1,5 +1,11 @@
1
1
  export * from './useDarkMode.js';
2
+ export * from './useData.js';
3
+ export * from './useEditLink.js';
4
+ export * from './useNavigate.js';
5
+ export * from './useNavbarConfig.js';
6
+ export * from './useNavbarRepo.js';
7
+ export * from './useNavbarSelectLanguage.js';
8
+ export * from './useRelatedLinks.js';
2
9
  export * from './useScrollPromise.js';
3
10
  export * from './useSidebarItems.js';
4
- export * from './useThemeData.js';
5
11
  export * from './useUpdateDeviceStatus.js';
@@ -1,6 +1,5 @@
1
- import type { InjectionKey, WritableComputedRef } from 'vue';
1
+ import type { WritableComputedRef } from 'vue';
2
2
  export type DarkModeRef = WritableComputedRef<boolean>;
3
- export declare const darkModeSymbol: InjectionKey<DarkModeRef>;
4
3
  /**
5
4
  * Inject dark mode global computed
6
5
  */
@@ -9,4 +8,3 @@ export declare const useDarkMode: () => DarkModeRef;
9
8
  * Create dark mode ref and provide as global computed in setup
10
9
  */
11
10
  export declare const setupDarkMode: () => void;
12
- export declare const updateHtmlDarkClass: (isDarkMode: DarkModeRef) => void;
@@ -1,7 +1,21 @@
1
- import { usePreferredDark, useStorage } from '@vueuse/core';
2
- import { computed, inject, onMounted, onUnmounted, provide, watch } from 'vue';
3
- import { useThemeLocaleData } from './useThemeData.js';
4
- export const darkModeSymbol = Symbol(__VUEPRESS_DEV__ ? 'darkMode' : '');
1
+ import { useData } from '@theme/useData';
2
+ import { darkModeSymbol } from '@vuepress/helper/client';
3
+ import { usePreferredDark, useStorage, watchImmediate } from '@vueuse/core';
4
+ import { computed, inject, onMounted, onUnmounted, provide } from 'vue';
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
+ watchImmediate(isDarkMode, update);
14
+ });
15
+ onUnmounted(() => {
16
+ update();
17
+ });
18
+ };
5
19
  /**
6
20
  * Inject dark mode global computed
7
21
  */
@@ -16,7 +30,7 @@ export const useDarkMode = () => {
16
30
  * Create dark mode ref and provide as global computed in setup
17
31
  */
18
32
  export const setupDarkMode = () => {
19
- const themeLocale = useThemeLocaleData();
33
+ const { themeLocale } = useData();
20
34
  const isDarkPreferred = usePreferredDark();
21
35
  const darkStorage = useStorage('vuepress-color-scheme', themeLocale.value.colorMode);
22
36
  const isDarkMode = computed({
@@ -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,8 @@
1
+ import type { ThemeDataRef, ThemeLocaleDataRef } from '@vuepress/plugin-theme-data/client';
2
+ import type { ClientData } from 'vuepress/client';
3
+ import type { DefaultThemeData, DefaultThemeNormalPageFrontmatter, DefaultThemePageData } from '../../shared/index.js';
4
+ export interface Data<PageFrontmatter extends Record<string, unknown> = DefaultThemeNormalPageFrontmatter, PageData extends Record<string, unknown> = DefaultThemePageData> extends Pick<ClientData<PageFrontmatter, PageData>, 'frontmatter' | 'head' | 'headTitle' | 'lang' | 'layouts' | 'page' | 'pageComponent' | 'pageLayout' | 'redirects' | 'routeLocale' | 'routePath' | 'routes' | 'site' | 'siteLocale'> {
5
+ theme: ThemeDataRef<DefaultThemeData>;
6
+ themeLocale: ThemeLocaleDataRef<DefaultThemeData>;
7
+ }
8
+ export declare const useData: <PageFrontmatter extends Record<string, unknown> = DefaultThemeNormalPageFrontmatter, PageData extends Record<string, unknown> = DefaultThemePageData>() => Data<PageFrontmatter, PageData>;
@@ -0,0 +1,7 @@
1
+ import { useThemeData, useThemeLocaleData, } from '@vuepress/plugin-theme-data/client';
2
+ import { useData as _useData } from 'vuepress/client';
3
+ export const useData = () => ({
4
+ ..._useData(),
5
+ theme: useThemeData(),
6
+ themeLocale: useThemeLocaleData(),
7
+ });
@@ -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,28 @@
1
+ import { resolveEditLink } from '@theme/resolveEditLink';
2
+ import { useData } from '@theme/useData';
3
+ import { computed } from 'vue';
4
+ export const useEditLink = () => {
5
+ const { frontmatter, page, themeLocale } = useData();
6
+ return computed(() => {
7
+ const showEditLink = frontmatter.value.editLink ?? themeLocale.value.editLink ?? true;
8
+ if (!showEditLink) {
9
+ return null;
10
+ }
11
+ const { repo, docsRepo = repo, docsBranch = 'main', docsDir = '', editLinkText, } = themeLocale.value;
12
+ if (!docsRepo)
13
+ return null;
14
+ const editLink = resolveEditLink({
15
+ docsRepo,
16
+ docsBranch,
17
+ docsDir,
18
+ filePathRelative: page.value.filePathRelative,
19
+ editLinkPattern: frontmatter.value.editLinkPattern ?? themeLocale.value.editLinkPattern,
20
+ });
21
+ if (!editLink)
22
+ return null;
23
+ return {
24
+ text: editLinkText ?? 'Edit this page',
25
+ link: editLink,
26
+ };
27
+ });
28
+ };
@@ -0,0 +1,9 @@
1
+ import type { HeaderItem } from '@vuepress/helper/client';
2
+ import type { InjectionKey, Ref } from 'vue';
3
+ export type HeadersRef = Ref<HeaderItem[]>;
4
+ export declare const headersSymbol: InjectionKey<HeadersRef>;
5
+ /**
6
+ * Inject headers
7
+ */
8
+ export declare const useHeaders: () => HeadersRef;
9
+ export declare const setupHeaders: () => void;
@@ -0,0 +1,38 @@
1
+ import { useData } from '@theme/useData';
2
+ import { getHeaders } from '@vuepress/helper/client';
3
+ import { injectLocal, provideLocal } from '@vueuse/core';
4
+ import { computed, ref } from 'vue';
5
+ import { onContentUpdated } from 'vuepress/client';
6
+ export const headersSymbol = Symbol('headers');
7
+ /**
8
+ * Inject headers
9
+ */
10
+ export const useHeaders = () => {
11
+ const headers = injectLocal(headersSymbol);
12
+ if (!headers) {
13
+ throw new Error('useHeaders() is called without provider.');
14
+ }
15
+ return headers;
16
+ };
17
+ export const setupHeaders = () => {
18
+ const { frontmatter, themeLocale } = useData();
19
+ const headersRef = ref([]);
20
+ const levels = computed(() => frontmatter.value.sidebarDepth ?? themeLocale.value.sidebarDepth ?? 2);
21
+ const updateHeaders = () => {
22
+ if (levels.value <= 0) {
23
+ headersRef.value = [];
24
+ return;
25
+ }
26
+ headersRef.value = getHeaders({
27
+ levels: [2, levels.value + 1],
28
+ ignore: ['.vp-badge'],
29
+ });
30
+ };
31
+ provideLocal(headersSymbol, headersRef);
32
+ onContentUpdated((reason) => {
33
+ if (reason === 'beforeUnmount')
34
+ headersRef.value = [];
35
+ else
36
+ updateHeaders();
37
+ });
38
+ };
@@ -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,29 @@
1
+ import { resolveAutoLink } from '@theme/resolveAutoLink';
2
+ import { resolvePrefix } from '@theme/resolvePrefix';
3
+ import { useData } from '@theme/useData';
4
+ import { isLinkRelative } from '@vuepress/helper/client';
5
+ import { computed } from 'vue';
6
+ import { isString } from 'vuepress/shared';
7
+ const resolveNavbarItem = (item, prefix = '') => {
8
+ if (isString(item)) {
9
+ return resolveAutoLink(resolvePrefix(prefix, item));
10
+ }
11
+ if ('children' in item) {
12
+ return {
13
+ ...item,
14
+ children: item.children.map((child) => resolveNavbarItem(child, resolvePrefix(prefix, item.prefix))),
15
+ };
16
+ }
17
+ return {
18
+ ...item,
19
+ link: isLinkRelative(item.link)
20
+ ? resolveAutoLink(resolvePrefix(prefix, item.link)).link
21
+ : item.link,
22
+ };
23
+ };
24
+ export const useNavbarConfig = () => {
25
+ const { themeLocale } = useData();
26
+ return computed(() =>
27
+ // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
28
+ (themeLocale.value.navbar || []).map((item) => resolveNavbarItem(item)));
29
+ };
@@ -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 { resolveRepoType } from '@theme/resolveRepoType';
2
+ import { useData } from '@theme/useData';
3
+ import { computed } from 'vue';
4
+ import { isLinkHttp } from 'vuepress/shared';
5
+ /**
6
+ * Get navbar config of repository link
7
+ */
8
+ export const useNavbarRepo = () => {
9
+ const { themeLocale } = useData();
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 { useData } from '@theme/useData';
2
+ import { useRoutePaths } from '@vuepress/helper/client';
3
+ import { useMounted } from '@vueuse/core';
4
+ import { computed } from 'vue';
5
+ import { useRoute } from 'vuepress/client';
6
+ /**
7
+ * Get navbar config of select language dropdown
8
+ */
9
+ export const useNavbarSelectLanguage = () => {
10
+ const route = useRoute();
11
+ const routePaths = useRoutePaths();
12
+ const { routeLocale, site, siteLocale, theme, themeLocale } = useData();
13
+ const isMounted = useMounted();
14
+ return computed(() => {
15
+ const localePaths = Object.keys(site.value.locales);
16
+ // do not display language selection dropdown if there is only one language
17
+ if (localePaths.length < 2) {
18
+ return [];
19
+ }
20
+ const currentPath = route.path;
21
+ const currentFullPath = route.fullPath;
22
+ const languageDropdown = {
23
+ text: `${themeLocale.value.selectLanguageText}`,
24
+ ariaLabel: `${themeLocale.value.selectLanguageAriaLabel ??
25
+ themeLocale.value.selectLanguageText}`,
26
+ children: localePaths.map((targetLocalePath) => {
27
+ // target locale config of this language link
28
+ // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
29
+ const targetSiteLocale = site.value.locales?.[targetLocalePath] ?? {};
30
+ const targetThemeLocale = theme.value.locales?.[targetLocalePath] ?? {};
31
+ const targetLang = `${targetSiteLocale.lang}`;
32
+ const text = targetThemeLocale.selectLanguageName ?? targetLang;
33
+ // if the target language is current language
34
+ // stay at current link
35
+ if (targetLang === siteLocale.value.lang) {
36
+ return {
37
+ text,
38
+ activeMatch: '.',
39
+ link: isMounted.value ? currentFullPath : currentPath,
40
+ };
41
+ }
42
+ // if the target language is not current language
43
+ // try to link to the corresponding page of current page
44
+ // or fallback to homepage
45
+ const targetLocalePage = currentPath.replace(routeLocale.value, targetLocalePath);
46
+ return {
47
+ text,
48
+ // try to keep current hash and params across languages
49
+ link: routePaths.value.some((item) => item === targetLocalePage)
50
+ ? isMounted.value
51
+ ? currentFullPath.replace(currentPath, targetLocalePage)
52
+ : 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.fullPath !== 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,90 @@
1
+ import { resolveAutoLink } from '@theme/resolveAutoLink';
2
+ import { useData } from '@theme/useData';
3
+ import { useSidebarItems } from '@theme/useSidebarItems';
4
+ import { computed } from 'vue';
5
+ import { resolveRoute, useRoutePath } from 'vuepress/client';
6
+ import { isPlainObject, isString } from 'vuepress/shared';
7
+ const resolveFromFrontmatterConfig = (config, currentPath) => {
8
+ if (config === false) {
9
+ return false;
10
+ }
11
+ if (isString(config)) {
12
+ return resolveAutoLink(config, currentPath);
13
+ }
14
+ if (isPlainObject(config)) {
15
+ return {
16
+ ...config,
17
+ link: resolveAutoLink(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, themeLocale } = useData();
66
+ const sidebarItems = useSidebarItems();
67
+ const routePath = useRoutePath();
68
+ const prevLink = computed(() => {
69
+ const prevConfig = resolveFromFrontmatterConfig(frontmatter.value.prev, routePath.value);
70
+ return prevConfig === false
71
+ ? null
72
+ : (prevConfig ??
73
+ (themeLocale.value.prev === false
74
+ ? null
75
+ : resolveFromSidebarItems(sidebarItems.value, routePath.value, -1)));
76
+ });
77
+ const nextLink = computed(() => {
78
+ const nextConfig = resolveFromFrontmatterConfig(frontmatter.value.next, routePath.value);
79
+ return nextConfig === false
80
+ ? null
81
+ : (nextConfig ??
82
+ (themeLocale.value.next === false
83
+ ? null
84
+ : resolveFromSidebarItems(sidebarItems.value, routePath.value, 1)));
85
+ });
86
+ return {
87
+ prevLink,
88
+ nextLink,
89
+ };
90
+ };
@@ -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?.();