Skip to content

vcf-anchor-nav 23.1.0

Install from the command line:
Learn more about npm packages
$ npm install @vaadin-component-factory/vcf-anchor-nav@23.1.0
Install via package.json:
"@vaadin-component-factory/vcf-anchor-nav": "23.1.0"

About this version

<vcf-anchor-nav>

Gitter npm version Published on Vaadin Directory

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).

GIF for Vaadin Component Factory anchor nav

Live demo ↗ | API documentation ↗

Installation

Install vcf-anchor-nav:

npm i @vaadin-component-factory/vcf-anchor-nav --save

Usage

Once installed, import it in your application:

import '@vaadin-component-factory/vcf-anchor-nav';

Add <vcf-anchor-nav> element and <vcf-anchor-nav-section>s to the page.

<vcf-anchor-nav>
  <h1 slot="header">Header</h1>
  <vcf-anchor-nav-section name="One"> ... </vcf-anchor-nav-section>
  <vcf-anchor-nav-section name="Two"> ... </vcf-anchor-nav-section>
  <vcf-anchor-nav-section name="Three"> ... </vcf-anchor-nav-section>
</vcf-anchor-nav>

Running demo

  1. Fork the vcf-anchor-nav repository and clone it locally.

  2. Make sure you have npm installed.

  3. When in the vcf-anchor-nav directory, run npm install to install dependencies.

  4. 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

License

Apache License 2.0

Details

Assets

  • vcf-anchor-nav-23.1.0-npm.tgz

Download activity

  • Total downloads 0
  • Last 30 days 0
  • Last week 0
  • Today 0

Recent versions

View all