# @types/react-native-confetti

> TypeScript definitions for react-native-confetti

Latest version **0.1.4** (published 2023-12-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/react-native-confetti
pnpm add @types/react-native-confetti
yarn add @types/react-native-confetti
bun add @types/react-native-confetti
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2023-12-21 |
| First published | 2021-10-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51451 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/react-native-confetti
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-native-confetti
- npm.io page: https://npm.io/package/@types/react-native-confetti

## Dependencies (1)

- [@types/react](https://npm.io/package/@types/react.md) *

## Recent versions

- 0.1.4 (latest) — 2023-12-21
- 0.1.3 (ts4.5) — 2023-11-07
- 0.1.0 (ts3.7) — 2021-10-28
- 0.1.2 — 2023-10-18
- 0.1.1 — 2023-09-27

## README

# Installation
> `npm install --save @types/react-native-confetti`

# Summary
This package contains type definitions for react-native-confetti (https://github.com/cdvntr/react-native-confetti).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-native-confetti.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-native-confetti/index.d.ts)
````ts
import { Component } from "react";

export interface ConfettiProps {
    /**
     * The number of confetti to render.
     * @default 100
     */
    confettiCount?: number;
    /**
     * The duration of the animation in milliseconds.
     * @default 30
     */
    timeout?: number;
    /**
     * Render confetti continuously until stopConfetti() is called.
     *
     * This ignores confettiCount.
     *
     * @default false
     */
    untilStopped?: boolean;
    /**
     * The duration until a confetti reaches bottom.
     */
    duration?: number;
    /**
     * Array of color strings to choose from.
     * @default ["rgb(242.2, 102, 68.8)","rgb(255, 198.9, 91.8)","rgb(122.4, 198.9, 163.2)","rgb(76.5, 193.8, 216.7)","rgb(147.9, 99.4, 140.2)"]
     */
    colors?: string[];
    /**
     * Multiplier for size of confetti (width and heigh).
     * @default 1
     */
    size?: number;
    /**
     * Multiplier for radius of confetti (border radius).
     * @default 1
     */
    bsize?: number;
}

export default class Confetti extends Component<ConfettiProps> {
    /**
     * Start the confetti animation.
     *
     * The optional callback will be called when the entire animation is complete.
     */
    startConfetti(callback?: () => void): void;
    /**
     * Stop the confetti animation.
     */
    stopConfetti(): void;
    /**
     * Remove confetti by its key.
     *
     * This function is used internally.
     */
    removeConfetti(key: number): void;
}

````

### Additional Details
 * Last updated: Thu, 21 Dec 2023 19:06:51 GMT
 * Dependencies: [@types/react](https://npmjs.com/package/@types/react)

# Credits
These definitions were written by [Maurice el-Banna](https://github.com/MauriceNino).

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