1.0.4 • Published 1 year ago

@kurumi30/typewriter-ts v1.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

Typewriter-ts

Npm package version Npm package total downloads install size npm bundle size MIT License

  • Uma simples animação de digitação para você colocar nos seus projetos frontend 🙂
  • Leve e fácil de usar 🚀
  • Feito apenas com

Instalação

# npm
npm install @kurumi30/typewriter-ts

# pnpm
pnpm add @kurumi30/typewriter-ts

# yarn
yarn add @kurumi30/typewriter-ts

Exemplo

<!-- No HTML -->
<div id="test"></div>
// No JavaScript ou TypeScript

import Typewriter from '@kurumi30/typewriter-ts'
// ou se você estiver usando CommonJS:
// const Typewriter = require('@kurumi30/typewriter-ts')

const test = document.querySelector('#test')
const typewriter = new Typewriter(test, {
  loop: true,
  typingSpeed: 70,
  deletingSpeed: 50,
  cursorColor: 'rgb(255, 0, 0)' // suporta qualquer formato (hex, rgb, etc)
})

typewriter
  .typeString('Hello World!')
  .pauseFor(1000)
  .deleteChars(6)
  .pauseFor(1000)
  .typeString('Typewriter-ts')
  .pauseFor(1000)
  .deleteAll(10)
  .start()

Parâmetros

new Typewriter(element: HTMLElement, {
  loop: boolean,
  typingSpeed: number,
  deletingSpeed: number,
  cursorColor: string,
})
ParâmetroDescriçãoPadrãoObrigatório
elementElemento HTML para a animação.Sim
loopSe a animação deve repetir ou não.falseNão
typingSpeedVelocidade de digitação.50Não
deletingSpeedVelocidade para apagar.50Não
cursorColorCor do cursor.blackNão

Métodos

MétodoDescriçãoParâmetros
typeStringAdiciona um texto para ser digitado.str: string
deleteCharsApaga uma quantidade de caracteres.num: number
deleteAllApaga todo o texto.deleteSpeed: number
pauseForPausa a animação por um tempo.time: number
startInicia a animação.

Créditos

Contribuição

Se você quiser contribuir com o projeto, fique à vontade para abrir uma issue ou pull request. Toda ajuda é sempre bem-vinda! 💻

1.0.4

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.0

1 year ago