type-writer-text
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0 • Public • Published

    type-writer-text

    lightweight spinner library

    NPM JavaScript Style Guide

    Install

    npm install --save type-writer-text

    Usage

    Basic

    import * as React from 'react'
     
    import { TypeWriterText } from 'type-writer-text'
     
    class App extends React.Component {
      render () {
        return (
          <TypeWriterText text={"Happy Quarantine"} />
        )
      }
    }

    Passing Props

    The component takes in following props

    Text :

    • Mandatory paramter, to render the string you want

    Animation Speed :

    • Optional paramter, to provide the speed to text rendering, defaults to 100

    Cursor Props :

    • Optional paramter, to provide color and blink-speed to cursor
    • Should be passed in as an object, eg. {color:'grey', blinkSpeed: '1s'}, defaults to rgba(0,0,0,0.87) for color and '0.8s' for blinkSpeed
    Show Cursor :
    • Optional paramter, to show/hide cursor, defaults to true
    import * as React from 'react'
     
    import { TypeWriterText } from 'type-writer-text'
     
    class App extends React.Component {
      render () {
        return (
          <TypeWriterText text={"Happy Quarantine"} animationSpeed = {100} cursorProps = {{ color: 'rgba(0,0,0,0.87)', blinkSpeed: '0.8s' }} showCursor = {true} />
        )
      }
    }

    License

    MIT © HRSHDG8

    Keywords

    none

    Install

    npm i type-writer-text

    DownloadsWeekly Downloads

    1

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    14.2 kB

    Total Files

    10

    Last publish

    Collaborators

    • avatar