Image Cropper
Drag-to-crop image component with optional aspect ratio lock.
Preview
Usage
views.py
python
from djust import LiveView
from djust.decorators import event_handler
from djust.components import ImageCropper
class MyView(LiveView):
template_name = "my_template.html"
def mount(self, request, **kwargs):
self.component = ImageCropper()
@event_handler()
def save_crop(self, value=None, **kwargs):
... # write to self.component; the re-render carries itmy_template.html
django
{{ component }}Events this component sends to the view: save_crop.
Needs a client hook djust does not ship: dj-hook="ImageCropper". The markup renders, but the interaction described above is yours to add — register window.djust.hooks.ImageCropper = { mounted() { … } } before client.js loads (see the hooks guide).
Parameters
| Name | Type | Default |
|---|---|---|
| src | str | '' |
| crop_event | str — renames the event; identity is `name` | 'save_crop' |
| aspect_ratio | str | '' |
| min_width | int | 50 |
| min_height | int | 50 |
| disabled | bool | False |
| 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.image_cropper | Subclass it, or pass custom_class, to change how it renders. |
| css | djust_components/components.css | Defines 8 of this component's classes at line 1957, 1958, 1959, 1960, 1961, 1962, 1963, 1964. Override those rules, or the custom properties they read, in a stylesheet loaded after it. |