StreamTextProps

Defined in: react/src/StreamText.tsx:43

Properties

as?

optional as?: ElementType

Defined in: react/src/StreamText.tsx:47

Element to render. Defaults to a span so it inherits typography.

---

className?

optional className?: string

Defined in: react/src/StreamText.tsx:48

---

field

field: FieldState

Defined in: react/src/StreamText.tsx:45

The field, straight from useIsland().state.fields.*.

---

smooth?

optional smooth?: boolean

Defined in: react/src/StreamText.tsx:67

Motion — ON BY DEFAULT. Pass false to render text verbatim, with no typing pace and no fades.

Pure presentation, by contract:

• live stream text types in at a paced rate (bursty model output reads as fluent typing), and a field’s close finishes the typing rather than jumping to the end;
• copy that lands whole in a blank slot — a cached replay, or the fallback when the hold runs out — fades in once;
• visible text is never wiped and never retyped. A deliberate replacement (field.crossfade) cross-fades once; any other replacement of stream text is refused and the visible text stays;
• every fade uses COPY_MOTION_MS on COPY_MOTION_EASING;
• under prefers-reduced-motion, and on a hidden page, text renders at its final state with no motion.

---

style?

optional style?: CSSProperties

Defined in: react/src/StreamText.tsx:49