JSized Fireworks

Introduction

JSized Fireworks is a mesmerizing and impressive JavaScript-based solution that brings the thrill of fireworks displays to the world of front-end development. With JSized Fireworks, you can create interactive and responsive fireworks animations for your websites, apps, or digital projects, elevating their visual appeal and engaging audience. This comprehensive tutorial will guide you through the setup, customization, and usage of JSized Fireworks, enabling you to harness its capabilities to create breathtaking displays that capture attention.

Prerequisites

To follow this tutorial, you should have basic knowledge of HTML, CSS, and JavaScript. If you're new to front-end development, start with the basics and come back to this tutorial later. Additionally, make sure to have a code editor or IDE ready to use.

Setup and Configuration

Before you start working with JSized Fireworks, make sure to have the necessary dependencies installed.

1. Install the latest version of jsized-fireworks.js (available on npm) or download it from GitHub:

npm install jsized-fireworks

If you're using a CDN, include the script tag in your HTML file:

<script src="https://cdn.jsdelivr.net/npm/jsized-fireworks@1.5.1/dist/jsized-fireworks.js"></script>

1. Create an empty HTML file (e.g., index.html) and add a container element with an id (e.g., fireworks-container):

<div id="fireworks-container"></div>

Basic Usage

To initiate the fireworks display, include the JavaScript code in your HTML file or create a separate script tag:

import { firework, defaultConfig } from 'jsized-fireworks';

const fireworks = new firework(defaultConfig);

Customization Options

JSized Fireworks provides various options for customization:

1. Config options: Use the firework object to specify the config settings:

   • emitRate: Set the speed of sparks emission (0-10).
   • initialSize: Initialize the initial size of fireworks (10-500).
   • life: Set the lifetime of each firework in seconds (2-20).
   • emitDistance: Change the maximum distance for spark emission (100-500).
2. Layout and placement: Arrange and position your fireworks by customizing:
   • layout: Set a pre-defined layout (random, circle, line) or create your own layout functions.
   • offset: Modify the default spacing between fireworks.

Here's an example of setting emitRate to 5:

const customConfig = { emitRate: 5 };
const fireworks = new firework(customConfig);

Triggering the Display

You can trigger the fireworks display on page load, by scrolling, hovering, or pressing a specific button.

For a page load, remove the initial delay with:

window.onload = function() {
  fireworks.update();
  fireworks.draw();
};

For triggering on hover:

<!-- Set up your container div as a clickable area -->
<button id="fireworks-container" data-firework-display="on-hover">
    Hover Me!
</button>

<!-- Trigger on hover event listener -->
<script>
  document.getElementById("fireworks-container").addEventListener('mouseover', function() {
    fireworks.update();
    fireworks.draw();
  });
</script>

Full Code Example

// jsized-fireworks setup and config
import { firework, defaultConfig } from 'jsized-fireworks';
const fireworks = new firework(defaultConfig);

// Customization for emitRate
const customConfig = { emitRate: 5 };

// Update the config settings for fireworks display
fireworks.config = customConfig;

// Function to call once per frame to update fireworks movement
function updateFireworks() {
  fireworks.update();
}

// Initialize animations and begin the display on page load
window.onload = function() {
  updateFireworks();
};

By following these guidelines and tailoring your project's design, you're ready to unleash the majesty of JSized Fireworks to captivate and amaze your audience.

In the next section, you'll discover various creative scenarios and integration opportunities to unleash the true power of this mesmerizing plugin.

(To be continued in the next section of this tutorial series)