Fireworks Js

Theme by Crashmax dev

|

Updated: 16 Jul 2024

|

1270 Stars

A simple fireworks library! Ready to use components available for React, Vue 3, Svelte, Angular, Preact, Solid, and Web Components.

Categories

Overview:

The readme document is introducing the upcoming version 2 of the product, “fireworks-js”. It provides information about the features, installation process, and options available for customization. The product is a lightweight JavaScript library for creating fireworks effects on web pages. It supports various frameworks such as React, Angular, Preact, Vue, Solid, and Svelte.

Features:

• Zero dependencies: The library does not rely on any external dependencies, making it lightweight and easy to use.
• Flexible configuration: Users can customize various properties such as hue, rocketsPoint, mouse, boundaries, sound, delay, brightness, decay, lineWidth, lineStyle, explosion, opacity, acceleration, and friction.
• Lightweight: The library is small in size, approximately 3.0kB gzipped, making it efficient for performance.
• Supports TypeScript type definition: The library provides TypeScript type definitions for improved developer experience.

Installation:

To use the “fireworks-js” library, follow the installation instructions based on the desired package or framework:

• For Vanilla JS: Install the “fireworks-js” package.
• For React: Install the “@fireworks-js/react” package.
• For Preact: Install the “@fireworks-js/preact” package.
• For Solid: Install the “@fireworks-js/solid” package.
• For Vue 3: Install the “@fireworks-js/vue” package.
• For Svelte: Install the “@fireworks-js/svelte” package.
• For Angular: Install the “@fireworks-js/angular” package.
• For Web components: Install the “@fireworks-js/web” package.

Summary:

The “fireworks-js” library is a lightweight JavaScript library that allows users to create fireworks effects on web pages. It provides various features such as flexible configuration, zero dependencies, and TypeScript support. The library can be easily installed depending on the desired framework or package. With its small size and customizable options, “fireworks-js” offers an efficient way to add visually appealing fireworks effects to web projects.