Package Health Score

57 / 100

security
No known security issues
popularity
Recognized
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
3.2.0	\|	10/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.1.0	\|	06/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.1.2	\|	10/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.3	\|	05/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.9	\|	04/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (41,411)

GitHub Stars: 417
Forks: 24
Contributors: 6

Direct Usage Popularity

The npm package react-type-animation receives a total of 41,411 downloads a week. As such, we scored react-type-animation popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package react-type-animation, we found that it has been starred 417 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 6
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like react-type-animation is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 14
Open PR: 1
Last Release: 1 year ago
Last Commit: 4 months ago

Further analysis of the maintenance status of react-type-animation based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for react-type-animation is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 4 years
Dependencies: 0 Direct
Versions: 32
Install Size: 34.3 kB
Dist-tags: 1
# of Files: 20
Maintainers: 1
TS Typings: No

react-type-animation has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

react-type-animation

A customizable React typing animation component.

Installation

npm install react-type-animation

yarn add react-type-animation

Requires a react and react-dom version of at least 15.0.0.

Live Demo

A live demo and usage examples of the animation can be found at https://react-type-animation.netlify.app/examples.

Usage

A common typewriter animation for a landing page would look like this:

import { TypeAnimation } from 'react-type-animation';

const ExampleComponent = () =&gt; {
  return (
    
  );
};

Documentation

The docs with props, options and common problem solutions can be found at: https://react-type-animation.netlify.app/.

Migrating to v3

The default wrapper is now <span> instead of <div>: To migrate, add a display: inline-block/block or wrapper="div" to all `` occurances with unspecified wrapper.

Usage Notes

Immutability

Due to the nature of the animation, this component is permanently memoized, which means that the component never re-renders unless you hard-reload the page, and hence props changes will not be reflected.

Hot Reload NOT Supported

Because the TypeAnimation component is memoized and never re-rendered (see above), yet Hot Reload attempts to re-render the component, changes to the TypeAnimation component will not render until you hard-reload the page.

Hence, whenever you make changes to the TypeAnimation component, you unfortunately have to reload your page.

Props

See https://react-type-animation.netlify.app/options for more details.

Prop	Required	Type	Example	Description	Default
`sequence`	yes	Array void	Promise)>	`['One', 1000, 'Two', () => console.log("done")]`	Animation sequence: [TEXT, DELAY-MS, CALLBACK]
`wrapper`	no	string	`p`,`h2`,`div`, `strong`	HTML element tag that wraps the typing animation	`span`
`speed`	no	1,2,..,99	{type: "keyStrokeDelayInMs", value: number}	`45`, `{type: "keyStrokeDelayInMs", value: 100}`	Speed for the writing of the animation
`deletionSpeed`	no	1,2,..,99	{type: "keyStrokeDelayInMs", value: number}	`45`, `{type: "keyStrokeDelayInMs", value: 100}`	Speed for deleting of the animation
`omitDeletionAnimation`	no	boolean	`false`, `true`	If true, deletions will be instant and without animation	`false`
`repeat`	no	number	`0`, `3`, `Infinity`	Amount of animation repetitions	`0`
`cursor`	no	boolean	`false`, `true`	Display default blinking cursor css-animation	`true`
`preRenderFirstString`	no	boolean	`false`, `true`	If true, the first string of your sequence will not be animated and initially (pre-)rendered	`true`
`className`	no	string	`custom-class-name`	HTML class name applied to the wrapper to style the text	`-`
`style`	no	object	`{fontSize: '2em'}`	JSX inline style object	`-`
`ref`	no	HTMLElement	null	`-`	`-`
`splitter`	no	(text: string) => Array	`(str) => new GraphemeSplitter().splitGraphemes(str)`	Used for splitting complex characters, see grapheme-splitter for more details	`String.split('')`

npm / github Credits: typical Shoutouts/Supporters: blockig

FAQs

What is react-type-animation?

Customizable React typing animation component based on typical. Visit Snyk Advisor to see a full health score report for react-type-animation, including popularity, security, maintenance & community analysis.

Is react-type-animation popular?

The npm package react-type-animation receives a total of 41,411 weekly downloads. As such, react-type-animation popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is react-type-animation well maintained?

We found indications that react-type-animation is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is react-type-animation safe to use?

The npm package react-type-animation was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 8 November-2024, at 12:01 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP