@rspress/runtime 2.0.0-beta.25 → 2.0.0-beta.26

package/dist/Content.js

@@ -2,7 +2,7 @@ import { Fragment, jsx } from "react/jsx-runtime";
 import { Suspense, memo, useMemo } from "react";
 import { useLocation } from "react-router-dom";
 import virtual_site_data from "virtual-site-data";
-import { useViewTransition } from "./hooks.js";
+import { useViewTransition } from "./hooks/useViewTransition.js";
 import { pathnameToRouteService } from "./route.js";
 function TransitionContentImpl(props) {
     let element = props.el;

package/dist/hooks/useDark.d.ts

@@ -0,0 +1,7 @@
+interface IThemeContext {
+    theme: 'light' | 'dark';
+    setTheme?: (theme: 'light' | 'dark') => void;
+}
+export declare const ThemeContext: import("react").Context<IThemeContext>;
+export declare function useDark(): boolean;
+export {};

package/dist/hooks/useDark.js

@@ -0,0 +1,7 @@
+import { createContext, useContext } from "react";
+const ThemeContext = createContext({});
+function useDark() {
+    const ctx = useContext(ThemeContext);
+    return 'dark' === ctx.theme;
+}
+export { ThemeContext, useDark };

package/dist/hooks/useFrontmatter.d.ts

@@ -0,0 +1,4 @@
+import type { FrontMatterMeta } from '@rspress/shared';
+export declare const useFrontmatter: () => {
+    frontmatter: FrontMatterMeta;
+};

package/dist/hooks/useFrontmatter.js

@@ -0,0 +1,9 @@
+import { usePageData } from "./usePageData.js";
+const useFrontmatter = ()=>{
+    const { page } = usePageData();
+    const { frontmatter = {} } = page;
+    return {
+        frontmatter
+    };
+};
+export { useFrontmatter };

package/dist/hooks/useI18n.d.ts

@@ -0,0 +1 @@
+export declare function useI18n<T = Record<string, Record<string, string>>>(): (key: keyof T) => any;

package/dist/hooks/useI18n.js

@@ -0,0 +1,10 @@
+import { useCallback } from "react";
+import virtual_i18n_text from "virtual-i18n-text";
+import { useLang } from "./useLang.js";
+function useI18n() {
+    const lang = useLang();
+    return useCallback((key)=>virtual_i18n_text[key][lang], [
+        lang
+    ]);
+}
+export { useI18n };

package/dist/hooks/useLang.d.ts

@@ -0,0 +1 @@
+export declare function useLang(): string;

package/dist/hooks/useLang.js

@@ -0,0 +1,6 @@
+import { usePageData } from "./usePageData.js";
+function useLang() {
+    const { page } = usePageData();
+    return page.lang || '';
+}
+export { useLang };

package/dist/hooks/useLocaleSiteData.d.ts

@@ -0,0 +1,5 @@
+import { type NormalizedLocales } from '@rspress/shared';
+/**
+ * @deprecated
+ */
+export declare function useLocaleSiteData(): NormalizedLocales;

package/dist/hooks/useLocaleSiteData.js

@@ -0,0 +1,27 @@
+import { addTrailingSlash } from "@rspress/shared";
+import { useLang } from "./useLang.js";
+import { useSite } from "./useSite.js";
+function useLocaleSiteData() {
+    const { site } = useSite();
+    const lang = useLang();
+    const themeConfig = site?.themeConfig ?? {};
+    const defaultLang = site.lang ?? '';
+    const locales = themeConfig?.locales;
+    if (!locales || 0 === locales.length) return {
+        nav: themeConfig.nav,
+        sidebar: themeConfig.sidebar,
+        prevPageText: themeConfig.prevPageText,
+        nextPageText: themeConfig.nextPageText,
+        sourceCodeText: themeConfig.sourceCodeText,
+        searchPlaceholderText: themeConfig.searchPlaceholderText,
+        searchNoResultsText: themeConfig.searchNoResultsText,
+        searchSuggestedQueryText: themeConfig.searchSuggestedQueryText,
+        overview: themeConfig.overview
+    };
+    const localeInfo = locales.find((locale)=>locale.lang === lang);
+    return {
+        ...localeInfo,
+        langRoutePrefix: lang === defaultLang ? '/' : addTrailingSlash(lang)
+    };
+}
+export { useLocaleSiteData };

package/dist/hooks/useNav.d.ts

@@ -0,0 +1 @@
+export declare function useNav(): import("@rspress/shared").NavItem[];

package/dist/hooks/useNav.js

@@ -0,0 +1,12 @@
+import { useLocaleSiteData } from "./useLocaleSiteData.js";
+import { useVersion } from "./useVersion.js";
+function useNav() {
+    const { nav } = useLocaleSiteData();
+    const version = useVersion();
+    if (Array.isArray(nav)) return nav;
+    const navKey = version.length > 0 ? version : 'default';
+    return [
+        ...nav[navKey]
+    ];
+}
+export { useNav };

package/dist/hooks/usePage.d.ts

@@ -0,0 +1,10 @@
+export declare function usePage(): {
+    page: import("@rspress/shared").BaseRuntimePageInfo & {
+        [key: string]: unknown;
+        headingTitle?: string;
+        pagePath: string;
+        lastUpdatedTime?: string;
+        description?: string;
+        pageType: import("@rspress/shared").PageType;
+    };
+};

package/dist/hooks/usePage.js

@@ -0,0 +1,8 @@
+import { usePageData } from "./usePageData.js";
+function usePage() {
+    const { page } = usePageData();
+    return {
+        page
+    };
+}
+export { usePage };

package/dist/hooks/usePageData.d.ts

@@ -0,0 +1,11 @@
+import type { PageData } from '@rspress/shared';
+interface IDataContext {
+    data: PageData;
+    setData?: (data: PageData) => void;
+}
+export declare const DataContext: import("react").Context<IDataContext>;
+/**
+ * @deprecated should use `usePage` instead
+ */
+export declare function usePageData(): PageData;
+export {};

package/dist/hooks/usePageData.js

@@ -0,0 +1,7 @@
+import { createContext, useContext } from "react";
+const DataContext = createContext({});
+function usePageData() {
+    const ctx = useContext(DataContext);
+    return ctx.data;
+}
+export { DataContext, usePageData };

package/dist/hooks/useSidebar.d.ts

@@ -0,0 +1,9 @@
+import { type NormalizedSidebar, type SidebarData } from '@rspress/shared';
+/**
+ * get the sidebar group for the current page
+ * @param sidebar const { sidebar } = useLocaleSiteData();
+ * @param currentPathname
+ * @returns
+ */
+export declare const getSidebarDataGroup: (sidebar: NormalizedSidebar, currentPathname: string) => SidebarData;
+export declare function useSidebar(): SidebarData;

package/dist/hooks/useSidebar.js

@@ -0,0 +1,23 @@
+import { matchSidebar } from "@rspress/shared";
+import { useMemo } from "react";
+import { useLocation } from "react-router-dom";
+import { useLocaleSiteData } from "./useLocaleSiteData.js";
+const getSidebarDataGroup = (sidebar, currentPathname)=>{
+    const navRoutes = Object.keys(sidebar).sort((a, b)=>b.length - a.length);
+    for (const name of navRoutes)if (matchSidebar(name, currentPathname)) {
+        const sidebarGroup = sidebar[name];
+        return sidebarGroup;
+    }
+    return [];
+};
+function useSidebar() {
+    const { sidebar } = useLocaleSiteData();
+    const { pathname: rawPathname } = useLocation();
+    const pathname = decodeURIComponent(rawPathname);
+    const sidebarData = useMemo(()=>getSidebarDataGroup(sidebar, pathname), [
+        sidebar,
+        pathname
+    ]);
+    return sidebarData;
+}
+export { getSidebarDataGroup, useSidebar };

package/dist/hooks/useSite.d.ts

@@ -0,0 +1,3 @@
+export declare function useSite(): {
+    site: import("@rspress/shared").SiteData<import("@rspress/shared").DefaultThemeConfig>;
+};

package/dist/hooks/useSite.js

@@ -0,0 +1,8 @@
+import { usePageData } from "./usePageData.js";
+function useSite() {
+    const { siteData } = usePageData();
+    return {
+        site: siteData
+    };
+}
+export { useSite };

package/dist/hooks/useVersion.d.ts

@@ -0,0 +1 @@
+export declare function useVersion(): string;

package/dist/hooks/useVersion.js

@@ -0,0 +1,6 @@
+import { usePageData } from "./usePageData.js";
+function useVersion() {
+    const { page } = usePageData();
+    return page.version || '';
+}
+export { useVersion };

package/dist/hooks/useViewTransition.d.ts

@@ -0,0 +1,2 @@
+import { type ReactNode } from 'react';
+export declare function useViewTransition(dom: ReactNode): string | number | bigint | boolean | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<ReactNode> | import("react").ReactPortal | Promise<string | number | bigint | boolean | import("react").ReactPortal | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null | undefined;

package/dist/hooks/useViewTransition.js

@@ -0,0 +1,23 @@
+import { useLayoutEffect, useState } from "react";
+import { flushSync } from "react-dom";
+function useViewTransition(dom) {
+    const [element, setElement] = useState(dom);
+    useLayoutEffect(()=>{
+        if (document.startViewTransition && element !== dom) document.startViewTransition(()=>{
+            flushSync(()=>{
+                setElement(dom);
+            });
+            window.dispatchEvent(new Event('RspressReloadContent'));
+        });
+        else {
+            flushSync(()=>{
+                setElement(dom);
+            });
+            window.dispatchEvent(new Event('RspressReloadContent'));
+        }
+    }, [
+        dom
+    ]);
+    return element;
+}
+export { useViewTransition };

package/dist/hooks/useWindowSize.d.ts

@@ -0,0 +1,9 @@
+declare global {
+    interface Window {
+        __MODERN_PAGE_DATA__: any;
+    }
+}
+export declare function useWindowSize(initialWidth?: number, initialHeight?: number): {
+    width: number;
+    height: number;
+};

package/dist/hooks/useWindowSize.js

@@ -0,0 +1,22 @@
+import { useLayoutEffect, useState } from "react";
+function useWindowSize(initialWidth, initialHeight) {
+    const [size, setSize] = useState({
+        width: initialWidth ?? 1 / 0,
+        height: initialHeight ?? 1 / 0
+    });
+    useLayoutEffect(()=>{
+        const handleResize = ()=>{
+            setSize({
+                width: window.innerWidth,
+                height: window.innerHeight
+            });
+        };
+        handleResize();
+        window.addEventListener('resize', handleResize);
+        return ()=>{
+            window.removeEventListener('resize', handleResize);
+        };
+    }, []);
+    return size;
+}
+export { useWindowSize };

package/dist/index.d.ts

@@ -2,7 +2,17 @@ export { Head } from '@unhead/react';
 export { createPortal, flushSync, } from 'react-dom';
 export { BrowserRouter, matchPath, matchRoutes, useLocation, useNavigate, useSearchParams, } from 'react-router-dom';
 export { Content } from './Content.js';
-export { DataContext, ThemeContext, useDark, useI18n, useLang, usePageData, useVersion, useViewTransition, useWindowSize, } from './hooks.js';
+export { ThemeContext, useDark } from './hooks/useDark.js';
+export { useFrontmatter } from './hooks/useFrontmatter.js';
+export { useI18n } from './hooks/useI18n.js';
+export { useLang } from './hooks/useLang.js';
+export { useLocaleSiteData } from './hooks/useLocaleSiteData.js';
+export { useNav } from './hooks/useNav.js';
+export { DataContext, usePageData } from './hooks/usePageData.js';
+export { getSidebarDataGroup, useSidebar } from './hooks/useSidebar.js';
+export { useSite as useSiteData } from './hooks/useSite.js';
+export { useVersion } from './hooks/useVersion.js';
+export { useWindowSize } from './hooks/useWindowSize.js';
 export { NoSSR } from './NoSSR.js';
-export { normalizeRoutePath, pathnameToRouteService, } from './route.js';
+export { isActive, pathnameToRouteService, } from './route.js';
 export { addLeadingSlash, isEqualPath, isProduction, normalizeHrefInRuntime, normalizeImagePath, normalizeSlash, removeBase, removeTrailingSlash, withBase, } from './utils.js';

package/dist/index.js

@@ -2,8 +2,18 @@ import { Head } from "@unhead/react";
 import { createPortal, flushSync } from "react-dom";
 import { BrowserRouter, matchPath, matchRoutes, useLocation, useNavigate, useSearchParams } from "react-router-dom";
 import { Content } from "./Content.js";
-import { DataContext, ThemeContext, useDark, useI18n, useLang, usePageData, useVersion, useViewTransition, useWindowSize } from "./hooks.js";
+import { ThemeContext, useDark } from "./hooks/useDark.js";
+import { useFrontmatter } from "./hooks/useFrontmatter.js";
+import { useI18n } from "./hooks/useI18n.js";
+import { useLang } from "./hooks/useLang.js";
+import { useLocaleSiteData } from "./hooks/useLocaleSiteData.js";
+import { useNav } from "./hooks/useNav.js";
+import { DataContext, usePageData } from "./hooks/usePageData.js";
+import { getSidebarDataGroup, useSidebar } from "./hooks/useSidebar.js";
+import { useSite } from "./hooks/useSite.js";
+import { useVersion } from "./hooks/useVersion.js";
+import { useWindowSize } from "./hooks/useWindowSize.js";
 import { NoSSR } from "./NoSSR.js";
-import { normalizeRoutePath, pathnameToRouteService } from "./route.js";
+import { isActive, pathnameToRouteService } from "./route.js";
 import { addLeadingSlash, isEqualPath, isProduction, normalizeHrefInRuntime, normalizeImagePath, normalizeSlash, removeBase, removeTrailingSlash, withBase } from "./utils.js";
-export { BrowserRouter, Content, DataContext, Head, NoSSR, ThemeContext, addLeadingSlash, createPortal, flushSync, isEqualPath, isProduction, matchPath, matchRoutes, normalizeHrefInRuntime, normalizeImagePath, normalizeRoutePath, normalizeSlash, pathnameToRouteService, removeBase, removeTrailingSlash, useDark, useI18n, useLang, useLocation, useNavigate, usePageData, useSearchParams, useVersion, useViewTransition, useWindowSize, withBase };
+export { BrowserRouter, Content, DataContext, Head, NoSSR, ThemeContext, addLeadingSlash, createPortal, flushSync, getSidebarDataGroup, isActive, isEqualPath, isProduction, matchPath, matchRoutes, normalizeHrefInRuntime, normalizeImagePath, normalizeSlash, pathnameToRouteService, removeBase, removeTrailingSlash, useDark, useFrontmatter, useI18n, useLang, useLocaleSiteData, useLocation, useNav, useNavigate, usePageData, useSearchParams, useSidebar, useSite as useSiteData, useVersion, useWindowSize, withBase };

package/dist/route.d.ts

@@ -1,8 +1,20 @@
 import type { Route } from '@rspress/shared';
-export declare function normalizeRoutePath(routePath: string): string;
 /**
  * this is a bridge of two core features Sidebar and RouteService
  * @param pathname useLocation().pathname
  * @returns
  */
 export declare function pathnameToRouteService(pathname: string): Route | undefined;
+/**
+ * link: /api/config
+ * currentPathname:
+ *  0. /api/config
+ *  1. /api/config.html
+ *  2. /api/config/
+ *  3. /api/config/index
+ *  4. /api/config/index.html
+ * @param itemLink
+ * @param currentPathname
+ * @returns
+ */
+export declare function isActive(itemLink: string, currentPathname: string): boolean;

package/dist/route.js

@@ -1,4 +1,4 @@
-import { matchRoutes } from "react-router-dom";
+import { matchPath, matchRoutes } from "react-router-dom";
 import { routes } from "virtual-routes";
 function normalizeRoutePath(routePath) {
     return decodeURIComponent(routePath).replace(/\.html$/, '').replace(/\/index$/, '/');
@@ -12,4 +12,10 @@ function pathnameToRouteService(pathname) {
     if (route) cache.set(pathname, route);
     return route;
 }
-export { normalizeRoutePath, pathnameToRouteService };
+function isActive(itemLink, currentPathname) {
+    const normalizedItemLink = normalizeRoutePath(itemLink);
+    const normalizedCurrentPathname = normalizeRoutePath(currentPathname);
+    const linkMatched = matchPath(normalizedItemLink, normalizedCurrentPathname);
+    return null !== linkMatched;
+}
+export { isActive, pathnameToRouteService };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/runtime",
-  "version": "2.0.0-beta.25",
+  "version": "2.0.0-beta.26",
   "description": "The Runtime of Rspress Documentation Framework",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
@@ -33,19 +33,19 @@
     "server.d.ts"
   ],
   "dependencies": {
-    "@unhead/react": "^2.0.13",
+    "@unhead/react": "^2.0.14",
     "react": "^19.1.1",
     "react-dom": "^19.1.1",
-    "react-router-dom": "^6.29.0",
-    "@rspress/shared": "2.0.0-beta.25"
+    "react-router-dom": "^6.30.1",
+    "@rspress/shared": "2.0.0-beta.26"
   },
   "devDependencies": {
-    "@rsbuild/plugin-react": "~1.3.4",
-    "@rslib/core": "0.11.1",
+    "@rsbuild/plugin-react": "~1.3.5",
+    "@rslib/core": "0.11.2",
     "@types/jest": "~29.5.14",
     "@types/react": "^19.1.9",
     "@types/react-dom": "^19.1.7",
-    "rsbuild-plugin-publint": "^0.3.2",
+    "rsbuild-plugin-publint": "^0.3.3",
     "typescript": "^5.8.2",
     "@rspress/config": "1.0.0"
   },

package/dist/hooks.d.ts

@@ -1,28 +0,0 @@
-import type { PageData } from '@rspress/shared';
-import { type ReactNode } from 'react';
-declare global {
-    interface Window {
-        __MODERN_PAGE_DATA__: any;
-    }
-}
-interface IDataContext {
-    data: PageData;
-    setData?: (data: PageData) => void;
-}
-interface IThemeContext {
-    theme: 'light' | 'dark';
-    setTheme?: (theme: 'light' | 'dark') => void;
-}
-export declare const DataContext: import("react").Context<IDataContext>;
-export declare const ThemeContext: import("react").Context<IThemeContext>;
-export declare function usePageData(): PageData;
-export declare function useLang(): string;
-export declare function useVersion(): string;
-export declare function useDark(): boolean;
-export declare function useI18n<T = Record<string, Record<string, string>>>(): (key: keyof T) => any;
-export declare function useViewTransition(dom: ReactNode): string | number | bigint | boolean | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<ReactNode> | import("react").ReactPortal | Promise<string | number | bigint | boolean | import("react").ReactPortal | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null | undefined;
-export declare function useWindowSize(initialWidth?: number, initialHeight?: number): {
-    width: number;
-    height: number;
-};
-export {};

package/dist/hooks.js

@@ -1,68 +0,0 @@
-import { createContext, useCallback, useContext, useLayoutEffect, useState } from "react";
-import { flushSync } from "react-dom";
-import virtual_i18n_text from "virtual-i18n-text";
-const DataContext = createContext({});
-const ThemeContext = createContext({});
-function usePageData() {
-    const ctx = useContext(DataContext);
-    return ctx.data;
-}
-function useLang() {
-    const ctx = useContext(DataContext);
-    return ctx.data.page.lang || '';
-}
-function useVersion() {
-    const ctx = useContext(DataContext);
-    return ctx.data.page.version || '';
-}
-function useDark() {
-    const ctx = useContext(ThemeContext);
-    return 'dark' === ctx.theme;
-}
-function useI18n() {
-    const lang = useLang();
-    return useCallback((key)=>virtual_i18n_text[key][lang], [
-        lang
-    ]);
-}
-function useViewTransition(dom) {
-    const [element, setElement] = useState(dom);
-    useLayoutEffect(()=>{
-        if (document.startViewTransition && element !== dom) document.startViewTransition(()=>{
-            flushSync(()=>{
-                setElement(dom);
-            });
-            window.dispatchEvent(new Event('RspressReloadContent'));
-        });
-        else {
-            flushSync(()=>{
-                setElement(dom);
-            });
-            window.dispatchEvent(new Event('RspressReloadContent'));
-        }
-    }, [
-        dom
-    ]);
-    return element;
-}
-function useWindowSize(initialWidth, initialHeight) {
-    const [size, setSize] = useState({
-        width: initialWidth ?? 1 / 0,
-        height: initialHeight ?? 1 / 0
-    });
-    useLayoutEffect(()=>{
-        const handleResize = ()=>{
-            setSize({
-                width: window.innerWidth,
-                height: window.innerHeight
-            });
-        };
-        handleResize();
-        window.addEventListener('resize', handleResize);
-        return ()=>{
-            window.removeEventListener('resize', handleResize);
-        };
-    }, []);
-    return size;
-}
-export { DataContext, ThemeContext, useDark, useI18n, useLang, usePageData, useVersion, useViewTransition, useWindowSize };