@basmilius/sparkle 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020-2024 Bas Milius
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,49 @@
+<a href="https://bas.dev" target="_blank" rel="noopener">
+	<img src="https://bmcdn.nl/assets/branding/logo.svg" alt="Bas Milius Logo" height="60" width="60" />
+</a>
+
+---
+
+# Sparkle
+
+Canvas-based visual effects library for the web. Includes fireworks, confetti and snow simulations.
+
+### Install
+
+```bash
+bun add @basmilius/sparkle
+```
+```bash
+npm install @basmilius/sparkle
+```
+```bash
+pnpm add @basmilius/sparkle
+```
+
+### Quick Start
+
+```typescript
+import { FireworkSimulation, ConfettiSimulation, SnowSimulation } from '@basmilius/sparkle';
+
+const canvas = document.getElementById('canvas') as HTMLCanvasElement;
+
+// Fireworks
+const fireworks = new FireworkSimulation(canvas);
+fireworks.start();
+
+// Confetti
+const confetti = new ConfettiSimulation(canvas);
+confetti.fire({ angle: 90, spread: 60, particles: 150, startVelocity: 45, x: 0.5, y: 0.5 });
+
+// Snow
+const snow = new SnowSimulation(canvas);
+snow.start();
+```
+
+### Documentation
+
+Visit the [documentation site](https://sparkle.graphics) for guides, examples and the full API reference.
+
+### License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,98 @@
+//#region src/canvas.d.ts
+declare class LimitedFrameRateCanvas {
+  #private;
+  get canvas(): HTMLCanvasElement;
+  get context(): CanvasRenderingContext2D;
+  get delta(): number;
+  get deltaFactor(): number;
+  get frameRate(): number;
+  get isSmall(): boolean;
+  get isTicking(): boolean;
+  get ticks(): number;
+  get height(): number;
+  get width(): number;
+  constructor(canvas: HTMLCanvasElement, frameRate: number, options?: CanvasRenderingContext2DSettings);
+  loop(): void;
+  start(): void;
+  stop(): void;
+  draw(): void;
+  tick(): void;
+  destroy(): void;
+  onResize(): void;
+  onVisibilityChange(): void;
+}
+//#endregion
+//#region src/confetti/types.d.ts
+type Config = {
+  readonly angle: number;
+  readonly colors: string[];
+  readonly decay: number;
+  readonly gravity: number;
+  readonly particles: number;
+  readonly shapes: Shape[];
+  readonly spread: number;
+  readonly ticks: number;
+  readonly startVelocity: number;
+  readonly x: number;
+  readonly y: number;
+};
+type Shape = "circle" | "diamond" | "ribbon" | "square" | "star" | "triangle";
+//#endregion
+//#region src/confetti/simulation.d.ts
+interface ConfettiSimulationConfig {
+  readonly scale?: number;
+  readonly canvasOptions?: CanvasRenderingContext2DSettings;
+}
+declare class ConfettiSimulation extends LimitedFrameRateCanvas {
+  #private;
+  constructor(canvas: HTMLCanvasElement, config?: ConfettiSimulationConfig);
+  fire(config: Partial<Config>): void;
+  draw(): void;
+  tick(): void;
+  onResize(): void;
+}
+//#endregion
+//#region src/point.d.ts
+type Point = {
+  x: number;
+  y: number;
+};
+//#endregion
+//#region src/fireworks/types.d.ts
+type ExplosionType = "peony" | "chrysanthemum" | "willow" | "ring" | "palm" | "crackle" | "crossette" | "dahlia" | "brocade" | "horsetail" | "strobe" | "heart" | "spiral" | "flower";
+type FireworkVariant = ExplosionType | "saturn" | "concentric";
+type ParticleShape = "line" | "circle" | "star" | "diamond";
+interface FireworkSimulationConfig {
+  readonly scale?: number;
+  readonly autoSpawn?: boolean;
+  readonly canvasOptions?: CanvasRenderingContext2DSettings;
+}
+declare const FIREWORK_VARIANTS: FireworkVariant[];
+//#endregion
+//#region src/fireworks/simulation.d.ts
+declare class FireworkSimulation extends LimitedFrameRateCanvas {
+  #private;
+  constructor(canvas: HTMLCanvasElement, config?: FireworkSimulationConfig);
+  draw(): void;
+  fireExplosion(variant: FireworkVariant, position?: Point): void;
+  tick(): void;
+}
+//#endregion
+//#region src/snow/simulation.d.ts
+interface SnowSimulationConfig {
+  readonly fillStyle?: string;
+  readonly particles?: number;
+  readonly scale?: number;
+  readonly size?: number;
+  readonly speed?: number;
+  readonly canvasOptions?: CanvasRenderingContext2DSettings;
+}
+declare class SnowSimulation extends LimitedFrameRateCanvas {
+  #private;
+  constructor(canvas: HTMLCanvasElement, config?: SnowSimulationConfig);
+  draw(): void;
+  tick(): void;
+}
+//#endregion
+export { ConfettiSimulation, ConfettiSimulationConfig, ExplosionType, FIREWORK_VARIANTS, FireworkSimulation, FireworkSimulationConfig, FireworkVariant, LimitedFrameRateCanvas, ParticleShape, SnowSimulation, SnowSimulationConfig };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/canvas.ts","../src/confetti/types.ts","../src/confetti/simulation.ts","../src/point.ts","../src/fireworks/types.ts","../src/fireworks/simulation.ts","../src/snow/simulation.ts"],"mappings":";cAAa,sBAAA;EAAA;MAeL,MAAA,CAAA,GAAU,iBAAA;EAAA,IAIV,OAAA,CAAA,GAAW,wBAAA;EAAA,IAIX,KAAA,CAAA;EAAA,IAIA,WAAA,CAAA;EAAA,IAIA,SAAA,CAAA;EAAA,IAIA,OAAA,CAAA;EAAA,IAIA,SAAA,CAAA;EAAA,IAIA,KAAA,CAAA;EAAA,IAIA,MAAA,CAAA;EAAA,IAIA,KAAA,CAAA;EAIJ,WAAA,CAAY,MAAA,EAAQ,iBAAA,EAAmB,SAAA,UAAmB,OAAA,GAAS,gCAAA;EAanE,IAAA,CAAA;EAuBA,KAAA,CAAA;EAOA,IAAA,CAAA;EAKA,IAAA,CAAA;EAIA,IAAA,CAAA;EAIA,OAAA,CAAA;EAMA,QAAA,CAAA;EAMA,kBAAA,CAAA;AAAA;;;KC3HQ,MAAA;EAAA,SACC,KAAA;EAAA,SACA,MAAA;EAAA,SACA,KAAA;EAAA,SACA,OAAA;EAAA,SACA,SAAA;EAAA,SACA,MAAA,EAAQ,KAAA;EAAA,SACR,MAAA;EAAA,SACA,KAAA;EAAA,SACA,aAAA;EAAA,SACA,CAAA;EAAA,SACA,CAAA;AAAA;AAAA,KAyCD,KAAA;;;UCKK,wBAAA;EAAA,SACJ,KAAA;EAAA,SACA,aAAA,GAAgB,gCAAA;AAAA;AAAA,cAGhB,kBAAA,SAA2B,sBAAA;EAAA;EAKpC,WAAA,CAAY,MAAA,EAAQ,iBAAA,EAAmB,MAAA,GAAQ,wBAAA;EAY/C,IAAA,CAAK,MAAA,EAAQ,OAAA,CAAQ,MAAA;EA+BrB,IAAA,CAAA;EA6BA,IAAA,CAAA;EA2BA,QAAA,CAAA;AAAA;;;KCtKQ,KAAA;EACR,CAAA;EACA,CAAA;AAAA;;;KCFQ,aAAA;AAAA,KAEA,eAAA,GAAkB,aAAA;AAAA,KAElB,aAAA;AAAA,UAmBK,wBAAA;EAAA,SACJ,KAAA;EAAA,SACA,SAAA;EAAA,SACA,aAAA,GAAgB,gCAAA;AAAA;AAAA,cAGhB,iBAAA,EAAmB,eAAA;;;cCrBnB,kBAAA,SAA2B,sBAAA;EAAA;EAWpC,WAAA,CAAY,MAAA,EAAQ,iBAAA,EAAmB,MAAA,GAAQ,wBAAA;EAgB/C,IAAA,CAAA;EAsBA,aAAA,CAAc,OAAA,EAAS,eAAA,EAAiB,QAAA,GAAW,KAAA;EAMnD,IAAA,CAAA;AAAA;;;UC3Da,oBAAA;EAAA,SACJ,SAAA;EAAA,SACA,SAAA;EAAA,SACA,KAAA;EAAA,SACA,IAAA;EAAA,SACA,KAAA;EAAA,SACA,aAAA,GAAgB,gCAAA;AAAA;AAAA,cAOhB,cAAA,SAAuB,sBAAA;EAAA;EAWhC,WAAA,CAAY,MAAA,EAAQ,iBAAA,EAAmB,MAAA,GAAQ,oBAAA;EA4B/C,IAAA,CAAA;EA6CA,IAAA,CAAA;AAAA"}