Skip to content

Commit 564171f

Browse files
committed
Last few fixes (pray)
1 parent af77064 commit 564171f

File tree

3 files changed

+18
-13
lines changed

3 files changed

+18
-13
lines changed

.markdownlint.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"no-duplicate-heading":false,
3+
"line-length": false
4+
}

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ routing has finished) and in both directions (horizontal/vertical)
1919

2020
## Table of contents
2121

22-
- [ngx-page-scroll ](#ngx-page-scroll--)
22+
- [ngx-page-scroll](#ngx-page-scroll--)
2323
- [Features](#features)
2424
- [Table of contents](#table-of-contents)
2525
- [Version compatibility](#version-compatibility)
@@ -58,6 +58,7 @@ Install later versions in case your app is not running the very latest angular v
5858
### Setup
5959

6060
First you need to install the core npm module:
61+
6162
```sh
6263
npm install ngx-page-scroll-core --save
6364
```
@@ -128,6 +129,7 @@ It utilizes the ngx-page-scroll-core module for that, thus requires it as a peer
128129
### Setup
129130

130131
First you need to install the directive npm module:
132+
131133
```sh
132134
npm install ngx-page-scroll --save
133135
```
@@ -179,22 +181,22 @@ of only 1 second.
179181

180182
| Attribute | Type | Default | Description |
181183
| ------------------------- | ----------- | ------------ |-------------- |
182-
| `pageScroll` | | | Attribute adding scroll-animation behavior when the `click`-event happens on the element.
183-
| `pageScrollTarget` | string | | Optional attribute to set the element that should be scrolled to. Takes precedence over the ´href´-value
184-
| `pageScrollHorizontal` | boolean | false | Whether the scroll should happen in vertical direction (`false`, default) or horizontal (`true`).
185-
| `pageScrollOffset` | number | 0 | Pixels to offset from the top of the element when scrolling to (positive value = scrolling will stop given pixels atop the target element).
186-
| `pageScrollDuration` | number | 1250 | Duration in milliseconds the whole scroll-animation should last.
187-
| `pageScrollSpeed` | number | - | Speed in Pixel/Second the animation should take. Only applied if no duration is set.
188-
| `pageScrollInView` | boolean | true | Whether the scroll animation should happen even when the scroll target is already inside the view port (`true`). Set to `false` to skip scroll animation if target is already in view.
189-
| `pageScrollInterruptible` | boolean | true | Whether the scroll animation should stop if the user interferes with it (`true`) or not (`false`).
190-
| `pageScrollAdjustHash` | boolean | false | Whether the [routes hash/fragment](https://angular.io/docs/ts/latest/guide/router.html#!#query-parameters) should be updated to reflect to section that has been scrolled to
191-
| `pageScrollEasing` | EasingLogic | linearEasing | Easing method to be used while calculating the scroll position over time (default is linear easing).
184+
| `pageScroll` | | | Attribute adding scroll-animation behavior when the `click`-event happens on the element. |
185+
| `pageScrollTarget` | string | | Optional attribute to set the element that should be scrolled to. Takes precedence over the ´href´-value |
186+
| `pageScrollHorizontal` | boolean | false | Whether the scroll should happen in vertical direction (`false`, default) or horizontal (`true`). |
187+
| `pageScrollOffset` | number | 0 | Pixels to offset from the top of the element when scrolling to (positive value = scrolling will stop given pixels atop the target element). |
188+
| `pageScrollDuration` | number | 1250 | Duration in milliseconds the whole scroll-animation should last. |
189+
| `pageScrollSpeed` | number | - | Speed in Pixel/Second the animation should take. Only applied if no duration is set. |
190+
| `pageScrollInView` | boolean | true | Whether the scroll animation should happen even when the scroll target is already inside the view port (`true`). Set to `false` to skip scroll animation if target is already in view. |
191+
| `pageScrollInterruptible` | boolean | true | Whether the scroll animation should stop if the user interferes with it (`true`) or not (`false`). |
192+
| `pageScrollAdjustHash` | boolean | false | Whether the [routes hash/fragment](https://angular.io/docs/ts/latest/guide/router.html#!#query-parameters) should be updated to reflect to section that has been scrolled to |
193+
| `pageScrollEasing` | EasingLogic | linearEasing | Easing method to be used while calculating the scroll position over time (default is linear easing). |
192194

193195
#### PageScroll events
194196

195197
| Event | Type | Description |
196198
| --------------------- | ------- | ------------- |
197-
| `pageScrollFinish` | boolean | Fired when the scroll-animation stops. Emits a boolean value which indicates whether the scroll animation finished successfully and reached its target (`true`) or not (`false`). Possible reasons for false: target not found or interrupted due to another scroll animation starting or user interaction.
199+
| `pageScrollFinish` | boolean | Fired when the scroll-animation stops. Emits a boolean value which indicates whether the scroll animation finished successfully and reached its target (`true`) or not (`false`). Possible reasons for false: target not found or interrupted due to another scroll animation starting or user interaction. |
198200

199201
#### Example
200202

SECURITY.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
## Supported Versions
44

5-
65
| Version | Supported |
76
| ------- | ------------------ |
87
| 7.0.x | :white_check_mark: |

0 commit comments

Comments
 (0)