react-native-animated-typewriter
v1.0.6
Published
A typewriter component for react-native
Downloads
12
Maintainers
Readme
react-native-typewriter
A React Native component for spelling out words, letter by letter.
Installation
$ yarn add react-native-animated-typewriter
OR
$ npm install --save react-native-animated-typewriter
Usage
All you need is a text prop to make it work.
import React, { Component } from 'react'
import AnimatedTypeWriter from 'react-native-animated-typewriter'
class YourLitComponent extends Component {
render() {
return <AnimatedTypewriter text={"I'm living my best life in 2019"}/>
}
}
Documentation
Any props accepted by React Native's Text
component are accepted by AnimatedTypeWriter
. These additional props are also accepted:
timeBetweenLetters
type: Number
default: 50
The number of milliseconds between letters typed on the screen
containerStyle
type: Object
default: {}
Style the text container
textStyle
type: Object
default: {}
Style the text
onTyped
type: Function
default: none
A callback called when each token is typed during the animation. The
function is called with two arguments:
(Number index, Number previousVisibleCharacters)
.
onTypingEnd
type: Function
default: none
Called once the typing animation has completed.
License
Released under the MIT license. See LICENSE for details.