Close Menu

EDStarRating

Introduction

The EDStarRating library is a lightweight and customizable star rating control for iOS development. It allows you to easily add star ratings to your iOS application, providing an interactive and visually appealing way for users to rate content.

Features

  • Easy integration into your iOS project
  • Customizable star size, color, and spacing
  • Supports both whole and half star ratings
  • Configurable touch response and animation
  • Includes star rating indicator to display user rating
  • Supports both Swift and Objective-C

Installation

To install the EDStarRating library, you can use one of the following methods:

Using CocoaPods

To integrate EDStarRating into your Xcode project using CocoaPods, add the following line to your Podfile:

# Empty line

platform :ios, '10.0'
use_frameworks!

target 'YourProjectName' do
  pod 'EDStarRating'
end

# Empty line

Afterwards, run the pod install command in your project directory to fetch and install the library.

Manual Installation

  1. Download the latest version of EDStarRating from the GitHub repository.
  2. Unzip the downloaded file.
  3. Drag and drop the EDStarRating folder into your Xcode project.
  4. Make sure to check the "Copy items if needed" option while adding the folder.
  5. Ensure that the "Add to targets" checkbox is selected for your project’s target.

Usage

To use EDStarRating in your project, follow these steps:

Step 1: Import the library

In the file where you want to use the star rating control, import the library in Swift:

// For Swift
import EDStarRating

// Rest of your code...

Or in Objective-C:

// For Objective-C
#import "EDStarRating.h"

// Rest of your code...

Step 2: Add the star rating control

Next, create an instance of EDStarRating and add it to your view:

let starRatingControl = EDStarRating()

// Configure the star rating control
starRatingControl.starImage = UIImage(named: "star_filled")
starRatingControl.starHighlightedImage = UIImage(named: "star_highlighted")
starRatingControl.backgroundColor = UIColor.clear
starRatingControl.starCount = 5
starRatingControl.rating = 0
starRatingControl.enabled = true
starRatingControl.maxRating = 5
starRatingControl.delegate = self

// Adjust the size and position of the star rating control
starRatingControl.frame = CGRect(x: 20, y: 20, width: 200, height: 40)

// Add the star rating control to your view
self.view.addSubview(starRatingControl)

Make sure to adjust the properties according to your requirements. For example, you can set custom star images, change the background color, adjust the frame size, etc.

Step 3: Implement the delegate methods (optional)

If you need to respond to changes in user ratings, conform to the EDStarRatingProtocol and implement its delegate methods:

// For Swift
class YourViewController: UIViewController, EDStarRatingProtocol {
    
    // Rest of your code...
    
    // Implement the delegate method
    func starsSelectionChanged(control: EDStarRating, rating: Float) {
        // Handle the rating change
        print("New rating: \(rating)")
    }
    
    // Rest of your code...
}

Or in Objective-C:

// For Objective-C
@interface YourViewController () <EDStarRatingProtocol>

// Rest of your code...

@end

@implementation YourViewController

// Rest of your code...

- (void)starsSelectionChanged:(EDStarRating *)control rating:(float)rating {
    // Handle the rating change
    NSLog(@"New rating: %f", rating);
}

// Rest of your code...

@end

By implementing the starsSelectionChanged method, you can perform actions based on the user’s rating selection.

Conclusion

Congratulations! You have successfully integrated the EDStarRating library into your iOS project. You can now allow users to rate content using the star rating control and customize its appearance and behavior to match your app’s design.

For further details and advanced usage, refer to the EDStarRating GitHub repository.