@openmrs/esm-user-onboarding-app 4.0.1-pre.97 → 4.0.1-pre.98

package/src/config-schema.ts

@@ -11,13 +11,15 @@ export const configSchema = {
     _description: 'List of tutorials to be displayed in the modal',
     _default: [
       {
-        title: 'Basic Tutorial',
-        description: 'Learn how to efficiently search for patients, register new patients, access user settings, and view ongoing visits and appointments.',
-        steps: [{
-          target: '[aria-label="OpenMRS"]',
-          content: 'Welcome to OpenMRS! This is the main dashboard where you can navigate to various features of the system.',
-          disableBeacon: true
-        },
+        title: 'Basic Overview',
+        description:
+          'This guide provides a quick look at the essential components that shape the layout and user experience of our homepage.',
+        steps: [
+          {
+            target: '[aria-label="OpenMRS"]',
+            content:
+              'Welcome to OpenMRS! This is the main dashboard where you can navigate to various features of the system.',
+          },
           {
             target: '[name="SearchPatientIcon"]',
             content: 'This is the search icon. Use it to find patients in the system quickly.',
@@ -30,90 +32,15 @@ export const configSchema = {
             target: '[name="User"]',
             content: 'The user icon. Click here to change your user preferences and settings.',
           },
-          {
-            target: '[data-extension-id="active-visits-widget"]',
-            content: 'This table displays active visits. Here you can see all the ongoing patient visits.',
-          },
-          {
-            target: '[data-extension-id="home-appointments"]',
-            content: 'This table shows appointments. View and manage patient appointments from this section.',
-          },
-        ],
-      },
-      {
-        title: 'Tutorial for demo purposes',
-        description: 'This tutorial is for demo / debugging purposes only',
-        steps: [
-          {
-            target: '[aria-label="OpenMRS"]',
-            title: 'Let us walk through the tutorial features together.',
-            disableBeacon: true,
-          },
-          {
-            target: '[data-extension-id="clinical-appointments-dashboard-link"]',
-            title:
-              'Click on this link. This step is configured to be automatic and will take you to the next step. Once the given query selector resolves an element on the page, it will proceed automatically.',
-            hideCloseButton: true,
-            hideNextButton: true,
-            disableOverlayClose: true,
-            spotlightClicks: true,
-            data: {
-              autoNextOn: '[data-extension-id="clinical-appointments-dashboard"]',
-            },
-          },
-          {
-            target: '[data-extension-id="clinical-appointments-dashboard"]',
-            title: 'Congrats! You have reached the clinical appointments dashboard.',
-            disableOverlayClose: true,
-          },
-          {
-            target: '[aria-label="OpenMRS"]',
-            title:
-              'Now, let’s see how this behaves when elements take a bit longer to load. Set your network throttling to "Slow 3G" and hit "Next".',
-            disableOverlayClose: true,
-            hideBackButton: true,
-          },
-          {
-            target: '[data-extension-id="laboratory-dashboard-link"]',
-            title:
-              'Let\'s navigate to the laboratory page. Our next target is the "Tests Ordered" table. I’ll disappear once you reach the laboratory page and reappear when the table is loaded. See you there!',
-            hideCloseButton: true,
-            hideNextButton: true,
-            disableOverlayClose: true,
-            spotlightClicks: true,
-            data: {
-              autoNextOn: '[data-extension-id="laboratory-dashboard"]',
-            },
-          },
-          {
-            target: '[data-extension-id="all-lab-requests-table"] table',
-            title:
-              "It's me again. By default, I'll wait for the element to appear, so you don't have to worry about slow components when writing a new tutorial.",
-            disableOverlayClose: true,
-            hideBackButton: true,
-          },
-          {
-            target: '[aria-label="OpenMRS"]',
-            title:
-              "Now let's do a fun exercise. Can you find out how to view a patient's allergies on your own? Feel free to turn off network throttling. ;) ",
-          },
-          {
-            target: '[data-extension-slot-name="patient-chart-allergies-dashboard-slot"]',
-            title:
-              'Great job! You found the allergies section! This is the end of the tutorial. Feel free to explore the system on your own or check out the other tutorials.',
-          },
         ],
       },
       {
-        title: 'Patient Registration Tutorial',
+        title: 'Registering a Patient',
         description: 'Learn how to register a new patient into the system.',
         steps: [
           {
             target: '[name="AddPatientIcon"]',
-            title: 'Add Patient',
             content: 'Click here to add a patient to the system.',
-            disableBeacon: true,
-            disableOverlayClose: true,
             spotlightClicks: true,
             hideCloseButton: true,
             hideNextButton: true,
@@ -127,41 +54,33 @@ export const configSchema = {
             title: 'Demographics',
             content:
               'This is the Demographics section. Here you can find various fields and information related to the patient.',
-            disableBeacon: true,
             hideBackButton: true,
           },
           {
             target: '#contact',
             title: 'Contact Details',
             content: "Here you can update the patient's contact information.",
-            disableBeacon: true,
           },
           {
             target: '#relationships',
             title: 'Relationships',
             content: "In this section, you can manage the patient's relationships.",
-            disableBeacon: true,
           },
           {
             target: 'button[type="submit"]',
-            title: 'Register Patient',
             content: "Click this button to register the patient's information into the system.",
-            disableBeacon: true,
           },
         ],
       },
       {
-        title: 'Patient Chart Tutorial',
+        title: 'Patient Chart',
         description:
           'Patient chart is the main point of interaction between healthcare professionals and patient data, where you can manage everything related to a single patient.',
         steps: [
           {
             target: '[data-testid="searchPatientIcon"]',
-            title: 'Search icon',
             content:
               'To access the patient chart, first, you need to select a patient. To start, click here to open the search box so that we can search for a patient.',
-            disableBeacon: true,
-            disableOverlayClose: true,
             spotlightClicks: true,
             hideNextButton: true,
             data: {
@@ -170,12 +89,10 @@ export const configSchema = {
           },
           {
             target: '[data-testid="patientSearchBar"]',
-            title: 'Search box',
             content:
               'Now, enter the name or the ID of the patient here. Some example patient names that you can search for are: John, Smith, Mary.',
             hideNextButton: true,
             hideBackButton: true,
-            disableOverlayClose: true,
             spotlightClicks: true,
             data: {
               autoNextOn: '[data-testid="floatingSearchResultsContainer"]',
@@ -183,11 +100,9 @@ export const configSchema = {
           },
           {
             target: '[data-testid="floatingSearchResultsContainer"]',
-            title: 'Search results',
             content: 'Click on the patient you want to go to their patient chart.',
             spotlightClicks: true,
-            disableOverlayClose: true,
-            disableOverlay : true,
+            disableOverlay: true,
             placement: 'left',
             hideNextButton: true,
             hideBackButton: true,
@@ -198,9 +113,9 @@ export const configSchema = {
           {
             target: 'body',
             title: 'Patient Chart',
-            content: "Welcome to the Patient Chart View! Here, you can quickly see everything about your patient's health history, visits, medications, allergies, and test results—all in one place. It's designed to help you provide the best care efficiently.",
+            content:
+              "Welcome to the Patient Chart View! Here, you can quickly see everything about your patient's health history, visits, medications, allergies, and test results—all in one place. It's designed to help you provide the best care efficiently.",
             spotlightClicks: true,
-            disableOverlayClose: true,
             hideBackButton: true,
             placement: 'center',
           },
@@ -209,7 +124,6 @@ export const configSchema = {
             title: 'Patient header',
             content:
               'The patient header contains all the key information you need to identify the patient you are currently viewing. You can click on the "Show Details" button to see additional patient information.',
-            disableOverlayClose: true,
             spotlightClicks: true,
             hideBackButton: true,
           },
@@ -218,7 +132,6 @@ export const configSchema = {
             title: 'Left panel',
             content:
               'The left panel shows the sections of the patient chart. Currently, we are on the patient summary page.',
-            disableOverlayClose: true,
             spotlightClicks: true,
             placement: 'right',
           },
@@ -227,7 +140,6 @@ export const configSchema = {
             title: 'Patient summary widgets',
             content:
               'Patient Summary is a personalized view made up of widgets that show essential features and information for quick access.',
-            disableOverlayClose: true,
           },
           {
             target: '[data-extension-slot-name="action-menu-patient-chart-items-slot"]',
@@ -237,23 +149,20 @@ export const configSchema = {
           },
           {
             target: 'body',
-            title:
+            content:
               "Great job! You've completed the tutorial. Now, take a moment to explore the Patient Chart View and discover all its features. Feel free to navigate around and get comfortable with the layout. If you need to return to the home page, just click the close button in the top right corner. Happy exploring!",
-            disableOverlayClose: true,
             placement: 'center',
           },
         ],
       },
       {
-        title: 'Patient Search',
-        description: 'Learn how to find a patient in the system using basic and advanced search features, including the use of filters to refine results.',
+        title: 'Finding a Patient',
+        description:
+          'Learn how to find a patient in the system using basic and advanced search features, including the use of filters to refine results.',
         steps: [
           {
             target: '[data-testid="searchPatientIcon"]',
-            title: 'Search icon',
             content: 'Click on the search icon to open the search box so that we can search for a patient.',
-            disableBeacon: true,
-            disableOverlayClose: true,
             spotlightClicks: true,
             hideNextButton: true,
             data: {
@@ -262,12 +171,10 @@ export const configSchema = {
           },
           {
             target: '[data-testid="patientSearchBar"]',
-            title: 'Search box',
             content:
               'Now, enter the name of the patient here. If you know the patient ID, you can use that as well. You will see the results if the patient you entered exists in the system. Some example patient names that you can search for are: John, Smith, Mary.',
             hideNextButton: true,
             hideBackButton: true,
-            disableOverlayClose: true,
             spotlightClicks: true,
             data: {
               autoNextOn: '[data-testid="floatingSearchResultsContainer"]',
@@ -275,11 +182,9 @@ export const configSchema = {
           },
           {
             target: 'button[type="submit"]',
-            title: 'Search button',
             content:
               'If there are a lot of patients in the system, you may need additional fields to search other than the name. Also, the patient you are looking for may not be displayed in the top results if there are multiple patients with the same name. In these scenarios, you can click here to open the advanced search.',
             spotlightClicks: true,
-            disableOverlayClose: true,
             placement: 'bottom',
             hideNextButton: true,
             hideBackButton: true,
@@ -293,22 +198,18 @@ export const configSchema = {
             content:
               'You can refine your search by applying filters such as date of birth, age, sex, and phone number here.',
             spotlightClicks: true,
-            disableOverlayClose: true,
             hideBackButton: true,
           },
           {
             target: '[data-openmrs-role="Search Results"]',
-            title: 'Search results',
             content:
               'Here you can see all the patients who match the search criteria. Clicking on a patient will open the patient’s patient chart.',
-            disableOverlayClose: true,
             placement: 'right',
           },
           {
             target: '[data-testid="closeSearchIcon"]',
             content: 'That’s the end of the tutorial. Click on the close button to go back to the home page.',
             spotlightClicks: true,
-            disableOverlayClose: true,
             placement: 'bottom',
             hideNextButton: true,
             hideBackButton: true,
@@ -327,7 +228,6 @@ export const configSchema = {
             target: '[data-extension-id="patient-lists-dashboard-link"]',
             content:
               'Creating a patient list is a great way to keep a group of patients organized for easier management. Click here to go to the patient lists view',
-            disableBeacon: true,
             spotlightClicks: true,
             hideNextButton: true,
             data: {
@@ -347,7 +247,6 @@ export const configSchema = {
           },
           {
             target: '[data-openmrs-role="New List"]',
-            title: 'New List',
             content: "Now, let's try creating a new list. Click here to open the new patient list form.",
             spotlightClicks: true,
             placement: 'left',
@@ -359,10 +258,8 @@ export const configSchema = {
           },
           {
             target: '[data-openmrs-role="Patient List Form"]',
-            title: 'Patient List Form',
             content: 'Enter the necessary details and click on "Create List" to create the list.',
             spotlightClicks: true,
-
             hideBackButton: true,
             hideNextButton: true,
             placement: 'left',
@@ -372,7 +269,6 @@ export const configSchema = {
           },
           {
             target: '[data-testid="patientListsTable"]',
-            title: 'Patient Lists table',
             content:
               'Great! We have successfully created a new patient list. Find and click on the patient list you created to proceed. You can use the search option at the top right if needed.',
             disableOverlay: true,
@@ -394,7 +290,6 @@ export const configSchema = {
             target: '[data-testid="searchPatientIcon"]',
             content:
               'To add a patient to the list, we have to go to the respective patient’s chart view. Click here to open the search box so that we can search for a patient.',
-            disableBeacon: true,
             spotlightClicks: true,
             hideNextButton: true,
             hideBackButton: true,
@@ -455,7 +350,6 @@ export const configSchema = {
             target: '[aria-label="Close"]',
             content:
               "We have successfully added a patient to the patient list. Let's go back to the patient lists by closing the patient chart by clicking here.",
-
             spotlightClicks: true,
             hideBackButton: true,
             hideNextButton: true,
@@ -467,13 +361,12 @@ export const configSchema = {
             target: '[data-testid="patientsTable"]',
             title: 'Patients List',
             content: 'You can see the added patient on the list of patients.',
-
             spotlightClicks: true,
             hideBackButton: true,
           },
           {
             target: 'body',
-            title:
+            content:
               'Congrats! You have now completed the tutorial on creating patient lists and adding patients to the lists.',
             placement: 'center',
             hideBackButton: true,
@@ -481,21 +374,19 @@ export const configSchema = {
         ],
       },
       {
-        title: 'Capture Vitals',
+        title: 'Recording Vitals',
         description:
-          'Learn how to record a patient\'s vitals and biometric data, and review the records through the patient chart.',
+          "Learn how to record a patient's vitals and biometric data, and review the records through the patient chart.",
         steps: [
           {
             target: '[data-testid="searchPatientIcon"]',
             content:
               'To capture the vitals of a patient, you need to start by going to the patient chart view of the respective patient. Click on the search icon to open the search box so that you can search for the patient.',
-            disableBeacon: true,
-            disableOverlayClose: true,
             spotlightClicks: true,
             hideNextButton: true,
             data: {
-               autoNextOn: '[data-testid="patientSearchBar"]'
-              },
+              autoNextOn: '[data-testid="patientSearchBar"]',
+            },
           },
           {
             target: '[data-testid="patientSearchBar"]',
@@ -503,16 +394,14 @@ export const configSchema = {
               'Now, enter the name or the ID of the patient here. Some example patient names you can search for are: John, Smith, Mary.',
             hideNextButton: true,
             hideBackButton: true,
-            disableOverlayClose: true,
             spotlightClicks: true,
-            data: { 
-              autoNextOn: '[data-testid="floatingSearchResultsContainer"]'
+            data: {
+              autoNextOn: '[data-testid="floatingSearchResultsContainer"]',
             },
           },
           {
             target: '[data-testid="floatingSearchResultsContainer"]',
             content: 'Click on the patient to go to their patient chart.',
-            disableOverlayClose: true,
             placement: 'left',
             spotlightClicks: true,
             hideBackButton: true,
@@ -523,10 +412,8 @@ export const configSchema = {
           },
           {
             target: '[data-extension-id="patient-vitals-info"] button',
-            title: 'Record Vitals',
             content:
-              'Welcome to the patient chart view! Click on the "Record Vitals" button to open the vitals form. If the selected patient doesn\'t have an active visit, you will be prompted to start one. In that case, submit the start visit form in order to the next step.',
-            disableOverlayClose: true,
+              'Click on the "Record Vitals" button to open the vitals form. If the selected patient doesn\'t have an active visit, you will be prompted to start one. In that case, submit the start visit form in order to the next step.',
             disableOverlay: true,
             spotlightClicks: true,
             hideBackButton: true,
@@ -540,60 +427,184 @@ export const configSchema = {
             title: 'Vitals form',
             content:
               'In this form, you can enter the vitals and biometrics you have captured. If any value entered is out of the normal range, you will see ↑ (High), ↓ (Low), ↑↑ (Very High) or ↓↓ (Very Low)  indicators next to the respective field. After entering all necessary details, click on the "Save and Close" button to submit the data.',
-            disableOverlayClose: true,
             disableOverlay: true,
             spotlightClicks: true,
             placement: 'left',
             hideBackButton: true,
             hideNextButton: true,
-            data: { 
-              autoNextOn: '.omrs-snackbars-container div' 
+            data: {
+              autoNextOn: '.omrs-snackbars-container div',
             },
           },
           {
             target: '[data-extension-id="patient-vitals-info"]',
-            title: 'Vitals Header',
             content: 'The latest vitals and biometrics data of the patient can be viewed in this section.',
-            disableOverlayClose: true,
             hideBackButton: true,
           },
           {
             target: '[data-extension-id="results-summary-dashboard"]',
-            title: 'Vitals and Biometrics Menu',
             content:
               'Click here to go to the Vitals and Biometrics page, where you can view the past records of vitals and biometrics.',
-            disableOverlayClose: true,
             hideBackButton: true,
             hideNextButton: true,
             spotlightClicks: true,
-            data: { 
-              autoNextOn: '[data-extension-slot-name="patient-chart-vitals-biometrics-dashboard-slot"]' 
+            data: {
+              autoNextOn: '[data-extension-slot-name="patient-chart-vitals-biometrics-dashboard-slot"]',
             },
           },
           {
             target: '[data-extension-slot-name="patient-chart-vitals-biometrics-dashboard-slot"]',
-            title: 'Vitals/Biometrics Tables',
             content:
               'These tables display the history of vitals and biometrics. Indicators may be present here to show measurements that are higher or lower than the typical range.',
-            disableOverlayClose: true,
             hideBackButton: true,
           },
           {
             target: '[aria-label="Chart view"]',
-            title: 'Charts',
             content: 'You can click on the "Chart" button for a graphical representation of the vitals history.',
-            disableOverlayClose: true,
           },
           {
             target: 'body',
-            title:
+            content:
               'You have now successfully completed the tutorial. You can continue with the rest of the patient visit by recording additional information or performing other necessary actions within the patient chart view, or you can return to the homepage.',
-            disableOverlayClose: true,
             placement: 'center',
             hideBackButton: true,
           },
         ],
       },
+      {
+        title: 'Starting a Patient Visit',
+        description: 'Learn how to start a visit for a patient.',
+        steps: [
+          {
+            target: '[data-testid="searchPatientIcon"]',
+            content:
+              'To fill out any forms or encounters of a patient, you have to start a visit. To start a patient visit, first you need to go to the patient chart view of the respective patient. Click on the search icon to open the search box so that we can search for the patient. ',
+            disableBeacon: true,
+            spotlightClicks: true,
+            hideNextButton: true,
+            data: {
+              autoNextOn: '[data-testid="patientSearchBar"]',
+            },
+          },
+          {
+            target: '[data-testid="patientSearchBar"]',
+            content:
+              'Now, enter the name or the ID of the patient here. Some example patient names that you can search for are: John, Smith, Mary.',
+            hideNextButton: true,
+            hideBackButton: true,
+            spotlightClicks: true,
+            data: {
+              autoNextOn: '[data-testid="floatingSearchResultsContainer"]',
+            },
+          },
+          {
+            target: '[data-testid="floatingSearchResultsContainer"]',
+            content:
+              'Click on the patient whose chart you want to access. Make sure to select a patient without the "Active visit" label, as we will start a visit in the next steps of the tutorial.',
+            spotlightClicks: true,
+            disableOverlay: true,
+            placement: 'left',
+            hideNextButton: true,
+            hideBackButton: true,
+            data: {
+              autoNextOn: '[data-extension-slot-name="action-menu-patient-chart-items-slot"]',
+            },
+          },
+          {
+            target: '[aria-label="Start a visit"]',
+            content:
+              'Welcome to the patient chart view! Here, you can find detailed patient information, records of clinical visits, demographic information, graphs, and medical forms. Click on the "Start Visit" button to open the Start Visit form.',
+            spotlightClicks: true,
+            hideNextButton: true,
+            hideBackButton: true,
+            data: {
+              autoNextOn: '[data-openmrs-role="Start Visit Form"]',
+            },
+          },
+          {
+            target: '[data-openmrs-role="Start Visit Form"]',
+            title: 'Start Visit Form',
+            content:
+              'Fill out the necessary information here and click on the "Start Visit" button at the bottom of this form to start the visit. You can click on "Discard" if you don\'t want to start a visit at the moment.',
+            disableOverlay: true,
+            spotlightClicks: true,
+            hideNextButton: true,
+            hideBackButton: true,
+            placement: 'left',
+            data: {
+              autoNextOn: '.omrs-snackbars-container div',
+            },
+          },
+          {
+            target: 'body',
+            content:
+              'That\'s the end of this tutorial! If you have already started a visit, you will see an "Active Visit" tag near the patient\'s name. After the visit is started, you can do things like capturing vitals, biometrics, and more through this patient chart view.',
+            hideBackButton: true,
+            placement: 'center',
+          },
+        ],
+      },
+      {
+        title: 'Tutorial for demo purposes',
+        description: 'This tutorial is for demo / debugging purposes only',
+        steps: [
+          {
+            target: '[aria-label="OpenMRS"]',
+            content: 'Let us walk through the tutorial features together.',
+          },
+          {
+            target: '[data-extension-id="clinical-appointments-dashboard-link"]',
+            content:
+              'Click on this link. This step is configured to be automatic and will take you to the next step. Once the given query selector resolves an element on the page, it will proceed automatically.',
+            hideCloseButton: true,
+            hideNextButton: true,
+            spotlightClicks: true,
+            data: {
+              autoNextOn: '[data-extension-id="clinical-appointments-dashboard"]',
+            },
+          },
+          {
+            target: '[data-extension-id="clinical-appointments-dashboard"]',
+            content: 'Congrats! You have reached the clinical appointments dashboard.',
+          },
+          {
+            target: '[aria-label="OpenMRS"]',
+            content:
+              'Now, let’s see how this behaves when elements take a bit longer to load. Set your network throttling to "Slow 3G" and hit "Next".',
+
+            hideBackButton: true,
+          },
+          {
+            target: '[data-extension-id="laboratory-dashboard-link"]',
+            content:
+              'Let\'s navigate to the laboratory page. Our next target is the "Tests Ordered" table. I’ll disappear once you reach the laboratory page and reappear when the table is loaded. See you there!',
+            hideCloseButton: true,
+            hideNextButton: true,
+
+            spotlightClicks: true,
+            data: {
+              autoNextOn: '[data-extension-id="laboratory-dashboard"]',
+            },
+          },
+          {
+            target: '[data-extension-id="all-lab-requests-table"] table',
+            content:
+              "It's me again. By default, I'll wait for the element to appear, so you don't have to worry about slow components when writing a new tutorial.",
+
+            hideBackButton: true,
+          },
+          {
+            target: '[aria-label="OpenMRS"]',
+            content:
+              "Now let's do a fun exercise. Can you find out how to view a patient's allergies on your own? Feel free to turn off network throttling. ;) ",
+          },
+          {
+            target: '[data-extension-slot-name="patient-chart-allergies-dashboard-slot"]',
+            content:
+              'Great job! You found the allergies section! This is the end of the tutorial. Feel free to explore the system on your own or check out the other tutorials.',
+          },
+        ],
+      },
     ],
   },
 };
@@ -607,7 +618,6 @@ export type Config = {
       target: string;
       title: string;
       content: string;
-      disableBeacon: boolean;
       data?: {
         autoNextOn?: boolean;
       };

package/src/declarations.d.ts

@@ -2,3 +2,5 @@ declare module '@carbon/react';
 declare module '*.css';
 declare module '*.scss';
 declare module '*.png';
+
+declare type SideNavProps = object;