@vuepress/theme-default 2.0.0-rc.126 → 2.0.0-rc.127
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.
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useSidebarItems.js","names":["useData"],"sources":["../../../src/client/composables/useSidebarItems.ts"],"sourcesContent":["import { isLinkRelative, keys, startsWith } from '@vuepress/helper/client'\nimport type { ComputedRef, InjectionKey } from 'vue'\nimport { computed, inject, provide } from 'vue'\nimport type { PageData, PageHeader } from 'vuepress/client'\nimport { useRoutePath } from 'vuepress/client'\nimport { isPlainObject, isString } from 'vuepress/shared'\n\nimport { resolveAutoLink } from '@theme/resolveAutoLink'\nimport { resolvePrefix } from '@theme/resolvePrefix'\nimport { useData } from '@theme/useData'\nimport { useHeaders } from '@theme/useHeaders'\n\nimport type {\n DefaultThemeHomePageFrontmatter,\n DefaultThemeNormalPageFrontmatter,\n SidebarArrayOptions,\n SidebarItemOptions,\n SidebarObjectOptions,\n SidebarOptions,\n} from '../../shared/index.js'\nimport type { SidebarHeaderItem, SidebarItem } from '../typings.js'\n\n/**\n * Util to transform page header to sidebar item\n *\n * @param header page header\n * @returns sidebar item from header\n */\nexport const resolveSidebarPageHeader = (\n header: PageHeader,\n): SidebarHeaderItem => ({\n text: header.title,\n link: header.link,\n // oxlint-disable-next-line no-use-before-define\n children: resolveSidebarPageHeaders(header.children),\n})\n\n/**\n * get sidebar header items from page headers\n *\n * @param headers page headers\n * @returns sidebar header items\n */\nexport const resolveSidebarPageHeaders = (\n headers?: PageHeader[],\n): SidebarHeaderItem[] =>\n headers ? headers.map((header) => resolveSidebarPageHeader(header)) : []\n\n/**\n * Resolve current page and its header to sidebar items if the config is `heading`\n *\n * @param page current page data\n * @param headers current page headers\n *\n * @returns sidebar items\n */\nexport const resolveSidebarHeadingItem = (\n page: PageData,\n headers: PageHeader[],\n): SidebarItem[] => [\n {\n text: page.title,\n children: resolveSidebarPageHeaders(headers),\n },\n]\n\n/**\n * Resolve sidebar items if the config is an array\n *\n * @param sidebarConfig sidebar config array\n * @param headers current page headers\n * @param path current page path\n * @param prefix path prefix\n *\n * @returns resolved sidebar items\n */\nexport const resolveArraySidebarItems = (\n sidebarConfig: SidebarArrayOptions,\n headers: PageHeader[],\n path: string,\n prefix = '',\n): SidebarItem[] => {\n const handleChildItem = (\n item: SidebarItemOptions,\n pathPrefix: string,\n ): SidebarItem => {\n const childItem: SidebarItemOptions = isString(item)\n ? resolveAutoLink(resolvePrefix(pathPrefix, item))\n : isString(item.link)\n ? {\n ...item,\n link: isLinkRelative(item.link)\n ? resolveAutoLink(resolvePrefix(pathPrefix, item.link)).link\n : item.link,\n }\n : item\n\n if ('children' in childItem) {\n return {\n ...childItem,\n children: childItem.children.map((child) =>\n handleChildItem(child, resolvePrefix(pathPrefix, childItem.prefix)),\n ),\n }\n }\n\n // if the sidebar item is current page and children is not set\n // use headers of current page as children\n if (childItem.link === path) {\n // skip h1 header\n const currentHeaders =\n headers[0]?.level === 1 ? headers[0].children : headers\n\n return {\n ...childItem,\n children: resolveSidebarPageHeaders(currentHeaders),\n }\n }\n\n return childItem\n }\n\n return sidebarConfig.map((item) => handleChildItem(item, prefix))\n}\n\n/**\n * Resolve sidebar items if the config is a key -> value (path-prefix -> array) object\n *\n * @param sidebarConfig sidebar config object\n * @param page current page data\n * @param headers current page headers\n * @param path current page path\n *\n * @returns resolved sidebar items\n */\nexport const resolveMultiSidebarItems = (\n sidebarConfig: SidebarObjectOptions,\n page: PageData,\n headers: PageHeader[],\n path: string,\n): SidebarItem[] => {\n const sidebarRoutes = keys(sidebarConfig).sort((a, b) => b.length - a.length)\n\n // Find matching config\n for (const base of sidebarRoutes) {\n if (startsWith(decodeURI(path), base)) {\n const matched = sidebarConfig[base]\n\n return matched === false\n ? []\n : matched === 'heading'\n ? resolveSidebarHeadingItem(page, headers)\n : resolveArraySidebarItems(matched, headers, path, base)\n }\n }\n\n //
|
|
1
|
+
{"version":3,"file":"useSidebarItems.js","names":["useData"],"sources":["../../../src/client/composables/useSidebarItems.ts"],"sourcesContent":["import { isLinkRelative, keys, startsWith } from '@vuepress/helper/client'\nimport type { ComputedRef, InjectionKey } from 'vue'\nimport { computed, inject, provide } from 'vue'\nimport type { PageData, PageHeader } from 'vuepress/client'\nimport { useRoutePath } from 'vuepress/client'\nimport { isPlainObject, isString } from 'vuepress/shared'\n\nimport { resolveAutoLink } from '@theme/resolveAutoLink'\nimport { resolvePrefix } from '@theme/resolvePrefix'\nimport { useData } from '@theme/useData'\nimport { useHeaders } from '@theme/useHeaders'\n\nimport type {\n DefaultThemeHomePageFrontmatter,\n DefaultThemeNormalPageFrontmatter,\n SidebarArrayOptions,\n SidebarItemOptions,\n SidebarObjectOptions,\n SidebarOptions,\n} from '../../shared/index.js'\nimport type { SidebarHeaderItem, SidebarItem } from '../typings.js'\n\n/**\n * Util to transform page header to sidebar item\n *\n * @param header page header\n * @returns sidebar item from header\n */\nexport const resolveSidebarPageHeader = (\n header: PageHeader,\n): SidebarHeaderItem => ({\n text: header.title,\n link: header.link,\n // oxlint-disable-next-line no-use-before-define\n children: resolveSidebarPageHeaders(header.children),\n})\n\n/**\n * get sidebar header items from page headers\n *\n * @param headers page headers\n * @returns sidebar header items\n */\nexport const resolveSidebarPageHeaders = (\n headers?: PageHeader[],\n): SidebarHeaderItem[] =>\n headers ? headers.map((header) => resolveSidebarPageHeader(header)) : []\n\n/**\n * Resolve current page and its header to sidebar items if the config is `heading`\n *\n * @param page current page data\n * @param headers current page headers\n *\n * @returns sidebar items\n */\nexport const resolveSidebarHeadingItem = (\n page: PageData,\n headers: PageHeader[],\n): SidebarItem[] => [\n {\n text: page.title,\n children: resolveSidebarPageHeaders(headers),\n },\n]\n\n/**\n * Resolve sidebar items if the config is an array\n *\n * @param sidebarConfig sidebar config array\n * @param headers current page headers\n * @param path current page path\n * @param prefix path prefix\n *\n * @returns resolved sidebar items\n */\nexport const resolveArraySidebarItems = (\n sidebarConfig: SidebarArrayOptions,\n headers: PageHeader[],\n path: string,\n prefix = '',\n): SidebarItem[] => {\n const handleChildItem = (\n item: SidebarItemOptions,\n pathPrefix: string,\n ): SidebarItem => {\n const childItem: SidebarItemOptions = isString(item)\n ? resolveAutoLink(resolvePrefix(pathPrefix, item))\n : isString(item.link)\n ? {\n ...item,\n link: isLinkRelative(item.link)\n ? resolveAutoLink(resolvePrefix(pathPrefix, item.link)).link\n : item.link,\n }\n : item\n\n if ('children' in childItem) {\n return {\n ...childItem,\n children: childItem.children.map((child) =>\n handleChildItem(child, resolvePrefix(pathPrefix, childItem.prefix)),\n ),\n }\n }\n\n // if the sidebar item is current page and children is not set\n // use headers of current page as children\n if (childItem.link === path) {\n // skip h1 header\n const currentHeaders =\n headers[0]?.level === 1 ? headers[0].children : headers\n\n return {\n ...childItem,\n children: resolveSidebarPageHeaders(currentHeaders),\n }\n }\n\n return childItem\n }\n\n return sidebarConfig.map((item) => handleChildItem(item, prefix))\n}\n\n/**\n * Resolve sidebar items if the config is a key -> value (path-prefix -> array) object\n *\n * @param sidebarConfig sidebar config object\n * @param page current page data\n * @param headers current page headers\n * @param path current page path\n *\n * @returns resolved sidebar items\n */\nexport const resolveMultiSidebarItems = (\n sidebarConfig: SidebarObjectOptions,\n page: PageData,\n headers: PageHeader[],\n path: string,\n): SidebarItem[] => {\n const sidebarRoutes = keys(sidebarConfig).sort((a, b) => b.length - a.length)\n\n // Find matching config\n for (const base of sidebarRoutes) {\n if (startsWith(decodeURI(path), base)) {\n const matched = sidebarConfig[base]\n\n return matched === false\n ? []\n : matched === 'heading'\n ? resolveSidebarHeadingItem(page, headers)\n : resolveArraySidebarItems(matched, headers, path, base)\n }\n }\n\n // oxlint-disable-next-line no-console\n console.warn(`${decodeURI(path)} is missing sidebar config.`)\n\n return []\n}\n\nexport type SidebarItemsRef = ComputedRef<SidebarItem[]>\n\nexport const sidebarItemsSymbol: InjectionKey<SidebarItemsRef> =\n Symbol('sidebarItems')\n\n/**\n * Inject sidebar items global computed\n *\n * @returns sidebar items global computed\n */\nexport const useSidebarItems = (): SidebarItemsRef => {\n const sidebarItems = inject(sidebarItemsSymbol)\n if (!sidebarItems)\n throw new Error('useSidebarItems() is called without provider.')\n\n return sidebarItems\n}\n\n/**\n * Resolve sidebar items global computed\n *\n * It should only be resolved and provided once\n *\n * @param sidebarConfig sidebar config\n * @param page current page data\n * @param path current page path\n * @param routeLocale current route locale\n * @param headers current page headers\n *\n * @returns resolved sidebar items\n */\n\nexport const resolveSidebarItems = (\n sidebarConfig: SidebarOptions | false,\n page: PageData,\n path: string,\n routeLocale: string,\n headers: PageHeader[],\n): SidebarItem[] => {\n // resolve sidebar items according to the config\n if (sidebarConfig === false) return []\n\n if (sidebarConfig === 'heading')\n return resolveSidebarHeadingItem(page, headers)\n\n if (Array.isArray(sidebarConfig))\n return resolveArraySidebarItems(sidebarConfig, headers, path, routeLocale)\n\n if (isPlainObject(sidebarConfig))\n return resolveMultiSidebarItems(sidebarConfig, page, headers, path)\n\n return []\n}\n\n/**\n * Create sidebar items ref and provide as global computed in setup\n */\nexport const setupSidebarItems = (): void => {\n const { frontmatter, page, routeLocale, themeLocale } = useData<\n DefaultThemeHomePageFrontmatter | DefaultThemeNormalPageFrontmatter\n >()\n const headers = useHeaders()\n const routePath = useRoutePath()\n\n const sidebarConfig = computed<SidebarOptions | false>(\n () =>\n !frontmatter.value.home &&\n ((frontmatter.value as DefaultThemeNormalPageFrontmatter).sidebar ??\n themeLocale.value.sidebar ??\n 'heading'),\n )\n\n const sidebarItems = computed(() =>\n resolveSidebarItems(\n sidebarConfig.value,\n page.value,\n routePath.value,\n routeLocale.value,\n headers.value,\n ),\n )\n provide(sidebarItemsSymbol, sidebarItems)\n}\n"],"mappings":"8bA4BA,MAAa,EACX,IACuB,CACvB,KAAM,EAAO,MACb,KAAM,EAAO,KAEb,SAAU,EAA0B,EAAO,SAAS,CACrD,EAQY,EACX,GAEA,EAAU,EAAQ,IAAK,GAAW,EAAyB,EAAO,CAAC,CAAG,EAAE,CAU7D,GACX,EACA,IACkB,CAClB,CACE,KAAM,EAAK,MACX,SAAU,EAA0B,EAAQ,CAC7C,CACF,CAYY,GACX,EACA,EACA,EACA,EAAS,KACS,CAClB,IAAM,GACJ,EACA,IACgB,CAChB,IAAM,EAAgC,EAAS,EAAK,CAChD,EAAgB,EAAc,EAAY,EAAK,CAAC,CAChD,EAAS,EAAK,KAAK,CACjB,CACE,GAAG,EACH,KAAM,EAAe,EAAK,KAAK,CAC3B,EAAgB,EAAc,EAAY,EAAK,KAAK,CAAC,CAAC,KACtD,EAAK,KACV,CACD,EAEN,GAAI,aAAc,EAChB,MAAO,CACL,GAAG,EACH,SAAU,EAAU,SAAS,IAAK,GAChC,EAAgB,EAAO,EAAc,EAAY,EAAU,OAAO,CAAC,CACpE,CACF,CAKH,GAAI,EAAU,OAAS,EAAM,CAE3B,IAAM,EACJ,EAAQ,IAAI,QAAU,EAAI,EAAQ,GAAG,SAAW,EAElD,MAAO,CACL,GAAG,EACH,SAAU,EAA0B,EAAe,CACpD,CAGH,OAAO,GAGT,OAAO,EAAc,IAAK,GAAS,EAAgB,EAAM,EAAO,CAAC,EAatD,GACX,EACA,EACA,EACA,IACkB,CAClB,IAAM,EAAgB,EAAK,EAAc,CAAC,MAAM,EAAG,IAAM,EAAE,OAAS,EAAE,OAAO,CAG7E,IAAK,IAAM,KAAQ,EACjB,GAAI,EAAW,UAAU,EAAK,CAAE,EAAK,CAAE,CACrC,IAAM,EAAU,EAAc,GAE9B,OAAO,IAAY,GACf,EAAE,CACF,IAAY,UACV,EAA0B,EAAM,EAAQ,CACxC,EAAyB,EAAS,EAAS,EAAM,EAAK,CAOhE,OAFA,QAAQ,KAAK,GAAG,UAAU,EAAK,CAAC,6BAA6B,CAEtD,EAAE,EAKE,EACX,OAAO,eAAe,CAOX,MAAyC,CACpD,IAAM,EAAe,EAAO,EAAmB,CAC/C,GAAI,CAAC,EACH,MAAU,MAAM,gDAAgD,CAElE,OAAO,GAiBI,GACX,EACA,EACA,EACA,EACA,IAGI,IAAkB,GAAc,EAAE,CAElC,IAAkB,UACb,EAA0B,EAAM,EAAQ,CAE7C,MAAM,QAAQ,EAAc,CACvB,EAAyB,EAAe,EAAS,EAAM,EAAY,CAExE,EAAc,EAAc,CACvB,EAAyB,EAAe,EAAM,EAAS,EAAK,CAE9D,EAAE,CAME,MAAgC,CAC3C,GAAM,CAAE,cAAa,OAAM,cAAa,eAAgBA,GAErD,CACG,EAAU,GAAY,CACtB,EAAY,GAAc,CAE1B,EAAgB,MAElB,CAAC,EAAY,MAAM,OACjB,EAAY,MAA4C,SACxD,EAAY,MAAM,SAClB,WACL,CAWD,EAAQ,EATa,MACnB,EACE,EAAc,MACd,EAAK,MACL,EAAU,MACV,EAAY,MACZ,EAAQ,MACT,CACF,CACwC"}
|
package/dist/client/config.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import * as vuepress_client0 from "vuepress/client";
|
|
1
|
+
import * as _$vuepress_client0 from "vuepress/client";
|
|
2
2
|
//#region src/client/config.d.ts
|
|
3
|
-
declare const _default: vuepress_client0.ClientConfig;
|
|
3
|
+
declare const _default: _$vuepress_client0.ClientConfig;
|
|
4
4
|
//#endregion
|
|
5
5
|
export { _default as default };
|
|
6
6
|
//# sourceMappingURL=config.d.ts.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vuepress/theme-default",
|
|
3
|
-
"version": "2.0.0-rc.
|
|
3
|
+
"version": "2.0.0-rc.127",
|
|
4
4
|
"description": "Default theme of VuePress",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"default",
|
|
@@ -54,20 +54,20 @@
|
|
|
54
54
|
"access": "public"
|
|
55
55
|
},
|
|
56
56
|
"dependencies": {
|
|
57
|
-
"@vuepress/helper": "2.0.0-rc.
|
|
57
|
+
"@vuepress/helper": "2.0.0-rc.127",
|
|
58
58
|
"@vuepress/plugin-active-header-links": "2.0.0-rc.126",
|
|
59
|
-
"@vuepress/plugin-back-to-top": "2.0.0-rc.
|
|
60
|
-
"@vuepress/plugin-copy-code": "2.0.0-rc.
|
|
61
|
-
"@vuepress/plugin-git": "2.0.0-rc.
|
|
62
|
-
"@vuepress/plugin-links-check": "2.0.0-rc.
|
|
63
|
-
"@vuepress/plugin-markdown-hint": "2.0.0-rc.
|
|
64
|
-
"@vuepress/plugin-markdown-tab": "2.0.0-rc.
|
|
65
|
-
"@vuepress/plugin-medium-zoom": "2.0.0-rc.
|
|
66
|
-
"@vuepress/plugin-nprogress": "2.0.0-rc.
|
|
67
|
-
"@vuepress/plugin-palette": "2.0.0-rc.
|
|
68
|
-
"@vuepress/plugin-prismjs": "2.0.0-rc.
|
|
69
|
-
"@vuepress/plugin-seo": "2.0.0-rc.
|
|
70
|
-
"@vuepress/plugin-sitemap": "2.0.0-rc.
|
|
59
|
+
"@vuepress/plugin-back-to-top": "2.0.0-rc.127",
|
|
60
|
+
"@vuepress/plugin-copy-code": "2.0.0-rc.127",
|
|
61
|
+
"@vuepress/plugin-git": "2.0.0-rc.127",
|
|
62
|
+
"@vuepress/plugin-links-check": "2.0.0-rc.127",
|
|
63
|
+
"@vuepress/plugin-markdown-hint": "2.0.0-rc.127",
|
|
64
|
+
"@vuepress/plugin-markdown-tab": "2.0.0-rc.127",
|
|
65
|
+
"@vuepress/plugin-medium-zoom": "2.0.0-rc.127",
|
|
66
|
+
"@vuepress/plugin-nprogress": "2.0.0-rc.127",
|
|
67
|
+
"@vuepress/plugin-palette": "2.0.0-rc.127",
|
|
68
|
+
"@vuepress/plugin-prismjs": "2.0.0-rc.127",
|
|
69
|
+
"@vuepress/plugin-seo": "2.0.0-rc.127",
|
|
70
|
+
"@vuepress/plugin-sitemap": "2.0.0-rc.127",
|
|
71
71
|
"@vuepress/plugin-theme-data": "2.0.0-rc.126",
|
|
72
72
|
"@vueuse/core": "^14.2.1",
|
|
73
73
|
"vue": "^3.5.31"
|
|
@@ -89,5 +89,5 @@
|
|
|
89
89
|
"optional": true
|
|
90
90
|
}
|
|
91
91
|
},
|
|
92
|
-
"gitHead": "
|
|
92
|
+
"gitHead": "405b7cdccc7ed0ee2efea0dfa2b3f0036cc25e87"
|
|
93
93
|
}
|