Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@types/react-native-confetti

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@types/react-native-confetti

TypeScript definitions for react-native-confetti

  • 0.1.1
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

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

// Type definitions for react-native-confetti 0.1
// Project: https://github.com/cdvntr/react-native-confetti
// Definitions by: Maurice el-Banna <https://github.com/MauriceNino>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

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: Wed, 27 Sep 2023 07:12:04 GMT
  • Dependencies: @types/react
  • Global values: none

Credits

These definitions were written by Maurice el-Banna.

FAQs

Package last updated on 27 Sep 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc