crossroad 3.0.10 → 3.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "crossroad",
-  "version": "3.0.10",
+  "version": "3.0.11",
   "description": "A React library to handle navigation easily in your WebApp",
   "homepage": "https://crossroad.page/",
   "repository": "github:franciscop/crossroad",
@@ -14,15 +14,6 @@
     "javascript",
     "hooks"
   ],
-  "documentation": {
-    "home": "assets/home.html",
-    "menu": {
-      "Documentation": "/documentation",
-      "Donate": "https://www.paypal.me/franciscopresencia/19",
-      "Author": "https://francisco.io/",
-      "Github": "https://github.com/franciscop/crossroad"
-    }
-  },
   "scripts": {
     "build": "npm run build:library && npm run build:types && npm run build:prettier",
     "build:library": "vite build && mv dist/index.min.js . && rm -rf dist",
@@ -37,7 +28,6 @@
   "type": "module",
   "types": "index.d.ts",
   "files": [
-    "index.min.js",
     "index.d.ts"
   ],
   "devDependencies": {
@@ -51,14 +41,22 @@
     "prettier": "^3.8.1",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
-    "react-test": "^0.24.2",
+    "react-test": "^0.24.3",
     "terser": "^5.46.1",
     "typescript": "^6.0.2",
     "vite": "^8.0.3",
-    "vite-plugin-dts": "^4.5.4",
     "vitest": "^4.1.2"
   },
   "peerDependencies": {
     "react": ">=18.0.0"
+  },
+  "documentation": {
+    "home": "assets/home.html",
+    "menu": {
+      "Documentation": "/documentation",
+      "Donate": "https://www.paypal.me/franciscopresencia/19",
+      "Author": "https://francisco.io/",
+      "Github": "https://github.com/franciscop/crossroad"
+    }
   }
 }

package/readme.md

@@ -6,7 +6,7 @@ A React library to handle navigation in your WebApp. Built with simple component
 - Very useful hooks like [`useUrl`](#useurl), [`useQuery`](#usequery), etc. Follow [the rules of hooks](https://reactjs.org/docs/hooks-rules.html).
 - Links are plain `<a>` instead of custom components. [Read more](#a).
 - The `<Route>` path is `exact` by default and can match query parameters.
-- It's [just ~1.8kb](https://bundlephobia.com/package/crossroad) (min+gzip) instead of the 17kb of React Router(+Dom).
+- It's [just ~1.9kb](https://bundlephobia.com/package/crossroad) (min+gzip) instead of the 17kb of React Router(+Dom).
 - Add `scrollUp` to `<Router>` o `<Route>` to automatically scroll up on a route change.
 
 [**🔗 Demo on CodeSandbox**](https://codesandbox.io/s/recursing-wozniak-uftyo?file=/src/App.js)
@@ -250,7 +250,8 @@ const UserList = () => <div>List here</div>;
 // <div>List here</div>
 ```
 
-> NOTE: the parameter is passed straight to the component instead of wrapped like in React Router.
+> [!WARNING]
+> The parameter is passed straight to the component instead of wrapped like in React Router, see the examples above.
 
 The path can also include a wildcard `*`, in which case it will perform a partial match of everything before itself. It can only be at the end of the path:
 
@@ -265,7 +266,9 @@ The path can also include a wildcard `*`, in which case it will perform a partia
 <Route path="/user/:id/*" component={User} />
 ```
 
-> NOTE: in Crossroad the paths are exact by default, and with the wildcard you can make them partial matches. So the wildcard is the opposite of adding `exact` to React Router.
+
+> [!TIP]
+> In Crossroad the paths are exact by default, and with the wildcard you can make them partial matches. So the wildcard is the opposite of adding `exact` to React Router.
 
 It can also match query parameters:
 
@@ -347,9 +350,7 @@ Some examples:
 
 ### `useUrl()`
 
-> NOTE: within Crossroad's and for lack of a better name, "URL" refers to the combination of path + search query + hash.
-
-Read and set the full URL:
+Read and set the full URL (path + search query + hash):
 
 ```js
 import { useUrl } from "crossroad";
@@ -485,7 +486,7 @@ const Login = () => {
 
 The path is always a string equivalent to `window.location.pathname`. Why not use `window.location.pathname` then? Because usePath() is a hook that will trigger a re-render when the path changes!
 
-> Note: `setPath` _only_ modifies the path(name) and keeps the search query and hash the same, so if you want to modify the full URL you should instead utilize `useUrl()` and `setUrl('/welcome')`
+`setPath` _only_ modifies the path(name) and keeps the search query and hash the same, so if you want to modify the full URL you should instead utilize `useUrl()` and `setUrl('/welcome')`
 
 #### Setter
 
@@ -496,7 +497,7 @@ setPath("/newpath");
 setPath((oldPath) => "/newpath");
 ```
 
-The function `setPath` is _always_ the same, so it doesn't matter whether you put it as a dependency or not. However the `path` can be updated, so you might want to put that:
+The function `setPath` is _always_ stable, so it doesn't matter whether you put it as a dependency or not. However the `path` can be updated, so you might want to put that:
 
 ```js
 const [path, setPath] = usePath();
@@ -922,7 +923,8 @@ In this case the order matters, because the generic NotFound will be matched wit
 
 ### Github hosting
 
-> NOTE: this is a bad idea for SEO, but if that doesn't matter much for you go ahead and host your webapp in Github Pages
+> [!WARNING]
+> This is a bad idea for SEO, but if that doesn't matter much for you go ahead and host your webapp in Github Pages
 
 Github pages is a bit particular in that as of this writing it does not allow for a generic redirect like most other static website servers, so we need to do a workaround with the `404.html` page.