typing-effect-ts - npm Package Compare versions

Comparing version 1.3.3 to 1.3.4

package.json

		{
		"name": "typing-effect-ts",
		"version": "1.3.3",
		"version": "1.3.4",
		"description": "A small TypeScript package that provides the ability to create a typing effect with one or multiple strings.",
		@@ -18,2 +18,3 @@ "repository": {
		"dev": "vite",
		"build:demo": "vite build",
		"test": "vitest run",
		@@ -41,5 +42,5 @@ "coverage": "vitest run --coverage"
		"typescript": "^5.4.5",
		"vite": "^5.2.8",
		"vite": "^5.2.10",
		"vitest": "^1.3.1"
		}
		}

README.md

		@@ -16,8 +16,18 @@ # Typing Effect

		Ceck the [Notes](#notes) section and [demo](https://ydernov.github.io/typing-effect/) for more information and examples.

		## Installation

		Not available yet.

		```bash
		npm i typing-effect-ts
		```

		### Or via script tag
		Thanks to [JSDELIVR](https://www.jsdelivr.com)

		```html
		<script type="module">
		import { TypingEffect } from "https://cdn.jsdelivr.net/npm/typing-effect-ts/dist/index.js";
		const te = new TypingEffect();
		</script>
		```
		@@ -468,1 +478,8 @@
		Loop to the first string after the last. Defaults to `true`.


		## Notes

		Don't expect exact timing in milliseconds. TypingEffect uses requestAnimationFrame, which usually calls its callback around every 16ms (sometimes longer if the website is busy (usually with JS)). This means the shortest reaction time is at least 16ms, so any timing you set will be rounded to the nearest bigger multiple of 16.

		For instance, if you set `cursorBlinkRate` to 500ms, the cursor will actually blink every 512ms because 500 isn't divisible by 16, but 512 is.

New alerts