Skip to content

eo-typewriterjs


eo-typewriterjs / createTypewriter

Function: createTypewriter()

ts
function createTypewriter(options): TTypewriter;

Defined in: index.ts:173

Parameters

ParameterTypeDescription
optionsTTypewriterOptionsConfiguration options including the renderer to use

Returns

TTypewriter

A TTypewriter instance with a timeline builder and full playback controls

Description

Create a new typewriter instance with the given renderer. Use tw.timeline.type(...) to schedule commands, then call tw.play() to execute them. All playback controls (pause, stop, cancel, seek, step, rate) are available on the returned object.

Released under the MIT License.