@vaadin-component-factory/vcf-anchor-nav
v4.0.0
Published
Component with tabs used as anchor navigation and content sections. Automates the linking of tabs and sections.
Readme
<vcf-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).

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.
Since version 4.0.0
- The component has been migrated to Lit
- When the application does not load the Aura or Lumo theme, the component uses a minimal set of functional styles that provide a foundation for a custom theme.
ThemableMixinhas been removed from the component, and injecting styles into the component's shadow root usingregisterStylesis no longer supported. Use global CSS to style the component using part names and CSS variables instead.
Compatibility
- Version 1.x.x -> Vaadin 14+
- Version 2.x.x -> Vaadin 23+
- Version 3.x.x -> Vaadin 24.5.x (improved accessibility)
- Version 4.x.x -> Vaadin 25
Installation
Install vcf-anchor-nav:
npm i @vaadin-component-factory/vcf-anchor-nav --saveUsage
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
Fork the
vcf-anchor-navrepository and clone it locally.Make sure you have npm installed.
When in the
vcf-anchor-navdirectory, runnpm installto install dependencies.Run
npm startto open the demo.
Server-side API
This is the client-side 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
