Skip to content
This repository was archived by the owner on Jan 30, 2026. It is now read-only.

Commit 1779d28

Browse files
committed
docs: update README to reflect changes in document mode options and simplify component props
1 parent c36142a commit 1779d28

1 file changed

Lines changed: 9 additions & 23 deletions

File tree

README.md

Lines changed: 9 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,9 @@ function App() {
7171
```jsx
7272
document={{
7373
source: File | Blob | string, // Required
74-
mode: 'full' | 'download_only' | 'preview',
74+
mode: 'full' | 'download' | 'preview',
7575
displayOptions: {
76-
scrollRequired: boolean,
77-
watermark: boolean
76+
scrollRequired: boolean
7877
}
7978
}}
8079
```
@@ -154,9 +153,7 @@ fields={{
154153
alias: 'field_ref', // Optional alias for document references
155154
type: 'signature' | 'consent' | 'checkbox' | 'text',
156155
validation: {
157-
required: boolean,
158-
minLength: number,
159-
maxLength: number
156+
required: boolean
160157
},
161158
label: 'Field Label',
162159
component: CustomComponent // Optional - consistent with download/submit!
@@ -171,14 +168,11 @@ Simple customization:
171168
```jsx
172169
download={{
173170
fileName: "contract.pdf",
174-
label: "Download Contract",
175-
variant: "secondary"
171+
label: "Download Contract"
176172
}}
177173

178174
submit={{
179-
label: "Sign Document",
180-
loadingLabel: "Processing...",
181-
variant: "primary"
175+
label: "Sign Document"
182176
}}
183177
```
184178

@@ -368,15 +362,11 @@ fields={{
368362

369363
download={{
370364
fileName: 'service_agreement_signed.pdf',
371-
label: 'Download Agreement',
372-
variant: 'secondary'
365+
label: 'Download Agreement'
373366
}}
374367

375368
submit={{
376-
label: 'Sign Agreement',
377-
loadingLabel: 'Processing...',
378-
invalidLabel: 'Please complete all required fields',
379-
variant: 'success'
369+
label: 'Sign Agreement'
380370
}}
381371

382372
onSubmit={async (data) => {
@@ -412,7 +402,7 @@ The component supports three levels of customization:
412402
<SuperDocESign
413403
eventId="session-2"
414404
document={{ source: "doc.pdf" }}
415-
submit={{ label: "I Agree", variant: "success" }}
405+
submit={{ label: "I Agree" }}
416406
download={{ label: "Get Copy" }}
417407
onSubmit={handleSubmit}
418408
/>
@@ -448,8 +438,4 @@ import type {
448438
SignerField,
449439
FieldComponentProps
450440
} from '@superdoc-dev/esign';
451-
```
452-
453-
## License
454-
455-
MIT
441+
```

0 commit comments

Comments
 (0)