Exciting release!Introducing "safe npm". Learn more →
Socket
Log inDemoInstall

windups

Package Overview
Dependencies
1
Maintainers
1
Versions
24
Issues
File Explorer

Advanced tools

windups

A unique typewriter effect library for React.

    1.2.1latest
    GitHub

Version published
Maintainers
1
Weekly downloads
679
increased by26.44%

Weekly downloads

Changelog

Source

v1.2.1

  • Fixes an issue where using resume would cause the windup to add the next character 50 years in the future. Thank you anulman!

Readme

Source

windups

🐸 Examples, guides, API docs, and more! Much of it presented by a talking frog!


A unique typewriter (or, ahem, "windup") effect library for React.

This effect can be applied to strings or pretty anything you can put in React's children prop.

What's it look like?

For strings:

import { useWindup } from "windups"; function MyWindup() { const [text] = useWindup( "This string will be rendered character by character!" ); return <div>{text}</div>; }

For pretty much everything else:

import { WindupChildren } from "windups"; function MyWindup() { return ( <WindupChildren> {"It's fun to do"} <em>{"wild"}</em> {"stuff with text!"} </WindupChildren> ); }

There are additional APIs for:

  • Controlling the pacing of the text!
  • Adding pauses!
  • Firing effects (e.g. when each character is typed, or at arbitrary points)!
  • Ahead of render-time line-breaking!

Want to see a codebase that makes extensive, real-word use of this package? Source for the docs site is at https://github.com/sgwilym/windups-docs

Keywords

FAQs

Last updated on 20 Apr 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket
support@socket.devSocket SOC 2 Logo

Product

  • Package Issues
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc