@vuepress/theme-default 2.0.0-rc.1 → 2.0.0-rc.101

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 (147) 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/VPNavbarBrand.vue +89 -0
  13. package/lib/client/components/VPNavbarDropdown.vue +330 -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 +189 -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 +84 -18
  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 +0 -1
  29. package/lib/client/composables/useDarkMode.js +19 -16
  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 +55 -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 -21
  48. package/lib/client/composables/useSidebarItems.js +97 -84
  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 +11 -22
  53. package/lib/client/index.d.ts +2 -1
  54. package/lib/client/index.js +0 -1
  55. package/lib/client/layouts/Layout.vue +128 -56
  56. package/lib/client/layouts/NotFound.vue +25 -11
  57. package/lib/client/shim.d.ts +6 -5
  58. package/lib/client/styles/_mixins.scss +4 -4
  59. package/lib/client/styles/_variables.module.scss +1 -1
  60. package/lib/client/styles/_variables.scss +2 -1
  61. package/lib/client/styles/arrow.scss +24 -22
  62. package/lib/client/styles/code-group.scss +34 -30
  63. package/lib/client/styles/content/code.scss +23 -0
  64. package/lib/client/styles/content/index.scss +3 -0
  65. package/lib/client/styles/content/normalize.scss +39 -0
  66. package/lib/client/styles/{toc.scss → content/toc.scss} +1 -1
  67. package/lib/client/styles/external-link-icon.scss +36 -0
  68. package/lib/client/styles/index.scss +3 -13
  69. package/lib/client/styles/layout.scss +5 -197
  70. package/lib/client/styles/normalize.scss +1 -193
  71. package/lib/client/styles/plugins.scss +28 -0
  72. package/lib/client/styles/vars-dark.scss +20 -58
  73. package/lib/client/styles/vars.scss +54 -129
  74. package/lib/client/typings.d.ts +13 -0
  75. package/lib/client/typings.js +1 -0
  76. package/lib/client/utils/index.d.ts +2 -2
  77. package/lib/client/utils/index.js +2 -2
  78. package/lib/client/utils/isActiveSidebarItem.d.ts +3 -3
  79. package/lib/client/utils/isActiveSidebarItem.js +1 -1
  80. package/lib/client/utils/resolveAutoLink.d.ts +9 -0
  81. package/lib/client/utils/resolveAutoLink.js +17 -0
  82. package/lib/client/utils/resolveEditLink.d.ts +3 -3
  83. package/lib/client/utils/resolveEditLink.js +3 -3
  84. package/lib/client/utils/resolvePrefix.d.ts +1 -0
  85. package/lib/client/utils/resolvePrefix.js +4 -0
  86. package/lib/client/utils/resolveRepoType.d.ts +1 -1
  87. package/lib/client/utils/resolveRepoType.js +4 -4
  88. package/lib/node/defaultTheme.d.ts +7 -2
  89. package/lib/node/defaultTheme.js +82 -59
  90. package/lib/node/index.d.ts +2 -3
  91. package/lib/node/index.js +0 -3
  92. package/lib/node/typings.d.ts +59 -0
  93. package/lib/node/typings.js +1 -0
  94. package/lib/node/utils/assignDefaultLocaleOptions.js +3 -8
  95. package/lib/node/utils/index.d.ts +1 -1
  96. package/lib/node/utils/index.js +1 -1
  97. package/lib/node/utils/resolveMarkdownHintLocales.d.ts +9 -0
  98. package/lib/node/utils/resolveMarkdownHintLocales.js +19 -0
  99. package/lib/shared/index.d.ts +5 -3
  100. package/lib/shared/index.js +1 -3
  101. package/lib/shared/nav.d.ts +19 -29
  102. package/lib/shared/navbar.d.ts +21 -0
  103. package/lib/shared/navbar.js +1 -0
  104. package/lib/shared/options.d.ts +48 -47
  105. package/lib/shared/page.d.ts +9 -6
  106. package/lib/shared/sidebar.d.ts +26 -0
  107. package/lib/shared/sidebar.js +1 -0
  108. package/package.json +32 -25
  109. package/templates/build.html +23 -14
  110. package/lib/client/components/AutoLink.vue +0 -113
  111. package/lib/client/components/DropdownTransition.vue +0 -25
  112. package/lib/client/components/Home.vue +0 -15
  113. package/lib/client/components/HomeContent.vue +0 -5
  114. package/lib/client/components/HomeFeatures.vue +0 -22
  115. package/lib/client/components/HomeFooter.vue +0 -17
  116. package/lib/client/components/HomeHero.vue +0 -97
  117. package/lib/client/components/Navbar.vue +0 -79
  118. package/lib/client/components/NavbarBrand.vue +0 -55
  119. package/lib/client/components/NavbarDropdown.vue +0 -126
  120. package/lib/client/components/NavbarItems.vue +0 -194
  121. package/lib/client/components/Page.vue +0 -31
  122. package/lib/client/components/PageMeta.vue +0 -124
  123. package/lib/client/components/PageNav.vue +0 -113
  124. package/lib/client/components/Sidebar.vue +0 -18
  125. package/lib/client/components/SidebarItem.vue +0 -87
  126. package/lib/client/components/ToggleColorModeButton.vue +0 -57
  127. package/lib/client/components/ToggleSidebarButton.vue +0 -24
  128. package/lib/client/components/global/CodeGroup.d.ts +0 -6
  129. package/lib/client/components/global/CodeGroup.js +0 -120
  130. package/lib/client/components/global/CodeGroupItem.vue +0 -27
  131. package/lib/client/composables/useThemeData.d.ts +0 -4
  132. package/lib/client/composables/useThemeData.js +0 -3
  133. package/lib/client/styles/badge.scss +0 -36
  134. package/lib/client/styles/code.scss +0 -263
  135. package/lib/client/styles/custom-container.scss +0 -142
  136. package/lib/client/styles/home.scss +0 -168
  137. package/lib/client/styles/navbar-dropdown.scss +0 -183
  138. package/lib/client/styles/navbar.scss +0 -197
  139. package/lib/client/styles/page.scss +0 -87
  140. package/lib/client/styles/sidebar.scss +0 -134
  141. package/lib/client/styles/transitions.scss +0 -22
  142. package/lib/client/utils/getNavLink.d.ts +0 -15
  143. package/lib/client/utils/getNavLink.js +0 -18
  144. package/lib/client/utils/getResolveRouteWithRedirect.d.ts +0 -5
  145. package/lib/client/utils/getResolveRouteWithRedirect.js +0 -22
  146. package/lib/node/utils/resolveContainerPluginOptions.d.ts +0 -8
  147. package/lib/node/utils/resolveContainerPluginOptions.js +0 -17
@@ -0,0 +1,26 @@
1
+ import type { AutoLinkOptions, NavItemOptions } from './nav.js';
2
+ export type SidebarLinkOptions = AutoLinkOptions;
3
+ export interface SidebarGroupOptions extends NavItemOptions {
4
+ /**
5
+ * Link prefix of current group
6
+ */
7
+ prefix?: string;
8
+ /**
9
+ * Link of current group
10
+ */
11
+ link?: string;
12
+ /**
13
+ * Whether current group is collapsible
14
+ *
15
+ * @default false
16
+ */
17
+ collapsible?: boolean;
18
+ /**
19
+ * Children of current group
20
+ */
21
+ children: SidebarItemOptions[];
22
+ }
23
+ export type SidebarItemOptions = SidebarGroupOptions | SidebarLinkOptions | string;
24
+ export type SidebarArrayOptions = SidebarItemOptions[];
25
+ export type SidebarObjectOptions = Record<string, SidebarArrayOptions | 'heading' | false>;
26
+ export type SidebarOptions = SidebarArrayOptions | SidebarObjectOptions | 'heading';
@@ -0,0 +1 @@
1
+ export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vuepress/theme-default",
3
- "version": "2.0.0-rc.1",
3
+ "version": "2.0.0-rc.101",
4
4
  "description": "Default theme of VuePress",
5
5
  "keywords": [
6
6
  "vuepress-theme",
@@ -8,13 +8,14 @@
8
8
  "theme",
9
9
  "default"
10
10
  ],
11
- "homepage": "https://github.com/vuepress",
11
+ "homepage": "https://ecosystem.vuejs.press/themes/default/",
12
12
  "bugs": {
13
13
  "url": "https://github.com/vuepress/ecosystem/issues"
14
14
  },
15
15
  "repository": {
16
16
  "type": "git",
17
- "url": "git+https://github.com/vuepress/ecosystem.git"
17
+ "url": "git+https://github.com/vuepress/ecosystem.git",
18
+ "directory": "themes/theme-default"
18
19
  },
19
20
  "license": "MIT",
20
21
  "author": "meteorlxy",
@@ -35,32 +36,38 @@
35
36
  "lib",
36
37
  "templates"
37
38
  ],
38
- "scripts": {
39
- "build": "tsc -b tsconfig.build.json",
40
- "clean": "rimraf lib *.tsbuildinfo",
41
- "copy": "cpx \"src/**/*.{d.ts,vue,scss}\" lib"
42
- },
43
39
  "dependencies": {
44
- "@vuepress/plugin-active-header-links": "2.0.0-rc.1",
45
- "@vuepress/plugin-back-to-top": "2.0.0-rc.1",
46
- "@vuepress/plugin-container": "2.0.0-rc.1",
47
- "@vuepress/plugin-external-link-icon": "2.0.0-rc.1",
48
- "@vuepress/plugin-git": "2.0.0-rc.1",
49
- "@vuepress/plugin-medium-zoom": "2.0.0-rc.1",
50
- "@vuepress/plugin-nprogress": "2.0.0-rc.1",
51
- "@vuepress/plugin-palette": "2.0.0-rc.1",
52
- "@vuepress/plugin-prismjs": "2.0.0-rc.1",
53
- "@vuepress/plugin-theme-data": "2.0.0-rc.1",
54
- "@vueuse/core": "^10.7.2",
55
- "sass": "^1.70.0",
56
- "vue": "^3.4.15",
57
- "vue-router": "^4.2.5"
40
+ "@vuepress/helper": "2.0.0-rc.99",
41
+ "@vuepress/plugin-active-header-links": "2.0.0-rc.98",
42
+ "@vuepress/plugin-back-to-top": "2.0.0-rc.99",
43
+ "@vuepress/plugin-copy-code": "2.0.0-rc.99",
44
+ "@vuepress/plugin-git": "2.0.0-rc.99",
45
+ "@vuepress/plugin-links-check": "2.0.0-rc.99",
46
+ "@vuepress/plugin-markdown-hint": "2.0.0-rc.101",
47
+ "@vuepress/plugin-markdown-tab": "2.0.0-rc.101",
48
+ "@vuepress/plugin-medium-zoom": "2.0.0-rc.99",
49
+ "@vuepress/plugin-nprogress": "2.0.0-rc.99",
50
+ "@vuepress/plugin-palette": "2.0.0-rc.99",
51
+ "@vuepress/plugin-prismjs": "2.0.0-rc.99",
52
+ "@vuepress/plugin-seo": "2.0.0-rc.99",
53
+ "@vuepress/plugin-sitemap": "2.0.0-rc.99",
54
+ "@vuepress/plugin-theme-data": "2.0.0-rc.99",
55
+ "@vueuse/core": "^13.1.0",
56
+ "vue": "^3.5.13"
58
57
  },
59
58
  "peerDependencies": {
60
- "sass-loader": "^14.0.0",
61
- "vuepress": "2.0.0-rc.2"
59
+ "sass": "^1.86.3",
60
+ "sass-embedded": "^1.86.3",
61
+ "sass-loader": "^16.0.5",
62
+ "vuepress": "2.0.0-rc.22"
62
63
  },
63
64
  "peerDependenciesMeta": {
65
+ "sass": {
66
+ "optional": true
67
+ },
68
+ "sass-embedded": {
69
+ "optional": true
70
+ },
64
71
  "sass-loader": {
65
72
  "optional": true
66
73
  }
@@ -68,5 +75,5 @@
68
75
  "publishConfig": {
69
76
  "access": "public"
70
77
  },
71
- "gitHead": "1de7fea6963c3dd6c89df21eca4accc2d31204a4"
78
+ "gitHead": "3c7d17254125d130de55b13f7dca6ff574a17a4a"
72
79
  }
@@ -1,26 +1,35 @@
1
- <!DOCTYPE html>
1
+ <!doctype html>
2
2
  <html lang="{{ lang }}">
3
3
  <head>
4
- <meta charset="utf-8">
5
- <meta name="viewport" content="width=device-width,initial-scale=1">
6
- <meta name="generator" content="VuePress {{ version }}">
4
+ <meta charset="utf-8" />
5
+ <meta name="viewport" content="width=device-width,initial-scale=1" />
6
+ <meta name="generator" content="VuePress {{ version }}" />
7
7
  <style>
8
8
  :root {
9
- --c-bg: #fff;
9
+ --vp-c-bg: #fff;
10
10
  }
11
- html.dark {
12
- --c-bg: #22272e;
11
+
12
+ [data-theme='dark'] {
13
+ --vp-c-bg: #1b1b1f;
13
14
  }
14
- html, body {
15
- background-color: var(--c-bg);
15
+
16
+ html,
17
+ body {
18
+ background-color: var(--vp-c-bg);
16
19
  }
17
20
  </style>
18
21
  <script>
19
- const userMode = localStorage.getItem('vuepress-color-scheme');
20
- const systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;
21
- if (userMode === 'dark' || (userMode !== 'light' && systemDarkMode)) {
22
- document.documentElement.classList.toggle('dark', true);
23
- }
22
+ const useChoice = localStorage.getItem('vuepress-color-scheme')
23
+ const systemStatus =
24
+ 'matchMedia' in window
25
+ ? window.matchMedia('(prefers-color-scheme: dark)').matches
26
+ : false
27
+
28
+ if (useChoice === 'light') {
29
+ document.documentElement.dataset.theme = 'light'
30
+ } else if (useChoice === 'dark' || systemStatus) {
31
+ document.documentElement.dataset.theme = 'dark'
32
+ }
24
33
  </script>
25
34
  <!--vuepress-ssr-head-->
26
35
  <!--vuepress-ssr-styles-->
@@ -1,113 +0,0 @@
1
- <script setup lang="ts">
2
- import { computed, toRefs } from 'vue'
3
- import type { PropType } from 'vue'
4
- import { useRoute } from 'vue-router'
5
- import { useSiteData } from 'vuepress/client'
6
- import { isLinkHttp, isLinkWithProtocol } from 'vuepress/shared'
7
- import type { NavLink } from '../../shared/index.js'
8
-
9
- defineOptions({
10
- inheritAttrs: false,
11
- })
12
-
13
- const props = defineProps({
14
- item: {
15
- type: Object as PropType<NavLink>,
16
- required: true,
17
- },
18
- })
19
-
20
- defineSlots<{
21
- before?: (props: Record<never, never>) => any
22
- after?: (props: Record<never, never>) => any
23
- }>()
24
-
25
- const route = useRoute()
26
- const site = useSiteData()
27
- const { item } = toRefs(props)
28
-
29
- // if the link has http protocol
30
- const hasHttpProtocol = computed(() => isLinkHttp(item.value.link))
31
- // if the link has non-http protocol
32
- const hasNonHttpProtocol = computed(
33
- () => !hasHttpProtocol.value && isLinkWithProtocol(item.value.link),
34
- )
35
- // resolve the `target` attr
36
- const linkTarget = computed(() => {
37
- if (hasNonHttpProtocol.value) return undefined
38
- if (item.value.target) return item.value.target
39
- if (hasHttpProtocol.value) return '_blank'
40
- return undefined
41
- })
42
- // if the `target` attr is '_blank'
43
- const isBlankTarget = computed(() => linkTarget.value === '_blank')
44
- // is `<RouterLink>` or not
45
- const isRouterLink = computed(
46
- () =>
47
- !hasHttpProtocol.value && !hasNonHttpProtocol.value && !isBlankTarget.value,
48
- )
49
- // resolve the `rel` attr
50
- const linkRel = computed(() => {
51
- if (hasNonHttpProtocol.value) return undefined
52
- if (item.value.rel) return item.value.rel
53
- if (isBlankTarget.value) return 'noopener noreferrer'
54
- return undefined
55
- })
56
- // resolve the `aria-label` attr
57
- const linkAriaLabel = computed(() => item.value.ariaLabel || item.value.text)
58
-
59
- // should be active when current route is a subpath of this link
60
- const shouldBeActiveInSubpath = computed(() => {
61
- const localeKeys = Object.keys(site.value.locales)
62
- if (localeKeys.length) {
63
- return !localeKeys.some((key) => key === item.value.link)
64
- }
65
- return item.value.link !== '/'
66
- })
67
- // if this link is active in subpath
68
- const isActiveInSubpath = computed(() => {
69
- if (!shouldBeActiveInSubpath.value) {
70
- return false
71
- }
72
- return route.path.startsWith(item.value.link)
73
- })
74
-
75
- // if this link is active
76
- const isActive = computed(() => {
77
- if (!isRouterLink.value) {
78
- return false
79
- }
80
- if (item.value.activeMatch) {
81
- return new RegExp(item.value.activeMatch).test(route.path)
82
- }
83
- return isActiveInSubpath.value
84
- })
85
- </script>
86
-
87
- <template>
88
- <RouterLink
89
- v-if="isRouterLink"
90
- :class="{ 'router-link-active': isActive }"
91
- :to="item.link"
92
- :aria-label="linkAriaLabel"
93
- v-bind="$attrs"
94
- >
95
- <slot name="before" />
96
- {{ item.text }}
97
- <slot name="after" />
98
- </RouterLink>
99
- <a
100
- v-else
101
- class="external-link"
102
- :href="item.link"
103
- :rel="linkRel"
104
- :target="linkTarget"
105
- :aria-label="linkAriaLabel"
106
- v-bind="$attrs"
107
- >
108
- <slot name="before" />
109
- {{ item.text }}
110
- <AutoLinkExternalIcon v-if="isBlankTarget" />
111
- <slot name="after" />
112
- </a>
113
- </template>
@@ -1,25 +0,0 @@
1
- <script setup lang="ts">
2
- defineSlots<{
3
- default?: (props: Record<never, never>) => any
4
- }>()
5
-
6
- const setHeight = (items): void => {
7
- // explicitly set height so that it can be transitioned
8
- items.style.height = items.scrollHeight + 'px'
9
- }
10
-
11
- const unsetHeight = (items): void => {
12
- items.style.height = ''
13
- }
14
- </script>
15
-
16
- <template>
17
- <Transition
18
- name="dropdown"
19
- @enter="setHeight"
20
- @after-enter="unsetHeight"
21
- @before-leave="setHeight"
22
- >
23
- <slot />
24
- </Transition>
25
- </template>
@@ -1,15 +0,0 @@
1
- <script setup lang="ts">
2
- import HomeContent from '@theme/HomeContent.vue'
3
- import HomeFeatures from '@theme/HomeFeatures.vue'
4
- import HomeFooter from '@theme/HomeFooter.vue'
5
- import HomeHero from '@theme/HomeHero.vue'
6
- </script>
7
-
8
- <template>
9
- <main class="home">
10
- <HomeHero />
11
- <HomeFeatures />
12
- <HomeContent />
13
- <HomeFooter />
14
- </main>
15
- </template>
@@ -1,5 +0,0 @@
1
- <template>
2
- <div class="theme-default-content">
3
- <Content />
4
- </div>
5
- </template>
@@ -1,22 +0,0 @@
1
- <script setup lang="ts">
2
- import { computed } from 'vue'
3
- import { usePageFrontmatter } from 'vuepress/client'
4
- import type { DefaultThemeHomePageFrontmatter } from '../../shared/index.js'
5
-
6
- const frontmatter = usePageFrontmatter<DefaultThemeHomePageFrontmatter>()
7
- const features = computed(() => {
8
- if (Array.isArray(frontmatter.value.features)) {
9
- return frontmatter.value.features
10
- }
11
- return []
12
- })
13
- </script>
14
-
15
- <template>
16
- <div v-if="features.length" class="features">
17
- <div v-for="feature in features" :key="feature.title" class="feature">
18
- <h2>{{ feature.title }}</h2>
19
- <p>{{ feature.details }}</p>
20
- </div>
21
- </div>
22
- </template>
@@ -1,17 +0,0 @@
1
- <script setup lang="ts">
2
- import { computed } from 'vue'
3
- import { usePageFrontmatter } from 'vuepress/client'
4
- import type { DefaultThemeHomePageFrontmatter } from '../../shared/index.js'
5
-
6
- const frontmatter = usePageFrontmatter<DefaultThemeHomePageFrontmatter>()
7
- const footer = computed(() => frontmatter.value.footer)
8
- const footerHtml = computed(() => frontmatter.value.footerHtml)
9
- </script>
10
-
11
- <template>
12
- <template v-if="footer">
13
- <!-- eslint-disable-next-line vue/no-v-html -->
14
- <div v-if="footerHtml" class="footer" v-html="footer" />
15
- <div v-else class="footer" v-text="footer" />
16
- </template>
17
- </template>
@@ -1,97 +0,0 @@
1
- <script setup lang="ts">
2
- import AutoLink from '@theme/AutoLink.vue'
3
- import type { FunctionalComponent } from 'vue'
4
- import { computed, h } from 'vue'
5
- import {
6
- ClientOnly,
7
- usePageFrontmatter,
8
- useSiteLocaleData,
9
- withBase,
10
- } from 'vuepress/client'
11
- import type { DefaultThemeHomePageFrontmatter } from '../../shared/index.js'
12
- import { useDarkMode } from '../composables/index.js'
13
-
14
- const frontmatter = usePageFrontmatter<DefaultThemeHomePageFrontmatter>()
15
- const siteLocale = useSiteLocaleData()
16
- const isDarkMode = useDarkMode()
17
-
18
- const heroImage = computed(() => {
19
- if (isDarkMode.value && frontmatter.value.heroImageDark !== undefined) {
20
- return frontmatter.value.heroImageDark
21
- }
22
- return frontmatter.value.heroImage
23
- })
24
- const heroAlt = computed(
25
- () => frontmatter.value.heroAlt || heroText.value || 'hero',
26
- )
27
- const heroHeight = computed(() => frontmatter.value.heroHeight || 280)
28
-
29
- const heroText = computed(() => {
30
- if (frontmatter.value.heroText === null) {
31
- return null
32
- }
33
- return frontmatter.value.heroText || siteLocale.value.title || 'Hello'
34
- })
35
-
36
- const tagline = computed(() => {
37
- if (frontmatter.value.tagline === null) {
38
- return null
39
- }
40
- return (
41
- frontmatter.value.tagline ||
42
- siteLocale.value.description ||
43
- 'Welcome to your VuePress site'
44
- )
45
- })
46
-
47
- const actions = computed(() => {
48
- if (!Array.isArray(frontmatter.value.actions)) {
49
- return []
50
- }
51
-
52
- return frontmatter.value.actions.map(({ text, link, type = 'primary' }) => ({
53
- text,
54
- link,
55
- type,
56
- }))
57
- })
58
-
59
- const HomeHeroImage: FunctionalComponent = () => {
60
- if (!heroImage.value) return null
61
- const img = h('img', {
62
- src: withBase(heroImage.value),
63
- alt: heroAlt.value,
64
- height: heroHeight.value,
65
- })
66
- if (frontmatter.value.heroImageDark === undefined) {
67
- return img
68
- }
69
- // wrap hero image with <ClientOnly> to avoid ssr-mismatch
70
- // when using a different hero image in dark mode
71
- return h(ClientOnly, () => img)
72
- }
73
- </script>
74
-
75
- <template>
76
- <header class="hero">
77
- <HomeHeroImage />
78
-
79
- <h1 v-if="heroText" id="main-title">
80
- {{ heroText }}
81
- </h1>
82
-
83
- <p v-if="tagline" class="description">
84
- {{ tagline }}
85
- </p>
86
-
87
- <p v-if="actions.length" class="actions">
88
- <AutoLink
89
- v-for="action in actions"
90
- :key="action.text"
91
- class="action-button"
92
- :class="[action.type]"
93
- :item="action"
94
- />
95
- </p>
96
- </header>
97
- </template>
@@ -1,79 +0,0 @@
1
- <script setup lang="ts">
2
- import NavbarBrand from '@theme/NavbarBrand.vue'
3
- import NavbarItems from '@theme/NavbarItems.vue'
4
- import ToggleColorModeButton from '@theme/ToggleColorModeButton.vue'
5
- import ToggleSidebarButton from '@theme/ToggleSidebarButton.vue'
6
- import { computed, ref } from 'vue'
7
- import {
8
- DeviceType,
9
- useThemeLocaleData,
10
- useUpdateDeviceStatus,
11
- } from '../composables/index.js'
12
-
13
- defineEmits<(e: 'toggle-sidebar') => void>()
14
-
15
- defineSlots<{
16
- before?: (props: Record<never, never>) => any
17
- after?: (props: Record<never, never>) => any
18
- }>()
19
-
20
- const themeLocale = useThemeLocaleData()
21
-
22
- const navbar = ref<HTMLElement | null>(null)
23
- const navbarBrand = ref<HTMLElement | null>(null)
24
-
25
- const linksWrapperMaxWidth = ref(0)
26
- const linksWrapperStyle = computed(() => {
27
- if (!linksWrapperMaxWidth.value) {
28
- return {}
29
- }
30
- return {
31
- maxWidth: linksWrapperMaxWidth.value + 'px',
32
- }
33
- })
34
-
35
- useUpdateDeviceStatus(
36
- DeviceType.MOBILE,
37
- (mobileDesktopBreakpoint: number): void => {
38
- // avoid overlapping of long title and long navbar links
39
- const navbarHorizontalPadding =
40
- getCssValue(navbar.value, 'paddingLeft') +
41
- getCssValue(navbar.value, 'paddingRight')
42
- if (window.innerWidth < mobileDesktopBreakpoint) {
43
- linksWrapperMaxWidth.value = 0
44
- } else {
45
- linksWrapperMaxWidth.value =
46
- navbar.value!.offsetWidth -
47
- navbarHorizontalPadding -
48
- (navbarBrand.value?.offsetWidth || 0)
49
- }
50
- },
51
- )
52
-
53
- function getCssValue(el: HTMLElement | null, property: string): number {
54
- // NOTE: Known bug, will return 'auto' if style value is 'auto'
55
- const val = el?.ownerDocument?.defaultView?.getComputedStyle(el, null)?.[
56
- property
57
- ]
58
- const num = Number.parseInt(val, 10)
59
- return Number.isNaN(num) ? 0 : num
60
- }
61
- </script>
62
-
63
- <template>
64
- <header ref="navbar" class="navbar">
65
- <ToggleSidebarButton @toggle="$emit('toggle-sidebar')" />
66
-
67
- <span ref="navbarBrand">
68
- <NavbarBrand />
69
- </span>
70
-
71
- <div class="navbar-items-wrapper" :style="linksWrapperStyle">
72
- <slot name="before" />
73
- <NavbarItems class="can-hide" />
74
- <slot name="after" />
75
- <ToggleColorModeButton v-if="themeLocale.colorModeSwitch" />
76
- <NavbarSearch />
77
- </div>
78
- </header>
79
- </template>
@@ -1,55 +0,0 @@
1
- <script setup lang="ts">
2
- import { computed, h } from 'vue'
3
- import type { FunctionalComponent } from 'vue'
4
- import {
5
- ClientOnly,
6
- useRouteLocale,
7
- useSiteLocaleData,
8
- withBase,
9
- } from 'vuepress/client'
10
- import { useDarkMode, useThemeLocaleData } from '../composables/index.js'
11
-
12
- const routeLocale = useRouteLocale()
13
- const siteLocale = useSiteLocaleData()
14
- const themeLocale = useThemeLocaleData()
15
- const isDarkMode = useDarkMode()
16
-
17
- const navbarBrandLink = computed(
18
- () => themeLocale.value.home || routeLocale.value,
19
- )
20
- const navbarBrandTitle = computed(() => siteLocale.value.title)
21
- const navbarBrandLogo = computed(() => {
22
- if (isDarkMode.value && themeLocale.value.logoDark !== undefined) {
23
- return themeLocale.value.logoDark
24
- }
25
- return themeLocale.value.logo
26
- })
27
- const NavbarBrandLogo: FunctionalComponent = () => {
28
- if (!navbarBrandLogo.value) return null
29
- const img = h('img', {
30
- class: 'logo',
31
- src: withBase(navbarBrandLogo.value),
32
- alt: '',
33
- })
34
- if (themeLocale.value.logoDark === undefined) {
35
- return img
36
- }
37
- // wrap brand logo with <ClientOnly> to avoid ssr-mismatch
38
- // when using a different brand logo in dark mode
39
- return h(ClientOnly, () => img)
40
- }
41
- </script>
42
-
43
- <template>
44
- <RouterLink :to="navbarBrandLink">
45
- <NavbarBrandLogo />
46
-
47
- <span
48
- v-if="navbarBrandTitle"
49
- class="site-name"
50
- :class="{ 'can-hide': navbarBrandLogo }"
51
- >
52
- {{ navbarBrandTitle }}
53
- </span>
54
- </RouterLink>
55
- </template>