@hettiger/ngx-fragment-link-faker - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

CHANGELOG.md

 <!-- CHANGELOGGER -->
 
+## [v0.1.2] - 2022-09-24
+
+### Other (1 change)
+
+- Document behavior on various router extra options
+
+
 ## [v0.1.1] - 2022-02-14
@@ -4,0 +11,0 @@

package.json

@@ -13,3 +13,3 @@ {
   ],
-  "version": "0.1.1",
+  "version": "0.1.2",
   "author": {
@@ -16,0 +16,0 @@ "name": "Martin Hettiger",

README.md

@@ -105,2 +105,30 @@ # NgxFragmentLinkFaker
 
+## Router Extra Options
+
+Anchor scrolling may not work when you enable `scrollPositionRestoration` on the `RouterModule`.
+Make sure to also enable the `anchorScrolling` option and set an appropriate `scrollOffset`.
+
+> I.e. if you use `scrollTopDelta: 64` or `[mhScrollTopDelta]="64"` set `scrollOffset` to `[0, 64]`.
+
+```typescript
+@NgModule({
+  imports: [RouterModule.forRoot(routes, {
+    scrollPositionRestoration: 'enabled',
+    anchorScrolling: 'enabled',
+    scrollOffset: [0, 64],
+  })],
+  exports: [RouterModule]
+})
+export class AppRoutingModule {
+}
+```
+
+In addition to these extra options you optionally need the following global styles for smooth scroll support:
+
+```css
+html {
+  scroll-behavior: smooth;
+}
+```
+
 ## Demo application
@@ -107,0 +135,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

47138

increased by1.78%

Number of lines in readme file

184

increased by17.95%

No dependency changes