Skip to content

Documentation / @agentick/react / useStreamingText

Function: useStreamingText() ​

useStreamingText(options?): UseStreamingTextResult

Defined in: react/src/hooks/use-streaming-text.ts:32

Subscribe to streaming text from the client.

Uses the client's built-in streaming text accumulation which handles tick_start, content_delta, tick_end, and execution_end events.

Parameters ​

options? ​

UseStreamingTextOptions = {}

Returns ​

UseStreamingTextResult

Example ​

tsx
import { useStreamingText } from '@agentick/react';

function StreamingResponse() {
  const { text, isStreaming } = useStreamingText();

  return (
    <div>
      <p>{text}</p>
      {isStreaming && <span className="cursor">|</span>}
    </div>
  );
}

Released under the ISC License.