Appearance
Props
Name | Type | Default | Description |
---|---|---|---|
element | String | span | The HTML element to use for the wrapper. |
strings | Array | ["Hello", "World"] | Strings to type out when using autoStart option |
cursor | String | pipe character | String value to use as the cursor. |
delay | Number | natural | natural |
deleteSpeed | Number | natural | natural |
loop | Boolean | false | Whether to loop the strings. |
autoStart | Boolean | true | Whether to start typing automatically. |
pauseFor | Number | 1500 | The pause duration after a string is typed when using autostart mode. |
devMode | Boolean | false | Whether or not to display console logs. |
skipAddStyles | Boolean | false | Whether or not to skip adding styles to the document. |
wrapperClassName | String | Typewriter__wrapper | The class name to use for the wrapper element. |
cursorClassName | String | Typewriter__cursor | The class name to use for the cursor element. |
stringSplitter | Function | null | A function that splits the string into an array of characters. Example |
onCreateTextNode | Function | null | Callback function to replace the internal method which creates a text node for the character before adding it to the DOM. If you return null, then it will not add anything to the DOM and so it is up to you to handle it. |
onRemoveNode | Function | null | Callback function when a node is about to be removed. First param will be an object { node: HTMLNode, charater: string } |
See the Typewriter Effect package for more information.