alpha

This version is in early development and is subject to change and therefore not ready for wide use. There may be other stable versions available.

Smooth scroll utility

This enables smooth scrolling when a user clicks on anchor links or other in-page scrolling is triggered.

github location npm version

Usage

This is an opt-in behaviour that is activated by putting the vf-smooth-scroll class on a parent element — a good place would be at <html class="vf-smooth-scroll"> (note: it probably won't work if you add it your <body> element).

Note that as of Safari version 15.4 (released March 2022), CSS-based smooth scrolling is supported by Safari on Mac OS or iOS.

Accessibility

This component targets WCAG 2.1 AA accessibility.

Generally this improves accessibility by smooth scrolling between content, for some scenarios the behaviour may become distracting.

Note that smooth scrolling is disabled if a user has flagged prefers-reduced-motion.

You can also read about the Visual Framework's approach to accessibility.

Variants

Scroll to: A B C

Item A

With sub–heading

Item B

With sub–heading

Item C

With sub–heading

HTML
<div class="vf-smooth-scroll">

  <p>
    Scroll to:
    <a href="#pageA">A</a>
    <a href="#pageB">B</a>
    <a href="#pageC">C</a>
  </p>
  <div class="vf-stack vf-stack--800" style="scroll-behavior: smooth; overflow-y: scroll; height: 100px; max-width: 350px;">
    <article class="vf-card vf-card--brand vf-card--bordered" id="pageA">
      <div class="vf-card__content | vf-stack vf-stack--400">
        <h3 class="vf-card__heading">Item A</h3>
        <p class="vf-card__subheading">With sub–heading</p>
      </div>
    </article>
    <article class="vf-card vf-card--brand vf-card--bordered" id="pageB">
      <div class="vf-card__content | vf-stack vf-stack--400">
        <h3 class="vf-card__heading">Item B</h3>
        <p class="vf-card__subheading">With sub–heading</p>
      </div>
    </article>
    <article class="vf-card vf-card--brand vf-card--bordered" id="pageC">
      <div class="vf-card__content | vf-stack vf-stack--400">
        <h3 class="vf-card__heading">Item C</h3>
        <p class="vf-card__subheading">With sub–heading</p>
      </div>
    </article>
  </div>
</div>
              

Examples

Installation info

This repository is distributed with [npm][https://www.npmjs.com/]. After [installing npm][https://www.npmjs.com/get-npm] and yarn, you can install vf-smooth-scroll with this command.

$ yarn add --dev @visual-framework/vf-smooth-scroll

Sass/CSS

The style files included are written in Sass. If you're using a VF-core project, you can import it like this:

@import "@visual-framework/vf-smooth-scroll/vf-smooth-scroll.scss";

Make sure you import Sass requirements along with the modules. You can use a project boilerplate or the vf-sass-starter

Changelog

Changelog

1.2.3

  • Updated changelog

1.2.2

  • Documentation upgrade

1.2.1

  • New release

1.2.0

  • Update node-html-parser to 5.1.0
  • Use eleventy v1.0.0-beta.8
  • https://github.com/visual-framework/vf-core/pull/1257

1.1.16

  • Utilise new vf-navigation--on-this-page.
  • Update project boilerplate links at https://stable.visual-framework.dev/building/

1.1.13

  • Documentation updates
  • New release

1.1.12

  • Update milestones and roadmap.

1.1.11

  • Add ELIXIR banner to example EMBL-EBI page.
  • https://stable.visual-framework.dev/patterns/boilerplate-generic-embl-ebi/
  • https://github.com/visual-framework/vf-core/pull/1615

1.1.7

  • Fixed issue of overlapping menu on VF components site
  • https://github.com/visual-framework/vf-core/issues/1518

1.1.6

  • dependency bump

1.1.2

  • Implements updated vf-search markup.
  • Changes a few pages on how it works with nunjucks and markdown.

1.1.0

  • updates Design Tokens homepage.
  • adds neutral colour tokens
  • adds 'status banners' for components in the documentation page.
  • Adds the form options as their own set of components in the list.
  • https://github.com/visual-framework/vf-core/pull/1390/files
  • Updates to use 11ty 0.12.1
  • https://github.com/visual-framework/vf-core/pull/1435

1.0.24

  • changes the vf-intro so it's a white background, removes the padding.
  • changes the links in vf-intro to be the 'correct' buttons.

1.0.23

  • small change to cards on homepage

1.0.18

  • dependency bump

1.0.17

  • dependency bump

1.0.16

  • dependency bump

1.0.13

  • dependency bump
  • adds roamap and consultation docs

1.0.12

  • design token documenation now lives in the component libary

1.0.7

  • adds updates blog

1.0.6

  • begin to make more pattern/boilerplate guidance
  • minor templating updates

1.0.5

  • dependency bump

1.0.4

  • uses vf-favicon
  • adds meta attributes

1.0.3

  • run vf-component-assets:everything on local dev
  • remove reference to removed /css/app.css

1.0.2

  • Add 404
  • Fix component CSS generation

1.0.1

  • Also generate per-component CSS with vf-css:generate-component-css

1.0.0

  • Initial release to be used with vf-core 2.2.0

Assets



File system location: components/vf-smooth-scroll

Find an issue on this page? Propose a change or discuss it.