@lukoweb/apitogo 0.1.24 → 0.1.37

package/src/lib/util/useScrollToAnchor.ts

@@ -1,70 +1,70 @@
-import { useCallback, useEffect, useRef } from "react";
-import { useLocation } from "react-router";
-import { useViewportAnchor } from "../components/context/ViewportAnchorContext.js";
-import { DATA_ANCHOR_ATTR } from "../components/navigation/NavigationItem.js";
-import { scrollIntoViewIfNeeded } from "./scrollIntoViewIfNeeded.js";
-
-export const useScrollToHash = () => {
-  const { setActiveAnchor } = useViewportAnchor();
-
-  const scrollToHash = useCallback(
-    (hash: string) => {
-      const cleanHash = hash.replace(/^#/, "");
-
-      // Operation list items might have subdivisions that the navigation doesn't show.
-      // The subdivisions are separated by a slash so we need to remove everything before the slash to get the navigation correct item.
-      const linkHash = cleanHash.split("/").at(0);
-      if (!linkHash) return false;
-
-      const element = document.getElementById(decodeURIComponent(cleanHash));
-
-      const link = document.querySelector(
-        `[${DATA_ANCHOR_ATTR}="${linkHash}"]`,
-      );
-
-      if (element) {
-        element.scrollIntoView();
-        scrollIntoViewIfNeeded(link);
-        // Set the active anchor after the scroll has happened
-        // so the intersection observer doesn't trigger wrong items
-        requestIdleCallback(() => setActiveAnchor(linkHash));
-        return true;
-      }
-
-      // Scroll didn't happen
-      return false;
-    },
-    [setActiveAnchor],
-  );
-
-  return scrollToHash;
-};
-
-export const useScrollToAnchor = () => {
-  const location = useLocation();
-  const scrollToHash = useScrollToHash();
-  const initialScrolled = useRef(false);
-
-  useEffect(() => {
-    if (!location.hash || !initialScrolled.current) return;
-
-    scrollToHash(location.hash);
-  }, [location.hash, scrollToHash]);
-
-  useEffect(() => {
-    if (!location.hash) {
-      initialScrolled.current = true;
-      return;
-    }
-
-    const observer = new MutationObserver((_, obs) => {
-      if (!scrollToHash(location.hash)) return;
-      initialScrolled.current = true;
-      obs.disconnect();
-    });
-
-    observer.observe(document.body, { childList: true, subtree: true });
-
-    return () => observer.disconnect();
-  }, [location.hash, scrollToHash]);
-};
+import { useCallback, useEffect, useRef } from "react";
+import { useLocation } from "react-router";
+import { useViewportAnchor } from "../components/context/ViewportAnchorContext.js";
+import { DATA_ANCHOR_ATTR } from "../components/navigation/NavigationItem.js";
+import { scrollIntoViewIfNeeded } from "./scrollIntoViewIfNeeded.js";
+
+export const useScrollToHash = () => {
+  const { setActiveAnchor } = useViewportAnchor();
+
+  const scrollToHash = useCallback(
+    (hash: string) => {
+      const cleanHash = hash.replace(/^#/, "");
+
+      // Operation list items might have subdivisions that the navigation doesn't show.
+      // The subdivisions are separated by a slash so we need to remove everything before the slash to get the navigation correct item.
+      const linkHash = cleanHash.split("/").at(0);
+      if (!linkHash) return false;
+
+      const element = document.getElementById(decodeURIComponent(cleanHash));
+
+      const link = document.querySelector(
+        `[${DATA_ANCHOR_ATTR}="${linkHash}"]`,
+      );
+
+      if (element) {
+        element.scrollIntoView();
+        scrollIntoViewIfNeeded(link);
+        // Set the active anchor after the scroll has happened
+        // so the intersection observer doesn't trigger wrong items
+        requestIdleCallback(() => setActiveAnchor(linkHash));
+        return true;
+      }
+
+      // Scroll didn't happen
+      return false;
+    },
+    [setActiveAnchor],
+  );
+
+  return scrollToHash;
+};
+
+export const useScrollToAnchor = () => {
+  const location = useLocation();
+  const scrollToHash = useScrollToHash();
+  const initialScrolled = useRef(false);
+
+  useEffect(() => {
+    if (!location.hash || !initialScrolled.current) return;
+
+    scrollToHash(location.hash);
+  }, [location.hash, scrollToHash]);
+
+  useEffect(() => {
+    if (!location.hash) {
+      initialScrolled.current = true;
+      return;
+    }
+
+    const observer = new MutationObserver((_, obs) => {
+      if (!scrollToHash(location.hash)) return;
+      initialScrolled.current = true;
+      obs.disconnect();
+    });
+
+    observer.observe(document.body, { childList: true, subtree: true });
+
+    return () => observer.disconnect();
+  }, [location.hash, scrollToHash]);
+};

package/src/lib/util/useScrollToTop.ts

@@ -1,18 +1,18 @@
-import { useEffect, useRef } from "react";
-import { useLocation } from "react-router";
-
-export const useScrollToTop = () => {
-  const location = useLocation();
-  const previousPath = useRef(location.pathname);
-
-  useEffect(() => {
-    const isNewPage = previousPath.current !== location.pathname;
-    const hasAnchor = location.hash !== "";
-
-    if (isNewPage && !hasAnchor) {
-      window.scrollTo(0, 0);
-    }
-
-    previousPath.current = location.pathname;
-  }, [location.pathname, location.hash]);
-};
+import { useEffect, useRef } from "react";
+import { useLocation } from "react-router";
+
+export const useScrollToTop = () => {
+  const location = useLocation();
+  const previousPath = useRef(location.pathname);
+
+  useEffect(() => {
+    const isNewPage = previousPath.current !== location.pathname;
+    const hasAnchor = location.hash !== "";
+
+    if (isNewPage && !hasAnchor) {
+      window.scrollTo(0, 0);
+    }
+
+    previousPath.current = location.pathname;
+  }, [location.pathname, location.hash]);
+};

package/src/types.d.ts

@@ -1,53 +1,57 @@
-declare module "virtual:zudoku-docs-plugin" {
-  export const configuredDocsPlugin:
-    | import("./lib/core/plugins.ts").ApitogoPlugin
-    | undefined;
-  /**
-   * Map of markdown files and imports
-   */
-  export const configuredMarkdownFiles: Record<string, () => Promise<unknown>>;
-}
-
-declare module "virtual:zudoku-navigation" {
-  export const configuredHeaderNavigation: import("./config/validators/HeaderNavigationSchema.ts").HeaderNavigation;
-  export const configuredNavigation: import("./config/validators/NavigationSchema.ts").Navigation;
-  export const configuredNavigationRules: import("./config/validators/NavigationSchema.ts").ResolvedNavigationRule[];
-}
-
-declare module "virtual:zudoku-api-plugins" {
-  export const configuredApiPlugins: import("./lib/core/plugins.ts").ApitogoPlugin[];
-  export const configuredApiCatalogPlugins: import("./lib/core/plugins.ts").ApitogoPlugin[];
-}
-
-declare module "virtual:zudoku-search-plugin" {
-  export const configuredSearchPlugin:
-    | import("./lib/core/plugins.ts").ApitogoPlugin
-    | undefined;
-}
-
-declare module "virtual:zudoku-api-keys-plugin" {
-  export const configuredApiKeysPlugin:
-    | import("./lib/core/plugins.ts").ApitogoPlugin
-    | undefined;
-}
-
-declare module "virtual:zudoku-custom-pages-plugin" {
-  export const configuredCustomPagesPlugin:
-    | import("./lib/core/plugins.ts").ApitogoPlugin
-    | undefined;
-}
-
-declare module "virtual:zudoku-config" {
-  const config: import("./config/config.ts").ZudokuConfig;
-  export default config;
-}
-declare module "virtual:zudoku-auth" {
-  export const configuredAuthProvider:
-    | import("./lib/authentication/authentication.ts").AuthenticationPlugin
-    | undefined;
-}
-
-declare module "virtual:zudoku-shiki-register" {
-  import type { HighlighterCore } from "shiki/core";
-  export const registerShiki: (highlighter: HighlighterCore) => Promise<void>;
-}
+declare module "virtual:zudoku-docs-plugin" {
+  export const configuredDocsPlugin:
+    | import("./lib/core/plugins.ts").ApitogoPlugin
+    | undefined;
+  /**
+   * Map of markdown files and imports
+   */
+  export const configuredMarkdownFiles: Record<string, () => Promise<unknown>>;
+}
+
+declare module "virtual:zudoku-navigation" {
+  export const configuredHeaderNavigation: import("./config/validators/HeaderNavigationSchema.ts").HeaderNavigation;
+  export const configuredNavigation: import("./config/validators/NavigationSchema.ts").Navigation;
+  export const configuredNavigationRules: import("./config/validators/NavigationSchema.ts").ResolvedNavigationRule[];
+}
+
+declare module "virtual:zudoku-api-plugins" {
+  export const configuredApiPlugins: import("./lib/core/plugins.ts").ApitogoPlugin[];
+  export const configuredApiCatalogPlugins: import("./lib/core/plugins.ts").ApitogoPlugin[];
+}
+
+declare module "virtual:zudoku-search-plugin" {
+  export const configuredSearchPlugin:
+    | import("./lib/core/plugins.ts").ApitogoPlugin
+    | undefined;
+}
+
+declare module "virtual:zudoku-api-keys-plugin" {
+  export const configuredApiKeysPlugin:
+    | import("./lib/core/plugins.ts").ApitogoPlugin
+    | undefined;
+}
+
+declare module "virtual:zudoku-modules-plugin" {
+  export const configuredModulesPlugins: import("./lib/core/plugins.ts").ApitogoPlugin[];
+}
+
+declare module "virtual:zudoku-custom-pages-plugin" {
+  export const configuredCustomPagesPlugin:
+    | import("./lib/core/plugins.ts").ApitogoPlugin
+    | undefined;
+}
+
+declare module "virtual:zudoku-config" {
+  const config: import("./config/config.ts").ZudokuConfig;
+  export default config;
+}
+declare module "virtual:zudoku-auth" {
+  export const configuredAuthProvider:
+    | import("./lib/authentication/authentication.ts").AuthenticationPlugin
+    | undefined;
+}
+
+declare module "virtual:zudoku-shiki-register" {
+  import type { HighlighterCore } from "shiki/core";
+  export const registerShiki: (highlighter: HighlighterCore) => Promise<void>;
+}