A customizable star rating widget for CustomTkinter applications.
Project description
CtkRatingStar
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.
Features
- Customizable number of stars
- Smooth hover effects
- Current value display
- Optional title and rating label
- Easy integration with existing CustomTkinter applications
Installation
# Clone the repository
git clone https://github.com/ZachVFXX/CtkRatingStar.git
# Navigate to the project directory
cd ctk-star-rating
# Install required dependencies
pip install customtkinter Pillow
Usage
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()
Customization Options
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
Required Assets
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
Contributing
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
License
This project is licensed under the MIT License - see the LICENSE file for details.
Author
Acknowledgments
- Built with CustomTkinter
- Uses Pillow for image handling
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ctkratingstar-0.0.1.tar.gz
(17.1 kB
view hashes)
Built Distribution
Close
Hashes for CTkRatingStar-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d38f1fe41fe4cd4b9c245f14e9e7e4653324e660db1764b29ca2feefef7347da |
|
MD5 | f144fa6b560967f08ede38f4457f1f9c |
|
BLAKE2b-256 | ebe1e870a71a9403ed9dfb9400ebb74ca8979dae5b5f260404dd3cc61109bce0 |