https://github.com/vaadin-component-factory/vcf-anchor-nav
Web Component for easily creating layouts with sticky anchor navigation tabs and content sections.
https://github.com/vaadin-component-factory/vcf-anchor-nav
javascript polymer vaadin vaadin-component-factory web-component
Last synced: 3 months ago
JSON representation
Web Component for easily creating layouts with sticky anchor navigation tabs and content sections.
- Host: GitHub
- URL: https://github.com/vaadin-component-factory/vcf-anchor-nav
- Owner: vaadin-component-factory
- License: apache-2.0
- Created: 2020-05-14T14:33:59.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-17T10:02:06.000Z (5 months ago)
- Last Synced: 2025-02-04T23:36:06.284Z (4 months ago)
- Topics: javascript, polymer, vaadin, vaadin-component-factory, web-component
- Language: JavaScript
- Homepage:
- Size: 236 KB
- Stars: 2
- Watchers: 8
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# <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)
## Important information about versioning
**Component versions 23.x were deprecated in order to follow Semanting Versioning practices. Please use latest version 2.x for Vaadin 23+ and version 3.x for Vaadin 24.5.**
## Compatibility
- Version 1.x.x -> Vaadin 14+
- Version 2.x.x -> Vaadin 23+
- Version 3.x.x -> Vaadin 24.5.x (improved accessibility)
## 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
Header
...
...
...
```
## 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