react-typewrite

ReactJS component that simulates the effect of typing on a text editor

Demo & Examples

Live demo: antoniocapelo.github.io/react-typewrite

To build the examples locally, run:

npm install
npm start

Then open localhost:8000 in a browser.

Installation

The easiest way to use react-typewrite is to install it from NPM and include it in your own React build process (using Browserify, Webpack, etc).

You can also use the standalone build by including dist/react-typewrite.js in your page. If you use this, make sure you have already included React, and it is available as a global variable.

Just require the component and use it on your ReactJS app. Don't forget to include the component stylesheet, either lib/ReactTypewrite.css (if installed from NPM) or dist/react-typewrite.min.css (if installed from Bower). How you'll include the component style - either by requiring it, including directly on the html, importing it - is up to you, just make sure you're using it so that the cursor can blink.

npm install react-typewrite --save

Usage

var ReactTypewrite = require('react-typewrite');

<ReactTypewrite>
  <h1>
    Your component here
  </h1>
</ReactTypewrite>

Properties

• timeout {Number} - time (ms) between key strikes (it can be the exact time, if randomize is disabled, or the maximum time, if randomize = true
• initialDelay {Number} - time (ms) before starting to type the first word (default: 0ms)
• eraseDelay {Number} - time (ms) before starting to clean up (default: 1000ms)
• eraseSpeed {Number} - time (ms) between removing each letter (default: 100ms)
• initialDelay {Number} - time (ms) before starting to type the first word (default: 0ms)
• randomize {Boolean} - wether the keystroke times should be randomize up to a defined value or not (default: false)
• cleanUp {Boolean} wether the strings should be cleaned after typing them (default: false)
• hardBlink {Boolean} cursor blinking in hard mode - no animation (default: false)

Development (src, lib and the build process)

NOTE: The source code for the component is in src. A transpiled CommonJS version (generated with Babel) is available in lib for use with node.js, browserify and webpack. A UMD bundle is also built to dist, which can be included without the need for any build system.

To build, watch and serve the examples (which will also watch the component source), run npm start. If you just want to watch changes to src and rebuild lib, run npm run watch (this is useful if you are working with npm link).

Contributing

npm install && npm start for starting the server with the demo page.

License

MIT

Copyright (c) 2016 António Capelo.