SignaturePad
BasicInputs
<co-signature-pad>SignaturePad captures a patient or provider signature on consent forms, check-in and note signing.
import { SignaturePad } from 'health-components';
Examples
Showcase
Signed
Compact With Error
Usage
<SignaturePad label="Patient Signature" name={patient.name} required onSign={recordConsent} />
When to use
- Consent to treat, HIPAA acknowledgement, financial policy, proxy access.
When not to use
- Provider note signing that uses a PIN or password: PinEntry.
Variants and states
| Variant | What it is |
|---|---|
| empty | "Tap to sign". |
| signed | Name in script ink with time stamp and Clear. |
| compact | 90px, phone screens. |
| error | "Signature is required to continue." |
Accessibility
- The pad is a button named "Tap to sign as Henna West", so it works without drawing.
Do and don't
- Do: Show what the patient is signing above the pad.
- Don't: A signature with no date and time.
Props
| Prop | Type | Default | Description |
|---|---|---|---|
label | string | "Signature" | Label above the pad |
name | string | "patient" | Signer's name, drawn as the signature and used in the pad's accessible name |
signed | boolean | undefined (uncontrolled) | Controlled signed state |
defaultSigned | boolean | false | Initial signed state (uncontrolled) |
onSignedChange | (signed: boolean) => void | — | Called when the signed state changes (sign or clear) |
when | string | the time the pad was signed | Time stamp shown after signing ("10/09/2026 10:42 AM") |
compact | boolean | false | Shorter pad (90px) |
required | boolean | false | Red asterisk after the label |
error | string | none | Error message under the pad, role alert |
onSign | () => void | none | Called when the signer taps to sign |
onClear | () => void | none | Called when the signature is cleared |
style | CSSProperties | — | Inline style of the root |
Also accepts native attributes, including defaultChecked, defaultValue, autoFocus, type, disabled, value, plus className and event handlers on the root element.
Angular, Vue and HTML
Register the elements once (Angular guide), then use <co-signature-pad>. Attributes take strings; arrays and objects are set as properties (Angular [prop], Vue :prop) or as JSON attributes. Callbacks are DOM events with the value in event.detail.
Angular template
<co-signature-pad label="…" name="…" [style]="style" (co-signed-change)="onSignedChange($event.detail)"></co-signature-pad>
| Kind | Name | Description |
|---|---|---|
| attribute | label | Label above the pad; default "Signature" |
| attribute | name | Signer's name, drawn as the signature and used in the pad's accessible name; default "patient" |
| attribute | signed | Controlled signed state; default undefined (uncontrolled) |
| attribute | default-signed / defaultSigned | Initial signed state (uncontrolled); default false |
| attribute | when | Time stamp shown after signing ("10/09/2026 10:42 AM"); default the time the pad was signed |
| attribute | compact | Shorter pad (90px); default false |
| attribute | required | Red asterisk after the label; default false |
| attribute | error | Error message under the pad, role alert; default none |
| property / JSON attribute | style | Inline style of the root |
| attribute | default-checked / defaultChecked | |
| property / JSON attribute | default-value / defaultValue | |
| attribute | auto-focus / autoFocus | |
| attribute | type | |
| attribute | disabled | |
| property / JSON attribute | value | |
| event | co-signed-change | Called when the signed state changes (sign or clear) (React: onSignedChange) |
| event | co-sign | Called when the signer taps to sign; default none (React: onSign) |
| event | co-clear | Called when the signature is cleared; default none (React: onClear) |