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

solid-typer

v0.0.3

Published

Add text-typing animations to a Solid.js app

Downloads

22

Readme

Solid Typer

A component that offers a customisable text-typing animation for Solid.js. View live example.

Getting Started

Install the library

> npm i solid-typer
or
> yarn add solid-typer

Use the component

Install solid-typer, then use it your Solid.js app as follows:

import type { Component } from "solid-js";
import { SolidTyper } from "solid-typer";

const MatrixExample: Component<{ callback: () => void }> = ({ callback }) => {
  return (
    <p class={styles.typer}>
      <SolidTyper
        text={[
          "Wake up, Neo...",
          "The Matrix has you...",
          "Follow the white rabbit.",
          "Knock, knock, Neo.",
        ]}
        backspaceSpeed={30}
        typingSpeed={100}
        onFinish={callback}
      />
    </p>
  );
};

export default MatrixExample;

Customisation Options

You can provide the SolidTyper component with a variety of props that customise the typing animation. These props are defined by the TyperProps interface. The options include:

  • className - An optional CSS class that wraps all the text.
  • style - An optional style object to pass directly to the outer span.
  • cursorClassName - A class that is used to style the cursor.
  • text - A word/sentence or a group of words/sentences that get typed out.
  • loop - Control whether the typing animation occurs once or continuosly.
  • cursor - Control whether or not to show the cursor.
  • startDelay - An optional amount of time to wait before the animation starts.
  • typingSpeed - The speed at which the cursor types text forward.
  • backspaceSpeed - The speed at which the cursor deletes text.
  • typingPause - A time to pause before beginning to type.
  • backspacePause - A time to pause before beginning to backspace.
  • onTypingEnd - A method which can be called when the typing reaches the end of the line.
  • onBackspaceEnd - A method which can be called when the backspace typing reaches the beginning of the line.
  • onFinish - A method from the parent component to call when the typing animation is finished.

Cursor Styling

If you choose to use the cursor it is highly recommended to style it with a blinking animation to make it look like a realistic cursor. Here is a basic example. Define the following in a CSS file.

@keyframes blink {
  50% {
    opacity: 1;
  }
}

.cursor {
  opacity: 0;
  animation: blink 800ms steps(1) infinite;
  animation-delay: 100ms;
}

Then apply "cursor" to the cursorClassName prop as follows:

<SolidTyper text="Hello World" cursor cursorClassName="cursor" />

Collaboration

This is the first npm package I have created. I would love to have people collaborate on this project to make it a great package for Solid.js devs to use for adding text-typing animations to web apps. Feel free to fork and create pull requests.

Connect with me on Twitter @still_scripts