Skip to content
Snippets Groups Projects

Improve structure

Merged Improve structure
improve-structure into master
Merged Daniel Kurowski requested to merge improve-structure into master
Compare
and
Show latest version
1 file
+ 2
− 2
Compare changes
  • Side-by-side
  • Inline
README.md
+ 2
− 2
@@ -31,10 +31,10 @@ SmoothScroll.enable({
| Option | Value | Default value | Description |
| --- | --- | --- | --- |
| `scrollOnLoad` | `true`/`false` | `true` | Causes smooth scroll to anchored element when the page is loaded.\*
| `scrollOnLoad`\* | `true`/`false` | `true` | Causes smooth scroll to anchored element when the page is loaded.
| `scrollOnLinkClick` | `true`/`false` | `true` | Causes smooth scroll on given element when user clicks on an `a` tag having `href` starting with `#` character.
\*Note: when the page load lasts more than 500 ms, load smooth scrolling is disabled as it would lead to user-unfriendly behaviour like jumping on the page up and down.
\*Note: when the page load lasts more than 500 ms, load smooth scroll effect is disabled as it would lead to user-unfriendly behaviour like jumping on the page up and down due to browser native behaviour.
## Development