wtc-barfystars v1.3.2

wtc-barfystars

Turn any element into a particle system fountain.
Demo

Usage

HTML

<button id="unicorns" data-config='{ "numUniqueParticles": 3 }'>
  Hover me 🦄
</button>

CSS

Add the default css:

<link
  href="https://cdn.skypack.dev/wtc-barfystars/dist/wtc-barfystars.css"
  rel="stylesheet"
/>

Javascript

import BarfyStars from "https://cdn.skypack.dev/wtc-barfystars";

const barfUnicorns = new BarfyStars(document.getElementById("unicorns"));

// you can also trigger it manually
barfUnicorns.barf();

Customize it as you want:

#unicorns {
  .barfystars-particle::after {
    content: "🦄";
    font-size: 30px;
  }
  .barfystars-particle--2::after {
    content: "⭐️";
    font-size: 20px;
  }
  .barfystars-particle--3::after {
    content: "☄️";
    font-size: 25px;
  }
}

Options

Properties can be provided to the controller through the data-config attribute. This attribute must be JSON formatted and properies can be as follows:

action | String || Boolean | default: 'hover'
The action that triggers the barfy stars.
Can be one of:

• hover Triggers the action on hover (default)
• click Triggers the action on click
• callback Triggers the action on callback
• false Events are turned off

You can find examples of all action options on the demo.

momentum | Float | default: null
The initial momentum for the particles.

gravity | Float | default: null
The gravity to apply to the particles.

friction | Float | default: null
The friction to apply to the particles' momentum.

numParticles | Integer | default: 20
The number of particles to spawn.

numUniqueParticles | Integer | default: 5

scaleInitial | Float | default: null
The initial scale of the particles

scaleFactor | Float | default: null
A multiplier used to reduce the scale of the particles over time.

removeAt | Float | default: null
The point, in scale, at which the particles need to be removed.

additionalClasses | String | default: ''
Additional classes to be provided to the containing element.

respondToResize | Boolean | default: true
Whether the element should respond to resize events. This should happen when the positioning of the anchor also changes in response to resize

eventName | String | default: 'barf_stars'
This indicates the event to custom listen to on the window that causes the stars to barf if the controller is set to action:callback