Skip to main content

ConsentSigner

ComplexClinical<co-consent-signer>

ConsentSigner shows a consent document in a scroll box with agree, signature and guardian fields.

import { ConsentSigner } from 'health-components';

Examples​

Guardian​

Storybook

Signed​

Storybook

Compact​

Storybook

Usage​

<ConsentSigner title="Telehealth Consent" version="v3, 01/2026" body={text} signer="Henna West" />

When to use​

  • Consent to treat, telehealth consent, HIPAA notice, financial policy.

When not to use​

  • Unsigned information pages.

Variants and states​

VariantWhat it is
patientPatient signs.
guardianRelationship field.
signedPre-signed state.

Accessibility​

  • Document region is focusable for keyboard scroll.

Do and don't​

  • Do: Version and date on every consent.
  • Don't: Sign without showing the text.

Props​

PropTypeDefaultDescription
title *string—Consent title ("Consent for Telehealth Services"); also names the document region. Required
version *string—Version and effective date ("Version 3 . effective 01/01/2026"). Required
body *string—Consent text; blank lines separate paragraphs. Required
signer *string—Name of the person signing. Required
guardianstringnoneRelationship to the patient; shows the guardian field when set
agreedbooleanfalseAgree box ticked initially (uncontrolled)
agreedValuebooleanundefined (uncontrolled)Agree box state (controlled)
onAgreedChange(agreed: boolean) => voidnoneCalled when the agree box changes
signedbooleanfalseSignature present initially (uncontrolled)
onSignedChange(signed: boolean) => voidnoneCalled when the signature is added or cleared
agreeLabelstring"I have read and agree to this consent."Agree box label
signerLabelstring"Patient Signature"Signature pad label
compactbooleanfalseShorter signature pad
onSignConsent(signature: ConsentSignature) => voidnoneCalled by Sign Consent (enabled once agreed and signed)
onDecline() => voidnoneCalled by Decline

Also accepts native attributes, including defaultChecked, defaultValue, autoFocus, plus className and event handlers on the root element.

Angular, Vue and HTML​

Register the elements once (Angular guide), then use <co-consent-signer>. 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-consent-signer title="…" version="…" [defaultValue]="defaultValue" (co-agreed-change)="onAgreedChange($event.detail)"></co-consent-signer>
KindNameDescription
attributetitleConsent title ("Consent for Telehealth Services"); also names the document region. Required
attributeversionVersion and effective date ("Version 3 . effective 01/01/2026"). Required
attributebodyConsent text; blank lines separate paragraphs. Required
attributesignerName of the person signing. Required
attributeguardianRelationship to the patient; shows the guardian field when set; default none
attributeagreedAgree box ticked initially (uncontrolled); default false
attributeagreed-value / agreedValueAgree box state (controlled); default undefined (uncontrolled)
attributesignedSignature present initially (uncontrolled); default false
attributeagree-label / agreeLabelAgree box label; default "I have read and agree to this consent."
attributesigner-label / signerLabelSignature pad label; default "Patient Signature"
attributecompactShorter signature pad; default false
attributedefault-checked / defaultChecked
property / JSON attributedefault-value / defaultValue
attributeauto-focus / autoFocus
eventco-agreed-changeCalled when the agree box changes; default none (React: onAgreedChange)
eventco-signed-changeCalled when the signature is added or cleared; default none (React: onSignedChange)
eventco-sign-consentCalled by Sign Consent (enabled once agreed and signed); default none (React: onSignConsent)
eventco-declineCalled by Decline; default none (React: onDecline)