E-Signature
A signature capture with draw (canvas) and type modes, token-derived ink, and a hidden input carrying the signature for form submit.
Preview
Draw your signature in the box below.
Controls
Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.
Installation
php artisan ui:add pro/e-signature
Behavior layer (Alpine)
This component installs a self-registering Alpine module to
resources/js/ui/e-signature.js. Import the behavior layer once
from your bundle so it loads (it hooks alpine:init):
import './e-signature.js';
Registry contract
Install confidence
php artisan ui:add pro/e-signature
writes only the generated targets below. The CLI validates each file hash before writing and
prompts before replacing local changes unless --force is used.
- Version
- 1.0.0
- License
- pro
- Stability
- stable
- Contract
- v2
- Foundation
- ≥ 1.0.0
| Type | Generated target |
|---|---|
| blade | resources/views/components/ui/e-signature.blade.php |
| js | resources/js/ui/e-signature.js |
Registry dependencies
Package dependencies
composer: jml/brok:^1.0
npm: alpinejs
npm: signature_pad
Guidance
Document workflowUpload, inspect, edit, annotate, or sign a real document.
Use when
- Use when users need to upload, inspect, edit, annotate, or sign real documents as part of the workflow. Do not use a heavy document interface when the same task can be completed more simply in structured product UI.
Avoid when
- Use only for a real signing task with clear consent, document context, completion state, and a recoverable review path.
- Task length
- long
- Interaction cost
- high
- Interruptiveness
- none
- Input precision
- precise
- Mobile / touch risk
- high
- Accessibility risk
- high
- Needs background context
- Yes
- Comparison needed
- Yes
Preferred alternatives
- Structured product form
- Direct data entry
Anti-patterns
- Heavy document UI when structured fields are simpler
API
manifest knowledge + registry-derived coverageProps
| Prop | Type / values | Default | Description |
|---|---|---|---|
| name | string | signature | Declared by @props in the registry Blade source. |
| label | string | Signature | Declared by @props in the registry Blade source. |
| height | int | 200 | Declared by @props in the registry Blade source. |
Slots
Components use the default Blade slot unless a documented subcomponent is installed by the registry item.
Data slots
e-signature
e-signature-canvas
e-signature-draw
e-signature-modes
e-signature-type
e-signature-type-preview
Capabilities
Behavior
- Uses server-rendered Blade and semantic HTML.
- Installs a JavaScript behavior module when the registry item includes resources/js/ui files.
- Declares registry capability flags: a11y, interactive, responsive, rtl, darkMode, localized.
Usage
<div class="mx-auto w-full max-w-lg">
<x-ui.e-signature name="signature" />
</div>
Accessibility & localization
data-slot
Keyboard focus-visible
Localized labels
- Accessibility target: wcag-2.2-aa-target.
- Uses semantic HTML and a stable
data-slotattribute for styling/scripting hooks. - Focus-visible rings use the
ringtoken so keyboard focus is always visible. - Disabled and invalid states are conveyed to assistive tech, not by color alone.
- Targets WCAG 2.2 AA; verify contrast in light, dark, admin and customer surfaces above.
- Labels go through
__()and the component uses logical properties (ms-*,text-start,start-*) so it mirrors correctly — flip the preview to RTL to confirm.
Source
The exact, editable file ui:add writes
into your app — copy it or own the whole thing. Previews
render this same code; there are no preview-only components.
Changelog
Current version: v1.0.0. See the site changelog for the full release history.