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
27 коммитов 4 Ветки 2 Теги 269 KiB
JavaScript 61.8%
TypeScript 38.2%
Перейти к файлу
Kristján Oddsson 7f3abaec95
Merge branch 'main' of github.com:github/typing-effect-element into hazukitenki/main 		2021-06-04 09:59:14 +01:00
.github/workflows Set CI to run on Pull Requests as well 2021-05-28 09:31:51 +01:00
examples fix unpkg link 2021-05-04 18:08:36 +01:00
src Merge branch 'main' of github.com:github/typing-effect-element into hazukitenki/main 2021-06-04 09:59:14 +01:00
test Merge branch 'main' of github.com:github/typing-effect-element into hazukitenki/main 2021-06-04 09:59:14 +01:00
.eslintignore Initial commit 2021-04-08 17:57:50 -07:00
.eslintrc.json Reverts some inadvertent markdown formatting changes and unnecessary eslint config entry. 2021-05-28 11:26:12 -05: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 Adds mock condition for window.matchMedia for default case (prevents the test from setting delay to 0 when user has reduced motion set on their system). Removes code paths and mentions of attribute data-reduced-motion because including an escape hatch right now might be a bit confusing. 2021-06-01 16:08:44 -05:00
SECURITY.md Initial commit 2021-04-08 17:57:50 -07:00
karma.config.cjs Adds tests and getters to set character and line delay to 0 when reduced motion is preferred by user. 2021-05-27 12:43:09 -05:00
package-lock.json 0.0.2 2021-04-28 08:46:52 +01:00
package.json 0.0.2 2021-04-28 08:46:52 +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!", "Let’s begin the adventure"]'>
  <span data-target="typing-effect.content"></span>
  <span data-target="typing-effect.cursor">|</span>
</typing-effect>

Accessibility

This component detects whether prefers-reduced-motion is set on the window:

window.matchMedia('(prefers-reduced-motion)').matches === true

If this evaluates to true, any content lines provided will be appended immediately rather than being typed out with a delay.

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.