How do I change the color of the sparkles in Twinkle?

Twinkle doesn't directly support color changes via configuration; instead, you need to provide custom particle images with the desired colors using the `image` parameter. For example, create a UIImage with your star shape and tint it, then pass it to `view.twinkle(image: customImage)`.

Is Twinkle better than Lottie for simple animations?

Twinkle is ideal for quick, code-based sparkle effects with minimal setup, while Lottie is better for complex, vector-based animations from After Effects. Use Twinkle for lightweight, customizable particle effects; choose Lottie for rich, pre-designed animations requiring more flexibility.

How to stop the twinkle animation after it starts?

The README doesn't specify a built-in method to stop animations, but since it uses CAEmitterLayers, you might need to manually remove the emitter layers or set their birthRate to zero. Check the source code or sample project for implementation details.

Can I use Twinkle in a tvOS app?

Yes, Twinkle supports tvOS 15.0+ as indicated in the platform requirements, so you can apply sparkle effects to UIViews in tvOS applications similarly to iOS, using the same API methods.

What are the differences between the iOS and Android versions of Twinkle?

The iOS version is written in Swift and uses CAEmitterLayers, while the Android version is a separate library in another repository, likely using Android's particle system. They offer similar functionality but require platform-specific integration and may have slight API variations.

Does Twinkle work with Swift Package Manager?

Yes, Twinkle is compatible with Swift Package Manager, as shown in the installation instructions with `.package(url: "https://github.com/piemonte/Twinkle", from: "0.7.0")`, making it easy to add to modern Xcode projects.

Open-Awesome

Twinkle

MITSwift

A Swift library that adds sparkling particle effects to any UIView in iOS and tvOS apps.

GitHub

616 stars69 forks0 contributors

What is Twinkle?

Twinkle is a Swift library that adds sparkling particle animations to UIViews in iOS and tvOS applications. It uses CAEmitterLayers to generate customizable sparkle effects, solving the need for engaging visual feedback without complex animation code. Developers can apply these effects with minimal configuration to enhance user interfaces.

Target Audience

iOS and tvOS developers looking to add subtle, visually appealing particle effects to their apps without implementing complex Core Animation logic.

Value Proposition

Twinkle offers a dead-simple API for creating polished sparkle animations, reducing the boilerplate code typically required for CAEmitterLayer configurations. Its lightweight design and customization options make it a preferred choice over manual animation implementations.

Overview

:sparkles: Twinkle interface elements in Swift

Use Cases

Best For

Adding celebratory effects after user actions (e.g., completing a task)
Enhancing button or view interactions with visual feedback
Creating festive or decorative UI elements in holiday-themed apps
Drawing attention to important on-screen elements subtly
Implementing particle effects in iOS games or interactive experiences
Adding polish to onboarding or tutorial screens with animated highlights

Not Ideal For

Apps with strict performance budgets where GPU-intensive CAEmitterLayers could cause frame drops
Projects built entirely in SwiftUI that prefer native declarative animation tools over UIKit extensions
Teams needing a comprehensive animation library with varied effects beyond particle-based sparkles

Pros & Cons

Pros

Simple Integration

Offers a UIView extension with a single method call like `view.twinkle()` for quick addition of sparkle effects, as shown in the basic usage example.

Highly Customizable

Allows fine-tuning of particle parameters such as count, birth rate, and scale through the `Twinkle.Configuration` struct, enabling precise visual control.

Custom Image Support

Supports using custom images for particles, such as stars, via the `image` parameter in the `twinkle` method, for personalized animations without relying on default sparkles.

Cross-Platform Availability

Includes a companion library for Android, facilitating consistent sparkle effects across iOS and Android platforms, though as separate implementations.

Cons

Performance Overhead

Relies on CAEmitterLayers which are GPU-intensive and can impact app performance, especially on older devices or when animating multiple views simultaneously.

Limited Scope

Focused solely on sparkle particle animations, lacking support for other common UI animations like transitions or gestures, which may require integrating additional libraries.

UIKit-Centric Design

Built for UIKit and UIView, not natively compatible with SwiftUI, requiring extra effort such as wrappers for integration in modern SwiftUI-based projects.

Frequently Asked Questions

Related Projects

Lottie

An iOS library to natively render After Effects vector animations

Stars26,865

Forks3,833

Last commit5 days ago

SkeletonView

☠️ An elegant way to show users that something is happening and also prepare them to which contents they are awaiting

Stars12,892

Forks1,123

Last commit2 months ago

Material

A UI/UX framework for creating beautiful applications.

Stars12,008

Forks1,259

Last commit4 years ago

NVActivityIndicatorView

A collection of awesome loading animations

Stars10,707

Forks1,156

Last commit5 months ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub