Leum gu prìomh susbaint

Integrate Legalesign Document Viewer into Your Website

comhairle

Faodaidh tu faicinn an eileamaid seo ag obair mar Quick Send ann an Console.

Version làithreach: v1.0.27 — changelog

Is e eileamaid lìn neo-eisimeileach air àrd-ùrlar an Legalesign Document Viewer a leigeas leat teamplaidean airson soidhnigeadh sgrìobhainnean a dheasachadh, a ro-shealltainn agus a ghnàthachadh. Tha e ag obair gu rèidh ann an HTML le JavaScript, React, Vue, Angular, no le framework sam bith eile air an lìon.

Tha an eileamaid plug and play seo air a dhealbhadh gus am faigh thu cothrom a thoirt do phrìomh phàirtean cruthachaidh sgrìobhainnean a chur a-steach do na siostaman agad fhèin, mar eisimpleir CRM no tagradh gnìomhachais.

Fhad ‘s a dh’fhaodas an t-siostam agad eileamaidean HTML a riochdachadh agus a thoirt taic dhaibh, faodaidh tu am Viewer Sgrìobhainn a chleachdadh.

Ma dh’fheumas tu taic a bharrachd airson am Viewer Sgrìobhainn a chuir a-steach don stac teicnigeach agad, cuir fios dhan deasg taic againn.

Faodaidh tu na widgets nas motha seo a chleachdadh le amalachadh REST/GraphQL API gus pròiseasan soidhnigeadh sgrìobhainnean rèidh a thoirt do na stèidheachdich agad agus do luchd-cleachdaidh.

Installation​

NPM Installation​

npm install legalesign-document-viewer
# or
pnpm add legalesign-document-viewer

For React Projects​

npm install legalesign-document-viewer-react
# or
pnpm add legalesign-document-viewer-react

Basic Integration​

HTML/JavaScript​

Faodaidh an dreach HTML/Javascript den eileamaid seo a chleachdadh le stac leasachaidh sam bith, leithid PHP, ASP .Net msaa. Faodaidh tu ceangal dìreach a dhèanamh ris an eileamaid bho npm ma chan eil cead agad a stàladh. Faodaidh tu peàrlanas a dhèanamh air duilleag taisbeanaidh bhon repository eisimpleir an seo [https://github.com/legalesign/ls-viewer-demo].

Cuir na sgriobtaichean eileamaid ris an HTML agad:

<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="node_modules/legalesign-document-viewer/dist/ls-document-viewer/ls-document-viewer.css" />
<script type="module" src="node_modules/legalesign-document-viewer/dist/ls-document-viewer/ls-document-viewer.esm.js"></script>
<script nomodule src="node_modules/legalesign-document-viewer/dist/ls-document-viewer/ls-document-viewer.js"></script>
</head>
<body>
<ls-document-viewer
id="my-editor"
templateid="YOUR_TEMPLATE_ID"
token="YOUR_AUTH_TOKEN"
></ls-document-viewer>
</body>
</html>

Authentication - Get a token​

Feumaidh tu còd taobh an fhrithealaiche a chleachdadh gus YOUR_AUTH_TOKEN fhaighinn. Tha dà roghainn ann, agus bidh an dà chuid a’ cleachdadh do iuchair API:

  1. GraphQL generateComponentToken — Cuir an gnàthachadh leis an iuchair API agad gus token eileamaid sònraichte agus beaga fhaighinn.
  2. REST API — Cuir a-steach GET /templatepdf/{pdfId}/component-token/ leis an iuchair API agad.

Roghainn 1 (GraphQL):

const response = await fetch('https://graphql.uk.legalesign.com/graphql', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: `Bearer ${process.env.LEGALESIGN_API_KEY}`,
},
body: JSON.stringify({
query: `mutation {
generateComponentToken(input: { component: LS_DOCUMENT_VIEWER }) {
token
expiresIn
expiresAt
}
}`,
}),
});

const { data } = await response.json();
const token = data.generateComponentToken.token;

Roghainn 2 (REST):

const response = await fetch(
`https://eu-api.legalesign.com/api/v1/templatepdf/${pdfId}/component-token/`,
{
headers: {
Authorization: `Bearer ${process.env.LEGALESIGN_API_KEY}`,
},
}
);

const { token } = await response.json();

Cuir an token a thig air ais dhan widget. Faic Widget Authorization airson mion-fhiosrachadh mu roghainnean token.

React Integration​

Tha sinn cuideachd air dreach den eileamaid a chruthachadh a tha a’ dol dìreach leis na freamworks React.

import { LsDocumentViewer } from 'legalesign-document-viewer-react';

function App() {
return (
<LsDocumentViewer
templateid="YOUR_TEMPLATE_ID"
token="YOUR_AUTH_TOKEN"
mode="compose"
/>
);
}

Required Attributes​

token​

Do token tèarainteachd airson dearbhadh: token eileamaid beaga-latha bhon generateComponentToken no bhon endpoint REST component-token. Faic Widget Authorization airson sruth tèarainte token.

token="eyJraWQiOiJBTkJIeT..."

templateid​

An ID API den teamplaid a tha thu airson a thaisbeanadh do luchd-cleachdaidh. Faodaidh tu a lorg a’ coimhead anns an URL nuair a tha thu a’ deasachadh an teamplaid anns an Lìon App.

templateid="dHBsYjQ5YTg5NWQtYWRhMy0xMWYwLWIxZGMtMDY5NzZlZmU0MzIx"

Widget Modes​

Editor Mode​

Cruthachadh agus deasachadh teamplaid làn-ghnìomhach leis a h-uile inneal ri fhaighinn. Tha seo airson sruth obrach far a bheil teamplaid ath-chleachdadh àrd le dreuchdan feumail. Ma tha thu an dùil an sgrìobhainn agad a chleachdadh dìreach aon turas (mar gum biodh an siostam gineadh sgrìobhainn agad air na fiosrachaidhean luchd-ceannach uile a lìonadh mu thràth), dh’fhaodadh tu beachdachadh air modh compose an àite sin.

<ls-document-viewer mode="editor" ...></ls-document-viewer>

Compose Mode​

Is e modh ‘gabhail-naidheachd-cèin’ a th’ ann gus eòlas an neach-cleachdaidh a shìmplidheachadh. Ann an Lìon App Legalesign is e seo an gnìomhradh ‘Quick send’.

Cuir na gabhadairean agad ris an fheart ‘recipients’ agus faodaidh an neach-cleachdaidh aca soidhnichean agus raointean foirm a chuir gu luath mus cuir iad am faidhle. Freagarrach airson luchd-ceannach air an amalachadh far am bheil na gabhadairean air an comharrachadh mu thràth.

Is e an sruth obrach àbhaisteach clone no luchdaich suas PDF, an uairsin cuir am viewer far an urrainn don neach-cleachdaidh raointean soidhnidh is foirm a chur ris, an uairsin tabhann putan gus an sgrìobhainn a chuir.

Clone​

Clone teamplaid a th’ ann mar-thà le bhith a’ cleachdadh an gnàthachadh copyTemplate:

const response = await fetch('https://graphql.uk.legalesign.com/graphql', {
method: 'POST',
headers: {
'Authorization': `Bearer ${token}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
query: `
mutation CopyTemplate {
copyTemplate(input: {
groupId: "yourGroupId",
templateId: "yourTemplateId",
newTitle: "new document title",
copyFields: true|false
})
}
`
})
});
const { data } = await response.json();
const templateId = data.copyTemplate;

Or Upload​

Cruthaich teamplaid an uairsin luchdaich e suas tron uploadUrl a thug iad dhut. Cleachd tiotal [deleted] ma chan eil thu airson an PDF anns an leabharlann agad. Bidh e air a dhubhadh às anns an ath 24 uairean. Air neo cleachd tiotal sam bith a thogras tu:

const response = await fetch('https://graphql.uk.legalesign.com/graphql', {
method: 'POST',
headers: {
'Authorization': `Bearer ${token}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
query: `
mutation CreateTemplate {
createTemplate(input: {groupId: "yourGroupid", title: "[deleted]"}) {
id
uploadUrl
}
}
`
})
});
const { data } = await response.json();
const templateId = data.createTemplate.id;
const uploadUrl = data.createTemplate.uploadUrl;

A-nis cuir PUT air an fhaidhle agad dhan uploadUrl. Feumaidh seòrsa susbaint a bhith application/pdf.

Embed viewer​

Is e ‘recipients’ am feart prìomhach. Feumaidh tu mion-fhiosrachadh a bharrachd airson neach-dèanamh co-dhùnaidh no luchd-fianais - airson tuilleadh fiosrachaidh faic Recipients.

<ls-document-viewer 
mode="compose"
recipients='[
{"email": "user@example.com", "firstname": "John", "lastname": "Doe", "signerIndex": 1},
{"email": "user2@example.com", "firstname": "Jane", "lastname": "Smith", "signerIndex": 2}
]'
...></ls-document-viewer>

Gu fèin-ghluasadach bidh modh compose a:

  • A’ lorg gabhadairean a chaidh a chruthachadh ro-làimh
  • A’ falaich an neach-cuiridh bhon liosta tuiteam-sìos
  • A’ falaich roghainnean sgrìobhainnean
  • A’ sealltainn raointean riatanach mar thùs
  • A’ toirt air falbh an neach-cuiridh agus raointean luchd-cuiridh bhon deasaiche
  • A’ brosnachadh taghadh luath airson na raointean riatanach airson gach neach-gabhail

Preview Mode​

Ro-shealladh sgrìobhainn cuideachail a sheallas am faidhle leis na raointean gnàthach uile agus a leigeas leis an neach-cleachdaidh brobhsadh tro dhuilleagan.

<ls-document-viewer mode="preview" ...></ls-document-viewer>

Gu fèin-ghluasadach bidh modh ro-shealladh a:

  • A’ falaich a’ bhàr-innealan
  • A’ falaich roghainnean sgrìobhainn
  • A’ falaich baga innealan
  • A’ cruthachadh gun urrainn dha na com-pàirtichean agus raointean a-mhàin a bhith leughadh

Advanced Configuration​

Filter Toolbox​

Cuingealachadh seòrsaichean raointean a tha rim faighinn le luachan air an sgaradh le pìob. Mura sònraich luach, thathar a’ gabhail ris gun tèid an baga innealan a dhèanamh gun fhiltradh agus gu bheil na roghainnean uile rim faighinn.

<ls-document-viewer
filtertoolbox="signature|initials|date|text"
...
></ls-document-viewer>

Luachan sìoltachaidh rim faighinn:

LuachTuairisgeul
signatureRaon soidhnidh (a-mhàin airson an neach-soidhnidh)
auto signRaon soidhnidh fèin-ghluasadach (a-mhàin airson an neach-cuiridh)
textCuir a-steach teacsa saor
signing dateCeann-latha air a lìonadh gu fèin-ghluasadach aig àm soidhnidh (a-mhàin airson an neach-soidhnidh)
dateRaon tagh ceann-latha
emailCuir a-steach post-d
initialsRaon ainmean-toisich
numberCuir a-steach àireamhan
dropdownRoghainn tuiteam-sìos
checkboxBogsa-sgrìobhaidh
regexCuir a-steach air a sgrùdadh le Regex (a-mhàin airson an neach-soidhnidh)
imageLìonadh ìomhaigh suas (a-mhàin airson an neach-soidhnidh)
fileLìonadh faidhle suas (a-mhàin airson an neach-soidhnidh)
drawnRaon tarraing/saor-làimhe (a-mhàin airson an neach-soidhnidh)

Recipients​

Mìnich luchd-gabhail an sgrìobhainn ann an cruth JSON.

Tha na eileamaidean riatanach airson gach neach-gabhail: firstname, lastname, email agus signerIndex;

Faodaidh tu roghnach a chur seachad dreuchd agus àireamh fòn airson gach neach-gabhail. Ma leigeas tu às dreuchd, thèid an neach-gabhail a mheas mar neach-soidhnidh.

Faodaidh tu dreuchd a chur seachad "WITNESS" no "APPROVER". Airson dreuchd "WITNESS" cuir 100 ris an àireamh signerIndex den neach-soidhnidh aca. Mar eisimpleir ma tha feum agad air neach-fianais do neach-soidhnidh 2 (signerIndex: 2), dèan am WITNESS signerIndex: 102.

<ls-document-viewer
recipients='[
{"email": "user@example.com", "firstname": "John", "lastname": "Doe", "signerIndex": 1},
{"email": "user2@example.com", "firstname": "Jane", "lastname": "Smith", "signerIndex": 2}
{"email": "user3@example.com", "firstname": "Joan", "lastname": "Mitchell", "signerIndex": 102, roleType: "WITNESS"}
]'
...
></ls-document-viewer>

Custom Buttons with Slots​

Cuir putanan gnàthaichte ris a’ bhàr-innealan le bhith a’ cleachdadh slots. Gann gun cleachd thu iad airson an gnìomh a chuir dheth no an sgrìobhainn a chuir air adhart.

<ls-document-viewer ...>
<style>
.custom-button {
padding: 2px 12px;
border-radius: 1rem;
background-color: #9df5d4;
color: #125241;
font-weight: 500;
}
</style>
<span slot="left-button">
<button class="custom-button">Cancel</button>
</span>
<span slot="right-button">
<button class="custom-button">Send Document</button>
</span>
</ls-document-viewer>

Event Handling​

Èist ri tachartasan eileamaid airson atharrachaidhean a leantainn:

const editor = document.querySelector('ls-document-viewer');

editor.addEventListener('update', (event) => {
console.log('Template changed:', event.detail);
});

Faodaidh tu sùil a chumail a bheil teamplaid air fàs dligheach no mì-dligheach le bhith a’ cleachdadh an tachartas validate.

const editor = document.querySelector('ls-document-viewer');

editor.addEventListener('validate', (event) => {
console.log('Template validation changed:', event.detail.valid);
});

React Event Handling Example​

Ann an React, bidh tachartas air a ro-ainmachadh le on<EventName>.

<LsDocumentViewer
onUpdate={(event) => {
console.log('Template changed:', event.detail);
}}
...
/>

Event Types​

update event​

Bidh e lasgaichte nuair a thèid an teamplaid sgrìobhainn atharrachadh, leithid raointean a chur ris no a thoirt air falbh. Thug e cothrom chan ann a-mhàin air an tachartas ach cuideachd air staid ùraichte an teampla fhaighinn mar JSON.

validate event​

Bidh e lasgaichte nuair a thèid an teamplaid sgrìobhainn atharrachadh; seallaidh feart valid ann an mion-fhiosrachadh a bheil an teamplaid fàs dligheach no mì-dligheach.

selectFields event​

Bidh e lasgaichte nuair a thèid raon a thaghadh anns an deasaiche.

addParticipant event​

Bidh e lasgaichte nuair a thèid dreuchd com-pàirtiche a chur ris an teamplaid.

Complete Example​

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Document Editor</title>
<link rel="stylesheet" href="https://unpkg.com/legalesign-document-viewer/ls-document-viewer.css" />
<script type="module" src="https://unpkg.com/legalesign-document-viewer"></script>
</head>
<body style="padding: 0; margin: 0">
<ls-document-viewer
id="my-editor"
templateid="dHBsYjQ5YTg5NWQtYWRhMy0xMWYwLWIxZGMtMDY5NzZlZmU0MzIx"
token="YOUR_TOKEN_HERE"
mode="compose"
recipients='[
{"email": "signer@example.com", "firstname": "John", "lastname": "Doe", "signerIndex": 1}
]'
filtertoolbox="signature|initials|date"
>
<span slot="left-button">
<button onclick="handleCancel()">Cancel</button>
</span>
<span slot="right-button">
<button onclick="handleSend()">Send</button>
</span>
</ls-document-viewer>

<script>
const editor = document.querySelector('ls-document-viewer');

editor.addEventListener('update', (event) => {
// shows the change event and the template details
console.log('Document updated:', event.detail);
});

function handleCancel() {
// Implement the cancel logic, e.g. go to a home page
window.location.href = '/cancelpage';
}

function handleSend() {
// Implement send logic if required.
console.log('Sending document...');
}
</script>
</body>
</html>

Cuir an sgrìobhainn air adhart taobh an fhrithealaiche leis an iuchair API agad, tro eadar-aghaidh GraphQL no REST.

Trouble Shooting

Ma thachras duilgheadasan leis an eileamaid, dèan cinnteach gu bheil:

  • faodaidh tu faighinn gu no gu bheil thu air domain stòraidh an sgrìobhainn a shoilleireachadh aig https://s3.amazonaws.com/*

Browser Support​

Tha an eileamaid a’ cleachdadh inbhean-lìn ùra agus a’ toirt taic do:

  • Chrome/Edge (as ùire)
  • Firefox (as ùire)
  • Safari (as ùire)
  • Brobhsairean gluasadach (iOS Safari, Chrome Mobile)

Changelog​

VersionDateSummary
v1.0.2719 Oct 2026Leasachaidhean suidheachadh raointean
v1.0.263 Sep 2026Dèanachadh scroll; nochdadh air a chur dheth airson luchdachadh
v1.0.2112 Aug 2026Roghainnean modh ro-shealladh; leasachadh tachartas update
v1.0.1817 Jul 2026Bòrd raon regex; mòran feartan adhartach; leasachadh dropdown; ath-ainmeachadh neach-fianais
v1.0.1210 Jul 2026Feart raon excludeFromPdf
v1.0.99 Jul 2026Raointean ceann-latha fèin-ghluasadach agus regex; feartan adhartach; òrdugh raointean
v1.0.62 Jul 2026Càradh font a bha a’ cur casg air fàilligeadh soidhnidh; margainnean ro-shealladh
v1.0.529 Jun 2026Goireasan ath-dhèanadh/ùrachadh meur-chlàr
v1.0.426 Jun 2026Leasachaidhean tachartasan; ùrachaidhean dòchasach; undo/redo
v1.0.024 Jun 2026Tòiseachadh seasmhach tùsail

Resources​

Getting Help​

Airson taic theicnigeach no ceistean mu amalachadh, cuir fios dhan sgioba taic Legalesign no tadhal air an API documentation.