Skip to content

Commit f8c0e62

Browse files
committed
fixed documentation error regarding options map
1 parent f65aa33 commit f8c0e62

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

readme.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@
1818
The following options, shown with their default values, are available for both `$.fn.smoothScroll` and `$.smoothScroll`:
1919

2020
{
21-
exclude: [],
22-
excludeWithin:[],
2321
offset: 0,
2422
direction: 'top', // one of 'top' or 'left'
2523
scrollTarget: null, // only use if you want to override default behavior
@@ -28,6 +26,9 @@ The following options, shown with their default values, are available for both `
2826
speed: 400
2927
}
3028

29+
The options map for `$.fn.smoothScroll` can take two additional properties: `exclude` and `excludeWithin`. The value for both of these is an array of selectors, DOM elements or jQuery objects. Default value for both is an empty array.
30+
31+
3132
### $.smoothScroll
3233

3334
* Utility method works without a selector: `$.smoothScroll()`

0 commit comments

Comments
 (0)