@bolt/components-smooth-scroll

Smooth Scroll Component in Bolt

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@bolt/components-smooth-scroll
Minified + gzip package size for @bolt/components-smooth-scroll in KB

Readme


patternType: "smooth scroll"

Smooth Scroll

Including this component will apply smooth scroll behavior to all anchor links on a page.

Usage

  • When using a fixed header, you can avoid scrolling past anchors (and hiding the start of the content under the fixed header) by adding the class js-bolt-smooth-scroll-offset to the fixed header element itself.
  • To disable smooth scrolling for an individual link, add the data-scroll-ignore to the link attributes.
  • TODO: Document additional link-specific options.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.