Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dkk/StarRating
A StarRating element written for SwiftUI
https://github.com/dkk/StarRating
Last synced: about 2 months ago
JSON representation
A StarRating element written for SwiftUI
- Host: GitHub
- URL: https://github.com/dkk/StarRating
- Owner: dkk
- License: mit
- Created: 2021-02-10T17:09:05.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-29T16:52:03.000Z (about 2 years ago)
- Last Synced: 2024-08-03T18:13:25.320Z (5 months ago)
- Language: Swift
- Size: 222 KB
- Stars: 25
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-swiftui-libraries - StarRating - A customizable star rating control (Ratings / Content)
README
# StarRating
 
This is a customizable star rating control written specifically for SwiftUI. It shows a star rating and handles user input.
It also contains a star Shape with customizable number of vertices and weight.
## Installation
Requirements iOS 13+
### Swift Package Manager
1. In Xcode, open your project and navigate to File → Swift Packages → Add Package Dependency.
2. Paste the repository URL (https://github.com/dkk/StarRating) and click Next.
3. For Rules, select version.
4. Click Finish.
### Swift Package
```swift
.package(url: "https://github.com/dkk/StarRating", .upToNextMajor(from: "1.2.0"))
```
## Usage
Import StarRating package to your view.
```swift
import StarRating
```
and you are ready to use `StarRating` or the `Shape` `Star` in you SwiftUI code.
### Use StarRating to display a rating
You can display a rating with the line:
```swift
// set the rating you want to display as initialRating
StarRating(initialRating: 3.7)
```
### Use StarRating to get a rating from the user
To show a fully functional star rating that can handle user input, add the line:
```swift
// set the initialRating
// add a callback to do something with the new rating
StarRating(initialRating: 0, onRatingChanged: { print($0) })
```
### Configure StarRating
To configure the control, `StarRating` binds a `StarRatingConfiguration` object. This makes it easy to dynamically change the control's style and behaviour.
1. Create a `StarRatingConfiguration` object:
```swift
@State var customConfig = StarRatingConfiguration(minRating: 2, numberOfStars: 10)
```
2. Pass it when creating the instance of `StarRating` and update it later as needed:
```swift
StarRating(initialRating: 2.0, configuration: $customConfig) { newRating in
customConfig.starVertices = Int(newRating)
}
```
Read the implementation of [StarRatingConfiguration](Sources/StarRating/StarRatingConfiguration.swift) to see what configuration posibilities are available at the moment.
### Use the Star Shape
Use `Star` the same way as you would use standard SwiftUI Shapes, such as `Rectangle`. `Star` allows to configure the number of vertices and the weight. Example usage:
```swift
Star(vertices: 5, weight: 0.45)
```
## Contribute
You can contribute to this project by helping me solve any [reported issues or feature requests](https://github.com/dkk/WrappingHStack/issues) and creating a pull request.
## Support
If you just want to say thanks, you could [buy me a coffee ☕️](https://www.buymeacoffee.com/kloeck).
## License
StarRating is released under the [MIT License](LICENSE).