Installations

npm install @michaelwwn/react-simple-typewriter

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=14

Node Version

17.4.0

NPM Version

8.3.1 Score

52.2

Supply Chain

92.8

Quality

75.2

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

2

Total

5

Closed

0

Merged

3

Issues

Open

16

Total

21

Closed

5

Releases

7

5.0.0

v5.0.0

Published on 19 Nov 2022

v4.0.5

Published on 05 Oct 2022

v4.0.3

Published on 04 Oct 2022

v4.0.2

Published on 08 Sept 2022

v3.0.1

Published on 27 Aug 2021

v3.0.0

Published on 06 Jul 2021

View all 7 releases

Contributors

5

Unable to fetch Contributors

View all 5 contributors

Languages

3

TypeScript

JavaScript

CSS

TypeScript (79.16%)

JavaScript (17.17%)

CSS (3.67%)

Developer

awran5

Download Statistics

Total Downloads

238

Last Day

1

Last Week

2

Last Month

6

Last Year

48

GitHub Statistics

133 Stars

129 Commits

26 Forks

2 Watching

1 Branches

5 Contributors

Maintainers

1

Package Meta Information

Latest Version

5.0.1

Package Id

@michaelwwn/react-simple-typewriter@5.0.1

Unpacked Size

29.41 kB

Size

9.17 kB

File Count

10

NPM Version

8.3.1

Node Version

17.4.0

Total Downloads

Cumulative downloads

Total Downloads

238

Last day

0%

1

Compared to previous day

Last week

100%

2

Compared to previous week

Last month

200%

6

Compared to previous month

Last year

-46.7%

48

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

2

react react-dom

Dev Dependencies

28

Versions

React Simple Typewriter

A simple react component for adding a nice typewriter effect to your project.

npm bundle size GitHub

screenshot

Install

npm

1npm i react-simple-typewriter

Yarn

1yarn add react-simple-typewriter

Usage

There are two ways to Typewriter:

1. Component

1import React from 'react'
2import { Typewriter } from 'react-simple-typewriter'
3
4const MyComponent = () => {
5  return (
6    <div className='App'>
7      <Typewriter {/* Props */} />
8    </div>
9  )
10}

Component Props

Prop	Type	Options	Description	Default
`words`	array	Required	Array of strings holding the words	`['Hello', '...']`
`typeSpeed`	number	Optional	Character typing speed in Milliseconds	`80`
`deleteSpeed`	number	Optional	Character deleting speed in Milliseconds	`50`
`delaySpeed`	number	Optional	Delay time between the words in Milliseconds	`1500`
`loop`	number \| boolean	Optional	Control how many times to run. `0 \| false` to run infinitely	`1`
`cursor`	boolean	Optional	Show / Hide a cursor	`false`
`cursorStyle`	ReactNode	Optional	Change the cursor style available if `cursor` is `enabled`	`\|`
`cursorBlinking`	boolean	Optional	Enable cursor blinking animation	`\|`
`onLoopDone`	function	Optional	Callback function that is triggered when loops are completed. available if `loop` is `> 0`	`-`
`onType`	function	Optional	Callback function that is triggered while typing with typed words `count` passed	`-`
`onDelay`	function	Optional	Callback function that is triggered on typing delay	`-`
`onDelete`	function	Optional	Callback function that is triggered while deleting	`-`

Usage Example

1import React from 'react'
2import { Typewriter } from 'react-simple-typewriter'
3
4const MyComponent = () => {
5
6  const handleType = (count: number) => {
7    // access word count number
8    console.log(count)}
9  }
10
11  const handleDone = () => {
12    console.log(`Done after 5 loops!`)
13  }
14
15  return (
16    <div className='App'>
17      <h1 style={{ paddingTop: '5rem', margin: 'auto 0', fontWeight: 'normal' }}>
18        Life is simple{' '}
19        <span style={{ color: 'red', fontWeight: 'bold' }}>
20          {/* Style will be inherited from the parent element */}
21          <Typewriter
22            words={['Eat', 'Sleep', 'Code', 'Repeat!']}
23            loop={5}
24            cursor
25            cursorStyle='_'
26            typeSpeed={70}
27            deleteSpeed={50}
28            delaySpeed={1000}
29            onLoopDone={handleDone}
30            onType={handleType}
31          />
32        </span>
33      </h1>
34    </div>
35  )
36}

2. Hook

BREAKING CHANGES v5.0.0 Hook now returns text along with some useful flags:

Prop	Type	Description
`isType`	boolean	Check if currently typing
`isDelete`	boolean	Check if currently deleting
`isDelay`	boolean	Check if currently on delay
`isDone`	boolean	Check if all running loops are done

1import { useTypewriter } from 'react-simple-typewriter'
2
3const MyComponent = () => {
4  /**
5   * @returns
6   * text: [string] typed text
7   * NEW helper: {} helper flags
8   */
9  const [text, helper] = useTypewriter({
10    /* Config */
11  })
12
13  /* Hook helper */
14  const { isType, isDelete, isDelay, isDone } = helper
15
16  return (
17    <div className='App'>
18      <span>{text}</span>
19    </div>
20  )
21}

Hook Config

Prop	Type	Options	Description	Default
`words`	array	Required	Array of strings holding the words	`['Hello', '...']`
`typeSpeed`	number	Optional	Character typing speed in Milliseconds	`80`
`deleteSpeed`	number	Optional	Character deleting speed in Milliseconds	`50`
`delaySpeed`	number	Optional	Delay time between the words in Milliseconds	`1500`
`loop`	number \| boolean	Optional	Control how many times to run. `0 \| false` to run infinitely	`1`
`onLoopDone`	function	Optional	Callback function that is triggered when loops are completed. available if `loop` is `> 0`	`-`
`onType`	function	Optional	Callback function that is triggered while typing	`-`
`onDelete`	function	Optional	Callback function that is triggered while deleting	`-`
`onDelay`	function	Optional	Callback function that is triggered on typing delay	`-`

Hook Usage Example

1import React from 'react'
2import { useTypewriter } from 'react-simple-typewriter'
3
4const MyComponent = () => {
5  const [text] = useTypewriter({
6    words: ['Hello', 'From', 'Typewriter', 'Hook!'],
7    loop: 0
8  })
9
10  return (
11    <div className='App'>
12      <span>{text}</span>
13    </div>
14  )
15}

Hook with Cursor

If you like to have the Cursor effect, you can import it as a separate Component

1import React from 'react'
2import { useTypewriter, Cursor } from 'react-simple-typewriter'
3
4const MyComponent = () => {
5  const [text] = useTypewriter({
6    words: ['Hello', 'From', 'Typewriter', 'Hook!'],
7    loop: 3,
8    onLoopDone: () => console.log(`loop completed after 3 runs.`)
9  })
10
11  return (
12    <div className='App'>
13      <span>{text}</span>
14      <Cursor cursorColor='red' />
15    </div>
16  )
17}

Cursor Component Props

Prop	Type	Options	Description	Default
`cursorStyle`	ReactNode	Optional	Change cursor style	`\|`
`cursorColor`	String	Optional	Change cursor color	`inherit`
`cursorBlinking`	Boolean	Optional	disable cursor blinking animation	`true`

Demo

License

MIT © awran5

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

40 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-w5p7-h5w8-2hfq
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-hc6q-2mpp-qw7j
Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q

Score

1.7

/10

Last Scanned on 2024-12-23

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More