Socket
Socket
Sign inDemoInstall

@vaadin-component-factory/vcf-anchor-nav

Package Overview
Dependencies
27
Maintainers
10
Versions
69
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @vaadin-component-factory/vcf-anchor-nav

Component with tabs used as anchor navigation and content sections. Automates the linking of tabs and sections.


Version published
Weekly downloads
15
increased by66.67%
Maintainers
10
Created
Weekly downloads
 

Readme

Source

<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

Keywords

FAQs

Last updated on 12 Jun 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc