README.md

Twinkle ✨

Twinkle is a Swift and easy way to make any UIView in your iOS or tvOS app twinkle.

This library creates several CAEmitterLayers and animates them generating a sparkle effect.

A version of Twinkle is also available for Android.

If you like Twinkle, you may also like Burst.

Need a different version of Swift?

• 5.0 - Target your Podfile to the latest release or master
• 4.2 - Target your Podfile to the swift4.2 branch

Quick Start

Twinkle is available and recommended for installation using the Cocoa dependency manager CocoaPods. You can also simply copy the Twinkle.swift file into your Xcode project.

# CocoaPods
pod "Twinkle", "~> 0.5.0"

# Carthage
github "piemonte/Twinkle" ~> 0.5.0

# SwiftPM
let package = Package(
    dependencies: [
        .Package(url: "https://github.com/piemonte/Twinkle", majorVersion: 0)
    ]
)

Usage

The sample project provides an example of how to integrate Twinkle, otherwise you can follow this example.

   import Twinkle

   // using the UIView extension
   let view: UIView = UIView(frame: CGRect(x: 0, y: 0, width: 150, height: 50))
   self.view.addSubview(view)
   view.twinkle()

   // using the class func
   Twinkle.twinkle(myView)

Community

• Found a bug? Open an issue.
• Feature idea? Open an issue.
• Want to contribute? Submit a pull request.

Resources

• Core Animation Reference Collection
• Swift Evolution
• CAEmitterLayer – NSHipster
• Twinkle for Android
• Burst
• Shimmer
• Blurry

License

Twinkle is available under the MIT license, see the LICENSE file for more information.