Skip to content

An animated trophy banner that looks like Xbox achievement ๐Ÿ†

License

Notifications You must be signed in to change notification settings

xnth97/TrophyKit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

8 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

TrophyKit

An animated trophy banner that looks like Xbox achievement.

Version License Platform

Demo

demo.mov

Usage

Requirements

  • iOS 14.0+
  • tvOS 14.0+
  • Swift 5.3+

Installation

TrophyKit is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'TrophyKit'

Example

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

API

/// Create a trophy instance with a configuration. It is efficient to retain a trophy instance
/// and call `show` with different parameters.
let trophy = Trophy(configuration: TrophyConfiguration(size: .medium))
/// Show the trophy in view controller.
trophy.show(from: self,
            title: "Achievement Unlocked",
            subtitle: "You have added a new skill!",
            iconSymbol: "gamecontroller.fill",
            trophyIconSymbol: "rosette")

TODO

  • Performance optimization and support reuse
  • tvOS support
  • More customization APIs
  • Tweak animation and visual
  • Sound and haptic support
  • Swift Package Manager
  • Queue for multiple trophies
  • Position for display trophy banner
  • Manually hide banner
  • Support anchor view like toolbar or tab bar
  • Interactions like tap target and completion block

License

TrophyKit is available under the MIT license. See the LICENSE file for more info.