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

react-ascii-text

v0.0.4

Published

React hook to render and animate ASCII text art

Downloads

351

Readme

React ASCII Text

This library provides a React hook to render or animate ASCII text art using Figlet fonts.

DEMO

Installation

npm install react-ascii-text

Usage

Figlet fonts are included in the package and can be imported. Full list of fonts along with UI to try them out can be found here.

Note that the font names are converted to camelCasing, omitting spaces and hyphens to allow use as ES modules. This is to allow dynamic import of font and bundlers to only include the desired one in your project code.

| Font name| Import| | ------------- | ------------- | |1Row|import { oneRow } from 'react-ascii-text| |3-D|import { threeD } from 'react-ascii-text'| |5 Line Oblique|import { fiveLineOblique } from 'react-ascii-text'| |Big Money-sw|import { bigMoneySw } from 'react-ascii-text'| etc.

Render ASCII text

Passing a single string will render the text in a Figlet font.

import { useAsciiText, alligator } from 'react-ascii-text';

function MyComponent() {
  const asciiTextRef = useAsciiText({
    font: alligator,
    text: "Hello, World!",
  });

  return <pre ref={asciiTextRef}></pre>;
}

Animate ASCII text

Pass an array of strings to animate a transition between them.

import { useAsciiText, alligator } from 'react-ascii-text';

function MyComponent() {
  const asciiTextRef = useAsciiText({
    animationCharacters: "▒░█",
    animationCharacterSpacing: 1,
    animationDelay: 2000,
    animationDirection: "down",
    animationInterval: 100,
    animationLoop: true,
    animationSpeed: 30,
    font: alligator,
    text: ["REACT", "ASCII", "TEXT"],
  });

  return <pre ref={asciiTextRef}></pre>;
}

Parameters

  • animationDirection (optional, default: "horizontal"): Specifies the direction of the text animation. Possible are "down", "up", "left", "right", "horizontal", and "vertical".
  • animationCharacters (optional, default: '0123456789'): Characters that replace the rendered text in the animation.
  • animationCharacterSpacing (optional, default: 1): The spacing between animation characters.
  • animationDelay (optional, default: 500): The delay before the animation starts in ms.
  • animationInterval (optional, default: 1000): The interval (in milliseconds) between animations.
  • animationIteration (optional, default: 1): The number of times the animation should repeat.
  • animationLoop (optional, default: true): Whether the animation should loop indefinitely.
  • animationSpeed (optional, default: 20): The speed of the animation, affecting how quickly frames transition.
  • fadeInOnly (optional, default: false): Whether the animation should only fade in.
  • fadeOutOnly (optional, default: false): Whether the animation should only fade out.
  • font (optional, default: Slant): The font to be used for rendering the ASCII text.
  • isAnimated (optional, default: true): Whether the text should be animated.
  • isPaused (optional, default: false): Determines whether the animation is initially paused.
  • text (optional, default: ["React", "ASCII", "Text"]): The ASCII text to be animated. It can be a single string or an array of strings to transition animations between strings.

License

MIT