Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/NSHipster/ConfettiView
A view that emits confetti 🎉
https://github.com/NSHipster/ConfettiView
Last synced: about 2 months ago
JSON representation
A view that emits confetti 🎉
- Host: GitHub
- URL: https://github.com/NSHipster/ConfettiView
- Owner: NSHipster
- License: mit
- Archived: true
- Created: 2019-08-24T23:25:56.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-04-17T16:57:02.000Z (over 3 years ago)
- Last Synced: 2024-07-03T11:36:35.538Z (3 months ago)
- Language: Swift
- Homepage: https://nshipster.com/caemitterlayer/
- Size: 47.9 KB
- Stars: 545
- Watchers: 6
- Forks: 28
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ConfettiView
[![Build Status][build status badge]][build status]
[![License][license badge]][license]
![CocoaPods platforms][cocoapods platforms badge]
[![CocoaPods compatible][cocoapods badge]][cocoapods]
[![Swift Package Manager compatible][swift package manager badge]][swift package manager]
A view that emits confetti with shapes, images, and text of your choosing
for a specified duration,
and then fades out.
```swift
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](https://nshipster.com/caemitterlayer/).
## 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](https://cocoapods.org)
by adding the following line to your `Podfile`:
```ruby
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](https://twitter.com/mattt))
## License
ConfettiView is available under the MIT license.
See the LICENSE file for more information.
[build status]: https://github.com/NSHipster/ConfettiView/actions?query=workflow%3ACI
[build status badge]: https://github.com/NSHipster/ConfettiView/workflows/CI/badge.svg
[license]: https://opensource.org/licenses/MIT
[license badge]: https://img.shields.io/cocoapods/l/ConfettiView-NSHipster.svg
[cocoapods platforms badge]: https://img.shields.io/cocoapods/p/ConfettiView-NSHipster.svg
[cocoapods]: https://cocoapods.org/pods/ConfettiView-NSHipster
[cocoapods badge]: https://img.shields.io/cocoapods/v/ConfettiView-NSHipster.svg
[swift package manager badge]: https://img.shields.io/badge/spm-compatible-brightgreen.svg?style=flat
[swift package manager]: https://swift.org/package-manager