Rating
Star rating component.
Preview
Arguments
rating(value=4, max_stars=5)
Usage
views.py
python
from djust import LiveView
from djust.decorators import event_handler
from djust.components import Rating
class MyView(LiveView):
template_name = "my_template.html"
def mount(self, request, **kwargs):
self.component = Rating(value=4, max_stars=5)
@event_handler()
def set_rating(self, value, **kwargs):
self.component.value = valuemy_template.html
django
{{ component }}Events this component sends to the view: set_rating.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| value | float | 0 | current rating value (0-max_stars, supports half stars) |
| max_stars | int | 5 | maximum number of stars |
| readonly | bool | False | if True, stars are not clickable |
| event | str — renames the event; identity is `name` | 'set_rating' | dj-click event name |
| size | str | 'md' | sm, md, lg |
| custom_class | str | '' | — |
| **kwargs | — passed to `Component.__init__`: `name=` identifies the instance in the events it sends, `id=` sets `component.id`, and any other keyword is kept as state | — | — |
Source & styles
| File | Path | Notes |
|---|---|---|
| module | djust.components.components.rating | Subclass it, or pass custom_class, to change how it renders. |
| css | djust_components/components.css | Defines 4 of this component's classes at line 677, 678, 679, 684. Override those rules, or the custom properties they read, in a stylesheet loaded after it. |