A custom element that shows text as if it were being typed
Перейти к файлу
Kristján Oddsson 867ae38164
Fix example page
2021-04-13 13:01:24 +01:00
.github/workflows Initial commit 2021-04-08 17:57:50 -07:00
examples Fix example page 2021-04-13 13:01:24 +01:00
src Add real tests 2021-04-08 18:53:04 -07:00
test Improve tests 2021-04-09 14:53:28 -07:00
.eslintignore Initial commit 2021-04-08 17:57:50 -07:00
.eslintrc.json Initial commit 2021-04-08 17:57:50 -07:00
.gitattributes Initial commit 2021-04-08 17:57:50 -07:00
.gitignore Initial commit 2021-04-08 17:57:50 -07:00
.travis.yml Initial commit 2021-04-08 17:57:50 -07:00
CODEOWNERS Initial commit 2021-04-08 17:57:50 -07:00
CODE_OF_CONDUCT.md Initial commit 2021-04-08 17:57:50 -07:00
CONTRIBUTING.md Initial commit 2021-04-08 17:57:50 -07:00
LICENSE Initial commit 2021-04-08 17:57:50 -07:00
README.md Update README 2021-04-08 18:01:00 -07:00
SECURITY.md Initial commit 2021-04-08 17:57:50 -07:00
karma.config.cjs Initial commit 2021-04-08 17:57:50 -07:00
package-lock.json Update dependencies 2021-04-12 18:05:26 +01:00
package.json Update dependencies 2021-04-12 18:05:26 +01:00
tsconfig.json Initial commit 2021-04-08 17:57:50 -07:00

README.md

<typing-effect> element

A custom element that shows text as if it were being typed

Installation

$ npm install @github/typing-effect-element

Usage

import '@github/typing-effect-element'
<typing-effect data-lines='["Welcome to GitHub!", "Lets begin the adventure"]'>
  <span data-target="typing-effect.content"></span>
  <span data-target="typing-effect.cursor">|</span>
</typing-effect>

Browser support

Browsers without native custom element support require a polyfill.

  • Chrome
  • Firefox
  • Safari
  • Microsoft Edge

Development

npm install
npm test

License

Distributed under the MIT license. See LICENSE for details.