@openmrs/esm-framework 6.3.1-pre.3106 → 6.3.1-pre.3119
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build.log +1 -1
- package/dist/openmrs-esm-framework.js +2 -2
- package/dist/openmrs-esm-framework.js.map +1 -1
- package/docs/API.md +310 -8579
- package/docs/classes/OpenmrsFetchError.md +88 -117
- package/docs/enumerations/Type.md +77 -0
- package/docs/enumerations/VisitMode.md +29 -0
- package/docs/enumerations/VisitStatus.md +21 -0
- package/docs/functions/ConfigurableLink.md +19 -0
- package/docs/functions/CustomOverflowMenu.md +17 -0
- package/docs/functions/DashboardExtension.md +17 -0
- package/docs/functions/ExtensionSlot.md +46 -0
- package/docs/functions/OpenmrsAppContext.md +36 -0
- package/docs/functions/PatientBannerActionsMenu.md +17 -0
- package/docs/functions/PatientBannerContactDetails.md +17 -0
- package/docs/functions/PatientBannerPatientIdentifiers.md +17 -0
- package/docs/functions/PatientBannerPatientInfo.md +17 -0
- package/docs/functions/PatientBannerToggleContactDetailsButton.md +17 -0
- package/docs/functions/PatientPhoto.md +19 -0
- package/docs/functions/WorkspaceContainer.md +55 -0
- package/docs/functions/age.md +32 -0
- package/docs/functions/attach.md +40 -0
- package/docs/functions/beginEditSynchronizationItem.md +22 -0
- package/docs/functions/canAccessStorage.md +25 -0
- package/docs/functions/canBeginEditSynchronizationItemsOfType.md +22 -0
- package/docs/functions/clearCurrentUser.md +11 -0
- package/docs/functions/closeWorkspace.md +27 -0
- package/docs/functions/compile.md +30 -0
- package/docs/functions/convertToLocaleCalendar.md +25 -0
- package/docs/functions/createAttachment.md +21 -0
- package/docs/functions/createErrorHandler.md +21 -0
- package/docs/functions/createGlobalStore.md +36 -0
- package/docs/functions/createUseStore.md +66 -0
- package/docs/functions/defineConfigSchema.md +33 -0
- package/docs/functions/defineExtensionConfigSchema.md +38 -0
- package/docs/functions/deleteAttachmentPermanently.md +21 -0
- package/docs/functions/deleteSynchronizationItem.md +21 -0
- package/docs/functions/detach.md +25 -0
- package/docs/functions/detachAll.md +21 -0
- package/docs/functions/dispatchNotificationShown.md +17 -0
- package/docs/functions/dispatchPrecacheStaticDependencies.md +17 -0
- package/docs/functions/displayName.md +21 -0
- package/docs/functions/evaluate.md +84 -0
- package/docs/functions/evaluateAsBoolean.md +31 -0
- package/docs/functions/evaluateAsBooleanAsync.md +31 -0
- package/docs/functions/evaluateAsNumber.md +31 -0
- package/docs/functions/evaluateAsNumberAsync.md +31 -0
- package/docs/functions/evaluateAsType.md +46 -0
- package/docs/functions/evaluateAsTypeAsync.md +46 -0
- package/docs/functions/evaluateAsync.md +87 -0
- package/docs/functions/extractVariableNames.md +50 -0
- package/docs/functions/fetchCurrentPatient.md +25 -0
- package/docs/functions/filterBreadcrumbs.md +21 -0
- package/docs/functions/formatDate.md +39 -0
- package/docs/functions/formatDatetime.md +29 -0
- package/docs/functions/formatPartialDate.md +39 -0
- package/docs/functions/formatPatientName.md +23 -0
- package/docs/functions/formatTime.md +20 -0
- package/docs/functions/formattedName.md +21 -0
- package/docs/functions/generateOfflineUuid.md +13 -0
- package/docs/functions/getAssignedExtensions.md +23 -0
- package/docs/functions/getAsyncLifecycle.md +31 -0
- package/docs/functions/getAttachmentByUuid.md +21 -0
- package/docs/functions/getAttachments.md +25 -0
- package/docs/functions/getBreadcrumbs.md +11 -0
- package/docs/functions/getBreadcrumbsFor.md +17 -0
- package/docs/functions/getConfig.md +31 -0
- package/docs/functions/getContext.md +29 -0
- package/docs/functions/getCoreTranslation.md +35 -0
- package/docs/functions/getCurrentOfflineMode.md +11 -0
- package/docs/functions/getCurrentUser.md +154 -0
- package/docs/functions/getDefaultCalendar.md +21 -0
- package/docs/functions/getDefaultsFromConfigSchema.md +32 -0
- package/docs/functions/getDynamicOfflineDataEntries.md +28 -0
- package/docs/functions/getDynamicOfflineDataEntriesFor.md +34 -0
- package/docs/functions/getDynamicOfflineDataHandlers.md +13 -0
- package/docs/functions/getExtensionNameFromId.md +30 -0
- package/docs/functions/getExtensionStore.md +14 -0
- package/docs/functions/getFeatureFlag.md +21 -0
- package/docs/functions/getFhirServerPaginationHandlers.md +17 -0
- package/docs/functions/getFullSynchronizationItems.md +27 -0
- package/docs/functions/getFullSynchronizationItemsFor.md +33 -0
- package/docs/functions/getGlobalStore.md +36 -0
- package/docs/functions/getHistory.md +13 -0
- package/docs/functions/getLifecycle.md +27 -0
- package/docs/functions/getLocale.md +15 -0
- package/docs/functions/getLocations.md +21 -0
- package/docs/functions/getLoggedInUser.md +11 -0
- package/docs/functions/getOfflinePatientDataStore.md +15 -0
- package/docs/functions/getPatientName.md +26 -0
- package/docs/functions/getSessionLocation.md +11 -0
- package/docs/functions/getSessionStore.md +11 -0
- package/docs/functions/getSyncLifecycle.md +31 -0
- package/docs/functions/getSynchronizationItem.md +27 -0
- package/docs/functions/getSynchronizationItems.md +27 -0
- package/docs/functions/getVisitStore.md +11 -0
- package/docs/functions/getVisitTypes.md +11 -0
- package/docs/functions/getVisitsForPatient.md +29 -0
- package/docs/functions/goBackInHistory.md +25 -0
- package/docs/functions/importDynamic.md +58 -0
- package/docs/functions/inRange.md +27 -0
- package/docs/functions/interpolateString.md +34 -0
- package/docs/functions/interpolateUrl.md +48 -0
- package/docs/functions/isDesktop.md +17 -0
- package/docs/functions/isDevEnabled.md +11 -0
- package/docs/functions/isOfflineUuid.md +19 -0
- package/docs/functions/isOmrsDateStrict.md +20 -0
- package/docs/functions/isOmrsDateToday.md +19 -0
- package/docs/functions/isOnline.md +17 -0
- package/docs/functions/isUrlWithTemplateParameters.md +22 -0
- package/docs/functions/isVersionSatisfied.md +21 -0
- package/docs/functions/launchWorkspace.md +56 -0
- package/docs/functions/launchWorkspaceGroup.md +38 -0
- package/docs/functions/makeUrl.md +26 -0
- package/docs/functions/messageOmrsServiceWorker.md +23 -0
- package/docs/functions/navigate.md +48 -0
- package/docs/functions/navigateAndLaunchWorkspace.md +33 -0
- package/docs/functions/oneOf.md +21 -0
- package/docs/functions/openmrsFetch.md +75 -0
- package/docs/functions/openmrsObservableFetch.md +55 -0
- package/docs/functions/parseDate.md +20 -0
- package/docs/functions/provide.md +21 -0
- package/docs/functions/putDynamicOfflineData.md +28 -0
- package/docs/functions/putDynamicOfflineDataFor.md +34 -0
- package/docs/functions/queueSynchronizationItem.md +39 -0
- package/docs/functions/refetchCurrentUser.md +33 -0
- package/docs/functions/registerBreadcrumb.md +17 -0
- package/docs/functions/registerBreadcrumbs.md +17 -0
- package/docs/functions/registerContext.md +34 -0
- package/docs/functions/registerDefaultCalendar.md +33 -0
- package/docs/functions/registerFeatureFlag.md +36 -0
- package/docs/functions/registerOfflinePatientHandler.md +25 -0
- package/docs/functions/removeDynamicOfflineData.md +28 -0
- package/docs/functions/removeDynamicOfflineDataFor.md +34 -0
- package/docs/functions/renderExtension.md +41 -0
- package/docs/functions/reportError.md +17 -0
- package/docs/functions/retry.md +44 -0
- package/docs/functions/saveVisit.md +21 -0
- package/docs/functions/selectPreferredName.md +46 -0
- package/docs/functions/setCurrentVisit.md +21 -0
- package/docs/functions/setLeftNav.md +23 -0
- package/docs/functions/setSessionLocation.md +21 -0
- package/docs/functions/setUserLanguage.md +17 -0
- package/docs/functions/setUserProperties.md +23 -0
- package/docs/functions/setupDynamicOfflineDataHandler.md +22 -0
- package/docs/functions/setupOfflineSync.md +49 -0
- package/docs/functions/shallowEqual.md +32 -0
- package/docs/functions/showActionableNotification.md +21 -0
- package/docs/functions/showModal.md +44 -0
- package/docs/functions/showNotification.md +21 -0
- package/docs/functions/showSnackbar.md +21 -0
- package/docs/functions/showToast.md +21 -0
- package/docs/functions/subscribeActionableNotificationShown.md +21 -0
- package/docs/functions/subscribeConnectivity.md +21 -0
- package/docs/functions/subscribeConnectivityChanged.md +21 -0
- package/docs/functions/subscribeNotificationShown.md +21 -0
- package/docs/functions/subscribePrecacheStaticDependencies.md +21 -0
- package/docs/functions/subscribeSnackbarShown.md +21 -0
- package/docs/functions/subscribeTo.md +75 -0
- package/docs/functions/subscribeToContext.md +39 -0
- package/docs/functions/subscribeToastShown.md +21 -0
- package/docs/functions/syncAllDynamicOfflineData.md +27 -0
- package/docs/functions/syncDynamicOfflineData.md +33 -0
- package/docs/functions/syncOfflinePatientData.md +21 -0
- package/docs/functions/toDateObjectStrict.md +20 -0
- package/docs/functions/toLocationObject.md +17 -0
- package/docs/functions/toOmrsIsoString.md +23 -0
- package/docs/functions/toVisitTypeObject.md +17 -0
- package/docs/functions/translateFrom.md +55 -0
- package/docs/functions/unregisterContext.md +20 -0
- package/docs/functions/unsetLeftNav.md +23 -0
- package/docs/functions/updateContext.md +29 -0
- package/docs/functions/updateVisit.md +25 -0
- package/docs/functions/useAbortController.md +32 -0
- package/docs/functions/useAppContext.md +43 -0
- package/docs/functions/useAssignedExtensionIds.md +26 -0
- package/docs/functions/useAssignedExtensions.md +21 -0
- package/docs/functions/useAttachments.md +41 -0
- package/docs/functions/useBodyScrollLock.md +17 -0
- package/docs/functions/useConfig.md +27 -0
- package/docs/functions/useConnectivity.md +11 -0
- package/docs/functions/useDebounce.md +57 -0
- package/docs/functions/useDefineAppContext.md +70 -0
- package/docs/functions/useEmrConfiguration.md +35 -0
- package/docs/functions/useExtensionSlotMeta.md +25 -0
- package/docs/functions/useExtensionSlotStore.md +17 -0
- package/docs/functions/useFeatureFlag.md +30 -0
- package/docs/functions/useFhirFetchAll.md +44 -0
- package/docs/functions/useFhirInfinite.md +46 -0
- package/docs/functions/useFhirPagination.md +129 -0
- package/docs/functions/useLayoutType.md +11 -0
- package/docs/functions/useLeftNav.md +17 -0
- package/docs/functions/useLeftNavStore.md +11 -0
- package/docs/functions/useLocations.md +21 -0
- package/docs/functions/useOnClickOutside.md +27 -0
- package/docs/functions/useOnVisible.md +28 -0
- package/docs/functions/useOpenmrsFetchAll.md +46 -0
- package/docs/functions/useOpenmrsInfinite.md +54 -0
- package/docs/functions/useOpenmrsPagination.md +140 -0
- package/docs/functions/useOpenmrsSWR.md +71 -0
- package/docs/functions/usePagination.md +89 -0
- package/docs/functions/usePatient.md +38 -0
- package/docs/functions/usePatientPhoto.md +17 -0
- package/docs/functions/usePrimaryIdentifierCode.md +23 -0
- package/docs/functions/useRenderableExtensions.md +43 -0
- package/docs/functions/useSession.md +19 -0
- package/docs/functions/useStore.md +131 -0
- package/docs/functions/useStoreWithActions.md +33 -0
- package/docs/functions/useVisit.md +41 -0
- package/docs/functions/useVisitContextStore.md +23 -0
- package/docs/functions/useVisitTypes.md +11 -0
- package/docs/functions/useWorkspaces.md +11 -0
- package/docs/functions/userHasAccess.md +27 -0
- package/docs/functions/validator.md +44 -0
- package/docs/interfaces/ActionMenuButtonProps.md +33 -57
- package/docs/interfaces/ActionableNotificationDescriptor.md +32 -62
- package/docs/interfaces/AssignedExtension.md +30 -57
- package/docs/interfaces/Attachment.md +23 -47
- package/docs/interfaces/AttachmentResponse.md +20 -41
- package/docs/interfaces/AuditInfo.md +49 -88
- package/docs/interfaces/BreadcrumbRegistration.md +8 -17
- package/docs/interfaces/BreadcrumbSettings.md +18 -33
- package/docs/interfaces/CancelLoading.md +6 -10
- package/docs/interfaces/ClearDynamicRoutesMessage.md +9 -17
- package/docs/interfaces/CloseWorkspaceOptions.md +18 -29
- package/docs/interfaces/ComponentConfig.md +11 -23
- package/docs/interfaces/Concept.md +83 -131
- package/docs/interfaces/ConceptClass.md +46 -67
- package/docs/interfaces/ConceptDatatype.md +50 -74
- package/docs/interfaces/ConceptName.md +50 -74
- package/docs/interfaces/Config.md +4 -2
- package/docs/interfaces/ConfigObject.md +12 -21
- package/docs/interfaces/ConfigSchema.md +15 -27
- package/docs/interfaces/ConfigurableLinkProps.md +24 -4314
- package/docs/interfaces/ConnectedExtension.md +25 -41
- package/docs/interfaces/ConnectivityChangedEvent.md +4 -10
- package/docs/interfaces/CurrentPatientOptions.md +9 -18
- package/docs/interfaces/DashboardExtensionProps.md +13 -28
- package/docs/interfaces/DefaultWorkspaceProps.md +44 -51
- package/docs/interfaces/Diagnosis.md +80 -104
- package/docs/interfaces/DisplayConditionsConfigObject.md +18 -33
- package/docs/interfaces/DynamicOfflineData.md +23 -41
- package/docs/interfaces/DynamicOfflineDataHandler.md +47 -54
- package/docs/interfaces/DynamicOfflineDataSyncState.md +29 -39
- package/docs/interfaces/EmrApiConfigurationResponse.md +243 -350
- package/docs/interfaces/Encounter.md +67 -110
- package/docs/interfaces/EncounterProvider.md +39 -61
- package/docs/interfaces/EncounterRole.md +43 -68
- package/docs/interfaces/EncounterType.md +43 -68
- package/docs/interfaces/ErrorStateProps.md +7 -16
- package/docs/interfaces/ExtensionData.md +10 -22
- package/docs/interfaces/ExtensionMeta.md +4 -2
- package/docs/interfaces/ExtensionRegistration.md +36 -69
- package/docs/interfaces/ExtensionSlotBaseProps.md +35 -35
- package/docs/interfaces/ExtensionSlotConfig.md +17 -32
- package/docs/interfaces/ExtensionSlotConfigObject.md +14 -26
- package/docs/interfaces/ExtensionSlotConfigureValueObject.md +4 -2
- package/docs/interfaces/ExtensionSlotProps.md +3520 -0
- package/docs/interfaces/ExtensionSlotState.md +9 -18
- package/docs/interfaces/ExtensionStore.md +5 -11
- package/docs/interfaces/FHIRCode.md +11 -23
- package/docs/interfaces/FHIRLocationResource.md +25 -18
- package/docs/interfaces/FHIRResource.md +105 -41
- package/docs/interfaces/FeatureFlagDefinition.md +14 -26
- package/docs/interfaces/FetchConfig.md +80 -117
- package/docs/interfaces/FetchError.md +8 -21
- package/docs/interfaces/FetchHeaders.md +4 -2
- package/docs/interfaces/FetchResponse.md +124 -130
- package/docs/interfaces/FetchResponseJson.md +4 -2
- package/docs/interfaces/ImportMap.md +4 -10
- package/docs/interfaces/LeftNavStore.md +14 -29
- package/docs/interfaces/Link.md +11 -23
- package/docs/interfaces/Location.md +147 -250
- package/docs/interfaces/LoggedInUser.md +68 -70
- package/docs/interfaces/LoggedInUserFetchResponse.md +120 -128
- package/docs/interfaces/MessageServiceWorkerResult.md +17 -29
- package/docs/interfaces/NavigateOptions.md +9 -18
- package/docs/interfaces/NewVisitPayload.md +32 -48
- package/docs/interfaces/NotificationDescriptor.md +31 -58
- package/docs/interfaces/Obs.md +99 -166
- package/docs/interfaces/OfflineModeResult.md +11 -23
- package/docs/interfaces/OfflinePatientArgs.md +13 -20
- package/docs/interfaces/OfflinePatientDataSyncHandler.md +17 -27
- package/docs/interfaces/OfflinePatientDataSyncState.md +29 -51
- package/docs/interfaces/OfflinePatientDataSyncStore.md +13 -20
- package/docs/interfaces/OmrsServiceWorkerMessage.md +13 -23
- package/docs/interfaces/OnImportMapChangedMessage.md +12 -23
- package/docs/interfaces/OnlyThePatient.md +9 -17
- package/docs/interfaces/OpenWorkspace.md +116 -170
- package/docs/interfaces/OpenmrsAppContextProps.md +14 -23
- package/docs/interfaces/OpenmrsAppRoutes.md +41 -71
- package/docs/interfaces/OpenmrsDatePickerProps.md +346 -483
- package/docs/interfaces/OpenmrsResource.md +39 -57
- package/docs/interfaces/OpenmrsResourceStrict.md +27 -51
- package/docs/interfaces/PageHeaderContentProps.md +12 -24
- package/docs/interfaces/PageHeaderWrapperProps.md +9 -18
- package/docs/interfaces/Patient.md +41 -70
- package/docs/interfaces/PatientBannerActionsMenuProps.md +15 -30
- package/docs/interfaces/PatientBannerToggleContactDetailsButtonProps.md +17 -32
- package/docs/interfaces/PatientIdentifier.md +49 -84
- package/docs/interfaces/PatientIdentifierType.md +65 -112
- package/docs/interfaces/PatientPhotoProps.md +8 -17
- package/docs/interfaces/PatientWithFullResponse.md +9 -17
- package/docs/interfaces/Person.md +96 -160
- package/docs/interfaces/PersonAddress.md +136 -230
- package/docs/interfaces/PersonAttribute.md +43 -68
- package/docs/interfaces/PersonName.md +72 -118
- package/docs/interfaces/PrecacheStaticDependenciesEvent.md +3 -1
- package/docs/interfaces/PrimaryIdentifier.md +5 -11
- package/docs/interfaces/Privilege.md +11 -23
- package/docs/interfaces/Prompt.md +20 -41
- package/docs/interfaces/QueueItemDescriptor.md +23 -30
- package/docs/interfaces/RegisterDynamicRouteMessage.md +21 -38
- package/docs/interfaces/ResourceLoader.md +10 -14
- package/docs/interfaces/ResponsiveWrapperProps.md +5 -11
- package/docs/interfaces/RetryOptions.md +36 -37
- package/docs/interfaces/Role.md +10 -22
- package/docs/interfaces/Session.md +31 -54
- package/docs/interfaces/SessionLocation.md +10 -22
- package/docs/interfaces/SetLeftNavParams.md +15 -30
- package/docs/interfaces/ShowActionableNotificationEvent.md +26 -50
- package/docs/interfaces/ShowNotificationEvent.md +20 -38
- package/docs/interfaces/ShowSnackbarEvent.md +34 -64
- package/docs/interfaces/ShowToastEvent.md +22 -43
- package/docs/interfaces/SnackbarDescriptor.md +41 -76
- package/docs/interfaces/SnackbarMeta.md +55 -93
- package/docs/interfaces/SpaConfig.md +30 -40
- package/docs/interfaces/StyleguideConfigObject.md +39 -70
- package/docs/interfaces/SyncItem.md +34 -57
- package/docs/interfaces/SyncProcessOptions.md +22 -40
- package/docs/interfaces/ToastDescriptor.md +29 -55
- package/docs/interfaces/ToastNotificationMeta.md +40 -69
- package/docs/interfaces/UploadedFile.md +25 -49
- package/docs/interfaces/UseConfigOptions.md +6 -12
- package/docs/interfaces/UsePatientPhotoResult.md +12 -24
- package/docs/interfaces/UseServerFetchAllOptions.md +41 -61
- package/docs/interfaces/UseServerInfiniteOptions.md +29 -46
- package/docs/interfaces/UseServerPaginationOptions.md +26 -41
- package/docs/interfaces/User.md +34 -46
- package/docs/interfaces/UserHasAccessProps.md +13 -25
- package/docs/interfaces/Visit.md +36 -66
- package/docs/interfaces/VisitItem.md +16 -31
- package/docs/interfaces/VisitReturnType.md +24 -51
- package/docs/interfaces/VisitStoreState.md +14 -26
- package/docs/interfaces/VisitType.md +11 -23
- package/docs/interfaces/WorkspaceContainerProps.md +20 -38
- package/docs/interfaces/WorkspaceGroupDefinition.md +10 -19
- package/docs/interfaces/WorkspaceRegistration.md +43 -82
- package/docs/interfaces/WorkspacesInfo.md +30 -40
- package/docs/type-aliases/ActionFunction.md +27 -0
- package/docs/type-aliases/ActionableNotificationType.md +7 -0
- package/docs/type-aliases/Actions.md +13 -0
- package/docs/type-aliases/ArgumentsTuple.md +7 -0
- package/docs/type-aliases/BoundActions.md +17 -0
- package/docs/type-aliases/ConfigValue.md +7 -0
- package/docs/type-aliases/ContextCallback.md +23 -0
- package/docs/type-aliases/CoreTranslationKey.md +7 -0
- package/docs/type-aliases/CurrentPatient.md +7 -0
- package/docs/type-aliases/DateInput.md +7 -0
- package/docs/type-aliases/DefaultEvaluateReturnType.md +9 -0
- package/docs/type-aliases/ExtensionDefinition.md +69 -0
- package/docs/type-aliases/ExtensionProps.md +13 -0
- package/docs/type-aliases/FormatDateMode.md +7 -0
- package/docs/type-aliases/FormatDateOptions.md +102 -0
- package/docs/type-aliases/IconProps.md +31 -0
- package/docs/type-aliases/InlineNotificationType.md +7 -0
- package/docs/type-aliases/Key.md +7 -0
- package/docs/type-aliases/KnownOmrsServiceWorkerMessages.md +7 -0
- package/docs/type-aliases/LayoutType.md +7 -0
- package/docs/type-aliases/LoadedSessionStore.md +23 -0
- package/docs/type-aliases/ModalDefinition.md +17 -0
- package/docs/type-aliases/NameUse.md +7 -0
- package/docs/type-aliases/NullablePatient.md +7 -0
- package/docs/type-aliases/OfflineMode.md +7 -0
- package/docs/type-aliases/OmrsOfflineCachingStrategy.md +12 -0
- package/docs/type-aliases/OmrsOfflineHttpHeaderNames.md +7 -0
- package/docs/type-aliases/OmrsOfflineHttpHeaders.md +44 -0
- package/docs/type-aliases/OpenmrsRoutes.md +10 -0
- package/docs/type-aliases/PageDefinition.md +41 -0
- package/docs/type-aliases/PageHeaderProps.md +7 -0
- package/docs/type-aliases/PatientUuid.md +7 -0
- package/docs/type-aliases/PictogramProps.md +23 -0
- package/docs/type-aliases/ProvidedConfig.md +23 -0
- package/docs/type-aliases/ResourceName.md +7 -0
- package/docs/type-aliases/SessionStore.md +7 -0
- package/docs/type-aliases/SnackbarType.md +7 -0
- package/docs/type-aliases/SpaEnvironment.md +7 -0
- package/docs/type-aliases/SvgIconProps.md +23 -0
- package/docs/type-aliases/SvgPictogramProps.md +27 -0
- package/docs/type-aliases/TemplateParams.md +11 -0
- package/docs/type-aliases/ToastType.md +7 -0
- package/docs/type-aliases/UnloadedSessionStore.md +23 -0
- package/docs/type-aliases/UpdateVisitPayload.md +7 -0
- package/docs/type-aliases/UseOpenmrsSWROptions.md +39 -0
- package/docs/type-aliases/Validator.md +17 -0
- package/docs/type-aliases/ValidatorFunction.md +17 -0
- package/docs/type-aliases/VariablesMap.md +13 -0
- package/docs/type-aliases/WorkspaceDefinition.md +78 -0
- package/docs/type-aliases/WorkspaceWindowState.md +7 -0
- package/docs/variables/ActionMenuButton.md +7 -0
- package/docs/variables/ActivityIcon.md +7 -0
- package/docs/variables/AddIcon.md +7 -0
- package/docs/variables/AllergiesIcon.md +7 -0
- package/docs/variables/AppointmentsPictogram.md +7 -0
- package/docs/variables/ArrowDownIcon.md +7 -0
- package/docs/variables/ArrowLeftIcon.md +7 -0
- package/docs/variables/ArrowRightIcon.md +7 -0
- package/docs/variables/ArrowUpIcon.md +7 -0
- package/docs/variables/AttachmentIcon.md +7 -0
- package/docs/variables/BabyIcon.md +7 -0
- package/docs/variables/CalendarHeatMapIcon.md +7 -0
- package/docs/variables/CalendarIcon.md +7 -0
- package/docs/variables/CaretDownIcon.md +7 -0
- package/docs/variables/CaretLeftIcon.md +7 -0
- package/docs/variables/CaretRightIcon.md +7 -0
- package/docs/variables/CaretUpIcon.md +7 -0
- package/docs/variables/ChartAverageIcon.md +7 -0
- package/docs/variables/CheckmarkFilledIcon.md +7 -0
- package/docs/variables/CheckmarkOutlineIcon.md +7 -0
- package/docs/variables/ChemistryIcon.md +7 -0
- package/docs/variables/ChevronDownIcon.md +7 -0
- package/docs/variables/ChevronLeftIcon.md +7 -0
- package/docs/variables/ChevronRightIcon.md +7 -0
- package/docs/variables/ChevronUpIcon.md +7 -0
- package/docs/variables/CloseFilledIcon.md +7 -0
- package/docs/variables/CloseIcon.md +7 -0
- package/docs/variables/CloseOutlineIcon.md +7 -0
- package/docs/variables/ConditionsIcon.md +11 -0
- package/docs/variables/DiagnosisTags.md +11 -0
- package/docs/variables/DocumentAttachmentIcon.md +7 -0
- package/docs/variables/DocumentIcon.md +7 -0
- package/docs/variables/DownloadIcon.md +7 -0
- package/docs/variables/DrugOrderIcon.md +7 -0
- package/docs/variables/EditIcon.md +7 -0
- package/docs/variables/ErrorState.md +7 -0
- package/docs/variables/EventScheduleIcon.md +7 -0
- package/docs/variables/EventsIcon.md +7 -0
- package/docs/variables/Extension.md +15 -0
- package/docs/variables/GenderFemaleIcon.md +7 -0
- package/docs/variables/GenderMaleIcon.md +7 -0
- package/docs/variables/GenderOtherIcon.md +7 -0
- package/docs/variables/GenderUnknownIcon.md +7 -0
- package/docs/variables/GenericOrderTypeIcon.md +7 -0
- package/docs/variables/GroupAccessIcon.md +7 -0
- package/docs/variables/GroupIcon.md +7 -0
- package/docs/variables/HomePictogram.md +7 -0
- package/docs/variables/HospitalBedIcon.md +7 -0
- package/docs/variables/Icon.md +9 -0
- package/docs/variables/ImageMedicalIcon.md +7 -0
- package/docs/variables/InPatientPictogram.md +7 -0
- package/docs/variables/InformationFilledIcon.md +7 -0
- package/docs/variables/InformationIcon.md +7 -0
- package/docs/variables/InformationSquareIcon.md +7 -0
- package/docs/variables/InventoryManagementIcon.md +7 -0
- package/docs/variables/LabOrderIcon.md +7 -0
- package/docs/variables/LaboratoryPictogram.md +7 -0
- package/docs/variables/LeftNavMenu.md +13 -0
- package/docs/variables/ListCheckedIcon.md +7 -0
- package/docs/variables/LocationIcon.md +7 -0
- package/docs/variables/LocationPicker.md +7 -0
- package/docs/variables/MaterialOrderIcon.md +7 -0
- package/docs/variables/MaximizeIcon.md +7 -0
- package/docs/variables/MaybeIcon.md +16 -0
- package/docs/variables/MaybePictogram.md +16 -0
- package/docs/variables/MedicationIcon.md +7 -0
- package/docs/variables/MessageQueueIcon.md +7 -0
- package/docs/variables/MicroscopeIcon.md +7 -0
- package/docs/variables/MoneyIcon.md +9 -0
- package/docs/variables/MotherIcon.md +7 -0
- package/docs/variables/MovementIcon.md +7 -0
- package/docs/variables/OpenmrsDatePicker.md +9 -0
- package/docs/variables/OverflowMenuHorizontalIcon.md +7 -0
- package/docs/variables/OverflowMenuVerticalIcon.md +7 -0
- package/docs/variables/PageHeader.md +30 -0
- package/docs/variables/PageHeaderContent.md +21 -0
- package/docs/variables/PasswordIcon.md +7 -0
- package/docs/variables/PatientListsPictogram.md +7 -0
- package/docs/variables/PedestrianFamilyIcon.md +7 -0
- package/docs/variables/PenIcon.md +7 -0
- package/docs/variables/PharmacyPictogram.md +7 -0
- package/docs/variables/Pictogram.md +9 -0
- package/docs/variables/PrinterIcon.md +7 -0
- package/docs/variables/ProcedureOrderIcon.md +7 -0
- package/docs/variables/ProgramsIcon.md +7 -0
- package/docs/variables/RadiologyIcon.md +7 -0
- package/docs/variables/ReferralOrderIcon.md +7 -0
- package/docs/variables/RegistrationPictogram.md +7 -0
- package/docs/variables/RenderIfValueIsTruthy.md +21 -0
- package/docs/variables/RenewIcon.md +7 -0
- package/docs/variables/ReportIcon.md +7 -0
- package/docs/variables/ResetIcon.md +7 -0
- package/docs/variables/ResponsiveWrapper.md +11 -0
- package/docs/variables/SaveIcon.md +7 -0
- package/docs/variables/SearchIcon.md +7 -0
- package/docs/variables/ServiceQueuesPictogram.md +7 -0
- package/docs/variables/ShoppingCartAddItemIcon.md +11 -0
- package/docs/variables/ShoppingCartArrowDownIcon.md +9 -0
- package/docs/variables/ShoppingCartIcon.md +9 -0
- package/docs/variables/StickyNoteAddIcon.md +9 -0
- package/docs/variables/StockManagementPictogram.md +7 -0
- package/docs/variables/SwitcherIcon.md +7 -0
- package/docs/variables/SyringeIcon.md +7 -0
- package/docs/variables/TableIcon.md +7 -0
- package/docs/variables/TableOfContentsIcon.md +9 -0
- package/docs/variables/TimeIcon.md +9 -0
- package/docs/variables/ToolsIcon.md +7 -0
- package/docs/variables/TranslateIcon.md +7 -0
- package/docs/variables/TrashCanIcon.md +7 -0
- package/docs/variables/TreeViewAltIcon.md +7 -0
- package/docs/variables/UserAvatarIcon.md +9 -0
- package/docs/variables/UserFollowIcon.md +7 -0
- package/docs/variables/UserHasAccess.md +35 -0
- package/docs/variables/UserIcon.md +7 -0
- package/docs/variables/UserXrayIcon.md +11 -0
- package/docs/variables/ViewIcon.md +7 -0
- package/docs/variables/ViewOffIcon.md +7 -0
- package/docs/variables/WarningIcon.md +7 -0
- package/docs/variables/attachmentUrl.md +7 -0
- package/docs/variables/backendDependencies.md +17 -0
- package/docs/variables/defaultVisitCustomRepresentation.md +7 -0
- package/docs/variables/fhirBaseUrl.md +7 -0
- package/docs/variables/getAsyncExtensionLifecycle.md +35 -0
- package/docs/variables/getStartedVisit.md +9 -0
- package/docs/variables/isUrl.md +9 -0
- package/docs/variables/offlineUuidPrefix.md +7 -0
- package/docs/variables/omrsOfflineCachingStrategyHttpHeaderName.md +7 -0
- package/docs/variables/omrsOfflineResponseBodyHttpHeaderName.md +7 -0
- package/docs/variables/omrsOfflineResponseStatusHttpHeaderName.md +7 -0
- package/docs/variables/restBaseUrl.md +7 -0
- package/docs/variables/sessionEndpoint.md +7 -0
- package/docs/variables/useConnectedExtensions.md +25 -0
- package/docs/variables/useExtensionStore.md +55 -0
- package/docs/variables/validators.md +78 -0
- package/package.json +24 -20
- package/rspack.config.cjs +1 -8
- package/tsconfig.build.json +2 -1
- package/typedoc.json +16 -3
- package/docs/.nojekyll +0 -1
- package/docs/enums/Type.md +0 -107
- package/docs/enums/VisitMode.md +0 -41
- package/docs/enums/VisitStatus.md +0 -30
- package/docs/interfaces/OldExtensionSlotBaseProps.md +0 -67
@@ -1,32 +1,25 @@
|
|
1
|
-
[
|
1
|
+
[O3 Framework](../API.md) / OfflinePatientDataSyncStore
|
2
2
|
|
3
|
-
# Interface: OfflinePatientDataSyncStore
|
3
|
+
# Interface: ~~OfflinePatientDataSyncStore~~
|
4
4
|
|
5
|
-
|
5
|
+
Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L6)
|
6
6
|
|
7
|
-
##
|
7
|
+
## Deprecated
|
8
8
|
|
9
|
-
|
9
|
+
Will be removed once all modules have been migrated to the new dynamic offline data API.
|
10
10
|
|
11
|
-
|
12
|
-
- [offlinePatientDataSyncState](OfflinePatientDataSyncStore.md#offlinepatientdatasyncstate)
|
11
|
+
## Properties
|
13
12
|
|
14
|
-
|
13
|
+
### ~~handlers~~
|
15
14
|
|
16
|
-
|
15
|
+
> **handlers**: `Record`\<`string`, [`OfflinePatientDataSyncHandler`](OfflinePatientDataSyncHandler.md)\>
|
17
16
|
|
18
|
-
|
17
|
+
Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L8)
|
19
18
|
|
20
|
-
|
19
|
+
***
|
21
20
|
|
22
|
-
|
21
|
+
### ~~offlinePatientDataSyncState~~
|
23
22
|
|
24
|
-
|
23
|
+
> **offlinePatientDataSyncState**: `Record`\<`string`, [`OfflinePatientDataSyncState`](OfflinePatientDataSyncState.md)\>
|
25
24
|
|
26
|
-
|
27
|
-
|
28
|
-
• **offlinePatientDataSyncState**: `Record`<`string`, [`OfflinePatientDataSyncState`](OfflinePatientDataSyncState.md)\>
|
29
|
-
|
30
|
-
#### Defined in
|
31
|
-
|
32
|
-
[packages/framework/esm-offline/src/offline-patient-data.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L7)
|
25
|
+
Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L7)
|
@@ -1,35 +1,25 @@
|
|
1
|
-
[
|
1
|
+
[O3 Framework](../API.md) / OmrsServiceWorkerMessage
|
2
2
|
|
3
|
-
# Interface: OmrsServiceWorkerMessage
|
3
|
+
# Interface: OmrsServiceWorkerMessage\<MessageTypeTypeIdentifier\>
|
4
4
|
|
5
|
-
|
5
|
+
Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L25)
|
6
6
|
|
7
|
-
|
8
|
-
| :------ | :------ |
|
9
|
-
| `MessageTypeTypeIdentifier` | extends `string` |
|
7
|
+
## Extended by
|
10
8
|
|
11
|
-
|
9
|
+
- [`OnImportMapChangedMessage`](OnImportMapChangedMessage.md)
|
10
|
+
- [`ClearDynamicRoutesMessage`](ClearDynamicRoutesMessage.md)
|
11
|
+
- [`RegisterDynamicRouteMessage`](RegisterDynamicRouteMessage.md)
|
12
12
|
|
13
|
-
|
13
|
+
## Type Parameters
|
14
14
|
|
15
|
-
|
15
|
+
### MessageTypeTypeIdentifier
|
16
16
|
|
17
|
-
|
17
|
+
`MessageTypeTypeIdentifier` *extends* `string`
|
18
18
|
|
19
|
-
|
20
|
-
|
21
|
-
## Table of contents
|
22
|
-
|
23
|
-
### Offline Properties
|
24
|
-
|
25
|
-
- [type](OmrsServiceWorkerMessage.md#type)
|
26
|
-
|
27
|
-
## Offline Properties
|
19
|
+
## Properties
|
28
20
|
|
29
21
|
### type
|
30
22
|
|
31
|
-
|
32
|
-
|
33
|
-
#### Defined in
|
23
|
+
> **type**: `MessageTypeTypeIdentifier`
|
34
24
|
|
35
|
-
[packages/framework/esm-offline/src/service-worker-messaging.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L26)
|
25
|
+
Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L26)
|
@@ -1,40 +1,29 @@
|
|
1
|
-
[
|
1
|
+
[O3 Framework](../API.md) / OnImportMapChangedMessage
|
2
2
|
|
3
3
|
# Interface: OnImportMapChangedMessage
|
4
4
|
|
5
|
-
|
5
|
+
Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L29)
|
6
6
|
|
7
|
-
|
7
|
+
## Extends
|
8
8
|
|
9
|
-
|
9
|
+
- [`OmrsServiceWorkerMessage`](OmrsServiceWorkerMessage.md)\<`"onImportMapChanged"`\>
|
10
10
|
|
11
|
-
##
|
12
|
-
|
13
|
-
### Offline Properties
|
14
|
-
|
15
|
-
- [importMap](OnImportMapChangedMessage.md#importmap)
|
16
|
-
- [type](OnImportMapChangedMessage.md#type)
|
17
|
-
|
18
|
-
## Offline Properties
|
11
|
+
## Properties
|
19
12
|
|
20
13
|
### importMap
|
21
14
|
|
22
|
-
|
23
|
-
|
24
|
-
#### Defined in
|
15
|
+
> **importMap**: [`ImportMap`](ImportMap.md)
|
25
16
|
|
26
|
-
[packages/framework/esm-offline/src/service-worker-messaging.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L30)
|
17
|
+
Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L30)
|
27
18
|
|
28
|
-
|
19
|
+
***
|
29
20
|
|
30
21
|
### type
|
31
22
|
|
32
|
-
|
23
|
+
> **type**: `"onImportMapChanged"`
|
33
24
|
|
34
|
-
|
35
|
-
|
36
|
-
[OmrsServiceWorkerMessage](OmrsServiceWorkerMessage.md).[type](OmrsServiceWorkerMessage.md#type)
|
25
|
+
Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L26)
|
37
26
|
|
38
|
-
####
|
27
|
+
#### Inherited from
|
39
28
|
|
40
|
-
[
|
29
|
+
[`OmrsServiceWorkerMessage`](OmrsServiceWorkerMessage.md).[`type`](OmrsServiceWorkerMessage.md#type)
|
@@ -1,29 +1,21 @@
|
|
1
|
-
[
|
1
|
+
[O3 Framework](../API.md) / OnlyThePatient
|
2
2
|
|
3
3
|
# Interface: OnlyThePatient
|
4
4
|
|
5
|
-
|
5
|
+
Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/current-patient.ts#L15)
|
6
6
|
|
7
|
-
|
8
|
-
|
9
|
-
↳ **`OnlyThePatient`**
|
10
|
-
|
11
|
-
## Table of contents
|
12
|
-
|
13
|
-
### API Properties
|
7
|
+
## Extends
|
14
8
|
|
15
|
-
- [
|
9
|
+
- [`CurrentPatientOptions`](CurrentPatientOptions.md)
|
16
10
|
|
17
|
-
##
|
11
|
+
## Properties
|
18
12
|
|
19
13
|
### includeConfig
|
20
14
|
|
21
|
-
|
22
|
-
|
23
|
-
#### Overrides
|
15
|
+
> **includeConfig**: `false`
|
24
16
|
|
25
|
-
[
|
17
|
+
Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/current-patient.ts#L16)
|
26
18
|
|
27
|
-
####
|
19
|
+
#### Overrides
|
28
20
|
|
29
|
-
[
|
21
|
+
[`CurrentPatientOptions`](CurrentPatientOptions.md).[`includeConfig`](CurrentPatientOptions.md#includeconfig)
|
@@ -1,210 +1,174 @@
|
|
1
|
-
[
|
1
|
+
[O3 Framework](../API.md) / OpenWorkspace
|
2
2
|
|
3
3
|
# Interface: OpenWorkspace
|
4
4
|
|
5
|
-
|
5
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:113](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L113)
|
6
6
|
|
7
|
-
|
7
|
+
The default parameters received by all workspaces
|
8
8
|
|
9
|
-
|
9
|
+
## Extends
|
10
10
|
|
11
|
-
|
11
|
+
- `WorkspaceRegistration`.[`DefaultWorkspaceProps`](DefaultWorkspaceProps.md)
|
12
12
|
|
13
|
-
##
|
13
|
+
## Properties
|
14
14
|
|
15
|
-
###
|
16
|
-
|
17
|
-
- [canHide](OpenWorkspace.md#canhide)
|
18
|
-
- [canMaximize](OpenWorkspace.md#canmaximize)
|
19
|
-
- [groups](OpenWorkspace.md#groups)
|
20
|
-
- [moduleName](OpenWorkspace.md#modulename)
|
21
|
-
- [name](OpenWorkspace.md#name)
|
22
|
-
- [preferredWindowSize](OpenWorkspace.md#preferredwindowsize)
|
23
|
-
- [title](OpenWorkspace.md#title)
|
24
|
-
- [titleNode](OpenWorkspace.md#titlenode)
|
25
|
-
- [type](OpenWorkspace.md#type)
|
26
|
-
- [width](OpenWorkspace.md#width)
|
27
|
-
|
28
|
-
### Workspace Properties
|
29
|
-
|
30
|
-
- [additionalProps](OpenWorkspace.md#additionalprops)
|
31
|
-
- [currentWorkspaceGroup](OpenWorkspace.md#currentworkspacegroup)
|
15
|
+
### additionalProps
|
32
16
|
|
33
|
-
|
17
|
+
> **additionalProps**: `object`
|
34
18
|
|
35
|
-
|
36
|
-
- [closeWorkspaceWithSavedChanges](OpenWorkspace.md#closeworkspacewithsavedchanges)
|
37
|
-
- [load](OpenWorkspace.md#load)
|
38
|
-
- [promptBeforeClosing](OpenWorkspace.md#promptbeforeclosing)
|
39
|
-
- [setTitle](OpenWorkspace.md#settitle)
|
19
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:114](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L114)
|
40
20
|
|
41
|
-
|
21
|
+
***
|
42
22
|
|
43
23
|
### canHide
|
44
24
|
|
45
|
-
|
25
|
+
> **canHide**: `boolean`
|
46
26
|
|
47
|
-
|
48
|
-
|
49
|
-
WorkspaceRegistration.canHide
|
27
|
+
Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:10
|
50
28
|
|
51
|
-
####
|
29
|
+
#### Inherited from
|
52
30
|
|
53
|
-
|
31
|
+
`WorkspaceRegistration.canHide`
|
54
32
|
|
55
|
-
|
33
|
+
***
|
56
34
|
|
57
35
|
### canMaximize
|
58
36
|
|
59
|
-
|
60
|
-
|
61
|
-
#### Inherited from
|
62
|
-
|
63
|
-
WorkspaceRegistration.canMaximize
|
37
|
+
> **canMaximize**: `boolean`
|
64
38
|
|
65
|
-
|
39
|
+
Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:11
|
66
40
|
|
67
|
-
|
68
|
-
|
69
|
-
___
|
41
|
+
#### Inherited from
|
70
42
|
|
71
|
-
|
43
|
+
`WorkspaceRegistration.canMaximize`
|
72
44
|
|
73
|
-
|
45
|
+
***
|
74
46
|
|
75
|
-
|
47
|
+
### currentWorkspaceGroup?
|
76
48
|
|
77
|
-
|
49
|
+
> `optional` **currentWorkspaceGroup**: `string`
|
78
50
|
|
79
|
-
|
51
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:115](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L115)
|
80
52
|
|
81
|
-
|
53
|
+
***
|
82
54
|
|
83
|
-
|
55
|
+
### groups
|
84
56
|
|
85
|
-
|
57
|
+
> **groups**: `string`[]
|
86
58
|
|
87
|
-
|
59
|
+
Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:18
|
88
60
|
|
89
61
|
#### Inherited from
|
90
62
|
|
91
|
-
WorkspaceRegistration.
|
63
|
+
`WorkspaceRegistration.groups`
|
92
64
|
|
93
|
-
|
65
|
+
***
|
94
66
|
|
95
|
-
|
67
|
+
### load()
|
96
68
|
|
97
|
-
|
69
|
+
> **load**: () => `Promise`\<`object` & `LifeCycles`\>
|
98
70
|
|
99
|
-
|
71
|
+
Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:14
|
72
|
+
|
73
|
+
#### Returns
|
100
74
|
|
101
|
-
|
75
|
+
`Promise`\<`object` & `LifeCycles`\>
|
102
76
|
|
103
77
|
#### Inherited from
|
104
78
|
|
105
|
-
WorkspaceRegistration.
|
106
|
-
|
107
|
-
#### Defined in
|
79
|
+
`WorkspaceRegistration.load`
|
108
80
|
|
109
|
-
|
81
|
+
***
|
110
82
|
|
111
|
-
|
83
|
+
### moduleName
|
112
84
|
|
113
|
-
|
85
|
+
> **moduleName**: `string`
|
114
86
|
|
115
|
-
|
87
|
+
Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:17
|
116
88
|
|
117
89
|
#### Inherited from
|
118
90
|
|
119
|
-
WorkspaceRegistration.
|
91
|
+
`WorkspaceRegistration.moduleName`
|
120
92
|
|
121
|
-
|
93
|
+
***
|
122
94
|
|
123
|
-
|
124
|
-
|
125
|
-
___
|
95
|
+
### name
|
126
96
|
|
127
|
-
|
97
|
+
> **name**: `string`
|
128
98
|
|
129
|
-
|
99
|
+
Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:6
|
130
100
|
|
131
101
|
#### Inherited from
|
132
102
|
|
133
|
-
WorkspaceRegistration.
|
134
|
-
|
135
|
-
#### Defined in
|
103
|
+
`WorkspaceRegistration.name`
|
136
104
|
|
137
|
-
|
105
|
+
***
|
138
106
|
|
139
|
-
|
107
|
+
### preferredWindowSize
|
140
108
|
|
141
|
-
|
109
|
+
> **preferredWindowSize**: [`WorkspaceWindowState`](../type-aliases/WorkspaceWindowState.md)
|
142
110
|
|
143
|
-
|
111
|
+
Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:13
|
144
112
|
|
145
113
|
#### Inherited from
|
146
114
|
|
147
|
-
WorkspaceRegistration.
|
148
|
-
|
149
|
-
#### Defined in
|
115
|
+
`WorkspaceRegistration.preferredWindowSize`
|
150
116
|
|
151
|
-
|
117
|
+
***
|
152
118
|
|
153
|
-
|
119
|
+
### title
|
154
120
|
|
155
|
-
|
121
|
+
> **title**: `string`
|
156
122
|
|
157
|
-
|
123
|
+
Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:7
|
158
124
|
|
159
125
|
#### Inherited from
|
160
126
|
|
161
|
-
WorkspaceRegistration.
|
127
|
+
`WorkspaceRegistration.title`
|
162
128
|
|
163
|
-
|
129
|
+
***
|
164
130
|
|
165
|
-
|
131
|
+
### titleNode?
|
166
132
|
|
167
|
-
|
168
|
-
|
169
|
-
### width
|
133
|
+
> `optional` **titleNode**: `ReactNode`
|
170
134
|
|
171
|
-
|
135
|
+
Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:8
|
172
136
|
|
173
137
|
#### Inherited from
|
174
138
|
|
175
|
-
WorkspaceRegistration.
|
139
|
+
`WorkspaceRegistration.titleNode`
|
176
140
|
|
177
|
-
|
141
|
+
***
|
178
142
|
|
179
|
-
|
180
|
-
|
181
|
-
___
|
143
|
+
### type
|
182
144
|
|
183
|
-
|
145
|
+
> **type**: `string`
|
184
146
|
|
185
|
-
|
147
|
+
Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:9
|
186
148
|
|
187
|
-
|
149
|
+
#### Inherited from
|
188
150
|
|
189
|
-
|
151
|
+
`WorkspaceRegistration.type`
|
190
152
|
|
191
|
-
|
153
|
+
***
|
192
154
|
|
193
|
-
|
155
|
+
### width
|
194
156
|
|
195
|
-
|
157
|
+
> **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
|
196
158
|
|
197
|
-
|
159
|
+
Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:12
|
198
160
|
|
199
|
-
####
|
161
|
+
#### Inherited from
|
200
162
|
|
201
|
-
|
163
|
+
`WorkspaceRegistration.width`
|
202
164
|
|
203
165
|
## Methods
|
204
166
|
|
205
|
-
### closeWorkspace
|
167
|
+
### closeWorkspace()
|
206
168
|
|
207
|
-
|
169
|
+
> **closeWorkspace**(`closeWorkspaceOptions?`): `void`
|
170
|
+
|
171
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L49)
|
208
172
|
|
209
173
|
Call this function to close the workspace. This function will prompt the user
|
210
174
|
if there are any unsaved changes to workspace.
|
@@ -214,9 +178,9 @@ closed, given the user forcefully closes the workspace.
|
|
214
178
|
|
215
179
|
#### Parameters
|
216
180
|
|
217
|
-
|
218
|
-
|
219
|
-
|
181
|
+
##### closeWorkspaceOptions?
|
182
|
+
|
183
|
+
[`CloseWorkspaceOptions`](CloseWorkspaceOptions.md)
|
220
184
|
|
221
185
|
#### Returns
|
222
186
|
|
@@ -224,71 +188,49 @@ closed, given the user forcefully closes the workspace.
|
|
224
188
|
|
225
189
|
#### Inherited from
|
226
190
|
|
227
|
-
[DefaultWorkspaceProps](DefaultWorkspaceProps.md).[closeWorkspace](DefaultWorkspaceProps.md#closeworkspace)
|
191
|
+
[`DefaultWorkspaceProps`](DefaultWorkspaceProps.md).[`closeWorkspace`](DefaultWorkspaceProps.md#closeworkspace)
|
228
192
|
|
229
|
-
|
193
|
+
***
|
230
194
|
|
231
|
-
|
195
|
+
### closeWorkspaceWithSavedChanges()
|
232
196
|
|
233
|
-
|
197
|
+
> **closeWorkspaceWithSavedChanges**(`closeWorkspaceOptions?`): `void`
|
234
198
|
|
235
|
-
|
236
|
-
|
237
|
-
▸ **closeWorkspaceWithSavedChanges**(`closeWorkspaceOptions?`): `void`
|
199
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L59)
|
238
200
|
|
239
201
|
Call this function to close the workspace after the form is saved. This function
|
240
202
|
will directly close the workspace without any prompt
|
241
203
|
|
242
204
|
#### Parameters
|
243
205
|
|
244
|
-
|
245
|
-
| :------ | :------ |
|
246
|
-
| `closeWorkspaceOptions?` | [`CloseWorkspaceOptions`](CloseWorkspaceOptions.md) |
|
247
|
-
|
248
|
-
#### Returns
|
249
|
-
|
250
|
-
`void`
|
251
|
-
|
252
|
-
#### Inherited from
|
253
|
-
|
254
|
-
[DefaultWorkspaceProps](DefaultWorkspaceProps.md).[closeWorkspaceWithSavedChanges](DefaultWorkspaceProps.md#closeworkspacewithsavedchanges)
|
206
|
+
##### closeWorkspaceOptions?
|
255
207
|
|
256
|
-
|
257
|
-
|
258
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L59)
|
259
|
-
|
260
|
-
___
|
261
|
-
|
262
|
-
### load
|
263
|
-
|
264
|
-
▸ **load**(): `Promise`<{ `default?`: `LifeCycles`<{}\> } & `LifeCycles`<{}\>\>
|
208
|
+
[`CloseWorkspaceOptions`](CloseWorkspaceOptions.md)
|
265
209
|
|
266
210
|
#### Returns
|
267
211
|
|
268
|
-
`
|
212
|
+
`void`
|
269
213
|
|
270
214
|
#### Inherited from
|
271
215
|
|
272
|
-
|
273
|
-
|
274
|
-
#### Defined in
|
216
|
+
[`DefaultWorkspaceProps`](DefaultWorkspaceProps.md).[`closeWorkspaceWithSavedChanges`](DefaultWorkspaceProps.md#closeworkspacewithsavedchanges)
|
275
217
|
|
276
|
-
|
218
|
+
***
|
277
219
|
|
278
|
-
|
220
|
+
### promptBeforeClosing()
|
279
221
|
|
280
|
-
|
222
|
+
> **promptBeforeClosing**(`testFcn`): `void`
|
281
223
|
|
282
|
-
|
224
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L54)
|
283
225
|
|
284
226
|
Call this with a no-args function that returns true if the user should be prompted before
|
285
227
|
this workspace is closed; e.g. if there is unsaved data.
|
286
228
|
|
287
229
|
#### Parameters
|
288
230
|
|
289
|
-
|
290
|
-
|
291
|
-
|
231
|
+
##### testFcn
|
232
|
+
|
233
|
+
() => `boolean`
|
292
234
|
|
293
235
|
#### Returns
|
294
236
|
|
@@ -296,17 +238,15 @@ this workspace is closed; e.g. if there is unsaved data.
|
|
296
238
|
|
297
239
|
#### Inherited from
|
298
240
|
|
299
|
-
[DefaultWorkspaceProps](DefaultWorkspaceProps.md).[promptBeforeClosing](DefaultWorkspaceProps.md#promptbeforeclosing)
|
300
|
-
|
301
|
-
#### Defined in
|
241
|
+
[`DefaultWorkspaceProps`](DefaultWorkspaceProps.md).[`promptBeforeClosing`](DefaultWorkspaceProps.md#promptbeforeclosing)
|
302
242
|
|
303
|
-
|
243
|
+
***
|
304
244
|
|
305
|
-
|
245
|
+
### setTitle()
|
306
246
|
|
307
|
-
|
247
|
+
> **setTitle**(`title`, `titleNode?`): `void`
|
308
248
|
|
309
|
-
|
249
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L74)
|
310
250
|
|
311
251
|
Use this to set the workspace title if it needs to be set dynamically.
|
312
252
|
|
@@ -317,10 +257,20 @@ title needs to be set dynamically.
|
|
317
257
|
|
318
258
|
#### Parameters
|
319
259
|
|
320
|
-
|
321
|
-
|
322
|
-
|
323
|
-
|
260
|
+
##### title
|
261
|
+
|
262
|
+
`string`
|
263
|
+
|
264
|
+
The title to set. If using titleNode, set this to a human-readable string
|
265
|
+
which will identify the workspace in notifications and other places.
|
266
|
+
|
267
|
+
##### titleNode?
|
268
|
+
|
269
|
+
`ReactNode`
|
270
|
+
|
271
|
+
A React object to put in the workspace header in place of the title. This
|
272
|
+
is useful for displaying custom elements in the header. Note that custom header
|
273
|
+
elements can also be attached to the workspace header extension slots.
|
324
274
|
|
325
275
|
#### Returns
|
326
276
|
|
@@ -328,8 +278,4 @@ title needs to be set dynamically.
|
|
328
278
|
|
329
279
|
#### Inherited from
|
330
280
|
|
331
|
-
[DefaultWorkspaceProps](DefaultWorkspaceProps.md).[setTitle](DefaultWorkspaceProps.md#settitle)
|
332
|
-
|
333
|
-
#### Defined in
|
334
|
-
|
335
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L74)
|
281
|
+
[`DefaultWorkspaceProps`](DefaultWorkspaceProps.md).[`setTitle`](DefaultWorkspaceProps.md#settitle)
|