vcf-anchor-nav - Vaadin Add-on Directory
Web Component for easily creating layouts with sticky anchor navigation tabs and content sections.
# <vcf-anchor-nav>
[](https://gitter.im/vaadin/web-components?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[](https://www.npmjs.com/package/@vaadin-component-factory/vcf-anchor-nav)
[](https://vaadin.com/directory/component/vaadin-component-factoryvcf-anchor-nav)
Web Component for easily creating layouts with sticky anchor navigation tabs and content sections.
- Automates the linking of tabs and sections.
- Smooth scrolls to section on tab click and sets the URL hash.
- Scrolls to URL hash on load (preserve selected tab on refresh).
[Live demo ↗](https://vcf-anchor-nav.netlify.com)
|
[API documentation ↗](https://vcf-anchor-nav.netlify.com/api/#/elements/Vaadin.VcfAnchorNav)
## Installation
Install `vcf-anchor-nav`:
```sh
npm i @vaadin-component-factory/vcf-anchor-nav --save
```
## Usage
Once installed, import it in your application:
```js
import '@vaadin-component-factory/vcf-anchor-nav';
```
Add `` element and ``s to the page.
```html
...
...
...
```
## Running demo
1. Fork the `vcf-anchor-nav` repository and clone it locally.
1. Make sure you have [npm](https://www.npmjs.com/) installed.
1. When in the `vcf-anchor-nav` directory, run `npm install` to install dependencies.
1. Run `npm start` to open the demo.
## Server-side API
This is the client-side (Polymer 3) web component. If you are looking for the server-side (Java) API for the Vaadin Platform, it can be found here: [Anchor Nav](https://vaadin.com/directory/component/anchor-nav-for-flow)
## License
Apache License 2.0