メインコンテンツへスキップ
見出し画像

テキストインプットのUXを改善する:ユースケースに合った入力完了イベントを利用して、使いやすいUIを目指す

    先日、8hours(8時間タイマー+ポモドーロタイマー+TODO管理)というmacOSアプリをリリースしました。

    このプロジェクトの作成にあたり、使いやすさに直結する実装の観点として、考えた内容です。

    テキストエリアの入力確定タイミング

    通常、テキストエリアに入力を行い、確定する。という動作の検出には、onChangeイベントやEnterキーの入力監視、IMEの完了を判別するisComposingプロパティを用いますが、これらのイベントを正しい場所で利用しないと、思わぬ「使いづらさ」が発生してしまいます。

    画像
    UIとしてイケてない例:Enterのたびに確定してしまうと入力の途中でアクションが途切れてしまう

    僕が作ったアプリ 8hours では、TODOの入力・表示にTextInputを使っていて、readOnly属性の付け外しで確定を行なっています。この時、確定のタイミング(文字変換なども含む)を正しく検知していないと、上の図のように意図しないタイミング(入力の途中でフォーカスが外れてしまう)で確定されてしまい、ストレスになってしまいます。
    意図する動きとしては下図かと思います。これは、どのタイミングで入力完了にするか、という実装に依存するUXです。

    画像
    改善例:IME変換後に明示的にEnterを押したら確定になるのであれば自然な入力ができる

    その他にも、テキスト入力 → 確定(次のアクション)というフローを持つUIとしては以下が挙げられます。

    • 検索インプット:入力(変換確定)後、明確にEnterキーを押下した後で検索して欲しい。

    画像
    検索インプット
    • インクリメンタルサーチ(入力中に検索が走るインプット):検索キーワード入力中に検索が走って欲しい。中でも、以下が考えられます。

      • あいまい語のサポートがある(漢字・ひらがなどちらでも検索できる)場合:入力中(変換中も含む)に検索が走って欲しい。

      • あいまい語を明確に区別する(漢字・ひらがなは別に扱われる)場合:入力中(変換確定後)に検索が走って欲しい。

    画像
    インクリメンタルサーチ
    • タグインプット:入力後(変換確定後)、フォーカスが外れたタイミングやEnterキーで確定して欲しい。

    画像
    タグインプット
    • チャット・メッセージの送信インプット:入力後(変換確定後)、明確にEnterキーを押下した後で送信して欲しい。

    画像
    • ワンタイムパスワード / セキュリティコード入力:1文字入力したら速やかに、次のインプットにフォーカスが移動して欲しい。

    画像
    ワンタイムパスワード / セキュリティコード入力
    • 価格・数値入力:入力後(変換確定後)、フォーカスが外れたタイミングやEnterキーで再計算が行われて欲しい。

    画像
    価格・数値入力

    これらを正しく実装するためには、テキストインプットのどのタイミングでどのイベントが動いているかを知ることが大切です。

    入力に関するイベント・プロパティ

    以下、テキスト入力に用いられるイベント・プロパティをReact.jsを例にした解説(Input Element を「Element:」と呼びます)となります。

    Element:onInputイベント

    addEventListener("input", (event) => {});

    により登録するイベントです。
    基本的にInputイベントは、要素の値 (value)が、ユーザーのアクション(テキストボックスに入力)により、変更された際に発行されます。

    Element:onChangeイベント

    addEventListener("change", (event) => {});

    により登録するイベントです。
    change イベントはユーザーが要素の値を変更したときに発行されますが、inputイベントと異なり、要素の値 (value)が変更されるたびに発生するとは限りません。

    ReactのonChangeイベント

    <input type="text" onChange={handleChange} />;

    一般的なControlled Componentの方法として、上記のようにonChangeを記述する方法です。React側で1文字ごとの入力検知をしてイベントを発行してくれます。ネイティブのonChangeイベントとは異なります。

    Element:compositionstartイベント

    IMEなどのテキスト変換システムが新しい変換セッションを開始した時に発生します。

    Element:compositionendイベント

    IMEなどのテキスト編集システムが現在の編集セッションを完了またはキャンセルした時に発生します。

    KeyboardEvent.isComposingプロパティ

    は読み取り専用プロパティで、イベントが変換セッションの途中、すなわち compositionstartの後かつcompositionendの前に発行されたことを示す論理値となります。

    Element:keydownイベント(Enterキー)

    element.addEventListener("keydown", (e) => {
      if (e.key === "Enter") {
        // someting to do
      }  
      return false;
    });

    上記により、Enterキーのkeydownを検知する方法です。

    実験:イベントのタイミングを監視する

    上記のイベントをロギングするツールを作ってみました。
    よかったら実際に動かしてみて、検証してみていただけると嬉しいです。

    画像
    https://codesandbox.io/p/sandbox/m3gntj

    ソースコードは:https://codesandbox.io/p/sandbox/m3gntj です

    実験結果:イベントのタイミングを整理する

    ということで、上記のイベントが発火するタイミングを、入力の流れに追って整理したいと思います。

    英字入力のタイムライン

    ユーザーの操作:
    ❶「a」を入力
    ❷「Enter」を押してアクションを実行
    ❸ フォーカスを外す(blur)

    イベントの流れ:
    ❶「a」を入力した瞬間
    ├─ 🔴 KeyboardEvent.isComposing:false
    ├─ 🔥 Element:onInput 発火(値: "a")
    └─ 🔥 React onChange 発火(値: "a")
    ❷「Enter」を押した瞬間
    ├─ 🔥 Element:keydown (Enter)
    └─ 💤 その他(onInputなど)は沈黙
    ❸ 入力欄からフォーカスを外した瞬間(blur)
    └─ 🔥 Element:onChange 発火(値: "a")

    これは理解しやすいと思います。

    日本語入力のタイムライン

    ユーザーの操作:
    ❶「k」入力 
    ❷「a」入力 
    ❸「過」に変換 
    ❹ 変換確定のEnter 
    ❺ 送信などのEnter 
    ❻ フォーカスを外す(blur)

    イベントの流れ:
    ❶「k」を入力した瞬間(変換全体の開始)
    ├─ 🔥 Element:compositionstart 発火
    ├─ 🟢 KeyboardEvent.isComposing:true(以後、確定するまでtrue)
    ├─ 🔥 Element:onInput 発火(値: "k")
    ├─ 🔥 React onChange 発火(値: "k")
    └─ 💤 その他(native change / compositionend)は沈黙
    ❷「a」を入力した瞬間(変換中・「か」になる)
    ├─ 🟢 KeyboardEvent.isComposing:true のまま
    ├─ 🔥 Element:onInput 発火(値: "か")
    ├─ 🔥 React onChange 発火(値: "か")
    └─ 💤 その他は沈黙
    ❸ スペースキー等で「過」に変換した瞬間(まだ未確定)
    ├─ 🟢 KeyboardEvent.isComposing:true のまま
    ├─ 🔥 Element:onInput 発火(値: "過")
    ├─ 🔥 React onChange 発火(値: "過")
    └─ 💤 その他は沈黙
    ❹ スペースキー等で「過」を選び、「Enter」を押して文字を確定した瞬間
    ├─ 🔥 Element:keydown (Enter) 発火
    ├─ 🔥 Element:onInput 発火(値: "過") ※1 順序にブラウザ間差異あり
    ├─ 🔴 KeyboardEvent.isComposing:false
    ├─ 🔥 Element:compositionend 発火
    └─ 🔥 React onChange発火(値: "過") ※2 値に変化がないので間引かれる
    ❺ 文字が確定した状態(通常状態)で、もう一度「Enter」を押した瞬間├─ 🔥 Element:keydown (Enter) 発火
    ├─ 🔴 KeyboardEvent.isComposing:false のまま
    └─ 💤 その他は、文字が変化していないためすべて沈黙
    ❻ 入力欄からフォーカスを外した瞬間(blur)
    ├─ 🔴 KeyboardEvent.isComposing: false のまま
    ├─ 🔥 Element:onChange 発火(値: "過")
    └─ 💤 その他はすでに発火し終えているため沈黙

    だいぶ混んできましたね。実装のポイントとしては、以下かと思います。

    ポイント

    • Element:compositionstart と Element:compositionend は「セットで1回だけ」:文字を打つたびに毎回発火するわけではなく、日本語入力の「最初」と「最後(確定)」にだけピンポイントで1回ずつ発火します。

    • ReactのonChange は常にElement:onInputと連動する:Reactの onChangeは名前こそchangeですが、挙動は完全にElement:onInput と同じタイミングとなります。

    • ネイティブのonChangeだけが完全に孤高のタイミング:ユーザーが入力欄での作業をすべて終えて、別の場所をクリックした(あるいはTabキーで移動した)瞬間にしか動きません。

    まとめに書いた ※ の説明なのですが…この先は腐海の森に入ります。

    注意1:ブラウザ間でのイベント順序の差異

    上記の❹のonInputのところで注釈を入れましたが、「Enter」を押して文字を確定した瞬間のイベント順序にブラウザで差が発生します。

    Chrome / Safari の場合
    ChromeやSafariでは、文字を入力欄に反映(Element:onInput)が先で、そのあとに変換終了(Element:compositionend)が通知されます。

    Firefox の場合
    Firefoxは、まず変換が終わった(Element:compositionend)ことを宣言してから、最終的な文字を入力欄に反映(Element:onInput)します。

    この通り、ChromeやSafariでは「確定した瞬間の Element:onInput(=Reactの onChange)イベントの時点では、まだ isComposing が true のまま」です。
    そのため、以下のようなコードを React の onChange に書いてしまうと、問題が発生します。

    const handleChange = (e) => {
      // ❌ Chrome/Safariだと、確定の瞬間も true になってしまい、
      // 最後に確定した文字(今回の例なら「過」)がStateに反映されずに無視されてしまう
      if (e.nativeEvent.isComposing) {
        return; 
      }
      setValue(e.target.value);
    };
    
    return (
      <input type="text" onChange={handleChange} />;
    );

    このため、React v17以降では「日本語の変換中(未確定)であっても、文字が確定した瞬間であっても、開発者が e.target.value を見たときに『常に最新の文字』がバグなく取得できるようにする処理が入っているそうです。
    具体的には、Reactはcompositionend の直後に「確定版のダミーの onChange イベント」をReact内部で意図的に再生成して発火させています。

    注意2:Reactのイベントの間引き

    上記の説明を読んで、実際にイベントを観測してみたのですが、このタイミングでReactのonChangeは発火しませんでした。
    改めて思ったんですが、内部で「直前の値と現在の値の変化」をチェックしており、確定前にすでに同じ文字でイベントが発火しているため、間引かれている、という挙動でした。
    すみませんが、現状これを回避してイベントを発火させる方法を思いつきませんでした。

    ちょっと話題が逸れまくってしまったので

    あらためて元の話に戻って、纏めておきます。特にIME変換を用いる日本語の入力があるUIでは、どのイベントを拾ってアクションを起こすかが、UXに大きな影響を与えます。期待と合わないような動きをしている時は、この例とデモを参照してもらえると非常に嬉しいです。

    さらに最後に、イベントの順序にフォーカスして書ききれなかったのですが、これらのイベントを適切に間引く実装も重要です。インクリメンタルサーチなどでは、割り切ってReactのonChangeにDebounce処理を加えたものが一番スッキリしたりします。ぜひ検討してみてください。



    詰問しちゃったよ。

    画像
    ごめんいいすぎた
    画像
    ほんとごめん
    画像
    こちらこそごめん

    あなたへのおすすめ