DocumentSigner React components

@castandcrew/document-signer-react NPM packge provides following React components:

• DocumentViewer
• DocumentSigner
• MobileDocumentPane

DocumentViewer

Import:

import DocumentViewer from '@castandcrew/document-signer-react/DocumentViewer';
or;
import { DocumentViewer } from '@castandcrew/document-signer-react';

Props:

| Name | Type | Default | Description | | :------------------- | :---------------------------------------- | :------ | :----------------------------- | | actionBarProps | ActionBar.props | | ActionBar component properties | | actionButtons | Array<React.Component> | | ActionBar buttons | | activeRoleId | | null | | | activeRuleGroupId | | null | | | classes | Object | | | | className | String | | | | currentDocument | Object | | | | documentMappingMode | Boolean | false | | | getDocumentImageUrls | func(documentId: String, page: Integer) | | | | goToField | func(String) | | | | nextDocId | String | | | | prevDocId | String | | | | renderField | func(Object) | | | | setCurrentDocument | func(String) | | | | sideBar | React.Component | | | | throwFatalError | func | | Fatal error handler | | withSidebar | Boolean | false | Render sidebar? | | selectedDocIds | Array' | [] | | isPreviewDocument | Boolean |false |

DocumentSigner

Import:

import DocumentSigner from '@castandcrew/document-signer-react/DocumentSigner';
or;
import { DocumentSigner } from '@castandcrew/document-signer-react';

Props:

| Name | Type | Default | Description | | :------------------------ | :----------------------------------------------------------------------------------------------------------------------------------- | :------ | :-------------------------------------------------------------------------- | | actions | { submit?: Action, cancel?: Action, save?: Action } | | Action object is defined as { text: String, action: func(docs: [Object])} | | actor | { name: String, initials: String } | | Document Actor data | | canApproveOffers | Boolean | | Can Actor approve offers? (We want to remove this) | | classes | { root?: CSSObject, busyOverlay?: CSSObject, busyContainer?: CSSObject, documentSelector?: CSSObject, documentViewer?: CSSObject } | | CSSObject is a Object defining CSS rules | | className | String | | Additional CSS class name for the root HTML element | | documents | Array<Object> | | Array of document objects received from Document-Signer API application | | featureFlags | Array<String> | | Array of enabled Feature-Flag names | | getDocumentImageUrls | func(documentId: UUID, page: Int) | | Function to retreive image for the specific document page | | isDocOne | Bool | false | Is there only 1 document to sign? (We want to remove this) | | isSaveSignatureEnabled | Bool | | Should we offer to save signature for the session lifetime? | | me | Object | | Authneticated user information | | offer | Object | | Offer information | | showI9Note | Bool | | Should we show notification message for I-9 documents? | | styledEngineInjectFirst | Boolean | false | Should StyledEngineProvider inject CSS first? | | templatesAcknowledgeNotes | String | | Acknowledgement Notes | | templatesAcknowledgeTitle | String | | Acknowledgement Title | | throwFatalError | func(message: String) | | Fatal error handler |

MobileDocumentPane

Import:

import MobileDocumentPane from '@castandcrew/document-signer-react/MobileDocumentPane';
or;
import { MobileDocumentPane } from '@castandcrew/document-signer-react';

Props:

| Name | Type | Default | Description | | :--------------- | :----------------------------- | :------ | :---------- | | actor | Object | | | | className | String | | | | isAutosignActive | Boolean | | | | onChangeInput | func(inputId, value) | | | | onDoubleClick | func(Event) | | | | onFocusInput | func(inputId) | | | | onNeedPage | func(pageIndex) | | | | onPageLoadError | func(index, error, tryCount) | | | | pageHeight | Integer | | | | pages | Integer | | | | pageWidth | Integer | | | | scrollContainer | HTMLElement | | | | selectedInputId | String | | | | zoom | Integer | | |