(feat) O3-3866: Allow customized message/dialog for warning when clos… (

#1982)

packages/esm-patient-forms-app/src/htmlformentry/html-form-entry.workspace.tsx

@@ -6,6 +6,7 @@ import {
 } from '@openmrs/esm-patient-common-lib';
 import HtmlFormEntryWrapper from './html-form-entry-wrapper.component';
 import { usePatient } from '@openmrs/esm-framework';
+import { useTranslation } from 'react-i18next';
 
 interface HtmlFormEntryComponentProps extends DefaultPatientWorkspaceProps {
   formInfo: FormEntryProps;
@@ -15,15 +16,24 @@ const HtmlFormEntry: React.FC<HtmlFormEntryComponentProps> = ({
   patientUuid,
   closeWorkspaceWithSavedChanges,
   promptBeforeClosing,
+  setCancelTitle,
+  setCancelMessage,
+  setCancelConfirmText,
   formInfo,
 }) => {
+  const { t } = useTranslation();
   const { patient } = usePatient(patientUuid);
   const { currentVisit } = useVisitOrOfflineVisit(patientUuid);
   const { encounterUuid, visitUuid, htmlForm } = formInfo || {};
 
   // we always want to prompt the user before closing/hiding the workspace because we can't guarantee maintaining the state of the form
   promptBeforeClosing(() => true);
 
+  // custom messaging to display to a user when closing the workspace without using the buttons within the form
+  setCancelTitle(t('warning', 'Warning'));
+  setCancelMessage(t('closeHtmlFormWarning', 'Please use the Save or Cancel button on the form to close the form.'));
+  setCancelConfirmText(t('ignoreWarning', 'Ignore Warning'));
+
   // urls for entering a new form and editing an existing form; note that we specify the returnUrl as post-message:close-workspace,
   // which tells HFE-UI to send a message to the parent window to close the workspace when the form is saved or cancelled
   const url = `${window.openmrsBase}/htmlformentryui/htmlform/${

packages/esm-patient-forms-app/translations/en.json

@@ -1,11 +1,13 @@
 {
   "clinicalForm": "Clinical Form",
   "clinicalForms": "Clinical forms",
+  "closeHtmlFormWarning": "Please use the Save or Cancel button on the {{title}} form to close the form.",
   "editForm": "Edit form",
   "formName": "Form Name (A-Z)",
   "forms": "Forms",
   "formSearchHint": "Try searching for the form using an alternative name or keyword",
   "homeOverviewCardView": "View",
+  "ignoreWarning": "Ignore Warning",
   "lastCompleted": "Last completed",
   "never": "Never",
   "noFormsToDisplay": "There are no forms to display.",
@@ -21,5 +23,6 @@
   "offlinePatientsTableSearchPlaceholder": "Search this list",
   "offlineToggle": "Offline toggle",
   "searchForAForm": "Search for a form",
-  "searchThisList": "Search this list"
+  "searchThisList": "Search this list",
+  "warning": "Warning"
 }