negl機能一覧 / Exports / Scroller

Class: Scroller

スクロールの制御を行います。

このクラスはnegl内部でインスタンス化され、scroller オブジェクトとして提供されます。

取得方法

import { scroller } from "negl";
// or
window.negl.scroller

Table of contents

Properties

• delta
• scrolling

Accessors

• scrollTop

Methods

• disable
• enable
• scrollIntoView
• scrollToHash

Properties

delta

• delta: ScrollDelta

スクロールの変化量が渡ります。

スクロールに合わせてスクロールの変化量を取得したい場合は hook.on の SCROLL タイプで取得してください。

hook.on(hook.SCROLL, (scroller) => {
  console.log(scroller.delta);
  // スクロール中はスクロールの変化量がログに出力されます。
})

scrolling

• scrolling: boolean = false

スクロール中の時は true、それ以外は false が設定されます。

Accessors

scrollTop

• get scrollTop(): number

ページの最上部からのスクロール量を数値で取得します。

Returns

number

ページの最上部からのスクロール量

• set scrollTop(px): void

ページの最上部から px 分スクロールを行います。

Parameters

Returns

void

Methods

disable

▸ disable(): void

スクロールを無効化します。（スクロールできないようになります。）

Returns

void

enable

▸ enable(): void

スクロールを有効化します。（スクロールできるようになります。）

Returns

void

scrollIntoView

▸ scrollIntoView(el, scrollIntoViewOptions?): void

scrollIntoView (opens in a new tab) メソッドと同等の機能を持ちます。 scrollIntoView() が呼び出された要素がユーザーに見えるところまで、要素の親コンテナーをスクロールします。

Parameters

Returns

void

scrollToHash

▸ scrollToHash(hash): void

#id までページ内スクロールを行います。

Parameters

Returns

void