Skip to content

Commit efeb2d8

Browse files
committed
update readme
1 parent 1ee956d commit efeb2d8

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -53,30 +53,32 @@ Vue.use(Scrollspy, options);
5353

5454
Declares container of sections for elements to scrollspy.
5555

56-
1. Use `v-scroll-spy="{data: 'section'}"` to add a `section` data property in scope Vue instance that is binded to the
56+
1. `v-scroll-spy="{data: 'section'}"`: add a `section` data property in scope Vue instance that is binded to the
5757
section index.
5858

59-
2. Use `v-scroll-spy="{allowNoActive: true}"` to allow no active sections when scroll position is outside of the scrollspy
59+
2. `v-scroll-spy="{allowNoActive: true}"`: allow no active sections when scroll position is outside of the scrollspy
6060
container. Default behavior is too keep active at least one section in any case.
6161

62-
3. Use `v-scroll-spy="{offset: 50}"` to add an offset for scroll and active events.
62+
3. `v-scroll-spy="{offset: 50}"`: add an offset for scroll and active events.
6363

64-
4. Use `v-scroll-spy="{time: 200, steps: 30}"` to set the animation options.
64+
4. `v-scroll-spy="{time: 200, steps: 30}"`: set the animation options.
6565

6666
5. `$scrollTo(index: int)` is provided on scope Vue instance to invoke a scroll to the given section index.
6767

68+
6. `v-section-selector`: set section which should scrollto
69+
6870
### **v-scroll-spy-active**
6971

7072
Set the `active` css class on element that match the index of current scrollspy.
7173

72-
1. Use `v-scroll-spy-active="{selector: 'li.menu-item', class: 'custom-active'}"` to customize elements selection and class
74+
1. `v-scroll-spy-active="{selector: 'li.menu-item', class: 'custom-active'}"`: customize elements selection and class
7375
name to apply. By default, it will use direct children and apply `active` class.
7476

7577
### **v-scroll-spy-link**
7678

7779
Add click handler on children elements that will scroll to the related section.
7880

79-
1. Use `v-scroll-spy-link="{selector: 'a.menu-link'}"` to customize elements selection. By default, it will use `a` to
81+
1. `v-scroll-spy-link="{selector: 'a.menu-link'}"`: customize elements selection. By default, it will use `a` to
8082
select all links.
8183

8284
### Bezier animations

0 commit comments

Comments
 (0)