@real-router/browser-plugin 0.10.2 → 0.10.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -27
- package/dist/cjs/metafile-cjs.json +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -33,16 +33,18 @@ await router.start(); // path inferred from browser location
|
|
|
33
33
|
## Options
|
|
34
34
|
|
|
35
35
|
```typescript
|
|
36
|
-
router.usePlugin(
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
36
|
+
router.usePlugin(
|
|
37
|
+
browserPluginFactory({
|
|
38
|
+
base: "/app", // Base path prefix for all routes
|
|
39
|
+
forceDeactivate: true, // Bypass canDeactivate guards on back/forward
|
|
40
|
+
}),
|
|
41
|
+
);
|
|
40
42
|
```
|
|
41
43
|
|
|
42
|
-
| Option
|
|
43
|
-
|
|
44
|
-
| `base`
|
|
45
|
-
| `forceDeactivate` | `boolean` | `true`
|
|
44
|
+
| Option | Type | Default | Description |
|
|
45
|
+
| ----------------- | --------- | ------- | ---------------------------------------------------------------------- |
|
|
46
|
+
| `base` | `string` | `""` | Base path for all routes (e.g., `"/app"` → URLs start with `/app/...`) |
|
|
47
|
+
| `forceDeactivate` | `boolean` | `true` | Bypass `canDeactivate` guards on browser back/forward |
|
|
46
48
|
|
|
47
49
|
> **Hash routing?** Use [`@real-router/hash-plugin`](https://www.npmjs.com/package/@real-router/hash-plugin) instead.
|
|
48
50
|
|
|
@@ -50,11 +52,11 @@ router.usePlugin(browserPluginFactory({
|
|
|
50
52
|
|
|
51
53
|
The plugin extends the router instance with three methods via [`extendRouter()`](https://github.com/greydragon888/real-router/wiki/plugin-architecture):
|
|
52
54
|
|
|
53
|
-
| Method
|
|
54
|
-
|
|
55
|
-
| `buildUrl(name, params?)`
|
|
56
|
-
| `matchUrl(url)`
|
|
57
|
-
| `replaceHistoryState(name, params?, title?)` | `void`
|
|
55
|
+
| Method | Returns | Description |
|
|
56
|
+
| -------------------------------------------- | -------------------- | ------------------------------------------------ |
|
|
57
|
+
| `buildUrl(name, params?)` | `string` | Build full URL with base path |
|
|
58
|
+
| `matchUrl(url)` | `State \| undefined` | Parse URL to router state |
|
|
59
|
+
| `replaceHistoryState(name, params?, title?)` | `void` | Update browser URL without triggering navigation |
|
|
58
60
|
|
|
59
61
|
```typescript
|
|
60
62
|
router.buildUrl("users", { id: "123" });
|
|
@@ -71,14 +73,14 @@ router.replaceHistoryState("users", { id: "456" });
|
|
|
71
73
|
|
|
72
74
|
```typescript
|
|
73
75
|
router.buildPath("users", { id: 1 }); // "/users/1" — core, no base
|
|
74
|
-
router.buildUrl("users", { id: 1 });
|
|
76
|
+
router.buildUrl("users", { id: 1 }); // "/app/users/1" — plugin, with base
|
|
75
77
|
```
|
|
76
78
|
|
|
77
79
|
### `replaceHistoryState` vs `navigate({ replace: true })`
|
|
78
80
|
|
|
79
81
|
```typescript
|
|
80
|
-
router.replaceHistoryState(name, params);
|
|
81
|
-
router.navigate(name, params, { replace: true });
|
|
82
|
+
router.replaceHistoryState(name, params); // URL only, no transition
|
|
83
|
+
router.navigate(name, params, { replace: true }); // Full transition + URL update
|
|
82
84
|
```
|
|
83
85
|
|
|
84
86
|
## Form Protection
|
|
@@ -91,9 +93,12 @@ router.usePlugin(browserPluginFactory({ forceDeactivate: false }));
|
|
|
91
93
|
import { getLifecycleApi } from "@real-router/core/api";
|
|
92
94
|
|
|
93
95
|
const lifecycle = getLifecycleApi(router);
|
|
94
|
-
lifecycle.addDeactivateGuard(
|
|
95
|
-
|
|
96
|
-
|
|
96
|
+
lifecycle.addDeactivateGuard(
|
|
97
|
+
"checkout",
|
|
98
|
+
(router, getDep) => (toState, fromState) => {
|
|
99
|
+
return !hasUnsavedChanges(); // false blocks back/forward
|
|
100
|
+
},
|
|
101
|
+
);
|
|
97
102
|
```
|
|
98
103
|
|
|
99
104
|
## SSR Support
|
|
@@ -103,8 +108,8 @@ The plugin is SSR-safe — automatically detects the environment and falls back
|
|
|
103
108
|
```typescript
|
|
104
109
|
// Server-side — no errors, methods return safe defaults
|
|
105
110
|
router.usePlugin(browserPluginFactory());
|
|
106
|
-
router.buildUrl("home");
|
|
107
|
-
router.matchUrl("/path");
|
|
111
|
+
router.buildUrl("home"); // returns path without base
|
|
112
|
+
router.matchUrl("/path"); // returns undefined
|
|
108
113
|
```
|
|
109
114
|
|
|
110
115
|
## Documentation
|
|
@@ -118,12 +123,12 @@ Full documentation: [Wiki — browser-plugin](https://github.com/greydragon888/r
|
|
|
118
123
|
|
|
119
124
|
## Related Packages
|
|
120
125
|
|
|
121
|
-
| Package
|
|
122
|
-
|
|
123
|
-
| [@real-router/core](https://www.npmjs.com/package/@real-router/core)
|
|
124
|
-
| [@real-router/hash-plugin](https://www.npmjs.com/package/@real-router/hash-plugin)
|
|
125
|
-
| [@real-router/react](https://www.npmjs.com/package/@real-router/react)
|
|
126
|
-
| [@real-router/logger-plugin](https://www.npmjs.com/package/@real-router/logger-plugin) | Development logging
|
|
126
|
+
| Package | Description |
|
|
127
|
+
| -------------------------------------------------------------------------------------- | -------------------------------------- |
|
|
128
|
+
| [@real-router/core](https://www.npmjs.com/package/@real-router/core) | Core router (required peer dependency) |
|
|
129
|
+
| [@real-router/hash-plugin](https://www.npmjs.com/package/@real-router/hash-plugin) | Hash-based routing (`#/path`) |
|
|
130
|
+
| [@real-router/react](https://www.npmjs.com/package/@real-router/react) | React integration |
|
|
131
|
+
| [@real-router/logger-plugin](https://www.npmjs.com/package/@real-router/logger-plugin) | Development logging |
|
|
127
132
|
|
|
128
133
|
## Contributing
|
|
129
134
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"inputs":{"../../node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.
|
|
1
|
+
{"inputs":{"../../node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.8_tsx@4.19.4_typescript@5.9.3_yaml@2.8.2/node_modules/tsup/assets/cjs_shims.js":{"bytes":569,"imports":[],"format":"esm"},"../type-guards/dist/esm/index.mjs":{"bytes":3451,"imports":[{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.8_tsx@4.19.4_typescript@5.9.3_yaml@2.8.2/node_modules/tsup/assets/cjs_shims.js","kind":"import-statement","external":true}],"format":"esm"},"../browser-env/dist/esm/index.mjs":{"bytes":4153,"imports":[{"path":"../type-guards/dist/esm/index.mjs","kind":"import-statement","original":"type-guards"},{"path":"@real-router/core","kind":"import-statement","external":true},{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.8_tsx@4.19.4_typescript@5.9.3_yaml@2.8.2/node_modules/tsup/assets/cjs_shims.js","kind":"import-statement","external":true}],"format":"esm"},"src/constants.ts":{"bytes":493,"imports":[{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.8_tsx@4.19.4_typescript@5.9.3_yaml@2.8.2/node_modules/tsup/assets/cjs_shims.js","kind":"import-statement","external":true}],"format":"esm"},"src/url-utils.ts":{"bytes":703,"imports":[{"path":"../browser-env/dist/esm/index.mjs","kind":"import-statement","original":"browser-env"},{"path":"src/constants.ts","kind":"import-statement","original":"./constants"},{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.8_tsx@4.19.4_typescript@5.9.3_yaml@2.8.2/node_modules/tsup/assets/cjs_shims.js","kind":"import-statement","external":true}],"format":"esm"},"src/plugin.ts":{"bytes":2944,"imports":[{"path":"../browser-env/dist/esm/index.mjs","kind":"import-statement","original":"browser-env"},{"path":"src/url-utils.ts","kind":"import-statement","original":"./url-utils"},{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.8_tsx@4.19.4_typescript@5.9.3_yaml@2.8.2/node_modules/tsup/assets/cjs_shims.js","kind":"import-statement","external":true}],"format":"esm"},"src/validation.ts":{"bytes":288,"imports":[{"path":"../browser-env/dist/esm/index.mjs","kind":"import-statement","original":"browser-env"},{"path":"src/constants.ts","kind":"import-statement","original":"./constants"},{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.8_tsx@4.19.4_typescript@5.9.3_yaml@2.8.2/node_modules/tsup/assets/cjs_shims.js","kind":"import-statement","external":true}],"format":"esm"},"src/factory.ts":{"bytes":1517,"imports":[{"path":"@real-router/core/api","kind":"import-statement","external":true},{"path":"../browser-env/dist/esm/index.mjs","kind":"import-statement","original":"browser-env"},{"path":"src/constants.ts","kind":"import-statement","original":"./constants"},{"path":"src/plugin.ts","kind":"import-statement","original":"./plugin"},{"path":"src/url-utils.ts","kind":"import-statement","original":"./url-utils"},{"path":"src/validation.ts","kind":"import-statement","original":"./validation"},{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.8_tsx@4.19.4_typescript@5.9.3_yaml@2.8.2/node_modules/tsup/assets/cjs_shims.js","kind":"import-statement","external":true}],"format":"esm"},"src/index.ts":{"bytes":1311,"imports":[{"path":"src/factory.ts","kind":"import-statement","original":"./factory"},{"path":"../type-guards/dist/esm/index.mjs","kind":"import-statement","original":"type-guards"},{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.8_tsx@4.19.4_typescript@5.9.3_yaml@2.8.2/node_modules/tsup/assets/cjs_shims.js","kind":"import-statement","external":true}],"format":"esm"}},"outputs":{"dist/cjs/index.js.map":{"imports":[],"exports":[],"inputs":{},"bytes":8921},"dist/cjs/index.js":{"imports":[{"path":"@real-router/core/api","kind":"import-statement","external":true},{"path":"@real-router/core","kind":"import-statement","external":true}],"exports":["browserPluginFactory","isState"],"entryPoint":"src/index.ts","inputs":{"src/factory.ts":{"bytesInOutput":831},"../type-guards/dist/esm/index.mjs":{"bytesInOutput":2337},"../browser-env/dist/esm/index.mjs":{"bytesInOutput":4761},"src/constants.ts":{"bytesInOutput":126},"src/url-utils.ts":{"bytesInOutput":442},"src/plugin.ts":{"bytesInOutput":1790},"src/validation.ts":{"bytesInOutput":63},"src/index.ts":{"bytesInOutput":0}},"bytes":10596}}}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@real-router/browser-plugin",
|
|
3
|
-
"version": "0.10.
|
|
3
|
+
"version": "0.10.3",
|
|
4
4
|
"type": "commonjs",
|
|
5
5
|
"description": "Browser integration plugin with History API, hash routing, and popstate support",
|
|
6
6
|
"main": "./dist/cjs/index.js",
|
|
@@ -45,12 +45,12 @@
|
|
|
45
45
|
},
|
|
46
46
|
"sideEffects": false,
|
|
47
47
|
"dependencies": {
|
|
48
|
-
"@real-router/core": "^0.
|
|
48
|
+
"@real-router/core": "^0.38.0"
|
|
49
49
|
},
|
|
50
50
|
"devDependencies": {
|
|
51
51
|
"@testing-library/jest-dom": "6.9.1",
|
|
52
52
|
"jsdom": "28.1.0",
|
|
53
|
-
"browser-env": "^0.1.
|
|
53
|
+
"browser-env": "^0.1.5",
|
|
54
54
|
"type-guards": "^0.3.7"
|
|
55
55
|
},
|
|
56
56
|
"scripts": {
|