Skip to content

Commit af5304e

Browse files
committed
Fixed typos and updated docs
1 parent 37b1612 commit af5304e

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Highlight your menu items as you scroll
1+
# vue-scrollactive
22
This vue 2 component makes it simple to highlight a menu item with an 'active' class as you scroll.
33

44
- Highlights menu items as you scroll
@@ -57,7 +57,7 @@ methods: {
5757
}
5858
```
5959

60-
Make sure to set the `ref=scrollactive` property when you call the component in order to access the function as I do, or feel free to do it in any other way you would like, you just need to call the `setScrollactiveItems()` function.
60+
Make sure to set the `ref="scrollactive"` property when you call the component in order to access the function as I do, or feel free to do it in any other way you would like, you just need to call the `setScrollactiveItems()` function.
6161

6262
## Configuration
6363
All options should be passed as a prop in the `<scrollactive>` component as you can see in the example below:
@@ -69,8 +69,9 @@ All options should be passed as a prop in the `<scrollactive>` component as you
6969
bezier-easing-value=".5,0,.35,1">
7070
</scrollactive>
7171
```
72+
Remember that all options are optional and you can see the default values in the Options sections.
7273

73-
### Props
74+
### Options
7475
``` javascript
7576
/**
7677
* Class that will be applied in the menu item.

0 commit comments

Comments
 (0)