@vuepress/client - npm Package Compare versions

Comparing version 2.0.0-rc.9 to 2.0.0-rc.10

dist/app.js

@@ -15,3 +15,3 @@ import {
   withBase
-} from "./chunk-FJNK2BS7.js";
+} from "./chunk-GA5RAHE7.js";
 
@@ -62,4 +62,4 @@ // src/app.ts
     if (to.path !== from.path || from === START_LOCATION) {
-      const route = resolveRoute(to.path);
-      if (route.path !== to.path) {
+      const route = resolveRoute(to.fullPath);
+      if (route.path !== to.fullPath) {
         return route.path;
@@ -299,3 +299,3 @@ }
   if (__VUEPRESS_DEV__ || __VUE_PROD_DEVTOOLS__) {
-    const { setupDevtools } = await import("./setupDevtools-X4YFRK4B.js");
+    const { setupDevtools } = await import("./setupDevtools-H6KAGBNI.js");
     setupDevtools(app, globalComputed);
@@ -302,0 +302,0 @@ }

dist/index.d.ts

 import * as vue from 'vue';
-import { Component, ComputedRef, Ref, App, HTMLAttributes, FunctionalComponent, VNode, InjectionKey } from 'vue';
-import { PageData, HeadConfig, SiteData, PageFrontmatter } from '@vuepress/shared';
-export { HeadConfig, PageData, PageFrontmatter, PageHeader, SiteData } from '@vuepress/shared';
+import { Component, ComputedRef, Ref, App, 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';
@@ -42,3 +42,2 @@ export { RouteLocationNormalizedLoaded, Router, useRoute, useRouter } from 'vue-router';
 type RouteLocale = string;
-type SiteLocaleData = SiteData;
 type LayoutsRef = ComputedRef<Layouts>;
@@ -102,3 +101,147 @@ type PageComponentRef = ComputedRef<PageComponent>;
 
+interface AutoLinkProps {
+    /**
+     * Pattern to determine if the link should be active, which has higher priority than `exact`
+     */
+    activeMatch?: string | RegExp;
+    /**
+     * The `aria-label` attribute
+     */
+    ariaLabel?: string;
+    /**
+     * Whether the link should be active only if the url is an exact match
+     */
+    exact?: boolean;
+    /**
+     * URL of the auto link
+     */
+    link: string;
+    /**
+     * The `rel` attribute
+     */
+    rel?: string;
+    /**
+     * The `target` attribute
+     */
+    target?: string;
+    /**
+     * Text of the auto link
+     */
+    text: string;
+}
 /**
+ * Component to render a link automatically according to the link type
+ *
+ * - If the link is internal, it will be rendered as a `<RouteLink>`
+ * - 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;
+        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;
+        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;
+}>>;
+
+/**
  * Wrapper component that only renders its content on the client side and skips server side rendering
@@ -131,3 +274,3 @@ */
 
-interface RouteLinkProps extends HTMLAttributes {
+interface RouteLinkProps {
     /**
@@ -159,5 +302,52 @@ * Whether the link is active to have an active class
  */
-declare const RouteLink: FunctionalComponent<RouteLinkProps, Record<never, never>, {
+declare const RouteLink: vue.DefineComponent<{
+    /**
+     * The route path to link to
+     */
+    to: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Whether the link is active to have an active class
+     *
+     * Notice that the active status is not automatically determined according to the current route.
+     */
+    active: BooleanConstructor;
+    /**
+     * The class to add when the link is active
+     */
+    activeClass: {
+        type: StringConstructor;
+        default: string;
+    };
+}, () => VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    /**
+     * The route path to link to
+     */
+    to: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Whether the link is active to have an active class
+     *
+     * Notice that the active status is not automatically determined according to the current route.
+     */
+    active: BooleanConstructor;
+    /**
+     * The class to add when the link is active
+     */
+    activeClass: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    active: boolean;
+    activeClass: string;
+}, SlotsType<{
     default: () => string | VNode | (string | VNode)[];
-}>;
+}>>;
 
@@ -207,3 +397,3 @@ /**
  */
-declare const resolveRoute: <T extends RouteMeta = RouteMeta>(path: string) => ResolvedRoute<T>;
+declare const resolveRoute: <T extends RouteMeta = RouteMeta>(path: string, currentPath?: string) => ResolvedRoute<T>;
 
@@ -213,3 +403,3 @@ /**
  */
-declare const resolveRoutePath: (path: string) => string;
+declare const resolveRoutePath: (path: string, currentPath?: string) => string;
 
@@ -225,8 +415,8 @@ /**
     resolveLayouts: (clientConfigs: ClientConfig[]) => Layouts;
-    resolvePageHead: (pageHeadTitle: PageHeadTitle, pageFrontmatter: PageFrontmatter, siteLocaleDate: SiteData) => PageHead;
-    resolvePageHeadTitle: (pageData: PageData, siteLocaleDate: SiteData) => PageHeadTitle;
-    resolvePageLang: (pageData: PageData, siteLocaleData: SiteData) => PageLang;
+    resolvePageHead: (pageHeadTitle: PageHeadTitle, pageFrontmatter: PageFrontmatter, siteLocaleDate: SiteLocaleData) => PageHead;
+    resolvePageHeadTitle: (pageData: PageData, siteLocaleDate: SiteLocaleData) => PageHeadTitle;
+    resolvePageLang: (pageData: PageData, siteLocaleData: SiteLocaleData) => PageLang;
     resolvePageLayout: (pageData: PageData, layouts: Layouts) => PageLayout;
     resolveRouteLocale: (locales: SiteData['locales'], routePath: string) => RouteLocale;
-    resolveSiteLocaleData: (siteData: SiteData, routeLocale: RouteLocale) => SiteLocaleData;
+    resolveSiteLocaleData: ({ base, locales, ...siteData }: SiteData, routeLocale: RouteLocale) => SiteLocaleData;
 };
@@ -244,2 +434,2 @@
 
-export { 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 Route, RouteLink, type RouteLinkProps, type RouteLocale, type RouteLocaleRef, type RouteMeta, type RoutePath, type RoutePathRef, type Routes, type RoutesRef, type SiteDataRef, type SiteLocaleData, 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 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 };

dist/index.js

 import {
+  AutoLink,
   ClientOnly,
@@ -29,4 +30,5 @@ Content,
   withBase
-} from "./chunk-FJNK2BS7.js";
+} from "./chunk-GA5RAHE7.js";
 export {
+  AutoLink,
   ClientOnly,
@@ -33,0 +35,0 @@ Content,

package.json

 {
   "name": "@vuepress/client",
-  "version": "2.0.0-rc.9",
+  "version": "2.0.0-rc.10",
   "description": "Client package of VuePress",
@@ -37,5 +37,5 @@ "keywords": [
     "@vue/devtools-api": "^6.6.1",
-    "vue": "^3.4.21",
-    "vue-router": "^4.3.0",
-    "@vuepress/shared": "2.0.0-rc.9"
+    "vue": "^3.4.27",
+    "vue-router": "^4.3.2",
+    "@vuepress/shared": "2.0.0-rc.10"
   },
@@ -42,0 +42,0 @@ "publishConfig": {

No alert changes

Improved metrics

Total package byte prevSize

42202

increased by24.68%

Lines of code

1307

increased by33.91%

Dependency changes

• + Added@vuepress/shared@2.0.0-rc.10(transitive)

• - Removed@vuepress/shared@2.0.0-rc.9(transitive)

• Updated@vuepress/shared@2.0.0-rc.10

• Updatedvue@^3.4.27

• Updatedvue-router@^4.3.2