今さら調べるスムーススクロール

## はじめに

スムーススクロールの実装は未だに悩みます。

ほぼ必須で行う実装ではあるものの、毎回下記のような課題がちらつきます。

- パフォーマンスは落としたくない
- スクロール後にフォーカスも移動させたい（アクセシビリティ対応）
- ページ内検索ではアニメーションさせたくない（ユーザビリティ向上）
- 「視差効果を減らす」がオンのときはアニメーションさせたくない
- イージングが気持ちよかったらよりよい
- 実装は簡単なほうがいい

実装もややこしいし、検証も大変だし、自分なりの慣例が欲しくなったので調べました。

## 先に結論：今のところよさげな方法

「 `html` 要素に `scroll-behavior: smooth;` + リンク先に `tabindex="-1”` をつける」

2023年12月時点で、個人的にはこの方法が好みでした。

実装はかなりシンプル。

<p class="codepen" data-height="300" data-default-tab="result" data-slug-hash="mdodwaX" data-preview="true" data-user="eizarkuj-the-reactor" style="height: 300px; box-sizing: border-box; display: flex; align-items: center; justify-content: center; border: 2px solid; margin: 1em 0; padding: 1em;">
  <span>See the Pen <a href="https://codepen.io/eizarkuj-the-reactor/pen/mdodwaX">
  Untitled</a> by 伏屋楓 (<a href="https://codepen.io/eizarkuj-the-reactor">@eizarkuj-the-reactor</a>)
  on <a href="https://codepen.io">CodePen</a>.</span>
</p>
<script async src="https://cpwebassets.codepen.io/assets/embed/ei.js"></script>

ここからは、なぜこの方法がよさげだと判断したかの調査メモを書きます。

## なぜよさげだと判断したか

まず、スムーススクロールの実装方法をいくつか検討してみます。

- JSライブラリを入れる
- CSS の `scroll-behavior: smooth;` を使う
- 独自で実装する

よわよわエンジニアとしては、最後の選択肢はあまり取りたくありません。

（実装方法が様々すぎて、結局何がいいのか、課題をすべて解決できるのかわからないため）

JSライブラリも、jQuery全盛期のころはよく使っていましたが、最近は独自実装に押されている印象です。

となると、CSS の `scroll-behavior: smooth;` が気になります。

## **`scroll-behavior` とは**

https://developer.mozilla.org/ja/docs/Web/CSS/scroll-behavior

- スクロールが発生した際の振る舞いを設定するプロパティ
- ユーザーが実行したスクロールには影響しない
- このプロパティをルート要素（＝ `html` 要素）に指定した場合、ビューポートに適用される

`scroll-behavior` に `smooth` を指定することで、スクロールが滑らかになります。名前の通りです。

イージングや秒数は、ユーザーエージェントの定義に従います。

```css
html {
  scroll-behavior: smooth; /* 1行だけでスムーススクロールできる！ */
}
```

`scroll-behavior` のいいところは、とにかく簡潔なところ。

CSSを1行足すだけなので、何十行もJSを書くよりお手軽にアニメーションをつけられます。

とはいえ、そう簡単には済まないのがWebサイト実装です。

### **`scroll-behavior` の懸念点**

- ページ内検索までアニメーションしてしまう
- リンク先に `tabindex` 属性をつけないといけない
- 「視差効果がを減らす」がオンでも動いてしまう

メインは上記3点でしょうか。

対策次第で解決できるところもあるので、順番に考えます。

## 懸念点を解決する

### ページ内検索までアニメーションしてしまう

ページ内検索を使うときは、目的の場所にすぐ移動したいですよね。

しかし `scroll-behavior: smooth;` を設定すると、ページ内検索まで滑らかにスクロールしてしまいます。

検索に時間がかかって不便です。

これは `:focus-within` という擬似クラスを使えば解決できます。

https://developer.mozilla.org/ja/docs/Web/CSS/:focus-within

`:focus-within` は「その要素または子孫要素にフォーカスが当たっている場合」にCSSを適用できる擬似クラスです。

使用例はMDNの下記がわかりやすいです。

> このセレクターは、よくある例のように、 [`<input>`](https://developer.mozilla.org/ja/docs/Web/HTML/Element/input) 欄の一つにユーザーがフォーカスを置いたときに、それを含む [`<form>`](https://developer.mozilla.org/ja/docs/Web/HTML/Element/form) 全体を強調する場合に便利です。
> 

```css
html:focus-within { /* ここを追加 */
  scroll-behavior: smooth;
}
```

`:focus-within` 追加によって、フォーカスが当たっている要素があるときだけ、スクロールが滑らかになります。

しかし、ここで次の懸念点が出ます。

### リンク先に `tabindex` 属性をつけないといけない

`:focus-within` を追加するだけだと、Chrome と Firefox ではスムーススクロールが効きません。

理由は、下記のような挙動が影響しています。

#### 期待している挙動：

1. クリックしたリンクに一瞬フォーカスが当たる
2. その後、リンク先（移動先）の要素にフォーカスが当たる
3. 「フォーカスが当たっている要素があるとき」の条件を満たすので、該当のCSSが適用される

#### 実際の挙動：

1. クリックしたリンクに一瞬フォーカスが当たる
2. その後、リンク先の要素にフォーカスを当てたい
3. が、**リンク先の要素にフォーカスの機能がない！**
4. ので、該当のCSSが適用されない

アンカーリンクの場合、見出しやセクションにリンクすることが多いです。

しかし `<h2>` や `<section>` , `<p>` などには、標準ではフォーカスが当たりません。

それらの要素にフォーカスを当てるために、`tabindex` 属性の追加が必要です。

```html
<h2 id="can-not-focus">フォーカスが当たらない見出し</h2>

<h2 id="can-focus" tabindex="-1">フォーカスが当たる見出し</h2>
```

:::note info
`tabindex="-1"` なのは、tabキーでのフォーカスは不可にするためです。

`-1` に限らず、負の値であればなんでもOKです。

tabキーでのフォーカスを許可する場合は `0` 以上の値を設定してください。
:::

もろもろの課題を解決するには、この属性追加は避けられません。

HTMLに無駄な属性を増やしたくない派には、JSでの独自実装をおすすめします。

### 「視差効果を減らす」がオンでも動いてしまう

さまざまな事情で、デバイスのアニメーションを減らしたい人もいます。

Apple製品のアクセシビリティ機能のひとつである「視差効果を減らす」が有名ですが、WindowsやAndroidにも同様の設定が存在します。

ここまでの実装では、視差効果を減らす設定がオンでも動いてしまいます。

[WCAG (Web Content Accessibility Guidelines)](https://waic.jp/translations/WCAG21/Understanding/animation-from-interactions.html) にも下記の達成基準があるので、できれば対応しておきたいところ。

> 達成基準 **[2.3.3 インタラクションによるアニメーション](https://waic.jp/translations/WCAG21/#animation-from-interactions)** (レベル AAA): アニメーションが、機能又は伝達されている情報に[必要不可欠](https://waic.jp/translations/WCAG21/Understanding/animation-from-interactions.html#dfn-essential)でない限り、インタラクションによって引き起こされる[モーションアニメーション](https://waic.jp/translations/WCAG21/Understanding/animation-from-interactions.html#dfn-motion-animation)を無効にできる。
> 

`prefers-reduced-motion` というメディアクエリを使います。

https://developer.mozilla.org/ja/docs/Web/CSS/@media/prefers-reduced-motion

ユーザー設定に応じて余計な動きを軽減するためのメディアクエリです。

WCAG基準の「ウェブページの機能や情報に必要不可欠なアニメーション」に該当するもの以外は、上記で囲むことで無効化できます。

スムーススクロールは必要不可欠ではないので、無効化できるようにしておきましょう。

```css
@media (prefers-reduced-motion: no-preference) { /* ここを追加 */
  html:focus-within {
    scroll-behavior: smooth;
  }
}
```

<details><summary>🤔 : 「必要不可欠なアニメーション」とは</summary>

WCAG基準では下記のように書かれている。
    
> もし取り除いてしまうと、コンテンツの情報又は機能を根本的に変えてしまい、**かつ**、適合する他の方法では情報及び機能を実現できない。
> 
    
具体例をざっと調べたかぎりでは下記が挙がっていた。
    
- ローディングアニメーション
  - 特に、フォームの送信ボタン押下後
- マウスオーバー
- 利用者の動作に応じてコンテンツが変化するもの

こう見ると、「サイトが動作しているか判別するためのアニメーション」は「必要不可欠」に該当するのかなと思った。

逆に、必要不可欠ではない例では下記が挙がっていた。
    
- 出現する間に特定の位置に移動する、又はサイズが変化する要素（WCAGより引用）
- パララックス（視差効果）
- スクロールによるトランジション効果
  - スムーススクロール
  - スクロールに応じた要素表示
  - ページめくりのアニメーション
- テキストアニメーション
    
特に注意したほうがよい動きについては下記が挙がっていた。

- 移動、点滅、バウンス効果
  - スライドをフェードに変更するなど
  - 点滅がてんかん発作を引き起こす可能性があることは有名
  - 「ぼけ」や「にじみ」

アニメーションへの忌避感や症状には個人差があるので、一概には言えない。

WCAGには下記の記載があるので、CSSの `transform` プロパティに該当するもの以外は、ある程度は許容されているのかもしれない。
    
> 要素の見た目のサイズ、形状、又は位置の変化が生じない、色、ぼかし、又は不透明度の変化は、モーションアニメーションには含まれない。
</details>

## あらためて完成形を見る

これらの実装をまとめると、最初に載せたcodePenになります。

<p class="codepen" data-height="300" data-default-tab="result" data-slug-hash="mdodwaX" data-preview="true" data-user="eizarkuj-the-reactor" style="height: 300px; box-sizing: border-box; display: flex; align-items: center; justify-content: center; border: 2px solid; margin: 1em 0; padding: 1em;">
  <span>See the Pen <a href="https://codepen.io/eizarkuj-the-reactor/pen/mdodwaX">
  Untitled</a> by 伏屋楓 (<a href="https://codepen.io/eizarkuj-the-reactor">@eizarkuj-the-reactor</a>)
  on <a href="https://codepen.io">CodePen</a>.</span>
</p>
<script async src="https://cpwebassets.codepen.io/assets/embed/ei.js"></script>

要点をまとめるとこんな感じ。

- `html` 要素に `scroll-behavior: smooth;` を付与
    - 擬似クラス `:focus-within` を指定しておく
    - メディアクエリ `prefers-reduced-motion: no-preference` で囲っておく（視差効果に配慮）
- アンカーリンク先に `tabindex="-1”` を付与
    - 必要に応じて `scroll-margin-top` でヘッダー分の高さをずらす（詳細は後述）

シンプルかつ機能的で、まさに「最低限」という印象です。

（最初に挙げた課題のうち「イージングが気持ちよかったらよりよい」は無視していますが、「よりよい」なのでOKとします）

## よくある質問

### 固定ヘッダーがスクロール後にかぶってしまう

CSSの `scroll-margin-top` などを指定しましょう。

https://developer.mozilla.org/ja/docs/Web/CSS/scroll-margin-top

### イージングを調整したい

残念ながら、 `scroll-behavior: smooth;` ではイージングを指定できません。

イージングや秒数にこだわる場合は独自実装が必要です。

今回の方法は、なるべくシンプルに目的だけを果たしたい場合の選択肢としてご検討ください。

### 記事データをAPIから取得していて `tabindex` 属性が書けない

HTML解析ツール（HTMLパーサー）を挟めば属性を追加できます。

セクションではなく見出し要素に追加するほうが処理が簡単そうです。

<details><summary>例： cheerio の場合</summary>

```js
// 本文内の見出しにtabindex属性を設定
const $ = load(blog.content);
$('h2, h3, h4').attr('tabindex', '-1');
blog.content = $.html();
```

参考： [Manipulating the DOM | cheerio](https://cheerio.js.org/docs/basics/manipulation#modifying-element-attributes-and-properties)
</details>

## おわりに

想像より奥が深かったので長くなりました。
読んでくださりありがとうございます。

スムーススクロールの実装方法はさまざまだと思うので、よりよい方法がありましたら教えていただけると幸いです。

## 参考にさせていただいた記事など

- `scroll-behavior: smooth;` について
    - [scroll-behavior: smooth;によるページ内検索時のスクロールを除外するテクニック](https://coliss.com/articles/build-websites/operation/css/fixing-smooth-scrolling-with-page-search.html)
    - [scroll-behaviorでSmoothScrollを実現する](https://whyisthis.dev/basis/css-scroll-behavior/)
    - [Fixing Smooth Scrolling & Page Search (updated!)
](https://schepp.dev/posts/smooth-scrolling-and-page-search/)
- `:focus-within` について
    - [tabindex - HTML: ハイパーテキストマークアップ言語 | MDN](https://developer.mozilla.org/ja/docs/Web/HTML/Global_attributes/tabindex) 
  - [CSSの疑似クラス「:focus-within」が素晴らしい理由](https://coliss.com/articles/build-websites/operation/css/css-focus-within-is-amazing.html)
  - [フォーカスについてまとめてみた](https://qiita.com/anzuuuuu/items/c3df59b7e63221d0939c)
- `prefers-reduced-motion` について
    - [prefers-reduced-motion - CSS: カスケーディングスタイルシート | MDN](https://developer.mozilla.org/ja/docs/Web/CSS/@media/prefers-reduced-motion) 
    - [ユーザーのプリファレンスに応じて過度なアニメーションを無効にする「prefers-reduced-motion」](https://accessible-usable.net/2021/09/entry_210919.html)
    - [アニメーションを望まないユーザーを考えたWeb制作をしよう｜prefers-reduced-motion](https://jajaaan.co.jp/web-production/frontend/prefers-reduced-motion/)
    - https://twitter.com/kilianvalkhof/status/1374385192949874690
    - https://twitter.com/stackblitz/status/1321105526709755914
- 「必要不可欠なアニメーション」とは
  - [2.3.3 ユーザー操作で起きるアニメーションを無効にできる - Ameba Accessibility Guidelines](https://a11y-guidelines.ameba.design/2/3/3/)
  - [アニメーションが効かない原因は「視差効果を減らす」かも？そしてアクセシビリティへ](https://zenn.dev/tam_tam/articles/4c98d8f8098797)
  - [[HIG] アクセシビリティ - 視覚効果とモーション](https://qiita.com/akatsuki174/items/fc7bf850e1edaa49489c)