A customizable star rating widget for CustomTkinter applications. This widget provides an intuitive and visually appealing way to implement rating functionality in your CustomTkinter projects.
- Customizable number of stars
- Smooth hover effects
- Current value display
- Optional title and rating label
- Easy integration with existing CustomTkinter applications
pip install CTkRatingStar
Here's a simple example of how to use the CtkStarRating
widget:
import customtkinter as ctk
from ctk_star_rating import CtkStarRating
class App(ctk.CTk):
def __init__(self):
super().__init__()
# Create the star rating widget
star_rating = CtkStarRating(
self,
number_of_stars=5, # Number of stars to display
current_value=3, # Initial rating value
title="Rating:", # Optional title
current_value_label="/5" # Optional value label
)
star_rating.pack(pady=10)
# Get the current rating value
value = star_rating.get_value()
if __name__ == "__main__":
app = App()
app.mainloop()
The CtkStarRating
widget accepts the following parameters:
number_of_stars
(int): Number of stars to display (default: 5)current_value
(int): Initial rating value (default: 1)title
(str, optional): Title text to display above the starscurrent_value_label
(str, optional): Label to display after the current value
The widget requires the following image assets in the assets
directory:
full_star.png
: Filled star imageempty_star.png
: Empty star imagefull_star_hover.png
: Filled star hover statehover_star.png
: Empty star hover state
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature
) - Commit your changes (
git commit -m 'Add some AmazingFeature'
) - Push to the branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
- Built with CustomTkinter
- Uses Pillow for image handling