# react-floating-balloons

> Floating colorful balloons with custom names and popping feature

Latest version **3.0.2** (published 2025-03-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-floating-balloons
pnpm add react-floating-balloons
yarn add react-floating-balloons
bun add react-floating-balloons
```

## Health

**Score 25/100 (F)** — status: maintenance-mode.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.2 |
| Published | 2025-03-28 |
| First published | 2021-07-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 24.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | SNS |
| Maintainers | sanishkr |
| Keywords | react, balloons, floating, birthday, animation, colorful, pop, burst |

## Links

- npm: https://www.npmjs.com/package/react-floating-balloons
- Repository: https://github.com/sanishkr/react-floating-balloons
- Homepage: https://codesandbox.io/s/react-floating-balloons-basic-example-4cx9kh
- Issues: https://github.com/sanishkr/react-floating-balloons/issues
- npm.io page: https://npm.io/package/react-floating-balloons

## Dependencies (2)

- [@mojs/core](https://npm.io/package/@mojs/core.md) ^1.3.0
- [styled-components](https://npm.io/package/styled-components.md) ^5.3.3

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 3.0.2 (latest) — 2025-03-28
- 3.0.1 — 2022-03-10
- 3.0.0 — 2022-03-06
- 2.1.1 — 2022-02-28
- 2.1.0 — 2022-02-28
- 2.0.1 — 2022-02-28
- 2.0.0 — 2022-02-27
- 1.0.2 — 2021-07-20
- 1.0.1 — 2021-07-20
- 1.0.0 — 2021-07-19

## README

# React Floating Balloons 🎈💥

**Version Updates**

- [3.0.2] : Update balloon pop audio cdn
- [3.0.1] : Added optional `hangOnTop` feature, Added NextJS Example
- [3.0.0] : Removed native elements, used `styled-components`. Added optional `loop` prop
- [2.1.1] : Add optional custom props `count, msgText, colors, popVolumeLevel`
- [2.0.2] : Add 2 new colors `orange, purple`
- [2.0.1] : Pop event on single click for touch screen devices
- [2.0.0] : Added Pop animation and Sound

##

## Feature Bonus

- Double-Click event pops the Balloons
- Single Click pops on touch enabled devices
- All Balloons pops with same colored burst animation

## Motivation

Twitter and
[this post](https://erdoganbavas.medium.com/creating-birthday-balloons-like-twitter-profile-no-image-5348a1dc2720)

## Installation

**npm**

```bash
npm install --save react-floating-balloons
```

### Basic Example

[![Edit react-floating-balloons-basic-example](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/react-floating-balloons-basic-example-4cx9kh?fontsize=14&hidenavigation=1&theme=dark)

### NextJS Example(^v3.0.0)

[![Edit nextjs-react-floating-balloons-example](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/nextjs-react-floating-balloons-example-di5dhp?fontsize=14&hidenavigation=1&theme=dark&view=preview)

### Props

| Name           | Type            | Required | Options                                                | Default                                                  | Description                                               |
| -------------- | --------------- | -------- | ------------------------------------------------------ | -------------------------------------------------------- | --------------------------------------------------------- |
| count          | `number`        | `false`  |                                                        | `7`                                                      | Number of balloons on the screen                          |
| msgText        | `string`        | `false`  |                                                        | `Happy Birthday.`                                        | Msg written on random balloons(Keep it short)             |
| colors         | `Array<String>` | `false`  | `'yellow', 'green', 'blue', 'red', 'orange', 'purple'` | `['yellow', 'green', 'blue', 'red', 'orange', 'purple']` | list for balloons to choose random colors from            |
| popVolumeLevel | `Float`         | `false`  | `0 to 1`                                               | `0.5`                                                    | Volume level for Balloon pop sound                        |
| loop           | `Boolean`       | `false`  | `true\|false`                                          | `true`                                                   | Loop Balloon animation until popped                       |
| hangOnTop      | `Boolean`       | `false`  | `true\|false`                                          | `false`                                                  | Hangs Balloons on top until popped(set `loop` to `false`) |

##

### [Todo]

- [ ] Props validation
- [x] Remove CSS import
- [ ] Fix SSR issues
- [ ] Allow Custom colors
- [ ] Allow custom size
- [ ] Allow style customisation for `msgText`
- [ ] Better burst animation
- [ ] Test cases
- [ ] Balloons string curved
- [ ] Add more examples

##

Note for NextJS Usage: Use `next-global-css` npm module setup for (v2 and below) and use dynamic import feature with `{ ssr: false }` to avoid errors

## Maintenance Status

<img src="https://img.shields.io/badge/maintenance-stable-blue.svg" />

## License

Licensed under the MIT License, Copyright © 2021-present.

See [LICENSE](./LICENSE) for more information.

---
_Source: https://npm.io/package/react-floating-balloons · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._