Skip to content
This repository has been archived by the owner on Oct 17, 2021. It is now read-only.

NSHipster/ConfettiView

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

16 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

ConfettiView

Build Status License CocoaPods platforms CocoaPods compatible Swift Package Manager compatible

NSHipster ConfettiView

A view that emits confetti with shapes, images, and text of your choosing for a specified duration, and then fades out.

import ConfettiView

let confettiView = ConfettiView()
confettiView.emit(with: [
  .text("๐Ÿ‘จ๐Ÿป"),
  .text("๐Ÿ“ฑ"),
  .shape(.circle, .purple),
  .shape(.triangle, .lightGray),
  .image(star, .orange)
]) {
  // Optional completion handler fires when animation finishes.
}

For more information, see the accompanying blog post on NSHipster.


Example

To run the example project, clone the repo and run pod install from the Example directory.

Requirements

  • iOS 10.0+
  • Swift 5.1+

Installation

You can install ConfettiView via CocoaPods by adding the following line to your Podfile:

pod 'ConfettiView-NSHipster'

Run the pod install command to download the library and integrate it into your Xcode project.

Note The module name for this library is "ConfettiView" --- that is, to use it, you add import ConfettiView to the top of your Swift code just as you would by any other installation method. The pod is called "ConfettiView-NSHipster" because there's an existing pod with the name "ConfettiView".

Author

Mattt (@mattt)

License

ConfettiView is available under the MIT license. See the LICENSE file for more information.