# konfeti

> Zero-dependency, strictly typed, highly customizable canvas confetti with emoji, text, image and spritesheet particles. Version 0.6.0, MIT license, runs in the browser (ES2022).

Install with `npm install konfeti`. The everyday API is the shared `Konfeti` object: `Konfeti.fire(options?)`
fires one burst (or a list of bursts) on a fullscreen canvas and returns a handle. `KonfetiFactory.create()`
makes a dedicated instance (own canvas, defaults, particle budget), `createWorker()` from `konfeti/worker`
renders off the main thread, and `konfeti/lite` is the smallest entry (paper only until shapes are registered
with `registerShapes`, no presets). Every option is optional and typed; the API reference gives each option's
unit, range and default.

## Docs

- [Guide](https://konfeti.mbattaloglu.com/docs/index.md): every feature with examples (API at a glance, Basics, The paper particle, Shapes, Physics, Emission, Continuous emitter, Formations, Presets, Hooks, Instances & canvases, Worker rendering, Playable ads & webviews, Custom shapes & physics, Bundle size & konfeti/lite, Units & ranges, AI assistants)
- [API reference: konfeti](https://konfeti.mbattaloglu.com/docs/api/konfeti.md): every export of `konfeti` with option units, ranges and defaults
- [API reference: konfeti/worker](https://konfeti.mbattaloglu.com/docs/api/konfeti/worker.md): every export of `konfeti/worker` with option units, ranges and defaults

## Tools

- [Playground](https://konfeti.mbattaloglu.com/): tune every option live, load a preset, copy the code or a share link
- [npm package](https://www.npmjs.com/package/konfeti)
- [Source code](https://github.com/mbattaloglu/konfeti)

## Optional

- [Full documentation in one file](https://konfeti.mbattaloglu.com/llms-full.txt): the guide and the API reference together
- [Agent skill](https://konfeti.mbattaloglu.com/skills/konfeti/SKILL.md): how to use konfeti, for coding agents (also shipped in the npm package as `node_modules/konfeti/skills/konfeti`)
- [Guide in Turkish](https://konfeti.mbattaloglu.com/docs/tr.md)
- [Changelog](https://github.com/mbattaloglu/konfeti/blob/main/packages/konfeti/CHANGELOG.md)