Learn how to use our embedding SDK within your Preact application.
EmbedDirectTemplate
component.
Prop | Type | Description |
---|---|---|
token | string | The token for the document you want to embed |
host | string (optional) | The host to be used for the signing experience, relevant for self-hosters |
name | string (optional) | The name the signer that will be used by default for signing |
lockName | boolean (optional) | Whether or not the name field should be locked disallowing modifications |
string (optional) | The email the signer that will be used by default for signing | |
lockEmail | boolean (optional) | Whether or not the email field should be locked disallowing modifications |
externalId | string (optional) | The external ID to be used for the document that will be created upon completion |
css | string (optional) | Custom CSS to style the embedded component (Platform Plan only) |
cssVars | object (optional) | CSS variables for customizing colors, spacing, etc. (Platform Plan only) |
darkModeDisabled | boolean (optional) | Disable dark mode functionality (Platform Plan only) |
onDocumentReady | function (optional) | A callback function that will be called when the document is loaded and ready to be signed |
onDocumentCompleted | function (optional) | A callback function that will be called when the document has been completed |
onDocumentError | function (optional) | A callback function that will be called when an error occurs with the document |
onFieldSigned | function (optional) | A callback function that will be called when a field has been signed |
onFieldUnsigned | function (optional) | A callback function that will be called when a field has been unsigned |
EmbedSignDocument
component.
Prop | Type | Description |
---|---|---|
token | string | The token for the document you want to embed |
host | string (optional) | The host to be used for the signing experience, relevant for self-hosters |
name | string (optional) | The name the signer that will be used by default for signing |
lockName | boolean (optional) | Whether or not the name field should be locked disallowing modifications |
onDocumentReady | function (optional) | A callback function that will be called when the document is loaded and ready to be signed |
onDocumentCompleted | function (optional) | A callback function that will be called when the document has been completed |
onDocumentError | function (optional) | A callback function that will be called when an error occurs with the document |