github
/
typing-effect-element
зеркало из https://github.com/github/typing-effect-element.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
A custom element that shows text as if it were being typed
2 коммитов 4 Ветки 2 Теги 269 KiB
JavaScript 61.8%
TypeScript 38.2%
Перейти к файлу
Nick Holden 5911d602e2
Update README 		2021-04-08 18:01:00 -07:00
.github/workflows Initial commit 2021-04-08 17:57:50 -07:00
examples Initial commit 2021-04-08 17:57:50 -07:00
src Initial commit 2021-04-08 17:57:50 -07:00
test Initial commit 2021-04-08 17:57:50 -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 Initial commit 2021-04-08 17:57:50 -07:00
package.json Initial commit 2021-04-08 17:57:50 -07: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!", "Let’s 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.