iron-scroll-target-behavior | Vaadin

Polymer behavior that allows to define a scroller target

Published on NPM Build status Published on


IronScrollTargetBehavior allows an element to respond to scroll events from a designated scroll target.

Elements that consume this behavior can override the _scrollHandler method to add logic on the scroll event.

See: Documentation, Demo.



npm install --save @polymer/iron-scroll-target-behavior

In a Polymer 3 element

import {PolymerElement, html} from '@polymer/polymer';
import {mixinBehaviors} from '@polymer/polymer/lib/legacy/class.js';
import {IronScrollTargetBehavior} from '@polymer/iron-scroll-target-behavior/iron-scroll-target-behavior.js';

class SampleElement extends mixinBehaviors(IronScrollTargetBehavior, PolymerElement) {
  static get template() {
    return html`
      <p>Scrollable content here</p>

  _scrollHandler() {
    console.log('_scrollHandler', this._scrollTop, this._scrollLeft);
customElements.define('sample-element', SampleElement);


If you want to send a PR to this element, here are the instructions for running the tests and demo locally:


git clone
cd iron-scroll-target-behavior
npm install
npm install -g polymer-cli

Running the demo locally

polymer serve --npm

Running the tests

polymer test --npm


Link to this version
ImportedReleased 14 September 2018BSD 3-clause "New" or "Revised" License
Framework Support
Polymer 1.0+
Polymer 3.0+
Also supported:
Polymer 2 (2.1.1)
Browser Compatibility
Install with
npm install @polymer/iron-scroll-target-behavior"@3.0.1"
Run the above npm command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 3.0.1


  • @polymer/polymer#^3.0.0