aboutsummaryrefslogtreecommitdiff
path: root/files/ja/web/api/globaleventhandlers/onscroll/index.html
blob: 043cd44489ff6b1deb35f971ba424dfc1b679f20 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
---
title: GlobalEventHandlers.onscroll
slug: Web/API/GlobalEventHandlers/onscroll
tags:
  - API
  - Event Handler
  - GlobalEventHandlers
  - HTML DOM
  - Property
  - Reference
  - イベントハンドラー
  - プロパティ
translation_of: Web/API/GlobalEventHandlers/onscroll
---
<div>{{ApiRef("HTML DOM")}}</div>

<p><strong><code>onscroll</code></strong> は {{domxref("GlobalEventHandlers")}} ミックスインのプロパティで、 <code>scroll</code> イベントを処理するイベントハンドラー ({{domxref("EventHandler")}}) です。</p>

<p><code>scroll</code> イベントは、ユーザー、 <a href="/ja/docs/Web/API">Web API</a>、{{glossary("user agent","ユーザーエージェント")}}の何れかによって文書のビューまたは要素がスクロールしたときに発生します。</p>

<div class="blockIndicator note">
<p><strong>注:</strong> <code>onscroll</code> を {{domxref("GlobalEventHandlers.onwheel", "onwheel")}} と混同しないようにしてください。</p>

<p><code>onwheel</code> は一般的なホイールの回転を扱うのに対し、 <code>onscroll</code> はオブジェクトの内容のスクロールを扱います。</p>
</div>

<h2 id="Syntax" name="Syntax">構文</h2>

<pre class="syntaxbox notranslate"><var>target</var>.onscroll = <var>functionRef</var>
</pre>

<h3 id="Value" name="Value"></h3>

<dl>
 <dt><code><var>functionRef</var></code></dt>
 <dd>関数名または<a href="/ja/docs/Web/JavaScript/Reference/Operators/function">関数式</a>です。この関数は引数として一つだけ、 {{domxref("UIEvent")}} オブジェクトを受け取ります。</dd>
</dl>

<p><code>onscroll</code> ハンドラーは同時に1つだけ割り当てることができます。</p>

<p>柔軟性を高めるために、 {{event("scroll")}} イベントを {{domxref("EventTarget.addEventListener()")}} メソッドに渡すことができます。</p>

<h2 id="Example" name="Example"></h2>

<p>この例では {{HtmlElement("textarea")}} のスクロールを監視し、その結果である要素の垂直のスクロール位置をログ出力します。</p>

<h3 id="HTML">HTML</h3>

<pre class="brush: html notranslate">&lt;textarea&gt;1 2 3 4 5 6 7 8 9&lt;/textarea&gt;
&lt;p id="log"&gt;&lt;/p&gt;</pre>

<h3 id="CSS">CSS</h3>

<pre class="brush: css notranslate">textarea {
  width: 4rem;
  height: 8rem;
  font-size: 3rem;
}</pre>

<h3 id="JavaScript">JavaScript</h3>

<pre class="brush: js notranslate">const textarea = document.querySelector('textarea');
const log = document.getElementById('log');

textarea.onscroll = logScroll;

function logScroll(e) {
  log.textContent = `Scroll position: ${e.target.scrollTop}`;
}</pre>

<h3 id="Result" name="Result">結果</h3>

<p>{{EmbedLiveSample("Example", 700, 200)}}</p>

<h2 id="Specifications" name="Specifications">仕様書</h2>

<table class="standard-table">
 <thead>
  <tr>
   <th scope="col">仕様書</th>
   <th scope="col">状態</th>
   <th scope="col">備考</th>
  </tr>
 </thead>
 <tbody>
  <tr>
   <td>{{SpecName('HTML WHATWG','#handler-onscroll','onscroll')}}</td>
   <td>{{Spec2('HTML WHATWG')}}</td>
   <td></td>
  </tr>
  <tr>
   <td>{{SpecName("DOM3 Events", "#event-type-scroll", "onscroll")}}</td>
   <td>{{Spec2("DOM3 Events")}}</td>
   <td>初回定義</td>
  </tr>
 </tbody>
</table>

<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2>

<div class="hidden">このページの互換性一覧表は構造化データから生成されています。データに協力していただけるのであれば、 <a class="external" href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> をチェックアウトしてプルリクエストを送信してください。</div>

<p>{{Compat("api.GlobalEventHandlers.onscroll")}}</p>

<h2 id="See_also" name="See_also">関連情報</h2>

<ul>
 <li><a href="/ja/docs/Web/API/Document/scroll_event">Document: <code>scroll</code> イベント</a></li>
 <li><a href="/ja/docs/Web/API/Element/scroll_event">Element: <code>scroll</code> イベント</a></li>
</ul>