Signature Pad
Canvas-based signature capture pad.
Preview
Usage
views.py
python
from djust import LiveView
from djust.decorators import event_handler
from djust.components import SignaturePad
class MyView(LiveView):
template_name = "my_template.html"
def mount(self, request, **kwargs):
self.component = SignaturePad()
@event_handler()
def save_signature(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_signature.
Needs a client hook djust does not ship: dj-hook="SignaturePad". The markup renders, but the interaction described above is yours to add — register window.djust.hooks.SignaturePad = { mounted() { … } } before client.js loads (see the hooks guide).
Parameters
| Name | Type | Default |
|---|---|---|
| name | str | 'signature' |
| save_event | str — renames the event | 'save_signature' |
| width | int | 400 |
| height | int | 200 |
| pen_color | str | '#000000' |
| pen_width | int | 2 |
| disabled | bool | False |
| custom_class | str | '' |
| **kwargs | — passed to `Component.__init__`: `id=` sets `component.id`, and any other keyword is kept as state | — |
Source & styles
| File | Path | Notes |
|---|---|---|
| module | djust.components.components.signature_pad | Subclass it, or pass custom_class, to change how it renders. |
| css | djust_components/components.css | Defines 6 of this component's classes at line 1968, 1969, 1970, 1971, 1972, 2449. Override those rules, or the custom properties they read, in a stylesheet loaded after it. |