FortuneWheel

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #golang #android #machine-learning #macos #nodejs #java #awesome-list #mcp

(★ 107)

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

File Explorer

Download Latest Version (.zip)

- FUNDING.yml
- GITHUB-COVER-SPM.png
- iPhone-preview.png
- preview-wheel.gif
- - AppDelegate.swift
  - Info.plist
  - ViewController.swift
- - project.pbxproj
- - contents.xcworkspacedata
- - Manifest.lock
- - Info.plist
  - Tests.swift
- Podfile
- Podfile.lock
- - .gitkeep
- - .gitkeep
- - FortuneWheel.swift
  - FortuneWheelModel.swift
  - FortuneWheelViewModel.swift
- - FortuneWheelTests.swift
  - XCTestManifests.swift
- LinuxMain.swift
.gitignore
.travis.yml
_Pods.xcodeproj
CONTRIBUTION.md
FortuneWheel.podspec
LICENSE
Package.swift
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![CI Status](https://img.shields.io/travis/sameersyd/FortuneWheel.svg?style=flat)](https://travis-ci.org/sameersyd/FortuneWheel)
[![Version](https://img.shields.io/cocoapods/v/FortuneWheel.svg?style=flat)](https://cocoapods.org/pods/FortuneWheel)
[![License](https://img.shields.io/cocoapods/l/FortuneWheel.svg?style=flat)](https://cocoapods.org/pods/FortuneWheel)
[![Platform](https://img.shields.io/cocoapods/p/FortuneWheel.svg?style=flat)](https://cocoapods.org/pods/FortuneWheel)

![GitHub Cards Preview](https://github.com/sameersyd/FortuneWheel/blob/master/art/GITHUB-COVER-SPM.png?raw=true)

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

## Preview - Spin Wheel ⚙️
![gif](https://github.com/sameersyd/FortuneWheel/blob/master/art/preview-wheel.gif)

## CocoaPods Installation

FortuneWheel is available through [CocoaPods](https://cocoapods.org). To install
it, simply add the following line to your Podfile:

```ruby
pod 'FortuneWheel'
```

## Swift Package Manager

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

## Sample Code 🌟

Import Fortune Wheel in your file.
```ruby
import FortuneWheel
```

Create a `FortuneWheelModel` and pass it to the view.
```swift
struct ContentView: View {

private var players = ["Sameer", "Spikey", "Amelia", "Danny", "Karen", "Kathy"]
    
    var body: some View {
        let model = FortuneWheelModel(
            titles: players, size: 320,
            onSpinEnd: onSpinEnd,
            getWheelItemIndex: getWheelItemIndex
        )
        ZStack {
            FortuneWheel(model: model)
        }
    }

private func onSpinEnd(index: Int) {
        // your action here - based on index
    }

private func getWheelItemIndex() -> Int {
        return getIndexFromAPI()
    }
}
```

## 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
<table style="width:100%">
 <tr>
 <th>Parameter</th>
 <th>Optional</th> 
 <th>Type</th>
 <th>Default Value</th>
 </tr>
 <tr>
 <td>titles</td>
 <td>false</td>
 <td>[String]</td>
 <td>nil</td>
 </tr>
 <tr>
 <td>size</td>
 <td>false</td>
 <td>CGFloat</td>
 <td>nil</td>
 </tr>
 <tr>
 <td>onSpinEnd</td>
 <td>false</td>
 <td>(Int) -> ()</td>
 <td>nil</td>
 </tr>
 <tr>
 <td>colors</td>
 <td>true</td>
 <td>[Color]</td>
 <td>Color hex ["FBE488", "75AB53", "D1DC59", "EC9D42", "DE6037", "DA4533", "992C4D", "433589", "4660A8", "4291C8"]</td>
 </tr>
 <tr>
 <td>pointerColor</td>
 <td>true</td>
 <td>Color</td>
 <td>Color(hex: "DA4533")</td>
 </tr>
 <tr>
 <td>strokeWidth</td>
 <td>true</td>
 <td>CGFloat</td>
 <td>15</td>
 </tr>
 <tr>
 <td>strokeColor</td>
 <td>true</td>
 <td>Color</td>
 <td>Color(hex: "252D4F")</td>
 </tr>
 <tr>
 <td>animDuration</td>
 <td>true</td>
 <td>Double</td>
 <td>6</td>
 </tr>
 <tr>
 <td>animation</td>
 <td>true</td>
 <td>Animation</td>
 <td>Animation.timingCurve(0.51, 0.97, 0.56, 0.99, duration: 6)</td>
 </tr>
 <tr>
 <td>getWheelItemIndex</td>
 <td>true</td>
 <td>() -> (Int)</td>
 <td>nil</td>
 </tr>
</table>

## UI Design 🎨
The UI for this Fortune Wheel library was designed by <a href="https://github.com/Spikeysanju">@Spikeysanju</a>

## Contribute
If you want to contribute to this app, you're always welcome!
See [Contributing Guidelines](https://github.com/sameersyd/FortuneWheel/blob/master/CONTRIBUTION.md).

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

## Author
Sameer Nawaz, sameer.nwaz@gmail.com

## License
```
    Apache 2.0 License

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.

```

FortuneWheel

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

FortuneWheel

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README