solid-navigator 0.0.1 → 0.2.0

package/README.md

@@ -6,7 +6,7 @@
 
 [![pnpm](https://img.shields.io/badge/maintained%20with-pnpm-cc00ff.svg?style=for-the-badge&logo=pnpm)](https://pnpm.io/)
 
-Solid Navigator is a library that is inspired by vue router and solid router.
+Solid Navigator is a library that is inspired by vue-router and @solidjs/router.
 
 
 ## Quick start
@@ -22,7 +22,7 @@ pnpm add solid-navigator
 Use it:
 
 ```tsx
-import { useNavigate, Outlet, Route, Router, useLocation, useParams, A } from 'solid-navigator'
+import { Router, Route, Outlet, A, Navigate, useNavigate, useLocation, useParams,  useMatch, useSearchParams } from 'solid-navigator'
 ```
 
 
@@ -55,6 +55,27 @@ const params = useParams<{id: string}>();
 }
 ```
 
+### `useMatch`
+```js
+// path: /chats/1234
+const match = useMatch(() => "/chats/1234");
+{
+  path: "/chats/1234"
+  params: {}
+} | null
+```
+
+### `useSearchParams`
+```js
+// path: /chats?id=1234
+const [params, setParams] = useSearchParams();
+params = {
+  id: "1234"
+} | null
+
+setParams({id: "5678", hello: "Bye"}) // path: /chats?id=5678&hello=Bye
+```
+
 ## Components
 
 ### `Router`  

package/dist/dev.js

@@ -58,8 +58,7 @@ function matchSegment(input, filter) {
   }
   return false;
 }
-var createLocation = (path) => {
-  const [query, setQuery] = createStore({});
+var createLocation = (path, query, setQuery) => {
   const url = createMemo(() => {
     return new URL(path(), "http://owo");
   });
@@ -109,8 +108,9 @@ function Router(props) {
   const [pathname, setPathname] = createSignal(location.pathname);
   const [hashAndSearch, setHashAndSearch] = createSignal(getHashAndSearch());
   const [params, setParams] = createStore({});
+  const [query, setQuery] = createStore({});
   const pathnameWithHashAndSearch = createMemo(() => pathname() + hashAndSearch());
-  const loc = createLocation(pathnameWithHashAndSearch);
+  const loc = createLocation(pathnameWithHashAndSearch, query, setQuery);
   const matched = createMemo(() => {
     if (!routes())
       return;
@@ -167,7 +167,9 @@ function Router(props) {
       params,
       location: loc,
       setHashAndSearch,
-      setPathname
+      setPathname,
+      setQuery,
+      query
     },
     get children() {
       return props.root?.();
@@ -235,8 +237,6 @@ var flattenedRoute = (route) => {
   }
   return routes;
 };
-
-// src/navigator.ts
 var createNavigate = (routes, pathname, setPathname, setHashAndSearch) => {
   return (path, options) => {
     let newPath = path;
@@ -269,6 +269,18 @@ var Navigate = (props) => {
   navigate(props.href, { replace: true });
   return null;
 };
+var useSearchParams = () => {
+  const context = useRouterContext();
+  const navigate = useNavigate();
+  const updateQuery = (query) => {
+    context.setQuery(reconcile(query));
+    const url = new URL(window.location.href);
+    const newSearch = new URLSearchParams(context.query);
+    url.search = newSearch.toString();
+    navigate(url.pathname + url.search + url.hash);
+  };
+  return [context.location.query, updateQuery];
+};
 var Fragment = () => [];
 var Outlet = (props) => {
   const context = useRouterContext();
@@ -310,5 +322,10 @@ var A = (props) => {
     return _el$;
   })();
 };
+var useMatch = (path) => {
+  const context = useRouterContext();
+  const matcher = createMemo(() => createMatcher(path()));
+  return createMemo(() => matcher()(context.location.pathname));
+};
 
-export { A, Navigate, Outlet, Route, Router, useLocation, useNavigate, useParams };
+export { A, Navigate, Outlet, Route, Router, useLocation, useMatch, useNavigate, useParams, useSearchParams };

package/dist/dev.jsx

@@ -67,9 +67,8 @@ function matchSegment(input, filter) {
 
 // src/createLocation.ts
 import { createEffect, createMemo, on } from "solid-js";
-import { createStore, reconcile } from "solid-js/store";
-var createLocation = (path) => {
-  const [query, setQuery] = createStore({});
+import { reconcile } from "solid-js/store";
+var createLocation = (path, query, setQuery) => {
   const url = createMemo(() => {
     return new URL(path(), "http://owo");
   });
@@ -119,8 +118,9 @@ function Router(props) {
   const [pathname, setPathname] = createSignal(location.pathname);
   const [hashAndSearch, setHashAndSearch] = createSignal(getHashAndSearch());
   const [params, setParams] = createStore2({});
+  const [query, setQuery] = createStore2({});
   const pathnameWithHashAndSearch = createMemo2(() => pathname() + hashAndSearch());
-  const loc = createLocation(pathnameWithHashAndSearch);
+  const loc = createLocation(pathnameWithHashAndSearch, query, setQuery);
   const matched = createMemo2(() => {
     if (!routes())
       return;
@@ -167,7 +167,7 @@ function Router(props) {
     });
   });
   return <RouterContext.Provider
-    value={{ routes, matched, navigate, params, location: loc, setHashAndSearch, setPathname }}
+    value={{ routes, matched, navigate, params, location: loc, setHashAndSearch, setPathname, setQuery, query }}
   >{props.root?.()}</RouterContext.Provider>;
 }
 var useRouterContext = () => {
@@ -231,6 +231,7 @@ var flattenedRoute = (route) => {
 };
 
 // src/navigator.ts
+import { reconcile as reconcile3 } from "solid-js/store";
 var createNavigate = (routes, pathname, setPathname, setHashAndSearch) => {
   return (path, options) => {
     let newPath = path;
@@ -263,6 +264,19 @@ var Navigate = (props) => {
   navigate(props.href, { replace: true });
   return null;
 };
+var useSearchParams = () => {
+  const context = useRouterContext();
+  const navigate = useNavigate();
+  const updateQuery = (query) => {
+    context.setQuery(reconcile3(query));
+    const url = new URL(window.location.href);
+    const newSearch = new URLSearchParams(context.query);
+    ;
+    url.search = newSearch.toString();
+    navigate(url.pathname + url.search + url.hash);
+  };
+  return [context.location.query, updateQuery];
+};
 
 // src/Outlet.tsx
 import { createMemo as createMemo3 } from "solid-js";
@@ -304,9 +318,15 @@ var Route = (props) => {
 };
 
 // src/Link.tsx
+import { createMemo as createMemo4 } from "solid-js";
 var A = (props) => {
   return <a sn-link {...props} />;
 };
+var useMatch = (path) => {
+  const context = useRouterContext();
+  const matcher = createMemo4(() => createMatcher(path()));
+  return createMemo4(() => matcher()(context.location.pathname));
+};
 export {
   A,
   Navigate,
@@ -314,6 +334,8 @@ export {
   Route,
   Router,
   useLocation,
+  useMatch,
   useNavigate,
-  useParams
+  useParams,
+  useSearchParams
 };

package/dist/index.d.ts

@@ -18,12 +18,19 @@ declare const useNavigate: () => (path: string, options?: NavigateOptions | unde
 declare const Navigate: (props: {
     href: string;
 }) => null;
+declare const useSearchParams: () => readonly [Record<string, string>, (query: Record<string, string>) => void];
 
 declare const Outlet: (props: {
     children?: string;
     name?: string;
 }) => solid_js.JSX.Element;
 
+type Params = Record<string, string>;
+interface PathMatch {
+    params: Params;
+    path: string;
+}
+
 interface RouterProps {
     children?: JSX.Element;
     root?: () => JSX.Element;
@@ -41,5 +48,6 @@ type LinkProps = {
     replace?: boolean;
 } & JSX.AnchorHTMLAttributes<HTMLAnchorElement>;
 declare const A: (props: LinkProps) => JSX.Element;
+declare const useMatch: (path: () => string) => solid_js.Accessor<PathMatch | null>;
 
-export { A, Navigate, type NavigateOptions, Outlet, Route, type RouteObject, Router, type RouterProps, useLocation, useNavigate, useParams };
+export { A, Navigate, type NavigateOptions, Outlet, Route, type RouteObject, Router, type RouterProps, useLocation, useMatch, useNavigate, useParams, useSearchParams };

package/dist/index.js

@@ -58,8 +58,7 @@ function matchSegment(input, filter) {
   }
   return false;
 }
-var createLocation = (path) => {
-  const [query, setQuery] = createStore({});
+var createLocation = (path, query, setQuery) => {
   const url = createMemo(() => {
     return new URL(path(), "http://owo");
   });
@@ -109,8 +108,9 @@ function Router(props) {
   const [pathname, setPathname] = createSignal(location.pathname);
   const [hashAndSearch, setHashAndSearch] = createSignal(getHashAndSearch());
   const [params, setParams] = createStore({});
+  const [query, setQuery] = createStore({});
   const pathnameWithHashAndSearch = createMemo(() => pathname() + hashAndSearch());
-  const loc = createLocation(pathnameWithHashAndSearch);
+  const loc = createLocation(pathnameWithHashAndSearch, query, setQuery);
   const matched = createMemo(() => {
     if (!routes())
       return;
@@ -167,7 +167,9 @@ function Router(props) {
       params,
       location: loc,
       setHashAndSearch,
-      setPathname
+      setPathname,
+      setQuery,
+      query
     },
     get children() {
       return props.root?.();
@@ -235,8 +237,6 @@ var flattenedRoute = (route) => {
   }
   return routes;
 };
-
-// src/navigator.ts
 var createNavigate = (routes, pathname, setPathname, setHashAndSearch) => {
   return (path, options) => {
     let newPath = path;
@@ -268,6 +268,18 @@ var Navigate = (props) => {
   navigate(props.href, { replace: true });
   return null;
 };
+var useSearchParams = () => {
+  const context = useRouterContext();
+  const navigate = useNavigate();
+  const updateQuery = (query) => {
+    context.setQuery(reconcile(query));
+    const url = new URL(window.location.href);
+    const newSearch = new URLSearchParams(context.query);
+    url.search = newSearch.toString();
+    navigate(url.pathname + url.search + url.hash);
+  };
+  return [context.location.query, updateQuery];
+};
 var Fragment = () => [];
 var Outlet = (props) => {
   const context = useRouterContext();
@@ -307,5 +319,10 @@ var A = (props) => {
     return _el$;
   })();
 };
+var useMatch = (path) => {
+  const context = useRouterContext();
+  const matcher = createMemo(() => createMatcher(path()));
+  return createMemo(() => matcher()(context.location.pathname));
+};
 
-export { A, Navigate, Outlet, Route, Router, useLocation, useNavigate, useParams };
+export { A, Navigate, Outlet, Route, Router, useLocation, useMatch, useNavigate, useParams, useSearchParams };

package/dist/index.jsx

@@ -67,9 +67,8 @@ function matchSegment(input, filter) {
 
 // src/createLocation.ts
 import { createEffect, createMemo, on } from "solid-js";
-import { createStore, reconcile } from "solid-js/store";
-var createLocation = (path) => {
-  const [query, setQuery] = createStore({});
+import { reconcile } from "solid-js/store";
+var createLocation = (path, query, setQuery) => {
   const url = createMemo(() => {
     return new URL(path(), "http://owo");
   });
@@ -119,8 +118,9 @@ function Router(props) {
   const [pathname, setPathname] = createSignal(location.pathname);
   const [hashAndSearch, setHashAndSearch] = createSignal(getHashAndSearch());
   const [params, setParams] = createStore2({});
+  const [query, setQuery] = createStore2({});
   const pathnameWithHashAndSearch = createMemo2(() => pathname() + hashAndSearch());
-  const loc = createLocation(pathnameWithHashAndSearch);
+  const loc = createLocation(pathnameWithHashAndSearch, query, setQuery);
   const matched = createMemo2(() => {
     if (!routes())
       return;
@@ -167,7 +167,7 @@ function Router(props) {
     });
   });
   return <RouterContext.Provider
-    value={{ routes, matched, navigate, params, location: loc, setHashAndSearch, setPathname }}
+    value={{ routes, matched, navigate, params, location: loc, setHashAndSearch, setPathname, setQuery, query }}
   >{props.root?.()}</RouterContext.Provider>;
 }
 var useRouterContext = () => {
@@ -231,6 +231,7 @@ var flattenedRoute = (route) => {
 };
 
 // src/navigator.ts
+import { reconcile as reconcile3 } from "solid-js/store";
 var createNavigate = (routes, pathname, setPathname, setHashAndSearch) => {
   return (path, options) => {
     let newPath = path;
@@ -262,6 +263,19 @@ var Navigate = (props) => {
   navigate(props.href, { replace: true });
   return null;
 };
+var useSearchParams = () => {
+  const context = useRouterContext();
+  const navigate = useNavigate();
+  const updateQuery = (query) => {
+    context.setQuery(reconcile3(query));
+    const url = new URL(window.location.href);
+    const newSearch = new URLSearchParams(context.query);
+    ;
+    url.search = newSearch.toString();
+    navigate(url.pathname + url.search + url.hash);
+  };
+  return [context.location.query, updateQuery];
+};
 
 // src/Outlet.tsx
 import { createMemo as createMemo3 } from "solid-js";
@@ -301,9 +315,15 @@ var Route = (props) => {
 };
 
 // src/Link.tsx
+import { createMemo as createMemo4 } from "solid-js";
 var A = (props) => {
   return <a sn-link {...props} />;
 };
+var useMatch = (path) => {
+  const context = useRouterContext();
+  const matcher = createMemo4(() => createMatcher(path()));
+  return createMemo4(() => matcher()(context.location.pathname));
+};
 export {
   A,
   Navigate,
@@ -311,6 +331,8 @@ export {
   Route,
   Router,
   useLocation,
+  useMatch,
   useNavigate,
-  useParams
+  useParams,
+  useSearchParams
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "solid-navigator",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Solid Navigator is a library that is inspired by vue router and solid router.",
   "license": "MIT",
   "author": "SupertigerDev",