Add back support (#140)

* Add back suppor

* Add forward support

* Add readme entry

Author: JoviDeCroock

README.md

@@ -292,6 +292,8 @@ Returns an object with the following properties:
   - `path: string` - The current path
   - `query: Record<string, string>` - The current query string parameters (`/profile?name=John` -> `{ name: 'John' }`)
   - `route: (url: string, replace?: boolean) => void` - A function to programmatically navigate to a new route. The `replace` param can optionally be used to overwrite history, navigating them away without keeping the current location in the history stack.
+  - `back: () => void` - A function to programmatically navigate back one entry in the browser history stack.
+  - `forward: () => void` - A function to programmatically navigate forward one entry in the browser history stack.
 
 ### `useRoute`
 

src/router.d.ts

@@ -43,6 +43,8 @@ interface LocationHook {
 	path: string;
 	query: Record<string, string>;
 	route: (url: string, replace?: boolean) => void;
+	back: () => void;
+	forward: () => void;
 }
 export const useLocation: () => LocationHook;
 

src/router.js

@@ -61,6 +61,7 @@ function handleNav(state, action) {
 
 	if (push === true) history.pushState(null, '', url);
 	else if (push === false) history.replaceState(null, '', url);
+
 	return url;
 };
 
@@ -112,6 +113,12 @@ export function LocationProvider(props) {
 			path,
 			query: Object.fromEntries(u.searchParams),
 			route: (url, replace) => route({ url, replace }),
+			back: () => {
+				history.back();
+			},
+			forward: () => {
+				history.forward();
+			},
 			wasPush
 		};
 	}, [url]);