preact-hashish-router 0.0.11 → 0.0.13

package/README.md

@@ -88,6 +88,26 @@ export default function Header() {
 }
 ```
 
+### `<Redirect />` Component
+
+```tsx
+import { Redirect } from "preact-hashish-router";
+
+export default function ProductPage() {
+  return (
+    <>
+      <header>
+        <nav>
+          <A href="/">Home</A>
+          <A href="/about">About</A>
+        </nav>
+      </header>
+      <Redirect to="/" />
+    </>
+  );
+}
+```
+
 ## Development
 
 If you have any improvements or find any issues, feel free to contribute or open an issue in the associated repository.

package/dist/Redirect.d.ts

@@ -0,0 +1,4 @@
+export type RedirectProps = {
+    to: string;
+};
+export declare const Redirect: (props: RedirectProps) => import("preact").JSX.Element;

package/dist/Redirect.js

@@ -0,0 +1,10 @@
+import { jsx as _jsx } from "preact/jsx-runtime";
+import { Fragment, useLayoutEffect } from "preact/compat";
+import { useRouter } from "./useRouter";
+export const Redirect = (props) => {
+    const router = useRouter();
+    useLayoutEffect(() => {
+        router.go(props.to);
+    }, []);
+    return _jsx(Fragment, {});
+};

package/dist/Router.d.ts

@@ -2,6 +2,15 @@ import { PropsWithChildren } from "preact/compat";
 import { RouterContext } from "./context";
 type RouterProps = PropsWithChildren & {
     type: RouterContext["type"];
+    /**
+     * Only for `hash` routers.
+     *
+     * Decide if the initial pathname will be rewrite as the initial hash.
+     *
+     * `Caution`: This will replace the initial url hash
+     * @default false
+     */
+    redirect_path_to_hash?: boolean;
 };
 export declare const Router: (props: RouterProps) => import("preact").JSX.Element;
 export {};

package/dist/Router.js

@@ -44,9 +44,11 @@ export const Router = (props) => {
         const [path, query] = get_hash_route().split("?");
         setQuery(query || "");
         setPath(path);
-        if (location.pathname !== "/") {
-            location.hash = location.pathname;
-            location.pathname = "";
+        if (props.redirect_path_to_hash === true) {
+            if (location.pathname !== "/") {
+                location.hash = location.pathname;
+                location.pathname = "";
+            }
         }
         hashEffectHandler.effect();
         return () => hashEffectHandler.cleanUp();

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./A";
 export * from "./ErrorRoute";
+export * from "./Redirect";
 export * from "./Route";
 export * from "./Router";
 export * from "./RouterErrorBoundary";

package/dist/index.js

@@ -1,5 +1,6 @@
 export * from "./A";
 export * from "./ErrorRoute";
+export * from "./Redirect";
 export * from "./Route";
 export * from "./Router";
 export * from "./RouterErrorBoundary";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "preact-hashish-router",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "type": "module",
   "module": "dist/index.js",
   "description": "A simple router for preact",