npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

typing-flow

v0.1.6

Published

Npm package for typing animation for web

Downloads

29

Readme

Typing Flow

Powerful utility for creating typing animations on your website.

  • Tiny ⬇️
  • Zero dependencies 🕊️
  • Full TypeSafety 🔒
  • Chain design 🔗

Installation

npm i typing-flow

Usage

import { TypingFlow } from "typing-flow";

const flow = new TypingFlow(".containerSelector", options).type("Hello, Flow!");

flow.start();

Configuration

const flow = new TypingFlow(".selector", {
	mode: "lite" | "default",
	interval: 150,
	attr: "innerHTML",
	loop: false,
	charClass: ["class1", "class2", ...],
	charWithCursorClass: ["cursorClass1", "cursorClass2", ...],
});
  • mode - Property for setting animation mode. In default mode every visible symbol wraps into <span>. This makes styling easier. The lite mode means that text will be typed as simple string. It's comfortable for simple animations and "streaming" animation to other attributes different innerHTML.
  • interval - Property for setting default interval between two "presses on keys".
  • attr - Property for setting container attribute for streaming flow. In default mode attr property can be innerHTML only. In lite mode you can set any attribute of flow container (value, placeholder, data-*).
  • loop - Animation should be replay on finish if loop: true.
  • charClass - List of classes for <span> wrapper around symbols in default mode. Each of this classes will be applied to every visible symbol.
  • charWithCursorClass - List of classes for <span> wrapper around single symbol with cursor.

    Note: cursor always pinned to symbol. Cursor should be displayed before symbol with equal position.

API

flow.type(text: string, [options])

Method to add text for "typing". Text can include spaces and any symbols.

flow.type("Some text");

flow.config([options])

Method to configure flow. You can setting options: interval | attr | loop |.

flow
	.type("First text") // typing with interval 150 (default)
	.config({
		interval: 70,
	})
	.type("Second text"); // typing with interval 70 (configured)

flow.tag(tag: string, [options])

Method to add tag to flow. Support only single tags.

flow.tag("<br />");

flow.delay(ms: number)

Method to add delay in animation. You can enter any delay in ms.

flow.delay(2000); // 2 sec

flow.moveCursor(diff: number, [options])

Method to move cursor around visible typed symbols. You can enter position different as int.

flow1.type("Hello").moveCursor(-2); // Hel|lo

flow2.type("Hello").moveCursor(-4).moveCursor(1); // He|llo

flow.backspace(amount: number, [options])

Method to delete symbols on left side of cursor position. You can enter amount of symbols for deleting as int.

flow.type("Hello").backspace(2); // Hel|

flow.delete(amount: number, [options])

Method to delete symbols on right side of cursor position. You can enter amount of symbols for deleting as int.

flow.type("Hello").moveCursor(-2).delete(2); // Hel|

flow.on(event: "start" | "finish", cb: () => void)

Method to add animation hook. You can subscribe and apply callbacks on some animation lifecycle events.

Available events: start | finish

flow
	.type("Hello")
	.on("start", () => {
		console.log("Flow Start");
	})
	.on("finish", () => {
		console.log("Flow Finish");
	});

Utils

chainedFlows(...flows: TypingFlow[])

Utility for chaining many flows in one animation. Each flow will be start on finish prevent flow.

loop will be disabled for all flows in chain.

This function return ref on first flow in chain.

const flow1 = new TypingFlow(".flow1").type("Hello");

const flow2 = new TypingFlow(".flow2").type("Flow");

const resultFlow = chainedFlows(flow1, flow2); // resultFlow === flow1;

resultFlow.start();