@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,118 +1,154 @@
1
- import { computed, inject, provide } from 'vue';
2
- import { useRoute, useRouter } from 'vue-router';
3
- import { usePageData, usePageFrontmatter } from 'vuepress/client';
4
- import { isPlainObject, isString, resolveLocalePath } from 'vuepress/shared';
5
- import { getNavLink } from '../utils/index.js';
6
- import { useThemeLocaleData } from './useThemeData.js';
7
- export const sidebarItemsSymbol = Symbol('sidebarItems');
8
- /**
9
- * Inject sidebar items global computed
10
- */
11
- export const useSidebarItems = () => {
12
- const sidebarItems = inject(sidebarItemsSymbol);
13
- if (!sidebarItems) {
14
- throw new Error('useSidebarItems() is called without provider.');
15
- }
16
- return sidebarItems;
17
- };
18
- /**
19
- * Create sidebar items ref and provide as global computed in setup
20
- */
21
- export const setupSidebarItems = () => {
1
+ import { useThemeLocaleData } from '@theme/useThemeData';
2
+ import { getHeaders, keys, startsWith } from '@vuepress/helper/client';
3
+ import { computed, inject, onMounted, provide, ref, watch } from 'vue';
4
+ import { usePageData, usePageFrontmatter, useRoute, useRouteLocale, useRouter, } from 'vuepress/client';
5
+ import { isPlainObject, isString } from 'vuepress/shared';
6
+ import { getAutoLink, isLinkInternal, resolvePrefix } from '../utils/index.js';
7
+ export const headersRef = ref([]);
8
+ export const setupHeaders = () => {
9
+ const router = useRouter();
22
10
  const themeLocale = useThemeLocaleData();
23
11
  const frontmatter = usePageFrontmatter();
24
- const page = usePageData();
25
- const route = useRoute();
26
- const router = useRouter();
27
- const sidebarItems = computed(() => resolveSidebarItems(frontmatter.value, themeLocale.value, page.value, router, route.path));
28
- provide(sidebarItemsSymbol, sidebarItems);
29
- };
30
- /**
31
- * Resolve sidebar items global computed
32
- *
33
- * It should only be resolved and provided once
34
- */
35
- export const resolveSidebarItems = (frontmatter, themeLocale, page, router, path) => {
36
- // get sidebar config from frontmatter > theme data
37
- const sidebarConfig = frontmatter.sidebar ?? themeLocale.sidebar ?? 'auto';
38
- const sidebarDepth = frontmatter.sidebarDepth ?? themeLocale.sidebarDepth ?? 2;
39
- // resolve sidebar items according to the config
40
- if (frontmatter.home || sidebarConfig === false) {
41
- return [];
42
- }
43
- if (sidebarConfig === 'auto') {
44
- return resolveAutoSidebarItems(page, sidebarDepth);
45
- }
46
- if (Array.isArray(sidebarConfig)) {
47
- return resolveArraySidebarItems(page, router, path, sidebarConfig, sidebarDepth);
48
- }
49
- if (isPlainObject(sidebarConfig)) {
50
- return resolveMultiSidebarItems(page, router, path, sidebarConfig, sidebarDepth);
51
- }
52
- return [];
12
+ const levels = computed(() => frontmatter.value.sidebarDepth ?? themeLocale.value.sidebarDepth ?? 2);
13
+ router.beforeEach((to, from) => {
14
+ if (to.path !== from.path) {
15
+ headersRef.value = [];
16
+ }
17
+ });
18
+ const updateHeaders = () => {
19
+ if (levels.value <= 0) {
20
+ headersRef.value = [];
21
+ return;
22
+ }
23
+ headersRef.value = getHeaders({
24
+ levels: [2, levels.value + 1],
25
+ ignore: ['.vp-badge'],
26
+ });
27
+ };
28
+ watch(levels, updateHeaders);
29
+ onMounted(updateHeaders);
53
30
  };
31
+ export const useHeaders = () => headersRef;
54
32
  /**
55
33
  * Util to transform page header to sidebar item
56
34
  */
57
- export const headerToSidebarItem = (header, sidebarDepth) => ({
35
+ export const resolveSidebarHeaderItem = (header) => ({
58
36
  text: header.title,
59
37
  link: header.link,
60
- children: headersToSidebarItemChildren(header.children, sidebarDepth),
38
+ // eslint-disable-next-line @typescript-eslint/no-use-before-define
39
+ children: resolveSidebarHeaderItems(header.children),
61
40
  });
62
- export const headersToSidebarItemChildren = (headers, sidebarDepth) => sidebarDepth > 0
63
- ? headers.map((header) => headerToSidebarItem(header, sidebarDepth - 1))
64
- : [];
41
+ export const resolveSidebarHeaderItems = (headers) => headers ? headers.map((header) => resolveSidebarHeaderItem(header)) : [];
65
42
  /**
66
- * Resolve sidebar items if the config is `auto`
43
+ * Resolve current page and its header to sidebar items if the config is `heading`
67
44
  */
68
- export const resolveAutoSidebarItems = (page, sidebarDepth) => {
69
- return [
70
- {
71
- text: page.title,
72
- children: headersToSidebarItemChildren(page.headers, sidebarDepth),
73
- },
74
- ];
75
- };
45
+ export const resolveSidebarHeadingItem = (page, headers) => [
46
+ {
47
+ text: page.title,
48
+ children: resolveSidebarHeaderItems(headers),
49
+ },
50
+ ];
76
51
  /**
77
52
  * Resolve sidebar items if the config is an array
78
53
  */
79
- export const resolveArraySidebarItems = (page, router, path, sidebarConfig, sidebarDepth) => {
80
- const handleChildItem = (item) => {
81
- let childItem;
82
- if (isString(item)) {
83
- childItem = getNavLink(router, item);
84
- }
85
- else {
86
- childItem = item;
87
- }
88
- if (childItem.children) {
54
+ export const resolveArraySidebarItems = (sidebarConfig, headers, path, prefix = '') => {
55
+ const handleChildItem = (item, pathPrefix) => {
56
+ const childItem = isString(item)
57
+ ? getAutoLink(resolvePrefix(pathPrefix, item))
58
+ : isString(item.link)
59
+ ? {
60
+ ...item,
61
+ link: isLinkInternal(item.link)
62
+ ? getAutoLink(resolvePrefix(pathPrefix, item.link)).link
63
+ : item.link,
64
+ }
65
+ : item;
66
+ if ('children' in childItem) {
89
67
  return {
90
68
  ...childItem,
91
- children: childItem.children.map((item) => handleChildItem(item)),
69
+ children: childItem.children.map((child) => handleChildItem(child, resolvePrefix(pathPrefix, childItem.prefix))),
92
70
  };
93
71
  }
94
72
  // if the sidebar item is current page and children is not set
95
73
  // use headers of current page as children
96
74
  if (childItem.link === path) {
97
75
  // skip h1 header
98
- const headers = page.headers[0]?.level === 1 ? page.headers[0].children : page.headers;
76
+ const currentHeaders = headers[0]?.level === 1 ? headers[0].children : headers;
99
77
  return {
100
78
  ...childItem,
101
- children: headersToSidebarItemChildren(headers, sidebarDepth),
79
+ children: resolveSidebarHeaderItems(currentHeaders),
102
80
  };
103
81
  }
104
82
  return childItem;
105
83
  };
106
- return sidebarConfig.map((item) => handleChildItem(item));
84
+ return sidebarConfig.map((item) => handleChildItem(item, prefix));
107
85
  };
108
86
  /**
109
87
  * Resolve sidebar items if the config is a key -> value (path-prefix -> array) object
110
88
  */
111
- export const resolveMultiSidebarItems = (page, router, path, sidebarConfig, sidebarDepth) => {
112
- const sidebarPath = resolveLocalePath(sidebarConfig, path);
113
- const matchedSidebarConfig = sidebarConfig[sidebarPath] ?? [];
114
- if (matchedSidebarConfig === 'heading') {
115
- return resolveAutoSidebarItems(page, sidebarDepth);
89
+ export const resolveMultiSidebarItems = (sidebarConfig, page, headers, path) => {
90
+ const sidebarRoutes = keys(sidebarConfig).sort((x, y) => y.length - x.length);
91
+ // Find matching config
92
+ for (const base of sidebarRoutes)
93
+ if (startsWith(decodeURI(path), base)) {
94
+ const matched = sidebarConfig[base];
95
+ return matched
96
+ ? matched === 'heading'
97
+ ? resolveSidebarHeadingItem(page, headers)
98
+ : resolveArraySidebarItems(matched, headers, path, base)
99
+ : [];
100
+ }
101
+ // eslint-disable-next-line no-console
102
+ console.warn(`${decodeURI(path)} is missing sidebar config.`);
103
+ return [];
104
+ };
105
+ export const sidebarItemsSymbol = Symbol('sidebarItems');
106
+ /**
107
+ * Inject sidebar items global computed
108
+ */
109
+ export const useSidebarItems = () => {
110
+ const sidebarItems = inject(sidebarItemsSymbol);
111
+ if (!sidebarItems) {
112
+ throw new Error('useSidebarItems() is called without provider.');
116
113
  }
117
- return resolveArraySidebarItems(page, router, path, matchedSidebarConfig, sidebarDepth);
114
+ return sidebarItems;
115
+ };
116
+ /**
117
+ * Resolve sidebar items global computed
118
+ *
119
+ * It should only be resolved and provided once
120
+ */
121
+ export const resolveSidebarItems = (sidebarConfig, page, path, routeLocale, headers) => {
122
+ // resolve sidebar items according to the config
123
+ if (sidebarConfig === false) {
124
+ return [];
125
+ }
126
+ if (sidebarConfig === 'heading') {
127
+ return resolveSidebarHeadingItem(page, headers);
128
+ }
129
+ if (Array.isArray(sidebarConfig)) {
130
+ return resolveArraySidebarItems(sidebarConfig, headers, path, routeLocale);
131
+ }
132
+ if (isPlainObject(sidebarConfig)) {
133
+ return resolveMultiSidebarItems(sidebarConfig, page, headers, path);
134
+ }
135
+ return [];
136
+ };
137
+ /**
138
+ * Create sidebar items ref and provide as global computed in setup
139
+ */
140
+ export const setupSidebarItems = () => {
141
+ const themeLocale = useThemeLocaleData();
142
+ const frontmatter = usePageFrontmatter();
143
+ const page = usePageData();
144
+ const route = useRoute();
145
+ const routeLocale = useRouteLocale();
146
+ const headers = useHeaders();
147
+ const sidebarConfig = computed(() => frontmatter.value.home
148
+ ? false
149
+ : (frontmatter.value.sidebar ??
150
+ themeLocale.value.sidebar ??
151
+ 'heading'));
152
+ const sidebarItems = computed(() => resolveSidebarItems(sidebarConfig.value, page.value, route.path, routeLocale.value, headers.value));
153
+ provide(sidebarItemsSymbol, sidebarItems);
118
154
  };
@@ -1,5 +1,5 @@
1
1
  export declare enum DeviceType {
2
- MOBILE = "mobile"
2
+ Mobile = "mobile"
3
3
  }
4
4
  /**
5
5
  * add listener to detect screen though device type
@@ -1,11 +1,12 @@
1
+ import { useEventListener } from '@vueuse/core';
1
2
  import { onMounted } from 'vue';
2
- import cssVars from '../styles/_variables.module.scss?module';
3
+ import cssVariables from '../styles/_variables.module.scss';
3
4
  export var DeviceType;
4
5
  (function (DeviceType) {
5
- DeviceType["MOBILE"] = "mobile";
6
+ DeviceType["Mobile"] = "mobile";
6
7
  })(DeviceType || (DeviceType = {}));
7
8
  const DeviceTypeMap = {
8
- [DeviceType.MOBILE]: Number.parseInt(cssVars.mobile?.replace('px', ''), 10),
9
+ [DeviceType.Mobile]: Number.parseInt(cssVariables.mobile.replace('px', ''), 10),
9
10
  };
10
11
  /**
11
12
  * add listener to detect screen though device type
@@ -17,9 +18,13 @@ export const useUpdateDeviceStatus = (deviceType, callback) => {
17
18
  throw new Error('device width must be a integer');
18
19
  return;
19
20
  }
21
+ useEventListener('orientationchange', () => {
22
+ callback(width);
23
+ }, false);
24
+ useEventListener('resize', () => {
25
+ callback(width);
26
+ }, false);
20
27
  onMounted(() => {
21
28
  callback(width);
22
- window.addEventListener('resize', () => callback(width), false);
23
- window.addEventListener('orientationchange', () => callback(width), false);
24
29
  });
25
30
  };
@@ -1,4 +1,5 @@
1
- import type { ClientConfig } from 'vuepress/client';
1
+ import '@vuepress/helper/colors.css';
2
+ import '@vuepress/helper/normalize.css';
2
3
  import './styles/index.scss';
3
- declare const _default: ClientConfig;
4
+ declare const _default: import("vuepress/client").ClientConfig;
4
5
  export default _default;
@@ -1,31 +1,18 @@
1
- import { h } from 'vue';
1
+ import { setupDarkMode } from '@theme/useDarkMode';
2
+ import { useScrollPromise } from '@theme/useScrollPromise';
3
+ import { setupSidebarItems } from '@theme/useSidebarItems';
4
+ import { hasGlobalComponent } from '@vuepress/helper/client';
2
5
  import { defineClientConfig } from 'vuepress/client';
3
- import { Badge, CodeGroup, CodeGroupItem } from './components/global/index.js';
4
- import { setupDarkMode, setupSidebarItems, useScrollPromise, } from './composables/index.js';
6
+ import { Badge } from './components/global/index.js';
5
7
  import Layout from './layouts/Layout.vue';
6
8
  import NotFound from './layouts/NotFound.vue';
9
+ import '@vuepress/helper/colors.css';
10
+ import '@vuepress/helper/normalize.css';
7
11
  import './styles/index.scss';
8
12
  export default defineClientConfig({
9
13
  enhance({ app, router }) {
10
- app.component('Badge', Badge);
11
- app.component('CodeGroup', CodeGroup);
12
- app.component('CodeGroupItem', CodeGroupItem);
13
- // compat with @vuepress/plugin-external-link-icon
14
- app.component('AutoLinkExternalIcon', () => {
15
- const ExternalLinkIcon = app.component('ExternalLinkIcon');
16
- if (ExternalLinkIcon) {
17
- return h(ExternalLinkIcon);
18
- }
19
- return null;
20
- });
21
- // compat with @vuepress/plugin-docsearch and @vuepress/plugin-search
22
- app.component('NavbarSearch', () => {
23
- const SearchComponent = app.component('Docsearch') || app.component('SearchBox');
24
- if (SearchComponent) {
25
- return h(SearchComponent);
26
- }
27
- return null;
28
- });
14
+ if (!hasGlobalComponent('Badge'))
15
+ app.component('Badge', Badge);
29
16
  // handle scrollBehavior with transition
30
17
  const scrollBehavior = router.options.scrollBehavior;
31
18
  router.options.scrollBehavior = async (...args) => {
@@ -1,3 +1,4 @@
1
- export * from '../shared/index.js';
2
1
  export * from './composables/index.js';
2
+ export type * from './typings.js';
3
3
  export * from './utils/index.js';
4
+ export type * from '../shared/index.js';
@@ -1,3 +1,2 @@
1
- export * from '../shared/index.js';
2
1
  export * from './composables/index.js';
3
2
  export * from './utils/index.js';
@@ -1,30 +1,30 @@
1
1
  <script setup lang="ts">
2
- import Home from '@theme/Home.vue'
3
- import Navbar from '@theme/Navbar.vue'
4
- import Page from '@theme/Page.vue'
5
- import Sidebar from '@theme/Sidebar.vue'
2
+ import VPHome from '@theme/VPHome.vue'
3
+ import VPNavbar from '@theme/VPNavbar.vue'
4
+ import VPPage from '@theme/VPPage.vue'
5
+ import VPSidebar from '@theme/VPSidebar.vue'
6
+ import { useScrollPromise } from '@theme/useScrollPromise'
7
+ import { useSidebarItems } from '@theme/useSidebarItems'
8
+ import { useThemeLocaleData } from '@theme/useThemeData'
9
+ import type { VNode } from 'vue'
6
10
  import { computed, onMounted, onUnmounted, ref } from 'vue'
7
- import { useRouter } from 'vue-router'
8
- import { usePageData, usePageFrontmatter } from 'vuepress/client'
11
+ import { usePageData, usePageFrontmatter, useRouter } from 'vuepress/client'
9
12
  import type { DefaultThemePageFrontmatter } from '../../shared/index.js'
10
- import {
11
- useScrollPromise,
12
- useSidebarItems,
13
- useThemeLocaleData,
14
- } from '../composables/index.js'
15
13
 
16
14
  defineSlots<{
17
- 'navbar'?: (props: Record<never, never>) => any
18
- 'navbar-before'?: (props: Record<never, never>) => any
19
- 'navbar-after'?: (props: Record<never, never>) => any
20
- 'sidebar'?: (props: Record<never, never>) => any
21
- 'sidebar-top'?: (props: Record<never, never>) => any
22
- 'sidebar-bottom'?: (props: Record<never, never>) => any
23
- 'page'?: (props: Record<never, never>) => any
24
- 'page-top'?: (props: Record<never, never>) => any
25
- 'page-bottom'?: (props: Record<never, never>) => any
26
- 'page-content-top'?: (props: Record<never, never>) => any
27
- 'page-content-bottom'?: (props: Record<never, never>) => any
15
+ 'navbar'?: (props: Record<never, never>) => VNode | VNode[] | null
16
+ 'navbar-before'?: (props: Record<never, never>) => VNode | VNode[] | null
17
+ 'navbar-after'?: (props: Record<never, never>) => VNode | VNode[] | null
18
+ 'sidebar'?: (props: Record<never, never>) => VNode | VNode[] | null
19
+ 'sidebar-top'?: (props: Record<never, never>) => VNode | VNode[] | null
20
+ 'sidebar-bottom'?: (props: Record<never, never>) => VNode | VNode[] | null
21
+ 'page'?: (props: Record<never, never>) => VNode | VNode[] | null
22
+ 'page-top'?: (props: Record<never, never>) => VNode | VNode[] | null
23
+ 'page-bottom'?: (props: Record<never, never>) => VNode | VNode[] | null
24
+ 'page-content-top'?: (props: Record<never, never>) => VNode | VNode[] | null
25
+ 'page-content-bottom'?: (
26
+ props: Record<never, never>,
27
+ ) => VNode | VNode[] | null
28
28
  }>()
29
29
 
30
30
  const page = usePageData()
@@ -44,11 +44,11 @@ const toggleSidebar = (to?: boolean): void => {
44
44
  isSidebarOpen.value = typeof to === 'boolean' ? to : !isSidebarOpen.value
45
45
  }
46
46
  const touchStart = { x: 0, y: 0 }
47
- const onTouchStart = (e): void => {
47
+ const onTouchStart = (e: TouchEvent): void => {
48
48
  touchStart.x = e.changedTouches[0].clientX
49
49
  touchStart.y = e.changedTouches[0].clientY
50
50
  }
51
- const onTouchEnd = (e): void => {
51
+ const onTouchEnd = (e: TouchEvent): void => {
52
52
  const dx = e.changedTouches[0].clientX - touchStart.x
53
53
  const dy = e.changedTouches[0].clientY - touchStart.y
54
54
  if (Math.abs(dx) > Math.abs(dy) && Math.abs(dx) > 40) {
@@ -60,18 +60,27 @@ const onTouchEnd = (e): void => {
60
60
  }
61
61
  }
62
62
 
63
+ // external-link-icon
64
+ const enableExternalLinkIcon = computed(
65
+ () =>
66
+ frontmatter.value.externalLinkIcon ??
67
+ themeLocale.value.externalLinkIcon ??
68
+ true,
69
+ )
70
+
63
71
  // classes
64
72
  const containerClass = computed(() => [
65
73
  {
66
74
  'no-navbar': !shouldShowNavbar.value,
67
75
  'no-sidebar': !sidebarItems.value.length,
68
76
  'sidebar-open': isSidebarOpen.value,
77
+ 'external-link-icon': enableExternalLinkIcon.value,
69
78
  },
70
79
  frontmatter.value.pageClass,
71
80
  ])
72
81
 
73
82
  // close sidebar after navigation
74
- let unregisterRouterHook
83
+ let unregisterRouterHook: () => void
75
84
  onMounted(() => {
76
85
  const router = useRouter()
77
86
  unregisterRouterHook = router.afterEach(() => {
@@ -90,37 +99,38 @@ const onBeforeLeave = scrollPromise.pending
90
99
 
91
100
  <template>
92
101
  <div
93
- class="theme-container"
102
+ class="vp-theme-container"
94
103
  :class="containerClass"
104
+ vp-container
95
105
  @touchstart="onTouchStart"
96
106
  @touchend="onTouchEnd"
97
107
  >
98
108
  <slot name="navbar">
99
- <Navbar v-if="shouldShowNavbar" @toggle-sidebar="toggleSidebar">
109
+ <VPNavbar v-if="shouldShowNavbar" @toggle-sidebar="toggleSidebar">
100
110
  <template #before>
101
111
  <slot name="navbar-before" />
102
112
  </template>
103
113
  <template #after>
104
114
  <slot name="navbar-after" />
105
115
  </template>
106
- </Navbar>
116
+ </VPNavbar>
107
117
  </slot>
108
118
 
109
- <div class="sidebar-mask" @click="toggleSidebar(false)" />
119
+ <div class="vp-sidebar-mask" @click="toggleSidebar(false)" />
110
120
 
111
121
  <slot name="sidebar">
112
- <Sidebar>
122
+ <VPSidebar>
113
123
  <template #top>
114
124
  <slot name="sidebar-top" />
115
125
  </template>
116
126
  <template #bottom>
117
127
  <slot name="sidebar-bottom" />
118
128
  </template>
119
- </Sidebar>
129
+ </VPSidebar>
120
130
  </slot>
121
131
 
122
132
  <slot name="page">
123
- <Home v-if="frontmatter.home" />
133
+ <VPHome v-if="frontmatter.home" />
124
134
 
125
135
  <Transition
126
136
  v-else
@@ -129,7 +139,7 @@ const onBeforeLeave = scrollPromise.pending
129
139
  @before-enter="onBeforeEnter"
130
140
  @before-leave="onBeforeLeave"
131
141
  >
132
- <Page :key="page.path">
142
+ <VPPage :key="page.path">
133
143
  <template #top>
134
144
  <slot name="page-top" />
135
145
  </template>
@@ -142,8 +152,103 @@ const onBeforeLeave = scrollPromise.pending
142
152
  <template #bottom>
143
153
  <slot name="page-bottom" />
144
154
  </template>
145
- </Page>
155
+ </VPPage>
146
156
  </Transition>
147
157
  </slot>
148
158
  </div>
149
159
  </template>
160
+
161
+ <style lang="scss">
162
+ @import '../styles/variables';
163
+
164
+ .vp-sidebar-mask {
165
+ position: fixed;
166
+ top: 0;
167
+ left: 0;
168
+ z-index: 9;
169
+
170
+ display: none;
171
+
172
+ width: 100vw;
173
+ height: 100vh;
174
+ }
175
+
176
+ .vp-theme-container {
177
+ // navbar is disabled
178
+ &.no-navbar {
179
+ .vp-sidebar {
180
+ top: 0;
181
+
182
+ @media (max-width: $MQMobile) {
183
+ padding-top: 0;
184
+ }
185
+ }
186
+
187
+ .vp-page {
188
+ padding-top: 0;
189
+ }
190
+
191
+ // adjust heading margin and padding;
192
+ .theme-default-content {
193
+ h1,
194
+ h2,
195
+ h3,
196
+ h4,
197
+ h5,
198
+ h6 {
199
+ margin-top: 1.5rem;
200
+ padding-top: 0;
201
+ }
202
+ }
203
+ }
204
+
205
+ &.no-sidebar {
206
+ // hide sidebar
207
+ .vp-sidebar {
208
+ display: none;
209
+
210
+ // show sidebar on mobile because it has navbar links
211
+ @media (max-width: $MQMobile) {
212
+ display: block;
213
+ }
214
+ }
215
+
216
+ .vp-page {
217
+ padding-left: 0;
218
+ }
219
+ }
220
+
221
+ &.sidebar-open {
222
+ @media (max-width: $MQMobile) {
223
+ // show sidebar
224
+ .vp-sidebar {
225
+ transform: translateX(0);
226
+ }
227
+
228
+ // show sidebar mask
229
+ .vp-sidebar-mask {
230
+ display: block;
231
+ }
232
+ }
233
+ }
234
+ }
235
+
236
+ /**
237
+ * fade-slide-y transition
238
+ */
239
+ .fade-slide-y {
240
+ &-enter-active {
241
+ transition: all 0.2s ease;
242
+ }
243
+
244
+ &-leave-active {
245
+ transition: all 0.2s cubic-bezier(1, 0.5, 0.8, 1);
246
+ }
247
+
248
+ &-enter-from,
249
+ &-leave-to {
250
+ opacity: 0;
251
+ transform: translateY(10px);
252
+ }
253
+ }
254
+ </style>
@@ -1,6 +1,6 @@
1
1
  <script setup lang="ts">
2
- import { useRouteLocale } from 'vuepress/client'
3
- import { useThemeLocaleData } from '../composables/index.js'
2
+ import { useThemeLocaleData } from '@theme/useThemeData'
3
+ import { RouteLink, useRouteLocale } from 'vuepress/client'
4
4
 
5
5
  const routeLocale = useRouteLocale()
6
6
  const themeLocale = useThemeLocaleData()
@@ -13,15 +13,27 @@ const homeText = themeLocale.value.backToHome ?? 'Back to home'
13
13
  </script>
14
14
 
15
15
  <template>
16
- <div class="theme-container">
16
+ <div class="vp-theme-container" vp-container>
17
17
  <main class="page">
18
- <div class="theme-default-content">
18
+ <div class="theme-default-content" vp-content>
19
19
  <h1>404</h1>
20
20
 
21
21
  <blockquote>{{ getMsg() }}</blockquote>
22
22
 
23
- <RouterLink :to="homeLink">{{ homeText }}</RouterLink>
23
+ <RouteLink :to="homeLink">{{ homeText }}</RouteLink>
24
24
  </div>
25
25
  </main>
26
26
  </div>
27
27
  </template>
28
+
29
+ <style scoped lang="scss">
30
+ .vp-theme-container {
31
+ max-width: 740px;
32
+ margin: 0 auto;
33
+ padding: 2rem 2.5rem;
34
+
35
+ @media (max-width: 959px) {
36
+ padding: 2rem;
37
+ }
38
+ }
39
+ </style>
@@ -1,10 +1,19 @@
1
1
  declare module '*.vue' {
2
2
  import type { ComponentOptions } from 'vue'
3
+
3
4
  const comp: ComponentOptions
4
5
  export default comp
5
6
  }
6
7
 
7
- declare module '*.module.scss?module' {
8
- const cssVars: Record<string, string>
9
- export default cssVars
8
+ declare module '*.css' {
9
+ export {}
10
+ }
11
+
12
+ declare module '*/styles/_variables.module.scss' {
13
+ const cSSVariables: Record<string, string>
14
+ export default cSSVariables
15
+ }
16
+
17
+ declare module '*.scss' {
18
+ export {}
10
19
  }