Unverified Commit 1da21ab7 authored by Ken Hawkins's avatar Ken Hawkins Committed by GitHub
Browse files

Update vf-navigation readme (#1766)

Hi there, I had reason to look at this component and saw some room for improvement. This clarifies the guidance text for the on this page navigation variant,
parent 8df1d9aa
...@@ -22,15 +22,11 @@ There should be only one use of `vf-navigation--main` on a page. ...@@ -22,15 +22,11 @@ There should be only one use of `vf-navigation--main` on a page.
### On this page navigation variant ### On this page navigation variant
This sticky element allows users to quickly jump between sections on longer pages. The `vfNavigationOnThisPage` JavaScript adds a quality-of-life improvement by automatically activating sections as the user scrolls them into view on the page. This sticky element allows users to quickly jump between sections on longer pages.
There should be only one use of `vf-navigation--on-this-page` on a page. - There should be only one use of `vf-navigation--on-this-page` on a page.
- Anchor targets need an element id: `id="container-1"`. This can be added to any item on the page, but would most logically be added to a `vf-grid`, `embl-grid` or `vf-section-header` element.
Using the `vfNavigationOnThisPage` JavaScript adds a quality-of-life improvement by automatically activating sections as the user scrolls them into view on the page. - Ensure `data-vf-js-navigation-on-this-page-container="true"` is present on `.vf-navigation__list`.
For this feature to work, anchor targets need two things an element id: `id="container-1"`
These could be added to any item on the page, but would most logically be added to a `vf-grid`, `embl-grid` or `vf-section-header`
## Install ## Install
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment