2.0 alpha
These docs describe 2.0. Install it with @once-ui-system/core@alpha.
On 1.8.x? Read the 1.x docs
TrademarkTrademarkDocs
Ctrl k
Search docs...
Effects

TypeFx

Updated: October 14, 2025
View on GitHub
TypeFx creates a realistic typewriter animation that types out text character-by-character. When multiple words are provided, it automatically types, holds, deletes, and cycles through them. TypeFx can also display a single word that types out once without looping. Use the custom trigger to programmatically control when the typing animation starts.
Prop
Type
Default
wordsrequired
One string to type, or several to cycle through.
stringstring[]
speed
Milliseconds per character.
number100
delay
Milliseconds before typing starts.
number0
hold
Milliseconds a finished word stays before the next one.
number2000
trigger
"custom" waits for the function handed to onTrigger.
instantcustom
instant
onTrigger
Receives a function that starts it, when trigger is "custom".
(triggerFn: () => void) => void
loop
Cycle back to the first word instead of stopping.
booleantrue
children
Rendered after the typed text.
React.ReactNode
…and every TextProps propinherited
Edit this page on GitHub
TrademarkTrademark
Built with curiosity by Lorant One and the Design Engineers Club