ityped_t

1.0.4 • Public • Published

iTypedT

fork by iTyped

Dead simple Animated typing, with no dependencies.

Enter in any string, and watch it type at the speed you've set, backspace what it's typed, and begin a new sentence for however many strings you've set.


Features

  • iTyped has a tiny size: 2 kB.
  • iTyped has no jQuery dependency.
  • Just install and enjoy!
  • Placeholder input support.

At now, if you just need to render Strings, iTyped is the best solution for you.

diff

Customization

  init("#element", {

    /**
     * @param {Array} strings An array with the strings that will be animated
     */
     strings: ['Put your strings here...', 'and Enjoy!']

    /**
     * @param {Number} typeSpeed Type speed in milliseconds
     */
     typeSpeed:  100,

    /**
     * @param {Number} startDelay Time before typing starts
     */
     startDelay: 500,

    /**
     * @param {Number} waitDelay Time before next line
     */
     waitDelay:  500,

    /**
     * @param {Bollean} showCursor Show the cursor element
     */
     showCursor: true,

    /**
     * @property {String} cursorChar character for cursor
     */
     cursorChar: "|",


    // once the last string was typed
    /**
     * @property {Function} onFinished The callback called , if `loop` is false,
     * once the last string was typed
     */
    onFinished: function(){},
  }

Installation

CSS

CSS animations are build upon initialzation in JavaScript. But, you can customize them at your will! These classes are:

/* Cursor */
.ityped-cursor {
}

Want the animated blinking cursor?

.ityped-cursor {
  font-size: 2.2rem;
  opacity: 1;
  -webkit-animation: blink 0.3s infinite;
  -moz-animation: blink 0.3s infinite;
  animation: blink 0.3s infinite;
  animation-direction: alternate;
}

@keyframes blink {
  100% {
    opacity: 0;
  }
}

@-webkit-keyframes blink {
  100% {
    opacity: 0;
  }
}

@-moz-keyframes blink {
  100% {
    opacity: 0;
  }
}

Use with multiples instances at the same time

<span id="one"></span>
<span id="other"></span>
import { init } from 'ityped'

const oneElement = document.querySelector('#one')
const otherElement = document.querySelector('#other')

init(oneElement, { showCursor: false, strings: ['Nice', 'One'] })
init(otherElement, {
  strings: ['iTyped is', 'Awesome']
})

Use with React.js

import React, { Component } from 'react'
import { init } from 'ityped'

export default class Hello extends Component {
  componentDidMount() {
    const myElement = document.querySelector('#myElement')
    init(myElement, {
      showCursor: false,
      strings: ['Use with React.js!', 'Yeah!']
    })
  }
  render() {
    return <div id="myElement" />
  }
}

Thanks for checking this out.

If you're using this, let me know! I'd love to see it.

Dependents (0)

Package Sidebar

Install

npm i ityped_t

Weekly Downloads

1

Version

1.0.4

License

MIT

Unpacked Size

24.6 kB

Total Files

12

Last publish

Collaborators

  • tangdaoyuan