@openmrs/esm-framework 6.3.1-pre.3105 → 6.3.1-pre.3106
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/.nojekyll +1 -0
- package/docs/API.md +8579 -310
- package/docs/classes/OpenmrsFetchError.md +117 -88
- package/docs/enums/Type.md +107 -0
- package/docs/enums/VisitMode.md +41 -0
- package/docs/enums/VisitStatus.md +30 -0
- package/docs/interfaces/ActionMenuButtonProps.md +57 -33
- package/docs/interfaces/ActionableNotificationDescriptor.md +67 -37
- package/docs/interfaces/AssignedExtension.md +57 -30
- package/docs/interfaces/Attachment.md +47 -23
- package/docs/interfaces/AttachmentResponse.md +41 -20
- package/docs/interfaces/AuditInfo.md +88 -49
- package/docs/interfaces/BreadcrumbRegistration.md +17 -8
- package/docs/interfaces/BreadcrumbSettings.md +33 -18
- package/docs/interfaces/CancelLoading.md +10 -6
- package/docs/interfaces/ClearDynamicRoutesMessage.md +17 -9
- package/docs/interfaces/CloseWorkspaceOptions.md +29 -18
- package/docs/interfaces/ComponentConfig.md +23 -11
- package/docs/interfaces/Concept.md +131 -83
- package/docs/interfaces/ConceptClass.md +67 -46
- package/docs/interfaces/ConceptDatatype.md +74 -50
- package/docs/interfaces/ConceptName.md +74 -50
- package/docs/interfaces/Config.md +2 -4
- package/docs/interfaces/ConfigObject.md +21 -12
- package/docs/interfaces/ConfigSchema.md +27 -15
- package/docs/interfaces/ConfigurableLinkProps.md +4314 -24
- package/docs/interfaces/ConnectedExtension.md +41 -25
- package/docs/interfaces/ConnectivityChangedEvent.md +10 -4
- package/docs/interfaces/CurrentPatientOptions.md +18 -9
- package/docs/interfaces/DashboardExtensionProps.md +28 -13
- package/docs/interfaces/DefaultWorkspaceProps.md +51 -44
- package/docs/interfaces/Diagnosis.md +104 -80
- package/docs/interfaces/DisplayConditionsConfigObject.md +33 -18
- package/docs/interfaces/DynamicOfflineData.md +41 -23
- package/docs/interfaces/DynamicOfflineDataHandler.md +54 -47
- package/docs/interfaces/DynamicOfflineDataSyncState.md +39 -29
- package/docs/interfaces/EmrApiConfigurationResponse.md +350 -243
- package/docs/interfaces/Encounter.md +110 -67
- package/docs/interfaces/EncounterProvider.md +61 -39
- package/docs/interfaces/EncounterRole.md +68 -43
- package/docs/interfaces/EncounterType.md +68 -43
- package/docs/interfaces/ErrorStateProps.md +16 -7
- package/docs/interfaces/ExtensionData.md +22 -10
- package/docs/interfaces/ExtensionMeta.md +2 -4
- package/docs/interfaces/ExtensionRegistration.md +69 -36
- package/docs/interfaces/ExtensionSlotBaseProps.md +35 -35
- package/docs/interfaces/ExtensionSlotConfig.md +32 -17
- package/docs/interfaces/ExtensionSlotConfigObject.md +26 -14
- package/docs/interfaces/ExtensionSlotConfigureValueObject.md +2 -4
- package/docs/interfaces/ExtensionSlotState.md +18 -9
- package/docs/interfaces/ExtensionStore.md +11 -5
- package/docs/interfaces/FHIRCode.md +23 -11
- package/docs/interfaces/FHIRLocationResource.md +18 -25
- package/docs/interfaces/FHIRResource.md +41 -105
- package/docs/interfaces/FeatureFlagDefinition.md +26 -14
- package/docs/interfaces/FetchConfig.md +117 -80
- package/docs/interfaces/FetchError.md +21 -8
- package/docs/interfaces/FetchHeaders.md +2 -4
- package/docs/interfaces/FetchResponse.md +130 -124
- package/docs/interfaces/FetchResponseJson.md +2 -4
- package/docs/interfaces/ImportMap.md +10 -4
- package/docs/interfaces/LeftNavStore.md +29 -14
- package/docs/interfaces/Link.md +23 -11
- package/docs/interfaces/Location.md +250 -147
- package/docs/interfaces/LoggedInUser.md +70 -68
- package/docs/interfaces/LoggedInUserFetchResponse.md +128 -120
- package/docs/interfaces/MessageServiceWorkerResult.md +29 -17
- package/docs/interfaces/NavigateOptions.md +18 -9
- package/docs/interfaces/NewVisitPayload.md +48 -32
- package/docs/interfaces/NotificationDescriptor.md +58 -31
- package/docs/interfaces/Obs.md +166 -99
- package/docs/interfaces/OfflineModeResult.md +23 -11
- package/docs/interfaces/OfflinePatientArgs.md +20 -13
- package/docs/interfaces/OfflinePatientDataSyncHandler.md +27 -17
- package/docs/interfaces/OfflinePatientDataSyncState.md +51 -29
- package/docs/interfaces/OfflinePatientDataSyncStore.md +20 -13
- package/docs/interfaces/OldExtensionSlotBaseProps.md +67 -0
- package/docs/interfaces/OmrsServiceWorkerMessage.md +23 -13
- package/docs/interfaces/OnImportMapChangedMessage.md +23 -12
- package/docs/interfaces/OnlyThePatient.md +17 -9
- package/docs/interfaces/OpenWorkspace.md +170 -116
- package/docs/interfaces/OpenmrsAppContextProps.md +23 -14
- package/docs/interfaces/OpenmrsAppRoutes.md +71 -41
- package/docs/interfaces/OpenmrsDatePickerProps.md +483 -346
- package/docs/interfaces/OpenmrsResource.md +57 -39
- package/docs/interfaces/OpenmrsResourceStrict.md +51 -27
- package/docs/interfaces/PageHeaderContentProps.md +24 -12
- package/docs/interfaces/PageHeaderWrapperProps.md +18 -9
- package/docs/interfaces/Patient.md +70 -41
- package/docs/interfaces/PatientBannerActionsMenuProps.md +30 -15
- package/docs/interfaces/PatientBannerToggleContactDetailsButtonProps.md +32 -17
- package/docs/interfaces/PatientIdentifier.md +84 -49
- package/docs/interfaces/PatientIdentifierType.md +112 -65
- package/docs/interfaces/PatientPhotoProps.md +17 -8
- package/docs/interfaces/PatientWithFullResponse.md +17 -9
- package/docs/interfaces/Person.md +160 -96
- package/docs/interfaces/PersonAddress.md +230 -136
- package/docs/interfaces/PersonAttribute.md +68 -43
- package/docs/interfaces/PersonName.md +118 -72
- package/docs/interfaces/PrecacheStaticDependenciesEvent.md +1 -3
- package/docs/interfaces/PrimaryIdentifier.md +11 -5
- package/docs/interfaces/Privilege.md +23 -11
- package/docs/interfaces/Prompt.md +41 -20
- package/docs/interfaces/QueueItemDescriptor.md +30 -23
- package/docs/interfaces/RegisterDynamicRouteMessage.md +38 -21
- package/docs/interfaces/ResourceLoader.md +14 -10
- package/docs/interfaces/ResponsiveWrapperProps.md +11 -5
- package/docs/interfaces/RetryOptions.md +37 -36
- package/docs/interfaces/Role.md +22 -10
- package/docs/interfaces/Session.md +54 -31
- package/docs/interfaces/SessionLocation.md +22 -10
- package/docs/interfaces/SetLeftNavParams.md +30 -15
- package/docs/interfaces/ShowActionableNotificationEvent.md +50 -26
- package/docs/interfaces/ShowNotificationEvent.md +38 -20
- package/docs/interfaces/ShowSnackbarEvent.md +64 -34
- package/docs/interfaces/ShowToastEvent.md +43 -22
- package/docs/interfaces/SnackbarDescriptor.md +76 -41
- package/docs/interfaces/SnackbarMeta.md +93 -55
- package/docs/interfaces/SpaConfig.md +40 -30
- package/docs/interfaces/StyleguideConfigObject.md +70 -39
- package/docs/interfaces/SyncItem.md +57 -34
- package/docs/interfaces/SyncProcessOptions.md +40 -22
- package/docs/interfaces/ToastDescriptor.md +55 -29
- package/docs/interfaces/ToastNotificationMeta.md +69 -40
- package/docs/interfaces/UploadedFile.md +49 -25
- package/docs/interfaces/UseConfigOptions.md +12 -6
- package/docs/interfaces/UsePatientPhotoResult.md +24 -12
- package/docs/interfaces/UseServerFetchAllOptions.md +61 -41
- package/docs/interfaces/UseServerInfiniteOptions.md +46 -29
- package/docs/interfaces/UseServerPaginationOptions.md +41 -26
- package/docs/interfaces/User.md +46 -34
- package/docs/interfaces/UserHasAccessProps.md +25 -13
- package/docs/interfaces/Visit.md +66 -36
- package/docs/interfaces/VisitItem.md +31 -16
- package/docs/interfaces/VisitReturnType.md +51 -24
- package/docs/interfaces/VisitStoreState.md +26 -14
- package/docs/interfaces/VisitType.md +23 -11
- package/docs/interfaces/WorkspaceContainerProps.md +38 -20
- package/docs/interfaces/WorkspaceGroupDefinition.md +19 -10
- package/docs/interfaces/WorkspaceRegistration.md +82 -43
- package/docs/interfaces/WorkspacesInfo.md +40 -26
- package/package.json +20 -24
- package/rspack.config.cjs +8 -1
- package/tsconfig.build.json +1 -2
- package/typedoc.json +4 -16
- package/docs/enumerations/Type.md +0 -77
- package/docs/enumerations/VisitMode.md +0 -29
- package/docs/enumerations/VisitStatus.md +0 -21
- package/docs/functions/ConfigurableLink.md +0 -19
- package/docs/functions/CustomOverflowMenu.md +0 -17
- package/docs/functions/DashboardExtension.md +0 -17
- package/docs/functions/ExtensionSlot.md +0 -46
- package/docs/functions/OpenmrsAppContext.md +0 -36
- package/docs/functions/PatientBannerActionsMenu.md +0 -17
- package/docs/functions/PatientBannerContactDetails.md +0 -17
- package/docs/functions/PatientBannerPatientIdentifiers.md +0 -17
- package/docs/functions/PatientBannerPatientInfo.md +0 -17
- package/docs/functions/PatientBannerToggleContactDetailsButton.md +0 -17
- package/docs/functions/PatientPhoto.md +0 -19
- package/docs/functions/WorkspaceContainer.md +0 -55
- package/docs/functions/age.md +0 -32
- package/docs/functions/attach.md +0 -40
- package/docs/functions/beginEditSynchronizationItem.md +0 -22
- package/docs/functions/canAccessStorage.md +0 -25
- package/docs/functions/canBeginEditSynchronizationItemsOfType.md +0 -22
- package/docs/functions/clearCurrentUser.md +0 -11
- package/docs/functions/closeWorkspace.md +0 -27
- package/docs/functions/compile.md +0 -30
- package/docs/functions/convertToLocaleCalendar.md +0 -25
- package/docs/functions/createAttachment.md +0 -21
- package/docs/functions/createErrorHandler.md +0 -21
- package/docs/functions/createGlobalStore.md +0 -36
- package/docs/functions/createUseStore.md +0 -66
- package/docs/functions/defineConfigSchema.md +0 -33
- package/docs/functions/defineExtensionConfigSchema.md +0 -38
- package/docs/functions/deleteAttachmentPermanently.md +0 -21
- package/docs/functions/deleteSynchronizationItem.md +0 -21
- package/docs/functions/detach.md +0 -25
- package/docs/functions/detachAll.md +0 -21
- package/docs/functions/dispatchNotificationShown.md +0 -17
- package/docs/functions/dispatchPrecacheStaticDependencies.md +0 -17
- package/docs/functions/displayName.md +0 -21
- package/docs/functions/evaluate.md +0 -84
- package/docs/functions/evaluateAsBoolean.md +0 -31
- package/docs/functions/evaluateAsBooleanAsync.md +0 -31
- package/docs/functions/evaluateAsNumber.md +0 -31
- package/docs/functions/evaluateAsNumberAsync.md +0 -31
- package/docs/functions/evaluateAsType.md +0 -46
- package/docs/functions/evaluateAsTypeAsync.md +0 -46
- package/docs/functions/evaluateAsync.md +0 -87
- package/docs/functions/extractVariableNames.md +0 -50
- package/docs/functions/fetchCurrentPatient.md +0 -25
- package/docs/functions/filterBreadcrumbs.md +0 -21
- package/docs/functions/formatDate.md +0 -39
- package/docs/functions/formatDatetime.md +0 -29
- package/docs/functions/formatPartialDate.md +0 -39
- package/docs/functions/formatPatientName.md +0 -23
- package/docs/functions/formatTime.md +0 -20
- package/docs/functions/formattedName.md +0 -21
- package/docs/functions/generateOfflineUuid.md +0 -13
- package/docs/functions/getAssignedExtensions.md +0 -23
- package/docs/functions/getAsyncLifecycle.md +0 -31
- package/docs/functions/getAttachmentByUuid.md +0 -21
- package/docs/functions/getAttachments.md +0 -25
- package/docs/functions/getBreadcrumbs.md +0 -11
- package/docs/functions/getBreadcrumbsFor.md +0 -17
- package/docs/functions/getConfig.md +0 -31
- package/docs/functions/getContext.md +0 -29
- package/docs/functions/getCoreTranslation.md +0 -35
- package/docs/functions/getCurrentOfflineMode.md +0 -11
- package/docs/functions/getCurrentUser.md +0 -154
- package/docs/functions/getDefaultCalendar.md +0 -21
- package/docs/functions/getDefaultsFromConfigSchema.md +0 -32
- package/docs/functions/getDynamicOfflineDataEntries.md +0 -28
- package/docs/functions/getDynamicOfflineDataEntriesFor.md +0 -34
- package/docs/functions/getDynamicOfflineDataHandlers.md +0 -13
- package/docs/functions/getExtensionNameFromId.md +0 -30
- package/docs/functions/getExtensionStore.md +0 -14
- package/docs/functions/getFeatureFlag.md +0 -21
- package/docs/functions/getFhirServerPaginationHandlers.md +0 -17
- package/docs/functions/getFullSynchronizationItems.md +0 -27
- package/docs/functions/getFullSynchronizationItemsFor.md +0 -33
- package/docs/functions/getGlobalStore.md +0 -36
- package/docs/functions/getHistory.md +0 -13
- package/docs/functions/getLifecycle.md +0 -27
- package/docs/functions/getLocale.md +0 -15
- package/docs/functions/getLocations.md +0 -21
- package/docs/functions/getLoggedInUser.md +0 -11
- package/docs/functions/getOfflinePatientDataStore.md +0 -15
- package/docs/functions/getPatientName.md +0 -26
- package/docs/functions/getSessionLocation.md +0 -11
- package/docs/functions/getSessionStore.md +0 -11
- package/docs/functions/getSyncLifecycle.md +0 -31
- package/docs/functions/getSynchronizationItem.md +0 -27
- package/docs/functions/getSynchronizationItems.md +0 -27
- package/docs/functions/getVisitStore.md +0 -11
- package/docs/functions/getVisitTypes.md +0 -11
- package/docs/functions/getVisitsForPatient.md +0 -29
- package/docs/functions/goBackInHistory.md +0 -25
- package/docs/functions/importDynamic.md +0 -58
- package/docs/functions/inRange.md +0 -27
- package/docs/functions/interpolateString.md +0 -34
- package/docs/functions/interpolateUrl.md +0 -48
- package/docs/functions/isDesktop.md +0 -17
- package/docs/functions/isDevEnabled.md +0 -11
- package/docs/functions/isOfflineUuid.md +0 -19
- package/docs/functions/isOmrsDateStrict.md +0 -20
- package/docs/functions/isOmrsDateToday.md +0 -19
- package/docs/functions/isOnline.md +0 -17
- package/docs/functions/isUrlWithTemplateParameters.md +0 -22
- package/docs/functions/isVersionSatisfied.md +0 -21
- package/docs/functions/launchWorkspace.md +0 -56
- package/docs/functions/launchWorkspaceGroup.md +0 -38
- package/docs/functions/makeUrl.md +0 -26
- package/docs/functions/messageOmrsServiceWorker.md +0 -23
- package/docs/functions/navigate.md +0 -48
- package/docs/functions/navigateAndLaunchWorkspace.md +0 -33
- package/docs/functions/oneOf.md +0 -21
- package/docs/functions/openmrsFetch.md +0 -75
- package/docs/functions/openmrsObservableFetch.md +0 -55
- package/docs/functions/parseDate.md +0 -20
- package/docs/functions/provide.md +0 -21
- package/docs/functions/putDynamicOfflineData.md +0 -28
- package/docs/functions/putDynamicOfflineDataFor.md +0 -34
- package/docs/functions/queueSynchronizationItem.md +0 -39
- package/docs/functions/refetchCurrentUser.md +0 -33
- package/docs/functions/registerBreadcrumb.md +0 -17
- package/docs/functions/registerBreadcrumbs.md +0 -17
- package/docs/functions/registerContext.md +0 -34
- package/docs/functions/registerDefaultCalendar.md +0 -33
- package/docs/functions/registerFeatureFlag.md +0 -36
- package/docs/functions/registerOfflinePatientHandler.md +0 -25
- package/docs/functions/removeDynamicOfflineData.md +0 -28
- package/docs/functions/removeDynamicOfflineDataFor.md +0 -34
- package/docs/functions/renderExtension.md +0 -41
- package/docs/functions/reportError.md +0 -17
- package/docs/functions/retry.md +0 -44
- package/docs/functions/saveVisit.md +0 -21
- package/docs/functions/selectPreferredName.md +0 -46
- package/docs/functions/setCurrentVisit.md +0 -21
- package/docs/functions/setLeftNav.md +0 -23
- package/docs/functions/setSessionLocation.md +0 -21
- package/docs/functions/setUserLanguage.md +0 -17
- package/docs/functions/setUserProperties.md +0 -23
- package/docs/functions/setupDynamicOfflineDataHandler.md +0 -22
- package/docs/functions/setupOfflineSync.md +0 -49
- package/docs/functions/shallowEqual.md +0 -32
- package/docs/functions/showActionableNotification.md +0 -21
- package/docs/functions/showModal.md +0 -44
- package/docs/functions/showNotification.md +0 -21
- package/docs/functions/showSnackbar.md +0 -21
- package/docs/functions/showToast.md +0 -21
- package/docs/functions/subscribeActionableNotificationShown.md +0 -21
- package/docs/functions/subscribeConnectivity.md +0 -21
- package/docs/functions/subscribeConnectivityChanged.md +0 -21
- package/docs/functions/subscribeNotificationShown.md +0 -21
- package/docs/functions/subscribePrecacheStaticDependencies.md +0 -21
- package/docs/functions/subscribeSnackbarShown.md +0 -21
- package/docs/functions/subscribeTo.md +0 -75
- package/docs/functions/subscribeToContext.md +0 -39
- package/docs/functions/subscribeToastShown.md +0 -21
- package/docs/functions/syncAllDynamicOfflineData.md +0 -27
- package/docs/functions/syncDynamicOfflineData.md +0 -33
- package/docs/functions/syncOfflinePatientData.md +0 -21
- package/docs/functions/toDateObjectStrict.md +0 -20
- package/docs/functions/toLocationObject.md +0 -17
- package/docs/functions/toOmrsIsoString.md +0 -23
- package/docs/functions/toVisitTypeObject.md +0 -17
- package/docs/functions/translateFrom.md +0 -55
- package/docs/functions/unregisterContext.md +0 -20
- package/docs/functions/unsetLeftNav.md +0 -23
- package/docs/functions/updateContext.md +0 -29
- package/docs/functions/updateVisit.md +0 -25
- package/docs/functions/useAbortController.md +0 -32
- package/docs/functions/useAppContext.md +0 -43
- package/docs/functions/useAssignedExtensionIds.md +0 -26
- package/docs/functions/useAssignedExtensions.md +0 -21
- package/docs/functions/useAttachments.md +0 -41
- package/docs/functions/useBodyScrollLock.md +0 -17
- package/docs/functions/useConfig.md +0 -27
- package/docs/functions/useConnectivity.md +0 -11
- package/docs/functions/useDebounce.md +0 -57
- package/docs/functions/useDefineAppContext.md +0 -70
- package/docs/functions/useEmrConfiguration.md +0 -35
- package/docs/functions/useExtensionSlotMeta.md +0 -25
- package/docs/functions/useExtensionSlotStore.md +0 -17
- package/docs/functions/useFeatureFlag.md +0 -30
- package/docs/functions/useFhirFetchAll.md +0 -44
- package/docs/functions/useFhirInfinite.md +0 -46
- package/docs/functions/useFhirPagination.md +0 -129
- package/docs/functions/useLayoutType.md +0 -11
- package/docs/functions/useLeftNav.md +0 -17
- package/docs/functions/useLeftNavStore.md +0 -11
- package/docs/functions/useLocations.md +0 -21
- package/docs/functions/useOnClickOutside.md +0 -27
- package/docs/functions/useOnVisible.md +0 -28
- package/docs/functions/useOpenmrsFetchAll.md +0 -46
- package/docs/functions/useOpenmrsInfinite.md +0 -54
- package/docs/functions/useOpenmrsPagination.md +0 -140
- package/docs/functions/useOpenmrsSWR.md +0 -71
- package/docs/functions/usePagination.md +0 -89
- package/docs/functions/usePatient.md +0 -38
- package/docs/functions/usePatientPhoto.md +0 -17
- package/docs/functions/usePrimaryIdentifierCode.md +0 -23
- package/docs/functions/useRenderableExtensions.md +0 -43
- package/docs/functions/useSession.md +0 -19
- package/docs/functions/useStore.md +0 -131
- package/docs/functions/useStoreWithActions.md +0 -33
- package/docs/functions/useVisit.md +0 -41
- package/docs/functions/useVisitContextStore.md +0 -23
- package/docs/functions/useVisitTypes.md +0 -11
- package/docs/functions/useWorkspaces.md +0 -11
- package/docs/functions/userHasAccess.md +0 -27
- package/docs/functions/validator.md +0 -44
- package/docs/interfaces/ExtensionSlotProps.md +0 -3520
- package/docs/type-aliases/ActionFunction.md +0 -27
- package/docs/type-aliases/ActionableNotificationType.md +0 -7
- package/docs/type-aliases/Actions.md +0 -13
- package/docs/type-aliases/ArgumentsTuple.md +0 -7
- package/docs/type-aliases/BoundActions.md +0 -17
- package/docs/type-aliases/ConfigValue.md +0 -7
- package/docs/type-aliases/ContextCallback.md +0 -23
- package/docs/type-aliases/CoreTranslationKey.md +0 -7
- package/docs/type-aliases/CurrentPatient.md +0 -7
- package/docs/type-aliases/DateInput.md +0 -7
- package/docs/type-aliases/DefaultEvaluateReturnType.md +0 -9
- package/docs/type-aliases/ExtensionDefinition.md +0 -69
- package/docs/type-aliases/ExtensionProps.md +0 -13
- package/docs/type-aliases/FormatDateMode.md +0 -7
- package/docs/type-aliases/FormatDateOptions.md +0 -102
- package/docs/type-aliases/IconProps.md +0 -31
- package/docs/type-aliases/InlineNotificationType.md +0 -7
- package/docs/type-aliases/Key.md +0 -7
- package/docs/type-aliases/KnownOmrsServiceWorkerMessages.md +0 -7
- package/docs/type-aliases/LayoutType.md +0 -7
- package/docs/type-aliases/LoadedSessionStore.md +0 -23
- package/docs/type-aliases/ModalDefinition.md +0 -17
- package/docs/type-aliases/NameUse.md +0 -7
- package/docs/type-aliases/NullablePatient.md +0 -7
- package/docs/type-aliases/OfflineMode.md +0 -7
- package/docs/type-aliases/OmrsOfflineCachingStrategy.md +0 -12
- package/docs/type-aliases/OmrsOfflineHttpHeaderNames.md +0 -7
- package/docs/type-aliases/OmrsOfflineHttpHeaders.md +0 -44
- package/docs/type-aliases/OpenmrsRoutes.md +0 -10
- package/docs/type-aliases/PageDefinition.md +0 -41
- package/docs/type-aliases/PageHeaderProps.md +0 -7
- package/docs/type-aliases/PatientUuid.md +0 -7
- package/docs/type-aliases/PictogramProps.md +0 -23
- package/docs/type-aliases/ProvidedConfig.md +0 -23
- package/docs/type-aliases/ResourceName.md +0 -7
- package/docs/type-aliases/SessionStore.md +0 -7
- package/docs/type-aliases/SnackbarType.md +0 -7
- package/docs/type-aliases/SpaEnvironment.md +0 -7
- package/docs/type-aliases/SvgIconProps.md +0 -23
- package/docs/type-aliases/SvgPictogramProps.md +0 -27
- package/docs/type-aliases/TemplateParams.md +0 -11
- package/docs/type-aliases/ToastType.md +0 -7
- package/docs/type-aliases/UnloadedSessionStore.md +0 -23
- package/docs/type-aliases/UpdateVisitPayload.md +0 -7
- package/docs/type-aliases/UseOpenmrsSWROptions.md +0 -39
- package/docs/type-aliases/Validator.md +0 -17
- package/docs/type-aliases/ValidatorFunction.md +0 -17
- package/docs/type-aliases/VariablesMap.md +0 -13
- package/docs/type-aliases/WorkspaceDefinition.md +0 -78
- package/docs/type-aliases/WorkspaceWindowState.md +0 -7
- package/docs/variables/ActionMenuButton.md +0 -7
- package/docs/variables/ActivityIcon.md +0 -7
- package/docs/variables/AddIcon.md +0 -7
- package/docs/variables/AllergiesIcon.md +0 -7
- package/docs/variables/AppointmentsPictogram.md +0 -7
- package/docs/variables/ArrowDownIcon.md +0 -7
- package/docs/variables/ArrowLeftIcon.md +0 -7
- package/docs/variables/ArrowRightIcon.md +0 -7
- package/docs/variables/ArrowUpIcon.md +0 -7
- package/docs/variables/AttachmentIcon.md +0 -7
- package/docs/variables/BabyIcon.md +0 -7
- package/docs/variables/CalendarHeatMapIcon.md +0 -7
- package/docs/variables/CalendarIcon.md +0 -7
- package/docs/variables/CaretDownIcon.md +0 -7
- package/docs/variables/CaretLeftIcon.md +0 -7
- package/docs/variables/CaretRightIcon.md +0 -7
- package/docs/variables/CaretUpIcon.md +0 -7
- package/docs/variables/ChartAverageIcon.md +0 -7
- package/docs/variables/CheckmarkFilledIcon.md +0 -7
- package/docs/variables/CheckmarkOutlineIcon.md +0 -7
- package/docs/variables/ChemistryIcon.md +0 -7
- package/docs/variables/ChevronDownIcon.md +0 -7
- package/docs/variables/ChevronLeftIcon.md +0 -7
- package/docs/variables/ChevronRightIcon.md +0 -7
- package/docs/variables/ChevronUpIcon.md +0 -7
- package/docs/variables/CloseFilledIcon.md +0 -7
- package/docs/variables/CloseIcon.md +0 -7
- package/docs/variables/CloseOutlineIcon.md +0 -7
- package/docs/variables/ConditionsIcon.md +0 -11
- package/docs/variables/DiagnosisTags.md +0 -11
- package/docs/variables/DocumentAttachmentIcon.md +0 -7
- package/docs/variables/DocumentIcon.md +0 -7
- package/docs/variables/DownloadIcon.md +0 -7
- package/docs/variables/DrugOrderIcon.md +0 -7
- package/docs/variables/EditIcon.md +0 -7
- package/docs/variables/ErrorState.md +0 -7
- package/docs/variables/EventScheduleIcon.md +0 -7
- package/docs/variables/EventsIcon.md +0 -7
- package/docs/variables/Extension.md +0 -15
- package/docs/variables/GenderFemaleIcon.md +0 -7
- package/docs/variables/GenderMaleIcon.md +0 -7
- package/docs/variables/GenderOtherIcon.md +0 -7
- package/docs/variables/GenderUnknownIcon.md +0 -7
- package/docs/variables/GenericOrderTypeIcon.md +0 -7
- package/docs/variables/GroupAccessIcon.md +0 -7
- package/docs/variables/GroupIcon.md +0 -7
- package/docs/variables/HomePictogram.md +0 -7
- package/docs/variables/HospitalBedIcon.md +0 -7
- package/docs/variables/Icon.md +0 -9
- package/docs/variables/ImageMedicalIcon.md +0 -7
- package/docs/variables/InPatientPictogram.md +0 -7
- package/docs/variables/InformationFilledIcon.md +0 -7
- package/docs/variables/InformationIcon.md +0 -7
- package/docs/variables/InformationSquareIcon.md +0 -7
- package/docs/variables/InventoryManagementIcon.md +0 -7
- package/docs/variables/LabOrderIcon.md +0 -7
- package/docs/variables/LaboratoryPictogram.md +0 -7
- package/docs/variables/LeftNavMenu.md +0 -13
- package/docs/variables/ListCheckedIcon.md +0 -7
- package/docs/variables/LocationIcon.md +0 -7
- package/docs/variables/LocationPicker.md +0 -7
- package/docs/variables/MaterialOrderIcon.md +0 -7
- package/docs/variables/MaximizeIcon.md +0 -7
- package/docs/variables/MaybeIcon.md +0 -16
- package/docs/variables/MaybePictogram.md +0 -16
- package/docs/variables/MedicationIcon.md +0 -7
- package/docs/variables/MessageQueueIcon.md +0 -7
- package/docs/variables/MicroscopeIcon.md +0 -7
- package/docs/variables/MoneyIcon.md +0 -9
- package/docs/variables/MotherIcon.md +0 -7
- package/docs/variables/MovementIcon.md +0 -7
- package/docs/variables/OpenmrsDatePicker.md +0 -9
- package/docs/variables/OverflowMenuHorizontalIcon.md +0 -7
- package/docs/variables/OverflowMenuVerticalIcon.md +0 -7
- package/docs/variables/PageHeader.md +0 -30
- package/docs/variables/PageHeaderContent.md +0 -21
- package/docs/variables/PasswordIcon.md +0 -7
- package/docs/variables/PatientListsPictogram.md +0 -7
- package/docs/variables/PedestrianFamilyIcon.md +0 -7
- package/docs/variables/PenIcon.md +0 -7
- package/docs/variables/PharmacyPictogram.md +0 -7
- package/docs/variables/Pictogram.md +0 -9
- package/docs/variables/PrinterIcon.md +0 -7
- package/docs/variables/ProcedureOrderIcon.md +0 -7
- package/docs/variables/ProgramsIcon.md +0 -7
- package/docs/variables/RadiologyIcon.md +0 -7
- package/docs/variables/ReferralOrderIcon.md +0 -7
- package/docs/variables/RegistrationPictogram.md +0 -7
- package/docs/variables/RenderIfValueIsTruthy.md +0 -21
- package/docs/variables/RenewIcon.md +0 -7
- package/docs/variables/ReportIcon.md +0 -7
- package/docs/variables/ResetIcon.md +0 -7
- package/docs/variables/ResponsiveWrapper.md +0 -11
- package/docs/variables/SaveIcon.md +0 -7
- package/docs/variables/SearchIcon.md +0 -7
- package/docs/variables/ServiceQueuesPictogram.md +0 -7
- package/docs/variables/ShoppingCartAddItemIcon.md +0 -11
- package/docs/variables/ShoppingCartArrowDownIcon.md +0 -9
- package/docs/variables/ShoppingCartIcon.md +0 -9
- package/docs/variables/StickyNoteAddIcon.md +0 -9
- package/docs/variables/StockManagementPictogram.md +0 -7
- package/docs/variables/SwitcherIcon.md +0 -7
- package/docs/variables/SyringeIcon.md +0 -7
- package/docs/variables/TableIcon.md +0 -7
- package/docs/variables/TableOfContentsIcon.md +0 -9
- package/docs/variables/TimeIcon.md +0 -9
- package/docs/variables/ToolsIcon.md +0 -7
- package/docs/variables/TranslateIcon.md +0 -7
- package/docs/variables/TrashCanIcon.md +0 -7
- package/docs/variables/TreeViewAltIcon.md +0 -7
- package/docs/variables/UserAvatarIcon.md +0 -9
- package/docs/variables/UserFollowIcon.md +0 -7
- package/docs/variables/UserHasAccess.md +0 -35
- package/docs/variables/UserIcon.md +0 -7
- package/docs/variables/UserXrayIcon.md +0 -11
- package/docs/variables/ViewIcon.md +0 -7
- package/docs/variables/ViewOffIcon.md +0 -7
- package/docs/variables/WarningIcon.md +0 -7
- package/docs/variables/attachmentUrl.md +0 -7
- package/docs/variables/backendDependencies.md +0 -17
- package/docs/variables/defaultVisitCustomRepresentation.md +0 -7
- package/docs/variables/fhirBaseUrl.md +0 -7
- package/docs/variables/getAsyncExtensionLifecycle.md +0 -35
- package/docs/variables/getStartedVisit.md +0 -9
- package/docs/variables/isUrl.md +0 -9
- package/docs/variables/offlineUuidPrefix.md +0 -7
- package/docs/variables/omrsOfflineCachingStrategyHttpHeaderName.md +0 -7
- package/docs/variables/omrsOfflineResponseBodyHttpHeaderName.md +0 -7
- package/docs/variables/omrsOfflineResponseStatusHttpHeaderName.md +0 -7
- package/docs/variables/restBaseUrl.md +0 -7
- package/docs/variables/sessionEndpoint.md +0 -7
- package/docs/variables/useConnectedExtensions.md +0 -25
- package/docs/variables/useExtensionStore.md +0 -55
- package/docs/variables/validators.md +0 -78
@@ -1,101 +1,140 @@
|
|
1
|
-
[
|
1
|
+
[@openmrs/esm-framework](../API.md) / AuditInfo
|
2
2
|
|
3
3
|
# Interface: AuditInfo
|
4
4
|
|
5
|
-
|
5
|
+
## Table of contents
|
6
|
+
|
7
|
+
### Properties
|
8
|
+
|
9
|
+
- [changedBy](AuditInfo.md#changedby)
|
10
|
+
- [creator](AuditInfo.md#creator)
|
11
|
+
- [dateChanged](AuditInfo.md#datechanged)
|
12
|
+
- [dateCreated](AuditInfo.md#datecreated)
|
13
|
+
- [dateVoided](AuditInfo.md#datevoided)
|
14
|
+
- [datedRetired](AuditInfo.md#datedretired)
|
15
|
+
- [retireReason](AuditInfo.md#retirereason)
|
16
|
+
- [retired](AuditInfo.md#retired)
|
17
|
+
- [retiredBy](AuditInfo.md#retiredby)
|
18
|
+
- [voidReason](AuditInfo.md#voidreason)
|
19
|
+
- [voided](AuditInfo.md#voided)
|
20
|
+
- [voidedBy](AuditInfo.md#voidedby)
|
6
21
|
|
7
22
|
## Properties
|
8
23
|
|
9
|
-
### changedBy
|
24
|
+
### changedBy
|
25
|
+
|
26
|
+
• `Optional` **changedBy**: [`User`](User.md)
|
27
|
+
|
28
|
+
#### Defined in
|
29
|
+
|
30
|
+
[packages/framework/esm-api/src/types/openmrs-resource.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L30)
|
31
|
+
|
32
|
+
___
|
33
|
+
|
34
|
+
### creator
|
35
|
+
|
36
|
+
• `Optional` **creator**: [`User`](User.md)
|
37
|
+
|
38
|
+
#### Defined in
|
39
|
+
|
40
|
+
[packages/framework/esm-api/src/types/openmrs-resource.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L28)
|
41
|
+
|
42
|
+
___
|
43
|
+
|
44
|
+
### dateChanged
|
45
|
+
|
46
|
+
• `Optional` **dateChanged**: `string`
|
47
|
+
|
48
|
+
#### Defined in
|
10
49
|
|
11
|
-
|
50
|
+
[packages/framework/esm-api/src/types/openmrs-resource.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L29)
|
12
51
|
|
13
|
-
|
52
|
+
___
|
14
53
|
|
15
|
-
|
54
|
+
### dateCreated
|
16
55
|
|
17
|
-
|
56
|
+
• `Optional` **dateCreated**: `string`
|
18
57
|
|
19
|
-
|
58
|
+
#### Defined in
|
20
59
|
|
21
|
-
|
60
|
+
[packages/framework/esm-api/src/types/openmrs-resource.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L27)
|
22
61
|
|
23
|
-
|
62
|
+
___
|
24
63
|
|
25
|
-
###
|
64
|
+
### dateVoided
|
26
65
|
|
27
|
-
|
66
|
+
• `Optional` **dateVoided**: `string`
|
28
67
|
|
29
|
-
Defined in
|
68
|
+
#### Defined in
|
30
69
|
|
31
|
-
|
70
|
+
[packages/framework/esm-api/src/types/openmrs-resource.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L32)
|
32
71
|
|
33
|
-
|
72
|
+
___
|
34
73
|
|
35
|
-
|
74
|
+
### datedRetired
|
36
75
|
|
37
|
-
|
76
|
+
• `Optional` **datedRetired**: `string`
|
38
77
|
|
39
|
-
|
78
|
+
#### Defined in
|
40
79
|
|
41
|
-
|
80
|
+
[packages/framework/esm-api/src/types/openmrs-resource.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L36)
|
42
81
|
|
43
|
-
|
82
|
+
___
|
44
83
|
|
45
|
-
|
84
|
+
### retireReason
|
46
85
|
|
47
|
-
|
86
|
+
• `Optional` **retireReason**: `string`
|
48
87
|
|
49
|
-
|
88
|
+
#### Defined in
|
50
89
|
|
51
|
-
|
90
|
+
[packages/framework/esm-api/src/types/openmrs-resource.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L38)
|
52
91
|
|
53
|
-
|
92
|
+
___
|
54
93
|
|
55
|
-
|
94
|
+
### retired
|
56
95
|
|
57
|
-
|
96
|
+
• `Optional` **retired**: `boolean`
|
58
97
|
|
59
|
-
|
98
|
+
#### Defined in
|
60
99
|
|
61
|
-
|
100
|
+
[packages/framework/esm-api/src/types/openmrs-resource.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L35)
|
62
101
|
|
63
|
-
|
102
|
+
___
|
64
103
|
|
65
|
-
### retiredBy
|
104
|
+
### retiredBy
|
66
105
|
|
67
|
-
|
106
|
+
• `Optional` **retiredBy**: [`User`](User.md)
|
68
107
|
|
69
|
-
Defined in
|
108
|
+
#### Defined in
|
70
109
|
|
71
|
-
|
110
|
+
[packages/framework/esm-api/src/types/openmrs-resource.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L37)
|
72
111
|
|
73
|
-
|
112
|
+
___
|
74
113
|
|
75
|
-
|
114
|
+
### voidReason
|
76
115
|
|
77
|
-
|
116
|
+
• `Optional` **voidReason**: `string`
|
78
117
|
|
79
|
-
|
118
|
+
#### Defined in
|
80
119
|
|
81
|
-
|
120
|
+
[packages/framework/esm-api/src/types/openmrs-resource.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L34)
|
82
121
|
|
83
|
-
|
122
|
+
___
|
84
123
|
|
85
|
-
|
124
|
+
### voided
|
86
125
|
|
87
|
-
|
126
|
+
• `Optional` **voided**: `boolean`
|
88
127
|
|
89
|
-
|
128
|
+
#### Defined in
|
90
129
|
|
91
|
-
|
130
|
+
[packages/framework/esm-api/src/types/openmrs-resource.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L31)
|
92
131
|
|
93
|
-
|
132
|
+
___
|
94
133
|
|
95
|
-
|
134
|
+
### voidedBy
|
96
135
|
|
97
|
-
|
136
|
+
• `Optional` **voidedBy**: [`User`](User.md)
|
98
137
|
|
99
|
-
|
138
|
+
#### Defined in
|
100
139
|
|
101
|
-
|
140
|
+
[packages/framework/esm-api/src/types/openmrs-resource.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L33)
|
@@ -1,21 +1,30 @@
|
|
1
|
-
[
|
1
|
+
[@openmrs/esm-framework](../API.md) / BreadcrumbRegistration
|
2
2
|
|
3
3
|
# Interface: BreadcrumbRegistration
|
4
4
|
|
5
|
-
|
5
|
+
## Table of contents
|
6
6
|
|
7
|
-
|
7
|
+
### Breadcrumb Properties
|
8
|
+
|
9
|
+
- [matcher](BreadcrumbRegistration.md#matcher)
|
10
|
+
- [settings](BreadcrumbRegistration.md#settings)
|
11
|
+
|
12
|
+
## Breadcrumb Properties
|
8
13
|
|
9
14
|
### matcher
|
10
15
|
|
11
|
-
|
16
|
+
• **matcher**: `RegExp`
|
12
17
|
|
13
|
-
Defined in
|
18
|
+
#### Defined in
|
14
19
|
|
15
|
-
|
20
|
+
[packages/framework/esm-navigation/src/types.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/types.ts#L33)
|
21
|
+
|
22
|
+
___
|
16
23
|
|
17
24
|
### settings
|
18
25
|
|
19
|
-
|
26
|
+
• **settings**: [`BreadcrumbSettings`](BreadcrumbSettings.md)
|
27
|
+
|
28
|
+
#### Defined in
|
20
29
|
|
21
|
-
|
30
|
+
[packages/framework/esm-navigation/src/types.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/types.ts#L34)
|
@@ -1,16 +1,21 @@
|
|
1
|
-
[
|
1
|
+
[@openmrs/esm-framework](../API.md) / BreadcrumbSettings
|
2
2
|
|
3
3
|
# Interface: BreadcrumbSettings
|
4
4
|
|
5
|
-
|
5
|
+
## Table of contents
|
6
6
|
|
7
|
-
|
7
|
+
### Breadcrumb Properties
|
8
8
|
|
9
|
-
|
9
|
+
- [matcher](BreadcrumbSettings.md#matcher)
|
10
|
+
- [parent](BreadcrumbSettings.md#parent)
|
11
|
+
- [path](BreadcrumbSettings.md#path)
|
12
|
+
- [title](BreadcrumbSettings.md#title)
|
10
13
|
|
11
|
-
|
14
|
+
## Breadcrumb Properties
|
12
15
|
|
13
|
-
|
16
|
+
### matcher
|
17
|
+
|
18
|
+
• `Optional` **matcher**: `string` \| `RegExp`
|
14
19
|
|
15
20
|
A string or RegEx that determines whether the breadcrumb should be displayed.
|
16
21
|
It is tested against the current location's path.
|
@@ -19,13 +24,15 @@ If `matcher` is a string, it can contain route parameters. e.g. `/foo/:bar`.
|
|
19
24
|
|
20
25
|
Can be omitted; the value of `path` is used as the default value.
|
21
26
|
|
22
|
-
|
27
|
+
#### Defined in
|
28
|
+
|
29
|
+
[packages/framework/esm-navigation/src/types.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/types.ts#L16)
|
23
30
|
|
24
|
-
|
31
|
+
___
|
25
32
|
|
26
|
-
|
33
|
+
### parent
|
27
34
|
|
28
|
-
|
35
|
+
• `Optional` **parent**: `string`
|
29
36
|
|
30
37
|
The breadcrumb's parent breadcrumb. Supply the path of the breadcrumb here, e.g.,
|
31
38
|
if we are currently in "/foo/bar", you could provide "/foo" to get the breadcrumb
|
@@ -34,22 +41,30 @@ associated with the path "/foo".
|
|
34
41
|
If a path is missing for some reason, the closest matching one will be taken as
|
35
42
|
parent.
|
36
43
|
|
37
|
-
|
44
|
+
#### Defined in
|
38
45
|
|
39
|
-
|
46
|
+
[packages/framework/esm-navigation/src/types.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/types.ts#L25)
|
40
47
|
|
41
|
-
|
48
|
+
___
|
49
|
+
|
50
|
+
### path
|
42
51
|
|
43
|
-
|
52
|
+
• **path**: `string`
|
44
53
|
|
45
54
|
Gets the path of breadcrumb for navigation purposes.
|
46
55
|
|
47
|
-
|
56
|
+
#### Defined in
|
48
57
|
|
49
|
-
|
58
|
+
[packages/framework/esm-navigation/src/types.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/types.ts#L7)
|
59
|
+
|
60
|
+
___
|
50
61
|
|
51
|
-
|
62
|
+
### title
|
52
63
|
|
53
|
-
|
64
|
+
• **title**: `string` \| (`params`: `any`) => `string` \| (`params`: `any`) => `Promise`<`string`\>
|
54
65
|
|
55
66
|
The title of the breadcrumb.
|
67
|
+
|
68
|
+
#### Defined in
|
69
|
+
|
70
|
+
[packages/framework/esm-navigation/src/types.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/types.ts#L29)
|
@@ -1,13 +1,17 @@
|
|
1
|
-
[
|
1
|
+
[@openmrs/esm-framework](../API.md) / CancelLoading
|
2
2
|
|
3
|
-
# Interface: CancelLoading
|
3
|
+
# Interface: CancelLoading
|
4
4
|
|
5
|
-
|
5
|
+
## Callable
|
6
6
|
|
7
|
-
|
7
|
+
### CancelLoading
|
8
8
|
|
9
|
-
|
9
|
+
▸ **CancelLoading**(): `void`
|
10
10
|
|
11
|
-
|
11
|
+
#### Returns
|
12
12
|
|
13
13
|
`void`
|
14
|
+
|
15
|
+
#### Defined in
|
16
|
+
|
17
|
+
[packages/framework/esm-extensions/src/render.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/render.ts#L8)
|
@@ -1,21 +1,29 @@
|
|
1
|
-
[
|
1
|
+
[@openmrs/esm-framework](../API.md) / ClearDynamicRoutesMessage
|
2
2
|
|
3
3
|
# Interface: ClearDynamicRoutesMessage
|
4
4
|
|
5
|
-
|
5
|
+
## Hierarchy
|
6
6
|
|
7
|
-
|
7
|
+
- [`OmrsServiceWorkerMessage`](OmrsServiceWorkerMessage.md)<``"clearDynamicRoutes"``\>
|
8
8
|
|
9
|
-
|
9
|
+
↳ **`ClearDynamicRoutesMessage`**
|
10
10
|
|
11
|
-
##
|
11
|
+
## Table of contents
|
12
12
|
|
13
|
-
###
|
13
|
+
### Offline Properties
|
14
|
+
|
15
|
+
- [type](ClearDynamicRoutesMessage.md#type)
|
16
|
+
|
17
|
+
## Offline Properties
|
14
18
|
|
15
|
-
|
19
|
+
### type
|
16
20
|
|
17
|
-
|
21
|
+
• **type**: ``"clearDynamicRoutes"``
|
18
22
|
|
19
23
|
#### Inherited from
|
20
24
|
|
21
|
-
[
|
25
|
+
[OmrsServiceWorkerMessage](OmrsServiceWorkerMessage.md).[type](OmrsServiceWorkerMessage.md#type)
|
26
|
+
|
27
|
+
#### Defined in
|
28
|
+
|
29
|
+
[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,47 +1,54 @@
|
|
1
|
-
[
|
1
|
+
[@openmrs/esm-framework](../API.md) / CloseWorkspaceOptions
|
2
2
|
|
3
3
|
# Interface: CloseWorkspaceOptions
|
4
4
|
|
5
|
-
|
5
|
+
## Table of contents
|
6
6
|
|
7
|
-
|
7
|
+
### Workspace Properties
|
8
8
|
|
9
|
-
|
9
|
+
- [closeWorkspaceGroup](CloseWorkspaceOptions.md#closeworkspacegroup)
|
10
|
+
- [ignoreChanges](CloseWorkspaceOptions.md#ignorechanges)
|
10
11
|
|
11
|
-
|
12
|
+
### Workspace Methods
|
12
13
|
|
13
|
-
|
14
|
+
- [onWorkspaceClose](CloseWorkspaceOptions.md#onworkspaceclose)
|
15
|
+
|
16
|
+
## Workspace Properties
|
17
|
+
|
18
|
+
### closeWorkspaceGroup
|
19
|
+
|
20
|
+
• `Optional` **closeWorkspaceGroup**: `boolean`
|
14
21
|
|
15
22
|
Controls whether the workspace group should be closed and store to be
|
16
23
|
cleared when this workspace is closed.
|
17
24
|
Defaults to true except when opening a new workspace of the same group.
|
18
25
|
|
19
|
-
|
26
|
+
**`default`** true
|
20
27
|
|
21
|
-
|
22
|
-
true
|
23
|
-
```
|
28
|
+
#### Defined in
|
24
29
|
|
25
|
-
|
30
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L37)
|
26
31
|
|
27
|
-
|
32
|
+
___
|
28
33
|
|
29
|
-
|
34
|
+
### ignoreChanges
|
30
35
|
|
31
|
-
|
36
|
+
• `Optional` **ignoreChanges**: `boolean`
|
32
37
|
|
33
38
|
Whether to close the workspace ignoring all the changes present in the workspace.
|
34
39
|
|
35
40
|
If ignoreChanges is true, the user will not be prompted to save changes before closing
|
36
41
|
even if the `testFcn` passed to `promptBeforeClosing` returns `true`.
|
37
42
|
|
38
|
-
|
43
|
+
#### Defined in
|
39
44
|
|
40
|
-
|
45
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L22)
|
41
46
|
|
42
|
-
|
47
|
+
## Workspace Methods
|
43
48
|
|
44
|
-
|
49
|
+
### onWorkspaceClose
|
50
|
+
|
51
|
+
▸ `Optional` **onWorkspaceClose**(): `void`
|
45
52
|
|
46
53
|
If you want to take an action after the workspace is closed, you can pass your function as
|
47
54
|
`onWorkspaceClose`. This function will be called only after the workspace is closed, given
|
@@ -52,3 +59,7 @@ that the user might be shown a prompt.
|
|
52
59
|
`void`
|
53
60
|
|
54
61
|
void
|
62
|
+
|
63
|
+
#### Defined in
|
64
|
+
|
65
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L29)
|
@@ -1,29 +1,41 @@
|
|
1
|
-
[
|
1
|
+
[@openmrs/esm-framework](../API.md) / ComponentConfig
|
2
2
|
|
3
3
|
# Interface: ComponentConfig
|
4
4
|
|
5
|
-
|
5
|
+
## Table of contents
|
6
|
+
|
7
|
+
### Properties
|
8
|
+
|
9
|
+
- [extension](ComponentConfig.md#extension)
|
10
|
+
- [featureName](ComponentConfig.md#featurename)
|
11
|
+
- [moduleName](ComponentConfig.md#modulename)
|
6
12
|
|
7
13
|
## Properties
|
8
14
|
|
9
|
-
### extension
|
15
|
+
### extension
|
16
|
+
|
17
|
+
• `Optional` **extension**: [`ExtensionData`](ExtensionData.md)
|
10
18
|
|
11
|
-
|
19
|
+
#### Defined in
|
12
20
|
|
13
|
-
|
21
|
+
[packages/framework/esm-extensions/src/types.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L10)
|
14
22
|
|
15
|
-
|
23
|
+
___
|
16
24
|
|
17
25
|
### featureName
|
18
26
|
|
19
|
-
|
27
|
+
• **featureName**: `string`
|
20
28
|
|
21
|
-
Defined in
|
29
|
+
#### Defined in
|
22
30
|
|
23
|
-
|
31
|
+
[packages/framework/esm-extensions/src/types.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L9)
|
32
|
+
|
33
|
+
___
|
24
34
|
|
25
35
|
### moduleName
|
26
36
|
|
27
|
-
|
37
|
+
• **moduleName**: `string`
|
38
|
+
|
39
|
+
#### Defined in
|
28
40
|
|
29
|
-
|
41
|
+
[packages/framework/esm-extensions/src/types.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L8)
|