JSPM

  • Created
  • Published
  • Downloads 20056
  • Score
    100M100P100Q163814F
  • License BSD-3-Clause

Allows to define a scroller target

Package Exports

  • @polymer/iron-scroll-target-behavior
  • @polymer/iron-scroll-target-behavior/iron-scroll-target-behavior.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@polymer/iron-scroll-target-behavior) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Published on NPM Build status Published on webcomponents.org

IronScrollTargetBehavior

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.

Usage

Installation

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);

Contributing

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

Installation

git clone https://github.com/PolymerElements/iron-scroll-target-behavior
cd iron-scroll-target-behavior
npm install
npm install -g polymer-cli

Running the demo locally

polymer serve --npm
open http://127.0.0.1:<port>/demo/

Running the tests

polymer test --npm