MotionStream

まとめて届くストリーミングテキストを一定のペースで表示し、溜まった分にも追いつきます。

WebReact Native数字とテキスト

試してみる

サンプルを準備中…

JavaScript がオフになっています。下のコードがサンプルの全体です。

App.jsx

import { useEffect, useRef, useState } from 'react';
import { MotionStream } from '@kkwaenggwari/animated-chorus';
import './styles.css';

const answer =
  'Motion helps people follow change. When a total updates, a rolling number shows which way it moved. ' +
  'When a panel opens, the height that follows its content keeps the reader in place. ' +
  'When an answer arrives in bursts, a steady reveal turns the bursts into reading: nothing waits for the ' +
  'next packet, and nothing is dumped at once. The pace speeds up only when a backlog builds, so the text ' +
  'never falls far behind what the server has already sent.';

// Network-like bursts: long pauses, then a lot of text at once.
const pauses = [300, 1100, 250, 1500, 400, 900];

export default function App({ speed = 90, catchUp = 900, chunk = 160, effect = 'fade' }) {
  const [received, setReceived] = useState(0);
  const [chunks, setChunks] = useState(0);
  const renders = useRef(0);
  renders.current += 1;

  useEffect(() => {
    if (received >= answer.length) return;
    const timer = setTimeout(
      () => {
        setReceived((current) => Math.min(answer.length, current + chunk));
        setChunks((count) => count + 1);
      },
      pauses[chunks % pauses.length],
    );
    return () => clearTimeout(timer);
  }, [received, chunks, chunk]);

  const askAgain = () => {
    setReceived(0);
    setChunks(0);
  };

  return (
    <div className="chat">
      <p className="question">Why does motion help an interface?</p>
      <p className="answer">
        <MotionStream
          text={answer.slice(0, received)}
          speed={speed}
          catchUp={catchUp}
          effect={effect}
        />
      </p>
      <footer>
        <output>
          {chunks} chunks · App rendered {renders.current} times
        </output>
        <button onClick={askAgain}>Ask again</button>
      </footer>
    </div>
  );
}

styles.css

.chat {
  display: grid;
  gap: 16px;
  max-width: 620px;
  margin: 0 auto;
  padding: 24px 20px;
}

.question {
  justify-self: end;
  max-width: 80%;
  margin: 0;
  padding: 10px 16px;
  border-radius: 18px 18px 4px 18px;
  background: #176b52;
  color: #fff;
}

.answer {
  min-height: 180px;
  margin: 0;
  padding: 16px 18px;
  border: 1px solid #cfe8dc;
  border-radius: 18px 18px 18px 4px;
  background: #fff;
  color: #16181d;
  line-height: 1.65;
}

footer {
  display: flex;
  flex-wrap: wrap;
  align-items: center;
  justify-content: space-between;
  gap: 10px;
}

output {
  font:
    600 13px ui-monospace,
    Consolas,
    monospace;
  color: #176b52;
}

footer button {
  min-height: 40px;
  padding: 0 16px;
  border: 1px solid #cfe8dc;
  border-radius: 999px;
  background: #fff;
  font:
    600 14px system-ui,
    sans-serif;
  cursor: pointer;
}

いちばん短い使い方

Answer.jsx

<MotionStream text={answerSoFar} initial />

<MotionStream text={answerSoFar}>
  {visible => <Markdown>{visible}</Markdown>}
</MotionStream>

代わりに処理してくれること

まとまって届いた文字が読めるペースに: テキストは塊ではなく、1 秒に speed 文字のペースで表示されます。
溜まった分は表示を速めて、約 catchUp ミリ秒以内に見せきります。
絵文字、国旗、結合文字は決して分割されず、届きかけの絵文字は残りを待ちます。
回答が書き直されても、最初からやり直さず、共通する先頭部分から続けます。
表示された文字はページに直接追加され、React のレンダリングは 1 秒に数回だけです。

こんなときに

チャットでのアシスタントの回答。
ビルドやデプロイのログ。
リアルタイムの字幕。

props

Prop	型	デフォルト	説明
`text`	`string`	`—`必須	これまでのテキスト。増えたテキストは一定のペースで表示され、書き直された場合は共通する先頭部分から続きます。
`speed`	`number`	`90`	1 秒あたりの基本の表示文字数。
`catchUp`	`number`	`900`	溜まった分は、表示を速めてこのミリ秒数ほどで見せきります。
`initial`	`boolean`	`false`	マウント時にあるテキストも順に表示します(指定しなければすぐに表示)。
`effect`	`'fade' \| 'none'`	`'fade'`	`fade` は新しい文字をフェードインし、`none` はそのまま表示します。
`children`	`(visible: string) => ReactNode`		ペース配分されたテキストを受け取る関数。たとえば Markdown の描画に。
`as`	`element`	`'span'`	描画する要素。
`onMotionComplete`	`(text) => void`		表示が `text` に追いつくたびに実行されます。

ほかの props は描画される要素に渡るので、className、style、イベントハンドラーはいつもどおり使えます。

Web と React Native

Web では新しい文字がフェードインし(effect="fade")、選択できる普通のテキストにまとめられます。関数の子要素はペース配分された文字列を受け取るので Markdown も描画でき、更新は最大で 2 フレームに 1 回です。非表示のタブではすべてを一度に表示します。

React Native では、テキストは本物の Text で、フェードなしで表示されます。

使っているサンプル

チャットの回答折りたたまれる提案、一定のペースで流れる回答、切り替わるステータス行。MotionStreamMotionListMotionSwapMotionHeight