Skip to main content

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​

Storybook

Signed​

Storybook

Compact With Error​

Storybook

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​

VariantWhat it is
empty"Tap to sign".
signedName in script ink with time stamp and Clear.
compact90px, 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​

PropTypeDefaultDescription
labelstring"Signature"Label above the pad
namestring"patient"Signer's name, drawn as the signature and used in the pad's accessible name
signedbooleanundefined (uncontrolled)Controlled signed state
defaultSignedbooleanfalseInitial signed state (uncontrolled)
onSignedChange(signed: boolean) => void—Called when the signed state changes (sign or clear)
whenstringthe time the pad was signedTime stamp shown after signing ("10/09/2026 10:42 AM")
compactbooleanfalseShorter pad (90px)
requiredbooleanfalseRed asterisk after the label
errorstringnoneError message under the pad, role alert
onSign() => voidnoneCalled when the signer taps to sign
onClear() => voidnoneCalled when the signature is cleared
styleCSSProperties—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>
KindNameDescription
attributelabelLabel above the pad; default "Signature"
attributenameSigner's name, drawn as the signature and used in the pad's accessible name; default "patient"
attributesignedControlled signed state; default undefined (uncontrolled)
attributedefault-signed / defaultSignedInitial signed state (uncontrolled); default false
attributewhenTime stamp shown after signing ("10/09/2026 10:42 AM"); default the time the pad was signed
attributecompactShorter pad (90px); default false
attributerequiredRed asterisk after the label; default false
attributeerrorError message under the pad, role alert; default none
property / JSON attributestyleInline style of the root
attributedefault-checked / defaultChecked
property / JSON attributedefault-value / defaultValue
attributeauto-focus / autoFocus
attributetype
attributedisabled
property / JSON attributevalue
eventco-signed-changeCalled when the signed state changes (sign or clear) (React: onSignedChange)
eventco-signCalled when the signer taps to sign; default none (React: onSign)
eventco-clearCalled when the signature is cleared; default none (React: onClear)