@sign-kit/core Types

---

@sign-kit/core Types / SignerProps

Interface: SignerProps

Defined in: types.ts:200

Props accepted by the <Signer> component.

Properties

allowOverride?

optional allowOverride?: boolean

Defined in: types.ts:223

When true, signers may override a failed integrity check to proceed anyway.

---

embedPdfHash?

optional embedPdfHash?: boolean

Defined in: types.ts:227

When true, embeds the PDF hash into the manifest at finalize time.

---

expectedHashes?

optional expectedHashes?: ExpectedHashes | null

Defined in: types.ts:214

Expected hashes for integrity verification. Only used when mode is 'integrity'.

---

mode?

optional mode?: "standard" | "integrity"

Defined in: types.ts:212

Display mode.

• 'standard' — basic signing UI.
• 'integrity' — shows the integrity banner with hash verification results.

---

pdfSrc

pdfSrc: string | File | ArrayBuffer | null

Defined in: types.ts:202

PDF source to render and sign. Accepts a URL string, File, or ArrayBuffer.

---

readonly?

optional readonly?: boolean

Defined in: types.ts:225

When true, all fields are rendered as read-only.

---

signer?

optional signer?: SignerInfo | null

Defined in: types.ts:206

Identity of the current signer. Controls role-based field access.

---

template

template: Template

Defined in: types.ts:204

Template describing the fields to present for signing.

---

verificationMode?

optional verificationMode?: "warn" | "disabled" | "strict"

Defined in: types.ts:221

How to respond when integrity verification fails.

• 'disabled' — no checks performed.
• 'warn' — show a warning but allow signing.
• 'strict' — block signing if verification fails.