Skip to content

Repository files navigation

CI StatusVersionLicensePlatform

GitHub Cards Preview

Fortune Wheel

Fortune spinning wheel 🎡 library built using SwiftUI, supports dynamic content.


Preview - Spin Wheel ⚙️

gif


CocoaPods Installation

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

pod'FortuneWheel'

Swift Package Manager

dependencies:[.package(url:"https://github.com/sameersyd/FortuneWheel.git",.upToNextMajor(from:"0.1.5"))]

Sample Code 🌟

Import Fortune Wheel in your file.

importFortuneWheel

Create a FortuneWheelModel and pass it to the view.

structContentView:View{privatevarplayers=["Sameer","Spikey","Amelia","Danny","Karen","Kathy"]varbody:someView{letmodel=FortuneWheelModel(
titles: players, size:320,
onSpinEnd: onSpinEnd,
getWheelItemIndex: getWheelItemIndex
)ZStack{FortuneWheel(model: model)}}privatefunc onSpinEnd(index:Int){
// your action here - based on index
}privatefunc getWheelItemIndex()->Int{returngetIndexFromAPI()}}

Note:

When custom animation is used, provide it's duration in animDuration parameter

Change the animDuration only if custom animation is used, or it may cause delay in pointer result.

Function getWheelItemIndex will be called everytime wheel is spinned. If it's nil or provides invalid index, random element will be selected.


Fortune Wheel properties

ParameterOptionalTypeDefault Value
titlesfalse[String]nil
sizefalseCGFloatnil
onSpinEndfalse(Int) -> ()nil
colorstrue[Color]Color hex ["FBE488", "75AB53", "D1DC59", "EC9D42", "DE6037", "DA4533", "992C4D", "433589", "4660A8", "4291C8"]
pointerColortrueColorColor(hex: "DA4533")
strokeWidthtrueCGFloat15
strokeColortrueColorColor(hex: "252D4F")
animDurationtrueDouble6
animationtrueAnimationAnimation.timingCurve(0.51, 0.97, 0.56, 0.99, duration: 6)
getWheelItemIndextrue() -> (Int)nil

UI Design 🎨

The UI for this Fortune Wheel library was designed by @Spikeysanju


Contribute

If you want to contribute to this app, you're always welcome! See Contributing Guidelines.


Donation

If this project helped you reduce time to develop, you can buy me a cup of coffee :)

Buy Me A Coffee


Author

Sameer Nawaz, sameer.nwaz@gmail.com


License

 Apache 2.0 License
Copyright 2021 Sameer Nawaz
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Releases

Sponsor this project

Contributors

Languages