Star Ratings for swift projects
- iOS 10.0+ / tvOS 9.0+
- Xcode 9.0+
CocoaPods
CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:
$ gem install cocoapods
To integrate MLStarRating into your Xcode project using CocoaPods, specify it in your Podfile
:
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '10.0'
use_frameworks!
pod 'MLStarRating', '~> 1.0.3'
Then, run the following command:
$ pod install
Carthage
Carthage is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.
You can install Carthage with Homebrew using the following command:
$ brew update
$ brew install carthage
To integrate MLStarRating into your Xcode project using Carthage, specify it in your Cartfile
:
github "micheltlutz/MLStarRating" ~> 1.0.3
Swift Package Manager
To use MLStarRating as a Swift Package Manager package just add the following in your Package.swift file.
// swift-tools-version:4.2
import PackageDescription
let package = Package(
name: "HelloMLStarRating",
dependencies: [
.package(url: "https://github.com/micheltlutz/MLStarRating.git", .upToNextMajor(from: "1.0.3"))
],
targets: [
.target(name: "HelloMLStarRating", dependencies: ["MLStarRating"])
]
)
If you prefer not to use either of the aforementioned dependency managers, you can integrate MLStarRating into your project manually.
Git Submodules
- Open up Terminal,
cd
into your top-level project directory, and run the following command "if" your project is not initialized as a git repository:
$ git init
- Add MLStarRating as a git submodule by running the following command:
$ git submodule add https://github.com/micheltlutz/MLStarRating.git
$ git submodule update --init --recursive
- Open the new
MLStarRating
folder, and drag theMLStarRating.xcodeproj
into the Project Navigator of your application's Xcode project.
It should appear nested underneath your application's blue project icon. Whether it is above or below all the other Xcode groups does not matter.
- Select the
MLStarRating.xcodeproj
in the Project Navigator and verify the deployment target matches that of your application target. - Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.
- In the tab bar at the top of that window, open the "General" panel.
- Click on the
+
button under the "Embedded Binaries" section. - You will see two different
MLStarRating.xcodeproj
folders each with two different versions of theMLStarRating.framework
nested inside aProducts
folder.
It does not matter which
Products
folder you choose from.
-
Select the
MLStarRating.framework
. -
And that's it!
The
MLStarRating.framework
is automagically added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.
Embedded Binaries
- Download the latest release from https://github.com/micheltlutz/MLStarRating/releases
- Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.
- In the tab bar at the top of that window, open the "General" panel.
- Click on the
+
button under the "Embedded Binaries" section. - Add the downloaded
MLStarRating.framework
. - And that's it!
- emptyStar
- fullStar
import MLStarRating
let mlStarRating = MLStarRating()
mlStarRating.didChangeStar = { starCount in
print("Star selected: \(starCount)")
}
let mlStarRating = MLStarRating()
mlStarRating.emptyStarImageName = "string name image"
mlStarRating.fullStarImageName = "string name image"
mlStarRating.setupStars() // to change configuration buttons
let mlStarRating = MLStarRating()
mlStarRating.selectedStar = 4
Issues and pull requests are welcome!
See Documentation
MLLineChart Docs (80% documented)
- 100% documented
Michel Anderson Lutz Teixeira @michel_lutz
MLStarRating is released under the MIT license. See LICENSE for details.