[go: up one dir, main page]

このページはコミュニティーの尽力で英語から翻訳されました。MDN Web Docs コミュニティーについてもっと知り、仲間になるにはこちらから。

View in English Always switch to English

Window: scrollsnapchange イベント

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。

scrollsnapchangeWindow インターフェイスのイベントで、スクロール操作の終わりに、新しいスクロールスナップターゲットが選択されたときに window で発行されます。

このイベントは、 Element インターフェイスの scrollsnapchange イベントとほぼ同じように動作しますが、スクロールスナップコンテナーとして HTML 文書全体を設定する必要がある点が異なります(つまり、 scroll-snap-type<html> 要素に設定されている状態です)。

構文

このイベント名を addEventListener() などのメソッドで使用するか、イベントハンドラープロパティを設定するかしてください。

js
addEventListener("scrollsnapchange", (event) => { })

onscrollsnapchange = (event) => { }

イベント型

SnapEvent です。一般的な Event 型を継承しています。

基本的な使用

例えば、スクロールが発生するような重要なコンテンツを含む <main> 要素があったとします。

html
<main>
  <!-- 重要なコンテンツ -->
</main>

<main> 要素は、 CSS プロパティの組み合わせを使用してスクロール可能なコンテナーにすることができます。例を示します。

css
main {
  width: 250px;
  height: 450px;
  overflow: scroll;
}

次に、 scroll-snap-type プロパティを <html> 要素に指定することで、スクロール対象コンテンツにスクロールスナップ動作を実装することができます。

css
html {
  scroll-snap-type: block mandatory;
}

次の JavaScript スニペットは、<main> 要素の子要素が新たに選択されたスナップ対象となった際に、HTML 文書上で scrollsnapchange イベントが発生するようにします。ハンドラー関数では、 SnapEvent.snapTargetBlock プロパティで参照される子要素に selected クラスを設定します。これは、イベントが発生したときに、選択されたように見えるようにスタイルを設定するために使用することができます(例えば、アニメーションを使用して)。

js
window.addEventListener("scrollsnapchange", (event) => {
  event.snapTargetBlock.classList.add("selected");
});

仕様書

Specification
CSS Scroll Snap Module Level 2
# scrollsnapchange

ブラウザーの互換性

関連情報