@ngrdt/router 0.0.1 → 0.0.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 +48 -3
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -1,7 +1,52 @@
|
|
|
1
1
|
# @ngrdt/router
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
### Instalation
|
|
4
|
+
```npm install @ngrdt/router```
|
|
4
5
|
|
|
5
|
-
|
|
6
|
+
### Define Route
|
|
7
|
+
```javascript
|
|
8
|
+
export const COOL_ROUTE = new RdtRouteBuilder()
|
|
9
|
+
.setName('Cool Route')
|
|
10
|
+
.setPath('cool-route')
|
|
11
|
+
.setCanBeEntered(() => inject(MockPermissionService).hasPermission('COOL_ACCESS'))
|
|
12
|
+
.build();
|
|
13
|
+
```
|
|
6
14
|
|
|
7
|
-
|
|
15
|
+
### Define Child Route
|
|
16
|
+
```javascript
|
|
17
|
+
export const COOL_ROUTE_CHILD = new RdtRouteBuilder()
|
|
18
|
+
.setName('Cool Route child')
|
|
19
|
+
.setPath(':coolId')
|
|
20
|
+
.setCanBeEntered(() => inject(MockPermissionService).hasPermission('COOL_CHILD_ACCESS'))
|
|
21
|
+
.build();
|
|
22
|
+
|
|
23
|
+
PARENT_ROUTE
|
|
24
|
+
.setChildren(COOL_ROUTE_CHILD)
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### Define Angular Route
|
|
28
|
+
```javascript
|
|
29
|
+
// Create angular route
|
|
30
|
+
COOL_ROUTE.toAngularRoute()
|
|
31
|
+
.setComponent(RouteLevel1Component)
|
|
32
|
+
.build()
|
|
33
|
+
|
|
34
|
+
// Get information of route
|
|
35
|
+
COOL_ROUTE.name
|
|
36
|
+
```
|
|
37
|
+
### Use It in template
|
|
38
|
+
```html
|
|
39
|
+
<button [rdtRouterLink]="COOL_ROUTE" [params]="{ coolId: 123 }">
|
|
40
|
+
Go to Level 2
|
|
41
|
+
</button>
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### See other cool features like
|
|
45
|
+
```javascript
|
|
46
|
+
private readonly rdtRouter: RdtRouterService = inject(Dp3RouterService);
|
|
47
|
+
|
|
48
|
+
rdtRouter.navigate(...);
|
|
49
|
+
rdtRouter.parseAbsoluteUrl(...);
|
|
50
|
+
rdtRouter.navigateBack(...);
|
|
51
|
+
...
|
|
52
|
+
```
|
package/package.json
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ngrdt/router",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.3",
|
|
4
4
|
"peerDependencies": {
|
|
5
5
|
"@angular/common": "^18.2.0",
|
|
6
|
-
"@angular/core": "^18.2.0"
|
|
6
|
+
"@angular/core": "^18.2.0",
|
|
7
|
+
"@ngrdt/utils": "^0.0.1"
|
|
7
8
|
},
|
|
8
9
|
"sideEffects": false,
|
|
9
10
|
"module": "fesm2022/ngrdt-router.mjs",
|