Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AlirezaHadjar authored Nov 3, 2024
1 parent d0419c7 commit 58255b7
Showing 1 changed file with 51 additions and 2 deletions.
53 changes: 51 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,16 @@ yarn add react-native-fast-confetti
```

## Usage
### `<Confetti />`
This animation creates a basic confetti effect where pieces fall from the top in a straight line.

https://github.com/user-attachments/assets/d89ef248-6b27-435e-a322-fb62a3550343

You can also use the `cannonPositions` option to simulate confetti being launched from cannons before falling. in the screen recording, there's only one cannon. You can also pass multiple cannon positions to shoot confetti from multiple cannons


https://github.com/user-attachments/assets/f59b930d-7c22-4901-9c3e-995cc66b6ae9


```tsx
import { Confetti } from 'react-native-fast-confetti';
Expand All @@ -28,16 +38,37 @@ return (
</View>
)
```
### `<PIConfetti />`
This confetti type creates an effect where flakes burst outward from the center, and then drift down gracefully.

https://github.com/user-attachments/assets/30008c3b-0f1a-4dff-afdb-2ded80809291


```tsx
import { PIConfetti } from 'react-native-fast-confetti';

// ...

return (
<View>
{...Your other components}
<PIConfetti />
{...Your other components}
</View>
)
```

## Props
## `<Confetti />` Props

| Name | Required | Default Value | Description |
| ------------------ | -------- | ------------------------ | ------------------------------------------------------------------------------------------------- |
| `count` | No | 200 | Number of confetti pieces to render. |
| `flakeSize` | No | { width: 8, height: 16 } | The size of each confetti flake (object with `width` and `height`). |
| `width` | No | SCREEN_WIDTH | The width of the confetti's container. |
| `height` | No | SCREEN_HEIGHT | The height of the confetti's container. |
| `duration` | No | 8000 ms | The duration of the confetti animation in milliseconds. |
| `fallDuration` | No | 8000 ms | The duration of confetti falling down (milliseconds). |
| `blastDuration` | No | 300 ms | The duration of confetti blast (milliseconds). Use with `cannonsPositions` |
| `cannonsPositions` | No | N/A | An array of positions from which confetti flakes should blast. |
| `autoplay` | No | true | Whether the animation should play on mount. |
| `isInfinite` | No | follows `autoplay` | Wether the animation should play again after it ends. |
| `colors` | No | N/A | The array of confetti flakes colors. |
Expand All @@ -47,6 +78,24 @@ return (
| `onAnimationStart` | No | N/A | Callback function triggered when the falling animation starts. |
| `onAnimationEnd` | No | N/A | Callback function triggered when the falling animation ends. |

## `<PIConfetti />` Props

| Name | Required | Default Value | Description |
| ------------------ | -------- | ------------------------ | ------------------------------------------------------------------------------------------------- |
| `count` | No | 200 | Number of confetti pieces to render. |
| `flakeSize` | No | { width: 8, height: 16 } | The size of each confetti flake (object with `width` and `height`). |
| `width` | No | SCREEN_WIDTH | The width of the confetti's container. |
| `height` | No | SCREEN_HEIGHT | The height of the confetti's container. |
| `blastDuration` | No | 300 ms | The duration of confetti blast (milliseconds). |
| `fallDuration` | No | 8000 ms | The duration of the confetti animation in milliseconds. |
| `blastPosition` | No | `{ x: containerWidth / 2, y: 150 }` | The position from which confetti flakes should blast. |
| `blastRadius` | No | 180 | The radius of the blast. |
| `colors` | No | N/A | The array of confetti flakes colors. |
| `fadeOutOnEnd` | No | N/A | Should the confetti flakes fade out as they reach the bottom. |
| `onAnimationStart` | No | N/A | Callback function triggered when the falling animation starts. |
| `onAnimationEnd` | No | N/A | Callback function triggered when the falling animation ends. |


## Methods

| Name | Description |
Expand Down

0 comments on commit 58255b7

Please sign in to comment.