@vuepress/theme-default 2.0.0-rc.7 → 2.0.0-rc.71
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 +36 -0
- package/lib/client/components/VPEditIcon.vue +12 -0
- package/lib/client/components/VPHome.vue +38 -0
- package/lib/client/components/VPHomeFeatures.vue +66 -0
- package/lib/client/components/{HomeFooter.vue → VPHomeFooter.vue} +17 -2
- package/lib/client/components/VPHomeHero.vue +190 -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} +40 -7
- package/lib/client/components/VPNavbarDropdown.vue +335 -0
- package/lib/client/components/VPNavbarItems.vue +112 -0
- package/lib/client/components/VPPage.vue +69 -0
- package/lib/client/components/VPPageMeta.vue +134 -0
- package/lib/client/components/VPPageNav.vue +118 -0
- package/lib/client/components/VPSidebar.vue +113 -0
- package/lib/client/components/VPSidebarItem.vue +180 -0
- package/lib/client/components/{SidebarItems.vue → VPSidebarItems.vue} +28 -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 +8 -0
- package/lib/client/composables/index.js +8 -0
- package/lib/client/composables/useContributors.d.ts +3 -0
- package/lib/client/composables/useContributors.js +14 -0
- package/lib/client/composables/useDarkMode.d.ts +0 -1
- package/lib/client/composables/useDarkMode.js +18 -15
- package/lib/client/composables/useEditLink.d.ts +3 -0
- package/lib/client/composables/useEditLink.js +31 -0
- package/lib/client/composables/useHeaders.d.ts +9 -0
- package/lib/client/composables/useHeaders.js +37 -0
- package/lib/client/composables/useLastUpdated.d.ts +2 -0
- package/lib/client/composables/useLastUpdated.js +17 -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 +59 -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 +91 -0
- package/lib/client/composables/useScrollPromise.js +3 -1
- package/lib/client/composables/useSidebarItems.d.ts +23 -22
- package/lib/client/composables/useSidebarItems.js +99 -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 +139 -34
- package/lib/client/layouts/NotFound.vue +17 -5
- 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 +3 -199
- 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 +49 -50
- 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 +14 -8
- 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/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,37 +1,38 @@
|
|
|
1
|
+
import type { MenuItem } from '@vuepress/helper/client';
|
|
1
2
|
import type { ComputedRef, InjectionKey } from 'vue';
|
|
2
|
-
import type {
|
|
3
|
-
import type {
|
|
4
|
-
import type {
|
|
5
|
-
export type SidebarItemsRef = ComputedRef<ResolvedSidebarItem[]>;
|
|
6
|
-
export declare const sidebarItemsSymbol: InjectionKey<SidebarItemsRef>;
|
|
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';
|
|
7
6
|
/**
|
|
8
|
-
*
|
|
7
|
+
* Util to transform page header to sidebar item
|
|
9
8
|
*/
|
|
10
|
-
export declare const
|
|
9
|
+
export declare const resolveSidebarHeaderItem: (header: MenuItem) => SidebarHeaderItem;
|
|
10
|
+
export declare const resolveSidebarHeaderItems: (headers?: MenuItem[]) => SidebarHeaderItem[];
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
12
|
+
* Resolve current page and its header to sidebar items if the config is `heading`
|
|
13
13
|
*/
|
|
14
|
-
export declare const
|
|
14
|
+
export declare const resolveSidebarHeadingItem: (page: PageData, headers: MenuItem[]) => SidebarItem[];
|
|
15
15
|
/**
|
|
16
|
-
* Resolve sidebar items
|
|
17
|
-
*
|
|
18
|
-
* It should only be resolved and provided once
|
|
16
|
+
* Resolve sidebar items if the config is an array
|
|
19
17
|
*/
|
|
20
|
-
export declare const
|
|
18
|
+
export declare const resolveArraySidebarItems: (sidebarConfig: SidebarArrayOptions, headers: MenuItem[], path: string, prefix?: string) => SidebarItem[];
|
|
21
19
|
/**
|
|
22
|
-
*
|
|
20
|
+
* Resolve sidebar items if the config is a key -> value (path-prefix -> array) object
|
|
23
21
|
*/
|
|
24
|
-
export declare const
|
|
25
|
-
export
|
|
22
|
+
export declare const resolveMultiSidebarItems: (sidebarConfig: SidebarObjectOptions, page: PageData, headers: MenuItem[], path: string) => SidebarItem[];
|
|
23
|
+
export type SidebarItemsRef = ComputedRef<SidebarItem[]>;
|
|
24
|
+
export declare const sidebarItemsSymbol: InjectionKey<SidebarItemsRef>;
|
|
26
25
|
/**
|
|
27
|
-
*
|
|
26
|
+
* Inject sidebar items global computed
|
|
28
27
|
*/
|
|
29
|
-
export declare const
|
|
28
|
+
export declare const useSidebarItems: () => SidebarItemsRef;
|
|
30
29
|
/**
|
|
31
|
-
* Resolve sidebar items
|
|
30
|
+
* Resolve sidebar items global computed
|
|
31
|
+
*
|
|
32
|
+
* It should only be resolved and provided once
|
|
32
33
|
*/
|
|
33
|
-
export declare const
|
|
34
|
+
export declare const resolveSidebarItems: (sidebarConfig: SidebarOptions | false, page: PageData, path: string, routeLocale: string, headers: MenuItem[]) => SidebarItem[];
|
|
34
35
|
/**
|
|
35
|
-
*
|
|
36
|
+
* Create sidebar items ref and provide as global computed in setup
|
|
36
37
|
*/
|
|
37
|
-
export declare const
|
|
38
|
+
export declare const setupSidebarItems: () => void;
|
|
@@ -1,118 +1,131 @@
|
|
|
1
|
+
import { resolveAutoLink } from '@theme/resolveAutoLink';
|
|
2
|
+
import { resolvePrefix } from '@theme/resolvePrefix';
|
|
3
|
+
import { useHeaders } from '@theme/useHeaders';
|
|
4
|
+
import { useThemeLocaleData } from '@theme/useThemeData';
|
|
5
|
+
import { isLinkRelative, keys, startsWith } from '@vuepress/helper/client';
|
|
1
6
|
import { computed, inject, provide } from 'vue';
|
|
2
|
-
import { useRoute,
|
|
3
|
-
import {
|
|
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 = () => {
|
|
22
|
-
const themeLocale = useThemeLocaleData();
|
|
23
|
-
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 [];
|
|
53
|
-
};
|
|
7
|
+
import { usePageData, usePageFrontmatter, useRoute, useRouteLocale, } from 'vuepress/client';
|
|
8
|
+
import { isPlainObject, isString } from 'vuepress/shared';
|
|
54
9
|
/**
|
|
55
10
|
* Util to transform page header to sidebar item
|
|
56
11
|
*/
|
|
57
|
-
export const
|
|
12
|
+
export const resolveSidebarHeaderItem = (header) => ({
|
|
58
13
|
text: header.title,
|
|
59
14
|
link: header.link,
|
|
60
|
-
|
|
15
|
+
// eslint-disable-next-line @typescript-eslint/no-use-before-define
|
|
16
|
+
children: resolveSidebarHeaderItems(header.children),
|
|
61
17
|
});
|
|
62
|
-
export const
|
|
63
|
-
? headers.map((header) => headerToSidebarItem(header, sidebarDepth - 1))
|
|
64
|
-
: [];
|
|
18
|
+
export const resolveSidebarHeaderItems = (headers) => headers ? headers.map((header) => resolveSidebarHeaderItem(header)) : [];
|
|
65
19
|
/**
|
|
66
|
-
* Resolve sidebar items if the config is `
|
|
20
|
+
* Resolve current page and its header to sidebar items if the config is `heading`
|
|
67
21
|
*/
|
|
68
|
-
export const
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
];
|
|
75
|
-
};
|
|
22
|
+
export const resolveSidebarHeadingItem = (page, headers) => [
|
|
23
|
+
{
|
|
24
|
+
text: page.title,
|
|
25
|
+
children: resolveSidebarHeaderItems(headers),
|
|
26
|
+
},
|
|
27
|
+
];
|
|
76
28
|
/**
|
|
77
29
|
* Resolve sidebar items if the config is an array
|
|
78
30
|
*/
|
|
79
|
-
export const resolveArraySidebarItems = (
|
|
80
|
-
const handleChildItem = (item) => {
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
31
|
+
export const resolveArraySidebarItems = (sidebarConfig, headers, path, prefix = '') => {
|
|
32
|
+
const handleChildItem = (item, pathPrefix) => {
|
|
33
|
+
const childItem = isString(item)
|
|
34
|
+
? resolveAutoLink(resolvePrefix(pathPrefix, item))
|
|
35
|
+
: isString(item.link)
|
|
36
|
+
? {
|
|
37
|
+
...item,
|
|
38
|
+
link: isLinkRelative(item.link)
|
|
39
|
+
? resolveAutoLink(resolvePrefix(pathPrefix, item.link)).link
|
|
40
|
+
: item.link,
|
|
41
|
+
}
|
|
42
|
+
: item;
|
|
43
|
+
if ('children' in childItem) {
|
|
89
44
|
return {
|
|
90
45
|
...childItem,
|
|
91
|
-
children: childItem.children.map((
|
|
46
|
+
children: childItem.children.map((child) => handleChildItem(child, resolvePrefix(pathPrefix, childItem.prefix))),
|
|
92
47
|
};
|
|
93
48
|
}
|
|
94
49
|
// if the sidebar item is current page and children is not set
|
|
95
50
|
// use headers of current page as children
|
|
96
51
|
if (childItem.link === path) {
|
|
97
52
|
// skip h1 header
|
|
98
|
-
const
|
|
53
|
+
const currentHeaders = headers[0]?.level === 1 ? headers[0].children : headers;
|
|
99
54
|
return {
|
|
100
55
|
...childItem,
|
|
101
|
-
children:
|
|
56
|
+
children: resolveSidebarHeaderItems(currentHeaders),
|
|
102
57
|
};
|
|
103
58
|
}
|
|
104
59
|
return childItem;
|
|
105
60
|
};
|
|
106
|
-
return sidebarConfig.map((item) => handleChildItem(item));
|
|
61
|
+
return sidebarConfig.map((item) => handleChildItem(item, prefix));
|
|
107
62
|
};
|
|
108
63
|
/**
|
|
109
64
|
* Resolve sidebar items if the config is a key -> value (path-prefix -> array) object
|
|
110
65
|
*/
|
|
111
|
-
export const resolveMultiSidebarItems = (page,
|
|
112
|
-
const
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
66
|
+
export const resolveMultiSidebarItems = (sidebarConfig, page, headers, path) => {
|
|
67
|
+
const sidebarRoutes = keys(sidebarConfig).sort((x, y) => y.length - x.length);
|
|
68
|
+
// Find matching config
|
|
69
|
+
for (const base of sidebarRoutes)
|
|
70
|
+
if (startsWith(decodeURI(path), base)) {
|
|
71
|
+
const matched = sidebarConfig[base];
|
|
72
|
+
return matched
|
|
73
|
+
? matched === 'heading'
|
|
74
|
+
? resolveSidebarHeadingItem(page, headers)
|
|
75
|
+
: resolveArraySidebarItems(matched, headers, path, base)
|
|
76
|
+
: [];
|
|
77
|
+
}
|
|
78
|
+
// eslint-disable-next-line no-console
|
|
79
|
+
console.warn(`${decodeURI(path)} is missing sidebar config.`);
|
|
80
|
+
return [];
|
|
81
|
+
};
|
|
82
|
+
export const sidebarItemsSymbol = Symbol('sidebarItems');
|
|
83
|
+
/**
|
|
84
|
+
* Inject sidebar items global computed
|
|
85
|
+
*/
|
|
86
|
+
export const useSidebarItems = () => {
|
|
87
|
+
const sidebarItems = inject(sidebarItemsSymbol);
|
|
88
|
+
if (!sidebarItems) {
|
|
89
|
+
throw new Error('useSidebarItems() is called without provider.');
|
|
90
|
+
}
|
|
91
|
+
return sidebarItems;
|
|
92
|
+
};
|
|
93
|
+
/**
|
|
94
|
+
* Resolve sidebar items global computed
|
|
95
|
+
*
|
|
96
|
+
* It should only be resolved and provided once
|
|
97
|
+
*/
|
|
98
|
+
export const resolveSidebarItems = (sidebarConfig, page, path, routeLocale, headers) => {
|
|
99
|
+
// resolve sidebar items according to the config
|
|
100
|
+
if (sidebarConfig === false) {
|
|
101
|
+
return [];
|
|
102
|
+
}
|
|
103
|
+
if (sidebarConfig === 'heading') {
|
|
104
|
+
return resolveSidebarHeadingItem(page, headers);
|
|
105
|
+
}
|
|
106
|
+
if (Array.isArray(sidebarConfig)) {
|
|
107
|
+
return resolveArraySidebarItems(sidebarConfig, headers, path, routeLocale);
|
|
108
|
+
}
|
|
109
|
+
if (isPlainObject(sidebarConfig)) {
|
|
110
|
+
return resolveMultiSidebarItems(sidebarConfig, page, headers, path);
|
|
116
111
|
}
|
|
117
|
-
return
|
|
112
|
+
return [];
|
|
113
|
+
};
|
|
114
|
+
/**
|
|
115
|
+
* Create sidebar items ref and provide as global computed in setup
|
|
116
|
+
*/
|
|
117
|
+
export const setupSidebarItems = () => {
|
|
118
|
+
const themeLocale = useThemeLocaleData();
|
|
119
|
+
const frontmatter = usePageFrontmatter();
|
|
120
|
+
const page = usePageData();
|
|
121
|
+
const route = useRoute();
|
|
122
|
+
const routeLocale = useRouteLocale();
|
|
123
|
+
const headers = useHeaders();
|
|
124
|
+
const sidebarConfig = computed(() => frontmatter.value.home
|
|
125
|
+
? false
|
|
126
|
+
: (frontmatter.value.sidebar ??
|
|
127
|
+
themeLocale.value.sidebar ??
|
|
128
|
+
'heading'));
|
|
129
|
+
const sidebarItems = computed(() => resolveSidebarItems(sidebarConfig.value, page.value, route.path, routeLocale.value, headers.value));
|
|
130
|
+
provide(sidebarItemsSymbol, sidebarItems);
|
|
118
131
|
};
|
|
@@ -1,11 +1,12 @@
|
|
|
1
|
+
import { useEventListener } from '@vueuse/core';
|
|
1
2
|
import { onMounted } from 'vue';
|
|
2
|
-
import
|
|
3
|
+
import cssVariables from '../styles/_variables.module.scss';
|
|
3
4
|
export var DeviceType;
|
|
4
5
|
(function (DeviceType) {
|
|
5
|
-
DeviceType["
|
|
6
|
+
DeviceType["Mobile"] = "mobile";
|
|
6
7
|
})(DeviceType || (DeviceType = {}));
|
|
7
8
|
const DeviceTypeMap = {
|
|
8
|
-
[DeviceType.
|
|
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
|
};
|
package/lib/client/config.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import
|
|
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;
|
package/lib/client/config.js
CHANGED
|
@@ -1,35 +1,19 @@
|
|
|
1
|
+
import { setupDarkMode } from '@theme/useDarkMode';
|
|
2
|
+
import { setupHeaders } from '@theme/useHeaders';
|
|
3
|
+
import { useScrollPromise } from '@theme/useScrollPromise';
|
|
4
|
+
import { setupSidebarItems } from '@theme/useSidebarItems';
|
|
1
5
|
import { hasGlobalComponent } from '@vuepress/helper/client';
|
|
2
|
-
import { h } from 'vue';
|
|
3
6
|
import { defineClientConfig } from 'vuepress/client';
|
|
4
|
-
import { Badge
|
|
5
|
-
import { setupDarkMode, setupSidebarItems, useScrollPromise, } from './composables/index.js';
|
|
7
|
+
import { Badge } from './components/global/index.js';
|
|
6
8
|
import Layout from './layouts/Layout.vue';
|
|
7
9
|
import NotFound from './layouts/NotFound.vue';
|
|
10
|
+
import '@vuepress/helper/colors.css';
|
|
11
|
+
import '@vuepress/helper/normalize.css';
|
|
8
12
|
import './styles/index.scss';
|
|
9
13
|
export default defineClientConfig({
|
|
10
14
|
enhance({ app, router }) {
|
|
11
15
|
if (!hasGlobalComponent('Badge'))
|
|
12
16
|
app.component('Badge', Badge);
|
|
13
|
-
if (!hasGlobalComponent('CodeGroup'))
|
|
14
|
-
app.component('CodeGroup', CodeGroup);
|
|
15
|
-
if (!hasGlobalComponent('CodeGroupItem'))
|
|
16
|
-
app.component('CodeGroupItem', CodeGroupItem);
|
|
17
|
-
// compat with @vuepress/plugin-external-link-icon
|
|
18
|
-
app.component('AutoLinkExternalIcon', () => {
|
|
19
|
-
const ExternalLinkIcon = app.component('ExternalLinkIcon');
|
|
20
|
-
if (ExternalLinkIcon) {
|
|
21
|
-
return h(ExternalLinkIcon);
|
|
22
|
-
}
|
|
23
|
-
return null;
|
|
24
|
-
});
|
|
25
|
-
// compat with @vuepress/plugin-docsearch and @vuepress/plugin-search
|
|
26
|
-
app.component('NavbarSearch', () => {
|
|
27
|
-
const SearchComponent = app.component('Docsearch') || app.component('SearchBox');
|
|
28
|
-
if (SearchComponent) {
|
|
29
|
-
return h(SearchComponent);
|
|
30
|
-
}
|
|
31
|
-
return null;
|
|
32
|
-
});
|
|
33
17
|
// handle scrollBehavior with transition
|
|
34
18
|
const scrollBehavior = router.options.scrollBehavior;
|
|
35
19
|
router.options.scrollBehavior = async (...args) => {
|
|
@@ -39,6 +23,7 @@ export default defineClientConfig({
|
|
|
39
23
|
},
|
|
40
24
|
setup() {
|
|
41
25
|
setupDarkMode();
|
|
26
|
+
setupHeaders();
|
|
42
27
|
setupSidebarItems();
|
|
43
28
|
},
|
|
44
29
|
layouts: {
|
package/lib/client/index.d.ts
CHANGED
package/lib/client/index.js
CHANGED
|
@@ -1,30 +1,30 @@
|
|
|
1
1
|
<script setup lang="ts">
|
|
2
|
-
import
|
|
3
|
-
import
|
|
4
|
-
import
|
|
5
|
-
import
|
|
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 '
|
|
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>) =>
|
|
18
|
-
'navbar-before'?: (props: Record<never, never>) =>
|
|
19
|
-
'navbar-after'?: (props: Record<never, never>) =>
|
|
20
|
-
'sidebar'?: (props: Record<never, never>) =>
|
|
21
|
-
'sidebar-top'?: (props: Record<never, never>) =>
|
|
22
|
-
'sidebar-bottom'?: (props: Record<never, never>) =>
|
|
23
|
-
'page'?: (props: Record<never, never>) =>
|
|
24
|
-
'page-top'?: (props: Record<never, never>) =>
|
|
25
|
-
'page-bottom'?: (props: Record<never, never>) =>
|
|
26
|
-
'page-content-top'?: (props: Record<never, never>) =>
|
|
27
|
-
'page-content-bottom'?: (
|
|
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
|
-
<
|
|
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
|
-
</
|
|
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
|
-
<
|
|
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
|
-
</
|
|
129
|
+
</VPSidebar>
|
|
120
130
|
</slot>
|
|
121
131
|
|
|
122
132
|
<slot name="page">
|
|
123
|
-
<
|
|
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
|
-
<
|
|
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
|
-
</
|
|
155
|
+
</VPPage>
|
|
146
156
|
</Transition>
|
|
147
157
|
</slot>
|
|
148
158
|
</div>
|
|
149
159
|
</template>
|
|
160
|
+
|
|
161
|
+
<style lang="scss">
|
|
162
|
+
@use '../styles/variables' as *;
|
|
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
|
+
[vp-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>
|