0.2.3 • Published 10 months ago

react-fidget-spinner v0.2.3

Weekly downloads
-
License
MIT
Repository
-
Last release
10 months ago

React Fidget Spinner

CI Storybook deploy Storybook npm version Turn any react component into a fun clickable fidget spinner.

a silly goose

not just this goose 🪿

Quickstart

npm i react-fidget-spinner
import {FidgetSpinner} from "react-fidget-spinner"


const MyFidgetSpinner = () => {
    return (
        <FidgetSpinner>
            <MyComponent>
        </FidgetSpinner>
    )
}

Where are the full docs?

Interactive examples and full documentation can be found on Storybook.

Features

  • 🎡 Physics-based flywheel spinner animation and interaction
  • ✨ Spark Particles
  • 🫧 Bubble Particles
  • 💥 Click Animation
  • 🦣 Scaling Animation
  • 🏎️ Velocity Breakpoints - Change your configuration based on the velocity of the spinner.
  • 🎨 Highly customisable animations with full defaults to get you started
  • 🔫 Callback triggers for all key events

Context

Adding fun easter eggs into projects is often overlooked - It's often hard to justify the time investment from a business (or even personal) perspective.

But Users often love, remember and share these little interactions. There's always a bit of joy in finding something hidden.

I thought it could be a nice to spend a bit of time over the holiday season building something light and interactive that other people could use to quickly sprinkle a bit of fun around their existing comopnents. So, here it is... A silly component that turns whatever you want into a clickable spinning interactive widget.

I also took this as a nice opportunity to publish my first public npm package and learn a bit more about storybook (which I really enjoyed, especially given how the entire value of the component comes from interacting with the spinner live)

Shoutouts

  • react-library-template - I used this as a starting point for this project. It was a really painless way of publishing an npm package that was backed by good docs with storybook. Thank you morewings
  • react-confetti - A package that made fun and excitement quick and easy to add into another project and inspired this one. Really fun.

Contibuting

I would love to hear any ideas or feedback from you. If you have made anything with this, let me know - it will make my day.

Feel free to open issues, send me a message or submit a PR and I will try and respond ❤️

Roadmap

Further work on this project could include things like:

  • Throttling of animations
  • Make it clearer that the component is interactive, maybe a shake?
  • Linear scaling of effects based on speeds instead of breakpoints
  • Validation of inputs properly
  • Scoring
  • Exposing things like current speed via refs
  • Explosions at max speed

Breaking Changes

I will try and avoid breaking changes but if there are early signs or feedback that the interfaces could be clearer then I will likely change them.

0.2.3

10 months ago

0.2.2

10 months ago

0.2.1

11 months ago

0.2.0

11 months ago

0.1.13

11 months ago

0.1.12

11 months ago

0.1.11

11 months ago

0.1.10

11 months ago

0.1.9

11 months ago

0.1.8

11 months ago

0.1.7

11 months ago

0.1.6

11 months ago

0.1.5

11 months ago

0.1.4

11 months ago

0.1.3

11 months ago

0.1.2

11 months ago