diff --git a/src/directives/scrollspy/README.md b/src/directives/scrollspy/README.md index 8b41c2bc869..112e8ea77b8 100644 --- a/src/directives/scrollspy/README.md +++ b/src/directives/scrollspy/README.md @@ -13,7 +13,9 @@ The `v-b-scrollspy` directive has a few requirements to function properly: - When spying on elements other than the ``, be sure to have a `height` set and `overflow-y: scroll;` applied. - Anchors (``, ``, ``, ``) are required and must - have an `href` that points to an element with that id in the container you are spying on. + have an `href` (either via the `href` or `to` props) that points to an element with that `id` in + the container you are spying on. When using the `to` prop, either set the `path` ending with + `#id-of-element`, or set the location property `hash` to `#id-of-element`. When successfully implemented, your nav or list group will update accordingly, moving the `active` state from one item to the next based on their associated targets. @@ -99,8 +101,8 @@ as well. ### Example using nested navs -Scrollspy also works with nested ``. If a nested `` is active, its parents will -also be active. Scroll the area next to the navbar and watch the active class change. +Scrollspy also works with nested ``. If a nested `` is active, its parent()s +will also be active. Scroll the area next to the navbar and watch the active class change. ```html