Adding support for hash based routing

https://plausible.io/docs/hash-based-routing Fixes #99
4lejandrito · Aug 21, 2023 · e27f26c · e27f26c
1 parent 6bf6f5e
commit e27f26c
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -72,6 +72,7 @@ export default function RootLayout({ children }) {
 | `manualPageviews`    | Set this to `true` if you want to disable [automatic pageview events](https://plausible.io/docs/script-extensions#plausiblemanualjs).                                                                    |
 | `pageviewProps`      | Set the [custom properties for pageviews](https://plausible.io/docs/custom-pageview-props). The `event-` prefix will be added automatically. See [an example](test/page/pages/pageViewPropsAsObject.js). |
 | `revenue`            | Set this to `true` if you want to enable [ecommerce revenue tracking](https://plausible.io/docs/ecommerce-revenue-tracking).                                                                             |
+| `hash`               | Set this to `true` if you want to [use hash-based routing](https://plausible.io/docs/hash-based-routing).                                                                                                |
 | `exclude`            | Set this if you want to exclude a set of pages from being tracked. See https://plausible.io/docs/excluding-pages for more details.                                                                       |
 | `selfHosted`         | Set this to `true` if you are self hosting your Plausible instance. Otherwise you will get a 404 when requesting the script.                                                                             |
 | `enabled`            | Use this to explicitly decide whether or not to render script. If not passed the script will be rendered in production environments.                                                                     |

diff --git a/lib/PlausibleProvider.tsx b/lib/PlausibleProvider.tsx
@@ -35,6 +35,10 @@ export default function PlausibleProvider(props: {
    *  Set this to true if you want to track ecommerce revenue as described in https://plausible.io/docs/ecommerce-revenue-tracking .
    */
   revenue?: boolean
+  /**
+   *  Set this to true if you want to use hash-based routing as described in https://plausible.io/docs/hash-based-routing.
+   */
+  hash?: boolean
   /**
    * Set this to true if you want to enable localhost tracking as described in https://plausible.io/docs/script-extensions.
    */

diff --git a/lib/common.ts b/lib/common.ts
@@ -18,6 +18,7 @@ export const allModifiers = [
   'tagged-events',
   'pageview-props',
   'revenue',
+  'hash',
 ] as const
 
 export type ScriptModifier = typeof allModifiers[number]