@oneblink/apps-react 8.6.1 → 8.7.0-beta.2

package/dist/OneBlinkForm.d.ts

@@ -336,6 +336,7 @@ declare const OneBlinkFormControlled: React.NamedExoticComponent<import("./OneBl
     abnLookupAuthenticationGuid?: string;
     captchaSiteKey?: string;
     buttons?: import("@oneblink/types/typescript/formsApps").FormsListStyles["buttons"];
+    validationIcon?: import("@oneblink/types/typescript/environments").FormsAppEnvironmentStyles["validationIcon"];
     attachmentRetentionInDays?: number;
     isPendingQueueEnabled: boolean;
     onSaveDraft?: (newDraftSubmission: import("@oneblink/apps/dist/submission-service").NewDraftSubmission) => unknown;
@@ -578,6 +579,7 @@ declare const OneBlinkFormUncontrolled: React.NamedExoticComponent<import("./One
     abnLookupAuthenticationGuid?: string;
     captchaSiteKey?: string;
     buttons?: import("@oneblink/types/typescript/formsApps").FormsListStyles["buttons"];
+    validationIcon?: import("@oneblink/types/typescript/environments").FormsAppEnvironmentStyles["validationIcon"];
     attachmentRetentionInDays?: number;
     isPendingQueueEnabled: boolean;
     onSaveDraft?: (newDraftSubmission: import("@oneblink/apps/dist/submission-service").NewDraftSubmission) => unknown;

package/dist/OneBlinkFormBase.d.ts

@@ -1,6 +1,6 @@
 import * as React from 'react';
 import { submissionService, attachmentsService } from '@oneblink/apps';
-import { FormTypes, FormsAppsTypes, ScheduledTasksTypes, SubmissionTypes } from '@oneblink/types';
+import { EnvironmentTypes, FormTypes, FormsAppsTypes, ScheduledTasksTypes, SubmissionTypes } from '@oneblink/types';
 import { ReplaceInjectablesOverrides } from './hooks/useReplaceInjectablesOverrides';
 import { CaptchaType, ExecutedLookups, SetFormSubmission, SectionState } from './types/form';
 export type OneBlinkReadOnlyFormProps = {
@@ -60,6 +60,8 @@ export type OneBlinkFormBaseProps = OneBlinkReadOnlyFormProps & {
     captchaSiteKey?: string;
     /** Change properties for certain buttons on the form. */
     buttons?: FormsAppsTypes.FormsListStyles['buttons'];
+    /** Set a custom validation icon and accessible label. */
+    validationIcon?: EnvironmentTypes.FormsAppEnvironmentStyles['validationIcon'];
     /** Number of days attachments are retained for. */
     attachmentRetentionInDays?: number;
     /**
@@ -138,6 +140,6 @@ export type OneBlinkFormControlledProps = {
 type Props = OneBlinkFormBaseProps & OneBlinkFormControlledProps & {
     isReadOnly: boolean;
 };
-declare function OneBlinkFormBase({ googleMapsApiKey, abnLookupAuthenticationGuid, captchaSiteKey, definition, disabled, isPreview, submission, isReadOnly, onCancel, onSubmit, onSaveDraft, setFormSubmission, buttons, primaryColour, attachmentRetentionInDays, isPendingQueueEnabled, handleNavigateAway, isInfoPage: isInfoPageProp, lastElementUpdated, executedLookups, task, taskGroup, taskGroupInstance, onUploadAttachment, captchaType, shouldUseNavigableValidationErrorsNotification, navigableValidationErrorsNotificationSettings, replaceInjectablesOverrides, sectionState, }: Props): React.JSX.Element;
+declare function OneBlinkFormBase({ googleMapsApiKey, abnLookupAuthenticationGuid, captchaSiteKey, definition, disabled, isPreview, submission, isReadOnly, onCancel, onSubmit, onSaveDraft, setFormSubmission, buttons, validationIcon, primaryColour, attachmentRetentionInDays, isPendingQueueEnabled, handleNavigateAway, isInfoPage: isInfoPageProp, lastElementUpdated, executedLookups, task, taskGroup, taskGroupInstance, onUploadAttachment, captchaType, shouldUseNavigableValidationErrorsNotification, navigableValidationErrorsNotificationSettings, replaceInjectablesOverrides, sectionState, }: Props): React.JSX.Element;
 declare const _default: React.MemoExoticComponent<typeof OneBlinkFormBase>;
 export default _default;

package/dist/OneBlinkFormBase.js

@@ -40,8 +40,10 @@ import MaterialIcon from './components/MaterialIcon';
 import ValidationErrorsCard from './components/ValidationErrorsCard';
 import { sendGoogleAnalyticsEvent } from './utils/sendGoogleAnalyticsEvent';
 import { useUserProfileForInjectablesOutsideContext } from './hooks/useUserProfileForInjectables';
-function OneBlinkFormBase({ googleMapsApiKey, abnLookupAuthenticationGuid, captchaSiteKey, definition, disabled, isPreview, submission, isReadOnly, onCancel, onSubmit, onSaveDraft, setFormSubmission, buttons, primaryColour, attachmentRetentionInDays, isPendingQueueEnabled, handleNavigateAway, isInfoPage: isInfoPageProp, lastElementUpdated, executedLookups, task, taskGroup, taskGroupInstance, onUploadAttachment, captchaType, shouldUseNavigableValidationErrorsNotification = true, navigableValidationErrorsNotificationSettings, replaceInjectablesOverrides, sectionState, }) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
+import OneBlinkFormFooter from './components/OneBlinkFormFooter';
+import { ValidationIconConfigurationContext } from './hooks/useValidationIconConfiguration';
+function OneBlinkFormBase({ googleMapsApiKey, abnLookupAuthenticationGuid, captchaSiteKey, definition, disabled, isPreview, submission, isReadOnly, onCancel, onSubmit, onSaveDraft, setFormSubmission, buttons, validationIcon, primaryColour, attachmentRetentionInDays, isPendingQueueEnabled, handleNavigateAway, isInfoPage: isInfoPageProp, lastElementUpdated, executedLookups, task, taskGroup, taskGroupInstance, onUploadAttachment, captchaType, shouldUseNavigableValidationErrorsNotification = true, navigableValidationErrorsNotificationSettings, replaceInjectablesOverrides, sectionState, }) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t;
     const isOffline = useIsOffline();
     const { isUsingFormsKey } = useAuth();
     const userProfileForInjectables = useUserProfileForInjectablesOutsideContext(replaceInjectablesOverrides === null || replaceInjectablesOverrides === void 0 ? void 0 : replaceInjectablesOverrides.getUserProfile);
@@ -742,13 +744,14 @@ function OneBlinkFormBase({ googleMapsApiKey, abnLookupAuthenticationGuid, captc
                                                     React.createElement(InjectPagesContext.Provider, { value: handlePagesLookupResult },
                                                         React.createElement(GoogleMapsApiKeyContext.Provider, { value: googleMapsApiKey },
                                                             React.createElement(AbnLookupAuthenticationGuidContext.Provider, { value: abnLookupAuthenticationGuid },
-                                                                React.createElement(CaptchaContext.Provider, { value: captchaContextValue },
-                                                                    React.createElement(AttachmentBlobsProvider, null,
-                                                                        React.createElement(FormIsReadOnlyContext.Provider, { value: isReadOnly },
-                                                                            React.createElement(TaskContext.Provider, { value: taskContextValue },
-                                                                                React.createElement(OnUploadAttachmentContext.Provider, { value: onUploadAttachment }, visiblePages.map((pageElement) => (React.createElement(PageFormElements, { key: pageElement.id, isActive: pageElement.id ===
-                                                                                        currentPage.id, formId: definition.id, formElementsConditionallyShown: formElementsConditionallyShown, formElementsValidation: formElementsValidation, displayValidationMessages: hasAttemptedSubmit ||
-                                                                                        isDisplayingCurrentPageError, pageElement: pageElement, onChange: handleChange, model: submission, setFormSubmission: setFormSubmission, sectionState: sectionState })))))))))))),
+                                                                React.createElement(ValidationIconConfigurationContext.Provider, { value: validationIcon },
+                                                                    React.createElement(CaptchaContext.Provider, { value: captchaContextValue },
+                                                                        React.createElement(AttachmentBlobsProvider, null,
+                                                                            React.createElement(FormIsReadOnlyContext.Provider, { value: isReadOnly },
+                                                                                React.createElement(TaskContext.Provider, { value: taskContextValue },
+                                                                                    React.createElement(OnUploadAttachmentContext.Provider, { value: onUploadAttachment }, visiblePages.map((pageElement) => (React.createElement(PageFormElements, { key: pageElement.id, isActive: pageElement.id ===
+                                                                                            currentPage.id, formId: definition.id, formElementsConditionallyShown: formElementsConditionallyShown, formElementsValidation: formElementsValidation, displayValidationMessages: hasAttemptedSubmit ||
+                                                                                            isDisplayingCurrentPageError, pageElement: pageElement, onChange: handleChange, model: submission, setFormSubmission: setFormSubmission, sectionState: sectionState }))))))))))))),
                                                 isShowingMultiplePages && (React.createElement("div", { className: "steps-actions" },
                                                     React.createElement("div", { className: "steps-action" },
                                                         React.createElement("button", { type: "button", onClick: goToPreviousPage, disabled: isFirstVisiblePage, className: "button is-light cypress-pages-previous" },
@@ -784,16 +787,17 @@ function OneBlinkFormBase({ googleMapsApiKey, abnLookupAuthenticationGuid, captc
                                                         React.createElement(CustomisableButtonInner, { label: isInfoPage
                                                                 ? 'Done'
                                                                 : ((_e = buttons === null || buttons === void 0 ? void 0 : buttons.submit) === null || _e === void 0 ? void 0 : _e.label) || 'Submit', icon: (_f = buttons === null || buttons === void 0 ? void 0 : buttons.submit) === null || _f === void 0 ? void 0 : _f.icon })))))))),
+                                    !!((_g = definition.footer) === null || _g === void 0 ? void 0 : _g.html) && (React.createElement(OneBlinkFormFooter, { footer: (_h = definition.footer) === null || _h === void 0 ? void 0 : _h.html })),
                                     !isReadOnly && !isPreview && (React.createElement(React.Fragment, null,
                                         React.createElement(Prompt, { when: isDirty && !isNavigationAllowed, message: handleBlockedNavigation }),
                                         React.createElement(Modal, { isOpen: hasConfirmedNavigation === false, title: "Unsaved Changes", cardClassName: "cypress-cancel-confirm", titleClassName: "cypress-cancel-confirm-title", bodyClassName: "cypress-cancel-confirm-body", actions: React.createElement(React.Fragment, null,
                                                 onSaveDraft && (React.createElement("button", { type: "button", className: "button ob-button is-success cypress-cancel-confirm-save-draft", onClick: () => handleSaveDraft(false) },
-                                                    React.createElement(CustomisableButtonInner, { label: ((_g = buttons === null || buttons === void 0 ? void 0 : buttons.saveDraft) === null || _g === void 0 ? void 0 : _g.label) || 'Save Draft', icon: (_h = buttons === null || buttons === void 0 ? void 0 : buttons.saveDraft) === null || _h === void 0 ? void 0 : _h.icon }))),
+                                                    React.createElement(CustomisableButtonInner, { label: ((_j = buttons === null || buttons === void 0 ? void 0 : buttons.saveDraft) === null || _j === void 0 ? void 0 : _j.label) || 'Save Draft', icon: (_k = buttons === null || buttons === void 0 ? void 0 : buttons.saveDraft) === null || _k === void 0 ? void 0 : _k.icon }))),
                                                 React.createElement("span", { style: { flex: 1 } }),
                                                 React.createElement("button", { type: "button", className: "button ob-button is-light cypress-cancel-confirm-back", onClick: handleKeepGoing },
-                                                    React.createElement(CustomisableButtonInner, { label: ((_j = buttons === null || buttons === void 0 ? void 0 : buttons.cancelPromptNo) === null || _j === void 0 ? void 0 : _j.label) || 'Back', icon: (_k = buttons === null || buttons === void 0 ? void 0 : buttons.cancelPromptNo) === null || _k === void 0 ? void 0 : _k.icon })),
+                                                    React.createElement(CustomisableButtonInner, { label: ((_l = buttons === null || buttons === void 0 ? void 0 : buttons.cancelPromptNo) === null || _l === void 0 ? void 0 : _l.label) || 'Back', icon: (_m = buttons === null || buttons === void 0 ? void 0 : buttons.cancelPromptNo) === null || _m === void 0 ? void 0 : _m.icon })),
                                                 React.createElement("button", { type: "button", className: "button ob-button is-primary cypress-cancel-confirm-discard", onClick: handleDiscardUnsavedChanges, autoFocus: true },
-                                                    React.createElement(CustomisableButtonInner, { label: ((_l = buttons === null || buttons === void 0 ? void 0 : buttons.cancelPromptYes) === null || _l === void 0 ? void 0 : _l.label) || 'Discard', icon: (_m = buttons === null || buttons === void 0 ? void 0 : buttons.cancelPromptYes) === null || _m === void 0 ? void 0 : _m.icon }))) },
+                                                    React.createElement(CustomisableButtonInner, { label: ((_o = buttons === null || buttons === void 0 ? void 0 : buttons.cancelPromptYes) === null || _o === void 0 ? void 0 : _o.label) || 'Discard', icon: (_p = buttons === null || buttons === void 0 ? void 0 : buttons.cancelPromptYes) === null || _p === void 0 ? void 0 : _p.icon }))) },
                                             React.createElement("p", null, "You have unsaved changes, are you sure you want discard them?")),
                                         React.createElement(Modal, { isOpen: promptUploadingAttachments === true, title: "Attachment upload in progress", cardClassName: "cypress-attachments-wait-continue", titleClassName: "cypress-attachments-confirm-wait-title", bodyClassName: "cypress-attachments-confirm-wait-body", actions: React.createElement(React.Fragment, null,
                                                 React.createElement("span", { style: { flex: 1 } }),
@@ -802,7 +806,7 @@ function OneBlinkFormBase({ googleMapsApiKey, abnLookupAuthenticationGuid, captc
                                             React.createElement("p", null, "Your attachments are still uploading, do you want to wait for the uploads to complete or continue using the app? If you click continue the attachments will upload in the background. Do not close the app until the upload has been completed.")),
                                         React.createElement(Modal, { isOpen: promptOfflineSubmissionAttempt, title: "It looks like you're Offline", className: "ob-modal__offline-submission-attempt", cardClassName: "cypress-submission-offline has-text-centered", titleClassName: "cypress-offline-title", bodyClassName: "cypress-offline-body", actions: React.createElement(React.Fragment, null,
                                                 onSaveDraft && (React.createElement("button", { type: "button", className: "button ob-button ob-button__offline-submission-attempt-save-draft is-success", onClick: () => handleSaveDraft(false) },
-                                                    React.createElement(CustomisableButtonInner, { label: ((_o = buttons === null || buttons === void 0 ? void 0 : buttons.saveDraft) === null || _o === void 0 ? void 0 : _o.label) || 'Save Draft', icon: (_p = buttons === null || buttons === void 0 ? void 0 : buttons.saveDraft) === null || _p === void 0 ? void 0 : _p.icon }))),
+                                                    React.createElement(CustomisableButtonInner, { label: ((_q = buttons === null || buttons === void 0 ? void 0 : buttons.saveDraft) === null || _q === void 0 ? void 0 : _q.label) || 'Save Draft', icon: (_r = buttons === null || buttons === void 0 ? void 0 : buttons.saveDraft) === null || _r === void 0 ? void 0 : _r.icon }))),
                                                 React.createElement("span", { style: { flex: 1 } }),
                                                 React.createElement("button", { className: "button ob-button ob-button__offline-submission-attempt-cancel is-light", onClick: () => setPromptOfflineSubmissionAttempt(false) }, "Cancel"),
                                                 React.createElement("button", { className: "button ob-button ob-button__offline-submission-attempt-try-again is-primary", onClick: (e) => {
@@ -815,12 +819,12 @@ function OneBlinkFormBase({ googleMapsApiKey, abnLookupAuthenticationGuid, captc
                                                     ' ',
                                                     "Alternatively, click the",
                                                     ' ',
-                                                    React.createElement("b", null, ((_q = buttons === null || buttons === void 0 ? void 0 : buttons.saveDraft) === null || _q === void 0 ? void 0 : _q.label) || 'Save Draft'),
+                                                    React.createElement("b", null, ((_s = buttons === null || buttons === void 0 ? void 0 : buttons.saveDraft) === null || _s === void 0 ? void 0 : _s.label) || 'Save Draft'),
                                                     ' ',
                                                     "button below to come back to this later."))),
                                             React.createElement(MaterialIcon, { className: "has-text-warning icon-x-large ob-modal__offline-submission-attempt-icon" }, "wifi_off")))),
                                     shouldUseNavigableValidationErrorsNotification &&
-                                        isShowingValidationErrorsCard && (React.createElement(ValidationErrorsCard, { visiblePages: visiblePages, formElementsValidation: formElementsValidation, setPageId: setPageId, currentPage: currentPage, navigationTopOffset: (_r = navigableValidationErrorsNotificationSettings === null || navigableValidationErrorsNotificationSettings === void 0 ? void 0 : navigableValidationErrorsNotificationSettings.navigationTopOffset) !== null && _r !== void 0 ? _r : 'CALCULATE', scrollableContainerId: navigableValidationErrorsNotificationSettings === null || navigableValidationErrorsNotificationSettings === void 0 ? void 0 : navigableValidationErrorsNotificationSettings.scrollableContainerId, validationErrorToastFocusElementRef: validationErrorToastFocusElementRef })))))))))));
+                                        isShowingValidationErrorsCard && (React.createElement(ValidationErrorsCard, { visiblePages: visiblePages, formElementsValidation: formElementsValidation, setPageId: setPageId, currentPage: currentPage, navigationTopOffset: (_t = navigableValidationErrorsNotificationSettings === null || navigableValidationErrorsNotificationSettings === void 0 ? void 0 : navigableValidationErrorsNotificationSettings.navigationTopOffset) !== null && _t !== void 0 ? _t : 'CALCULATE', scrollableContainerId: navigableValidationErrorsNotificationSettings === null || navigableValidationErrorsNotificationSettings === void 0 ? void 0 : navigableValidationErrorsNotificationSettings.scrollableContainerId, validationErrorToastFocusElementRef: validationErrorToastFocusElementRef })))))))))));
 }
 export default React.memo(OneBlinkFormBase);
 //# sourceMappingURL=OneBlinkFormBase.js.map