Konfetti

Depending on your project type, add the corresponding dependency to your build.gradle file.

For Jetpack Compose projects:

dependencies {
    implementation 'nl.dionsegijn:konfetti-compose:2.0.5'
}

For View-based (XML) projects:

dependencies {
    implementation 'nl.dionsegijn:konfetti-xml:2.0.5'
}

A Party object defines how confetti is generated and behaves. Most properties have default values, so you only need to provide an Emitter for a basic effect.

Minimal configuration:

Party(
    emitter = Emitter(duration = 5, TimeUnit.SECONDS).perSecond(30)
)

Customized configuration example:

Party(
    speed = 0f,
    maxSpeed = 30f,
    damping = 0.9f,
    spread = 360,
    colors = listOf(0xfce18a, 0xff726d, 0xf4306d, 0xb48def),
    position = Position.Relative(0.5, 0.3),
    emitter = Emitter(duration = 100, TimeUnit.MILLISECONDS).max(100)
)

To use Konfetti in a Compose UI, include the KonfettiView component and pass your Party state to it.

KonfettiView(
    modifier = Modifier.fillMaxSize(),
    parties = state.party,
)

For traditional Android View-based projects, add the KonfettiView to your XML layout and trigger it via code.

XML Layout:

<nl.dionsegijn.konfetti.xml.KonfettiView
    android:id:@+id/konfettiView
    android:layout_width="match_parent"
    android:layout_height="match_parent" />

Triggering the confetti in Kotlin:

val party = Party(
    speed = 0f,
    maxSpeed = 30f,
    damping = 0.9f,
    spread = 360,
    colors = listOf(0xfce18a, 0xff726d, 0xf4306d, 0xb48def),
    emitter = Emitter(duration = 100, TimeUnit.MILLISECONDS).max(100),
    position = Position.Relative(0.5, 0.3)
)
viewKonfetti.start(party)

<nl.dionsegijn.konfetti.xml.KonfettiView
    android:id="@+id/konfettiView"
    android:layout_width="match_parent"
    android:layout_height="match_parent" />

The PartySystem class is the core engine responsible for managing the lifecycle of a confetti party. It handles requesting particles from the emitter and updating their state every frame.

To use it, you must provide a Party configuration object and the pixelDensity of the display. You can enable or disable the system using the enabled property.

The PartyFactory provides several ways to set the position of the confetti:

• Absolute Position (Float): Use position(x: Float, y: Float) or position(minX: Float, minY: Float, maxX: Float, maxY: Float) to define a specific area using float coordinates.
• Relative Position (Double): Use position(x: Double, y: Double) or position(minX: Double, minY: Double, maxX: Double, maxY: Double) to define position relative to the view using double coordinates.
• Position Object: Pass a pre-constructed Position object using position(position: Position).

Use these methods to define what the confetti looks like:

• sizes(vararg sizes: Size) or sizes(size: List<Size>): Sets the particle sizes.
• colors(colors: List<Int>): Sets the particle colors using a list of integers.
• shapes(vararg shapes: Shape) or shapes(shapes: List<Shape>): Sets the particle shapes.
• rotation(rotation: Rotation): Sets the rotation configuration.

Once an Emitter is defined, you can use EmitterConfig methods to control how many particles are generated:

• max(amount: Int): Sets the total maximum number of particles to be created over the entire duration specified in the Emitter.
• perSecond(amount: Int): Sets a constant rate of particle creation per second.

Use the following methods on PartyFactory to control the movement and lifecycle of the confetti:

• angle(angle: Int): Sets the launch angle.
• spread(spread: Int): Sets the spread of the particles.
• setSpeed(speed: Float): Sets a constant speed.
• setSpeedBetween(minSpeed: Float, maxSpeed: Float): Sets a speed range.
• setDamping(damping: Float): Sets the damping (air resistance).
• timeToLive(timeToLive: Long): Sets how long each particle lasts.
• delay(delay: Int): Sets a delay before the party starts.
• fadeOutEnabled(fadeOutEnabled: Boolean): Enables or disables the fade-out effect.