Comhtháthú Breathnóir Doiciméad Legalesign i do Láithreán Gréasáin
Is féidir leat an comhéadan seo a fheiceáil gníomhach mar Seol Tapa i Console.
Leagan reatha: v1.0.27 — changelog
Is comhpháirt gréasáin neamhspleách ar ardán é Breathnóir Doiciméad Legalesign a ligeann duit teimpléid a chur in eagar, réamhamharc a dhéanamh orthu, agus iad a shaincheapadh le haghaidh sínithe doiciméad. Oibríonn sé go réidh i HTML le JavaScript, React, Vue, Angular, nó aon fhráma oibre gréasáin.
Tá an chomhpháirt plug and play seo deartha ionas gur féidir leat príomhchodanna cruthaithe doiciméad a chomhtháthú i do chórais inmheánacha, cosúil le CRM nó aip gnó líne.
Fad is féidir le do chóras comhpháirteanna HTML a léiriú agus a thacaíonn leo, is féidir leat Breathnóir Doiciméad a úsáid.
Má theastaíonn tuilleadh cabhrach uait ag comhtháthú Breathnóir Doiciméad i do stáic teicniúil déan teagmháil lenár ndiúscairt tacaíochta.
Is féidir leat na wigéid mhóra seo a úsáid le comhtháthuithe REST/GraphQL API chun próisis sínithe doiciméad gan fhaoiseamh a sholáthar do do fhoireann agus do chustaiméirí.
Suiteáil
Suiteáil NPM
npm install legalesign-document-viewer
# or
pnpm add legalesign-document-viewer
Do Thionscadail React
npm install legalesign-document-viewer-react
# or
pnpm add legalesign-document-viewer-react
Comhtháthú Bunúsach
HTML/JavaScript
Is féidir an leagan HTML/Javascript den chomhpháirt seo a úsáid le haon stáic forbartha, cosúil le PHP, ASP .Net srl. Is féidir leat nasc a dhéanamh leis an gcomhpháirt go díreach ón npm má tá do chomhshaol neamhchumasaithe é a shuiteáil. Is féidir leat triail a bhaint as leathanach taispeána ón stór samplach anseo [https://github.com/legalesign/ls-viewer-demo].
Cuir na scriptí comhpháirte leis an HTML:
<!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>
Fíordheimhniú - Faigh ticéad
Beidh ort cód taobh an fhreastalaí a úsáid chun YOUR_AUTH_TOKEN a fháil. Tá dhá rogha ann, agus úsáidtear do eochair API san dá cheann:
- GraphQL
generateComponentToken— Glaoigh an athrú le do eochair API chun ticéad comhpháirte gearrthéarmach, scóipthe a ghiniúint. - REST API — Glaoigh
GET /templatepdf/{pdfId}/component-token/le do eochair API.
Rogha 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;
Rogha 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();
Pasúil an token a aisghafa isteach sa widget. Féach Údarás an Widget le haghaidh sonraí breise faoi roghanna ticéid.
Comhtháthú React
Tá leagan den chomhpháirt cruthaithe againn freisin a chomhtháthaíonn go díreach le frámaí React.
import { LsDocumentViewer } from 'legalesign-document-viewer-react';
function App() {
return (
<LsDocumentViewer
templateid="YOUR_TEMPLATE_ID"
token="YOUR_AUTH_TOKEN"
mode="compose"
/>
);
}
Airíonna Riachtanacha
token
Do thicéad slándála le haghaidh fíordheimhnithe: ticéad comhpháirte gearrthéarmach ó generateComponentToken nó ón gcríochfoirc REST component-token. Féach Údarás an Widget do shreabhadh slán ticéad.
token="eyJraWQiOiJBTkJIeT..."
templateid
ID API den teimpléad atá uait a thaispeáint do na húsáideoirí. Is féidir leat é seo a fháil trí féachaint ar an URL agus tú ag eagarthóireacht an teimpléid sa Web App.
templateid="dHBsYjQ5YTg5NWQtYWRhMy0xMWYwLWIxZGMtMDY5NzZlZmU0MzIx"
Módanna Widget
Mód Eagarthóra
Cruthú agus eagarthóireacht teimpléid lán-ghnéitheach leis na huirlisí go léir atá ar fáil. Tá sé seo beartaithe do shrutha oibre ina bhfuil teimpléad atá an-úsáidte arís agus arís eile le róil úsáideach. Má tá do chuspóir ach doiciméad a úsáid díreach uair amháin (b'fhéidir gur líon do chóras gineadh doiciméad an t-eolas uile faoin gcliant cheana féin) b'fhéidir gur mhaith leat an modh compose a úsáid seachas.
<ls-document-viewer mode="editor" ...></ls-document-viewer>
Mód Comhcheangail
Is modh 'faighteoir-ar-an gcéad' é an modh seo chun an taithí úsáideora a shruthlíniú. Sa Web App Legalesign seo an fheidhmiúlacht 'Seol Tapa'.
Cuir do ghlacthaí leis an airíonna 'recipients' agus is féidir leis an úsáideoir a shíniú agus réimsí foirme a chur go tapa sula seoltar. Oiriúnach do chliaint chomhtháite ina bhfuil na glacthaí réamhshonraithe cheana féin.
Is é an sreabhadh oibre tipiciúil clónáil nó uaslódáil PDF, ansin an breathnóir a chur isteach áit ar féidir leis an úsáideoir síniú agus réimsí foirme a chur, ansin cnaipe a thabhairt chun an doiciméad a sheoladh.
Clónáil
Clóin teimpléad atá ann cheana trí úsáid a bhaint as an athrú 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;
Nó Uaslódáil
Cruthaigh teimpléad ansin uaslódáil é chuig an uploadUrl atá curtha ar fáil. Úsáid an teideal [deleted] más mian leat nach mbeadh an pdf i do leabharlann. Scriosfar é laistigh den chéad 24 uair an chloig eile. Murab ionann agus sin, bain úsáid as aon teideal is mian leat:
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;
Anois cuir do chomhad PUT chuig an uploadUrl. Caithfidh cineál ábhair a bheith application/pdf.
Cuir an breathnóir isteach
Is é an príomh-airíonna ná 'recipients'. Beidh sonraí breise de dhíth ort do cheadaitheoirí nó fhinnéithe — le haghaidh tuilleadh eolais féach 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>
Déantar i mód compose go huathoibríoch:
- Glacann sé na glacthaí atá réamhghinte
- Ceilt an seoltóra ón liosta anuas
- Ceilt roghanna doiciméid
- Taispeánann sé na réimsí riachtanacha de réir réamhshocraithe
- Baintear an seoltóir agus réimsí seoltóra ón eagarthóir
- Cothaíonn sé roghnú tapa na réimsí riachtanacha do gach glacthaí
Mód Réamhamhairc
Réamhamharc cabhrach do doiciméad a thaispeánann an doiciméad leis na réimsí uile atá ann faoi láthair agus ligeann don úsáideoir brabhsáil tríd na leathanaigh.
<ls-document-viewer mode="preview" ...></ls-document-viewer>
Déantar i mód réamhamhairc go huathoibríoch:
- Ceilt an barra uirlisí
- Ceilt roghanna doiciméid
- Ceilt bosca uirlisí
- Déanann sé rannpháirtithe agus réimsí a léamh-a-amháin
Cumraíocht Chasta
Scagaire Bosca Uirlisí
Treisigh cineálacha réimse atá ar fáil trí luachanna scartha le píopaí a úsáid. Mura dtugtar aon luach amach ansin, déantar glacadh go mbeidh an bosca uirlisí neamhscríofa agus go mbeidh gach rogha ar fáil.
<ls-document-viewer
filtertoolbox="signature|initials|date|text"
...
></ls-document-viewer>
Luachanna scagtha ar fáil:
| Luach | Cur Síos |
|---|---|
signature | Réimse síniú (do shíniú amháin) |
auto sign | Réimse sínithe uathoibríoch (do sheoltóir amháin) |
text | Ionchur téacs saor in aisce |
signing date | Dáta líonta go huathoibríoch ag am na síniú (do shíniú amháin) |
date | Réimse roghnóir dáta |
email | Ionchur ríomhphoist |
initials | Réimse tosaíochtaí |
number | Ionchur uimhriúil |
dropdown | Roghanna anuas |
checkbox | Bosca seiceála |
regex | Ionchur bailíochtaithe le regex (do shíniú amháin) |
image | Uaslódáil íomhá (do shíniú amháin) |
file | Uaslódáil comhaid (do shíniú amháin) |
drawn | Réimse líonta/saorlámhach (do shíniú amháin) |
Glacthaí
Sainmhínigh glacthaí doiciméid i bhformáid JSON.
Is iad na heilimintí riachtanacha do gach glactha ná firstname, lastname, email agus signerIndex;
Is roghnach an róil agus uimhir gutháin a chur isteach do gach glacthaí. Má chuireann tú neamhaird ar róil, déanfar cóir le glacthaí mar shíniú.
Is féidir róil "WITNESS" nó "APPROVER" a sholáthar. Do ról "WITNESS" cuir 100 leis an uimhir signerIndex dá sínitheoir. Mar shampla má theastaíonn finné do shíniú 2 (signerIndex: 2), déan an 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>
Cnaipí Saincheaptha le Sliotáin
Cuir cnaipí saincheaptha leis an mbarra uirlisí ag úsáid sliotán. B'fhéidir go n-úsáidfidh tú iad seo chun an gníomh a chur ar ceal nó chun an doiciméad a sheoladh.
<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>
Láimhseáil Imeachtaí
Éist le himeachtaí comhpháirte chun athruithe a rianú:
const editor = document.querySelector('ls-document-viewer');
editor.addEventListener('update', (event) => {
console.log('Template changed:', event.detail);
});
Is féidir leat rian a fháil ar cibé an bhfuil teimpléad tar éis a bheith bailí nó neamhbhailí ag úsáid an imeachta validate.
const editor = document.querySelector('ls-document-viewer');
editor.addEventListener('validate', (event) => {
console.log('Template validation changed:', event.detail.valid);
});
Sampla Láimhseála Imeachtaí React
Agus imeacht i react á úsáid agat cuirtear réamhtheideal ar nós on<EventName> air.
<LsDocumentViewer
onUpdate={(event) => {
console.log('Template changed:', event.detail);
}}
...
/>
Cineálacha Imeachtaí
Imeacht update
Á lasadh nuair a athraítear an teimpléad doiciméid, mar shampla réimsí a chur leis nó a bhaint. Soláthraítear ní hamháin an imeacht a chuir ar bun é ach freisin an stát nuashonraithe den ruda teimpléid mar JSON.
Imeacht validate
Á lasadh nuair a athraítear an teimpléad doiciméid, léiríonn an mhaoin valid i sonraí an bhfuil an teimpléad tar éis a bheith bailí nó neamhbhailí.
Imeacht selectFields
Á lasadh nuair a roghnaítear réimse san eagarthóir.
Imeacht addParticipant
Á lasadh nuair a chuirtear ról rannpháirtí leis an teimpléad.
Sampla iomlán
<!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>
Seol an doiciméad ón taobh freastalaí ag úsáid d’eochair API, le GraphQL nó REST comhéadan.
- Athrú Seolta — doiciméad aonair a sheoladh
- Scéim Ionchuir Seolta — tagairt ionchuir iomlán
- Seoladh REST - tagairt doiciméad seolta REST
Fadhbanna a Dheisiú
Má théann rud éigin mícheart leis an gcomhpháirt, déan cinnte:
- gur féidir leat rochtain a fháil nó gur liostaigh tú an stóráil doiciméad bán ar https://s3.amazonaws.com/*
Tacú Brabhsálaí
Úsáideann an comhéadan caighdeáin gréasáin nua-aimseartha agus déanann sé tacú le:
- Chrome/Edge (is déanaí)
- Firefox (is déanaí)
- Safari (is déanaí)
- Brabhsálaithe soghluaiste (iOS Safari, Chrome Mobile)
Log Athruithe
| Leagan | Dáta | Achoimre |
|---|---|---|
| v1.0.27 | 19 Deireadh Fómhair 2026 | Feabhsúcháin suíomh réimsí |
| v1.0.26 | 3 Meán Fómhair 2026 | Socruithe scrollaithe; rindreáil moillithe ar an luchtú |
| v1.0.21 | 12 Lúnasa 2026 | Roghanna mód réamhamhairc; feabhsúcháin imeachta update |
| v1.0.18 | 17 Iúil 2026 | Painéal réimse regex; il-réimsí airíonna chun cinn; feabhsúcháin rogha anuas; athainmniú finné |
| v1.0.12 | 10 Iúil 2026 | Airíonna réimse excludeFromPdf |
| v1.0.9 | 9 Iúil 2026 | Dátaí uathoibríoch agus réimsí regex; airíonna forbartha; ord na réimsí |
| v1.0.6 | 2 Iúil 2026 | Socrú cló a choscann teipeanna sínithe; imeall réamhamhairc |
| v1.0.5 | 29 Meitheamh 2026 | Gortar agus athdhéan eochracha |
| v1.0.4 | 26 Meitheamh 2026 | Feabhsúcháin imeachta; nuashonruithe dóchasaí; gortar/athdhéan |
| v1.0.0 | 24 Meitheamh 2026 | Seoladh seasmhach tosaigh |
Acmhainní
- Treoir Comhtháthaithe GraphQL — conas an breathnóir a nascadh leis an API GraphQL chun a sheoladh
- Doiciméadú API GraphQL
- Pacáiste NPM
- Pacáiste React
- Tacaíocht
Ag Faigh Cabhair
Le haghaidh tacaíochta teicniúla nó ceisteanna faoin gcomhtháthú, déan teagmháil le foireann tacaíochta Legalesign nó tabhair cuairt ar an doiciméadú API.