This component is available on GitHub.

Stimulus Scroll To

A Stimulus controller to scroll to elements.

Installation

$ yarn add stimulus-scroll-to

And use it in your JS file:

// Probably in app/javascript/controllers/index.js

import { Application } from '@hotwired/stimulus'
import ScrollTo from 'stimulus-scroll-to'

const application = Application.start()
application.register('scroll-to', ScrollTo)

Usage

<a href="#awesome-stuff-here" data-controller="scroll-to">Scroll to #awesome-stuff-here</a>

<h2 id="awesome-stuff-here">Awesome stuff here</h2>

With options:

<a
  href="#awesome-stuff-here"
  data-controller="scroll-to"
  data-scroll-to-offset-value="150"
  data-scroll-to-behavior-value="auto"
  >Scroll to #awesome-stuff-here</a
>

<h2 id="awesome-stuff-here">Awesome stuff here</h2>

🛠 Configuration

AttributeDefaultDescriptionOptional
data-scroll-to-offset-value10Offset in pixels from top of the element.✅
data-scroll-to-behavior-valuesmoothThe scroll behavior. auto or smooth.✅

🎛 Extending Controller

You can use inheritance to extend the functionality of any Stimulus component:

import ScrollTo from 'stimulus-scroll-to'

export default class extends ScrollTo {
  connect() {
    super.connect()
    console.log('Do what you want here.')
  }

  // You can set default options in this getter for all your anchors.
  get defaultOptions() {
    return {
      offset: 100,
      behavior: 'auto',
    }
  }
}

This controller will automatically have access to targets defined in the parent class.

If you override the connect, disconnect or any other methods from the parent, you'll want to call super.method() to make sure the parent functionality is executed.

Compatibility

The Window.scrollTo() method is used under the hood.

It's basically compatible with every modern browsers. For now, Safari does not provide smooth behavior scroll support.

See https://caniuse.com/mdn-api_scrolltooptions_behavior.

You can easily add it with this polyfill: smoothscroll-polyfill.

☕️ Sponsors

Stimulus Component is an MIT licensed open source project and completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support Stimulus Components development on Github Sponsors. 🙏

👷 Contributing

Do not hesitate to contribute to the project by adapting or adding features ! Bug reports or pull requests are welcome.

Don’t forget to drop a 🌟 on Github to support the project.

📝 License

This project is released under the MIT license.