@vuepress/client 2.0.0-rc.10 → 2.0.0-rc.11

package/dist/app.js

@@ -12,7 +12,7 @@ import {
   usePageLang,
   usePageLayout,
   withBase
-} from "./chunk-GA5RAHE7.js";
+} from "./chunk-MPZOAYAQ.js";
 
 // src/app.ts
 import { clientConfigs } from "@internal/clientConfigs";

package/dist/{chunk-GA5RAHE7.js → chunk-MPZOAYAQ.js}

@@ -154,105 +154,70 @@ var RouteLink = defineComponent({
 
 // src/components/AutoLink.ts
 import { isLinkWithProtocol } from "@vuepress/shared";
-import { computed as computed2, defineComponent as defineComponent2, h as h2 } from "vue";
+import { computed as computed2, defineComponent as defineComponent2, h as h2, toRef } from "vue";
 import { useRoute as useRoute3 } from "vue-router";
 var AutoLink = defineComponent2({
   name: "AutoLink",
   props: {
-    /**
-     * Pattern to determine if the link should be active, which has higher priority than `exact`
-     */
-    activeMatch: {
-      type: [String, RegExp],
-      default: ""
-    },
-    /**
-     * The `aria-label` attribute
-     */
-    ariaLabel: {
-      type: String,
-      default: ""
-    },
-    /**
-     * Whether the link should be active only if the url is an exact match
-     */
-    exact: Boolean,
-    /**
-     * URL of the auto link
-     */
-    link: {
-      type: String,
-      required: true
-    },
-    /**
-     * The `rel` attribute
-     */
-    rel: {
-      type: String,
-      default: ""
-    },
-    /**
-     * The `target` attribute
-     */
-    target: {
-      type: String,
-      default: ""
-    },
-    /**
-     * Text of the auto link
-     */
-    text: {
-      type: String,
+    config: {
+      type: Object,
       required: true
     }
   },
   slots: Object,
   setup(props, { slots }) {
+    const config = toRef(props, "config");
     const route = useRoute3();
     const siteData = useSiteData();
-    const withProtocol = computed2(() => isLinkWithProtocol(props.link));
+    const withProtocol = computed2(() => isLinkWithProtocol(config.value.link));
     const linkTarget = computed2(
-      () => props.target || (withProtocol.value ? "_blank" : void 0)
+      () => config.value.target || (withProtocol.value ? "_blank" : void 0)
     );
     const isBlankTarget = computed2(() => linkTarget.value === "_blank");
     const isInternal = computed2(
       () => !withProtocol.value && !isBlankTarget.value
     );
     const linkRel = computed2(
-      () => props.rel || (isBlankTarget.value ? "noopener noreferrer" : null)
+      () => config.value.rel || (isBlankTarget.value ? "noopener noreferrer" : null)
+    );
+    const linkAriaLabel = computed2(
+      () => config.value.ariaLabel ?? config.value.text
     );
-    const linkAriaLabel = computed2(() => props.ariaLabel ?? props.text);
     const shouldBeActiveInSubpath = computed2(() => {
-      if (props.exact)
+      if (config.value.exact)
         return false;
       const localePaths = Object.keys(siteData.value.locales);
       return localePaths.length ? (
         // Check all the locales
-        localePaths.every((key) => key !== props.link)
+        localePaths.every((key) => key !== config.value.link)
       ) : (
         // Check root
-        props.link !== "/"
+        config.value.link !== "/"
       );
     });
     const isActive = computed2(() => {
       if (!isInternal.value)
         return false;
-      if (props.activeMatch) {
-        return (props.activeMatch instanceof RegExp ? props.activeMatch : new RegExp(props.activeMatch, "u")).test(route.path);
+      if (config.value.activeMatch) {
+        return (config.value.activeMatch instanceof RegExp ? config.value.activeMatch : new RegExp(config.value.activeMatch, "u")).test(route.path);
       }
       if (shouldBeActiveInSubpath.value) {
-        return route.path.startsWith(props.link);
+        return route.path.startsWith(config.value.link);
       }
-      return route.path === props.link;
+      return route.path === config.value.link;
     });
     return () => {
       const { before, after, default: defaultSlot } = slots;
-      const content = defaultSlot?.() || [before?.(), props.text, after?.()];
+      const content = defaultSlot?.(config.value) || [
+        before?.(config.value),
+        config.value.text,
+        after?.(config.value)
+      ];
       return isInternal.value ? h2(
         RouteLink,
         {
           "class": "auto-link",
-          "to": props.link,
+          "to": config.value.link,
           "active": isActive.value,
           "aria-label": linkAriaLabel.value
         },
@@ -261,7 +226,7 @@ var AutoLink = defineComponent2({
         "a",
         {
           "class": "auto-link external-link",
-          "href": props.link,
+          "href": config.value.link,
           "aria-label": linkAriaLabel.value,
           "rel": linkRel.value,
           "target": linkTarget.value

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as vue from 'vue';
-import { Component, ComputedRef, Ref, App, VNode, SlotsType, InjectionKey } from 'vue';
+import { Component, ComputedRef, Ref, App, PropType, VNode, SlotsType, InjectionKey } from 'vue';
 import { PageData, HeadConfig, PageFrontmatter, SiteData, SiteLocaleData } from '@vuepress/shared';
 export { HeadConfig, PageData, PageFrontmatter, PageHeader, SiteData, SiteLocaleData } from '@vuepress/shared';
 import { Router } from 'vue-router';
@@ -97,7 +97,7 @@ interface ClientConfig {
     rootComponents?: Component[];
 }
 
-interface AutoLinkProps {
+interface AutoLinkConfig {
     /**
      * Pattern to determine if the link should be active, which has higher priority than `exact`
      */
@@ -134,111 +134,21 @@ interface AutoLinkProps {
  * - If the link is external, it will be rendered as a normal `<a>` tag
  */
 declare const AutoLink: vue.DefineComponent<{
-    /**
-     * Pattern to determine if the link should be active, which has higher priority than `exact`
-     */
-    activeMatch: {
-        type: (StringConstructor | RegExpConstructor)[];
-        default: string;
-    };
-    /**
-     * The `aria-label` attribute
-     */
-    ariaLabel: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * Whether the link should be active only if the url is an exact match
-     */
-    exact: BooleanConstructor;
-    /**
-     * URL of the auto link
-     */
-    link: {
-        type: StringConstructor;
-        required: true;
-    };
-    /**
-     * The `rel` attribute
-     */
-    rel: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * The `target` attribute
-     */
-    target: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * Text of the auto link
-     */
-    text: {
-        type: StringConstructor;
+    config: {
+        type: PropType<AutoLinkConfig>;
         required: true;
     };
 }, () => VNode<vue.RendererNode, vue.RendererElement, {
     [key: string]: any;
 }>, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
-    /**
-     * Pattern to determine if the link should be active, which has higher priority than `exact`
-     */
-    activeMatch: {
-        type: (StringConstructor | RegExpConstructor)[];
-        default: string;
-    };
-    /**
-     * The `aria-label` attribute
-     */
-    ariaLabel: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * Whether the link should be active only if the url is an exact match
-     */
-    exact: BooleanConstructor;
-    /**
-     * URL of the auto link
-     */
-    link: {
-        type: StringConstructor;
+    config: {
+        type: PropType<AutoLinkConfig>;
         required: true;
     };
-    /**
-     * The `rel` attribute
-     */
-    rel: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * The `target` attribute
-     */
-    target: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * Text of the auto link
-     */
-    text: {
-        type: StringConstructor;
-        required: true;
-    };
-}>>, {
-    target: string;
-    activeMatch: string | RegExp;
-    ariaLabel: string;
-    exact: boolean;
-    rel: string;
-}, SlotsType<{
-    default?: (() => VNode[] | VNode) | undefined;
-    before?: (() => VNode[] | VNode | null) | undefined;
-    after?: (() => VNode[] | VNode | null) | undefined;
+}>>, {}, SlotsType<{
+    default?: ((config: AutoLinkConfig) => VNode[] | VNode) | undefined;
+    before?: ((config: AutoLinkConfig) => VNode[] | VNode | null) | undefined;
+    after?: ((config: AutoLinkConfig) => VNode[] | VNode | null) | undefined;
 }>>;
 
 /**
@@ -424,4 +334,4 @@ declare const defineClientConfig: (clientConfig?: ClientConfig) => ClientConfig;
  */
 declare const withBase: (url: string) => string;
 
-export { AutoLink, type AutoLinkProps, type ClientConfig, type ClientData, ClientOnly, Content, type Layouts, type LayoutsRef, type PageChunk, type PageComponent, type PageComponentRef, type PageDataRef, type PageFrontmatterRef, type PageHead, type PageHeadRef, type PageHeadTitle, type PageHeadTitleRef, type PageLang, type PageLangRef, type PageLayout, type PageLayoutRef, type Redirects, type RedirectsRef, type ResolvedRoute, type Route, RouteLink, type RouteLinkProps, type RouteLocale, type RouteLocaleRef, type RouteMeta, type RoutePath, type RoutePathRef, type Routes, type RoutesRef, type SiteDataRef, type SiteLocaleDataRef, type UpdateHead, clientDataSymbol, defineClientConfig, resolveRoute, resolveRoutePath, resolvers, updateHeadSymbol, useClientData, useLayouts, usePageComponent, usePageData, usePageFrontmatter, usePageHead, usePageLang, usePageLayout, useRedirects, useRouteLocale, useRoutePath, useRoutes, useSiteData, useSiteLocaleData, useUpdateHead, withBase };
+export { AutoLink, type AutoLinkConfig, type ClientConfig, type ClientData, ClientOnly, Content, type Layouts, type LayoutsRef, type PageChunk, type PageComponent, type PageComponentRef, type PageDataRef, type PageFrontmatterRef, type PageHead, type PageHeadRef, type PageHeadTitle, type PageHeadTitleRef, type PageLang, type PageLangRef, type PageLayout, type PageLayoutRef, type Redirects, type RedirectsRef, type ResolvedRoute, type Route, RouteLink, type RouteLinkProps, type RouteLocale, type RouteLocaleRef, type RouteMeta, type RoutePath, type RoutePathRef, type Routes, type RoutesRef, type SiteDataRef, type SiteLocaleDataRef, type UpdateHead, clientDataSymbol, defineClientConfig, resolveRoute, resolveRoutePath, resolvers, updateHeadSymbol, useClientData, useLayouts, usePageComponent, usePageData, usePageFrontmatter, usePageHead, usePageLang, usePageLayout, useRedirects, useRouteLocale, useRoutePath, useRoutes, useSiteData, useSiteLocaleData, useUpdateHead, withBase };

package/dist/index.js

@@ -27,7 +27,7 @@ import {
   useSiteLocaleData,
   useUpdateHead,
   withBase
-} from "./chunk-GA5RAHE7.js";
+} from "./chunk-MPZOAYAQ.js";
 export {
   AutoLink,
   ClientOnly,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/client",
-  "version": "2.0.0-rc.10",
+  "version": "2.0.0-rc.11",
   "description": "Client package of VuePress",
   "keywords": [
     "vuepress",
@@ -36,7 +36,7 @@
     "@vue/devtools-api": "^6.6.1",
     "vue": "^3.4.27",
     "vue-router": "^4.3.2",
-    "@vuepress/shared": "2.0.0-rc.10"
+    "@vuepress/shared": "2.0.0-rc.11"
   },
   "publishConfig": {
     "access": "public"