@openmrs/esm-framework 6.3.1-pre.3105 → 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.map +1 -1
- package/docs/classes/OpenmrsFetchError.md +4 -4
- package/docs/enumerations/Type.md +10 -10
- package/docs/enumerations/VisitMode.md +4 -4
- package/docs/enumerations/VisitStatus.md +3 -3
- package/docs/functions/ConfigurableLink.md +1 -1
- package/docs/functions/CustomOverflowMenu.md +1 -1
- package/docs/functions/DashboardExtension.md +1 -1
- package/docs/functions/ExtensionSlot.md +1 -1
- package/docs/functions/OpenmrsAppContext.md +2 -2
- package/docs/functions/PatientBannerActionsMenu.md +1 -1
- package/docs/functions/PatientBannerContactDetails.md +1 -1
- package/docs/functions/PatientBannerPatientIdentifiers.md +1 -1
- package/docs/functions/PatientBannerPatientInfo.md +1 -1
- package/docs/functions/PatientBannerToggleContactDetailsButton.md +1 -1
- package/docs/functions/PatientPhoto.md +1 -1
- package/docs/functions/WorkspaceContainer.md +1 -1
- package/docs/functions/attach.md +1 -1
- package/docs/functions/beginEditSynchronizationItem.md +1 -1
- package/docs/functions/canBeginEditSynchronizationItemsOfType.md +1 -1
- package/docs/functions/clearCurrentUser.md +1 -1
- package/docs/functions/closeWorkspace.md +1 -1
- package/docs/functions/compile.md +1 -1
- package/docs/functions/createAttachment.md +1 -1
- package/docs/functions/createGlobalStore.md +1 -1
- package/docs/functions/createUseStore.md +1 -1
- package/docs/functions/defineConfigSchema.md +1 -1
- package/docs/functions/defineExtensionConfigSchema.md +1 -1
- package/docs/functions/deleteAttachmentPermanently.md +1 -1
- package/docs/functions/deleteSynchronizationItem.md +1 -1
- package/docs/functions/detach.md +1 -1
- package/docs/functions/detachAll.md +1 -1
- package/docs/functions/evaluate.md +1 -1
- package/docs/functions/evaluateAsBoolean.md +3 -3
- package/docs/functions/evaluateAsBooleanAsync.md +3 -3
- package/docs/functions/evaluateAsNumber.md +1 -1
- package/docs/functions/evaluateAsNumberAsync.md +1 -1
- package/docs/functions/evaluateAsType.md +1 -1
- package/docs/functions/evaluateAsTypeAsync.md +1 -1
- package/docs/functions/evaluateAsync.md +1 -1
- package/docs/functions/extractVariableNames.md +1 -1
- package/docs/functions/fetchCurrentPatient.md +1 -1
- package/docs/functions/filterBreadcrumbs.md +1 -1
- package/docs/functions/generateOfflineUuid.md +1 -1
- package/docs/functions/getAssignedExtensions.md +1 -1
- package/docs/functions/getAsyncLifecycle.md +1 -1
- package/docs/functions/getAttachmentByUuid.md +1 -1
- package/docs/functions/getAttachments.md +1 -1
- package/docs/functions/getBreadcrumbs.md +1 -1
- package/docs/functions/getBreadcrumbsFor.md +1 -1
- package/docs/functions/getConfig.md +1 -1
- package/docs/functions/getContext.md +2 -2
- package/docs/functions/getCoreTranslation.md +1 -1
- package/docs/functions/getCurrentOfflineMode.md +1 -1
- package/docs/functions/getCurrentUser.md +3 -3
- package/docs/functions/getDynamicOfflineDataEntries.md +1 -1
- package/docs/functions/getDynamicOfflineDataEntriesFor.md +1 -1
- package/docs/functions/getDynamicOfflineDataHandlers.md +1 -1
- package/docs/functions/getExtensionNameFromId.md +1 -1
- package/docs/functions/getExtensionStore.md +1 -1
- package/docs/functions/getFeatureFlag.md +1 -1
- package/docs/functions/getFhirServerPaginationHandlers.md +1 -1
- package/docs/functions/getFullSynchronizationItems.md +1 -1
- package/docs/functions/getFullSynchronizationItemsFor.md +1 -1
- package/docs/functions/getGlobalStore.md +1 -1
- package/docs/functions/getHistory.md +1 -1
- package/docs/functions/getLifecycle.md +1 -1
- package/docs/functions/getLocations.md +1 -1
- package/docs/functions/getLoggedInUser.md +1 -1
- package/docs/functions/getOfflinePatientDataStore.md +1 -1
- package/docs/functions/getSessionLocation.md +1 -1
- package/docs/functions/getSessionStore.md +1 -1
- package/docs/functions/getSyncLifecycle.md +1 -1
- package/docs/functions/getSynchronizationItem.md +1 -1
- package/docs/functions/getSynchronizationItems.md +1 -1
- package/docs/functions/getVisitStore.md +1 -1
- package/docs/functions/getVisitTypes.md +1 -1
- package/docs/functions/getVisitsForPatient.md +1 -1
- package/docs/functions/goBackInHistory.md +1 -1
- package/docs/functions/importDynamic.md +1 -1
- package/docs/functions/inRange.md +1 -1
- package/docs/functions/interpolateString.md +1 -1
- package/docs/functions/interpolateUrl.md +1 -1
- package/docs/functions/isDesktop.md +1 -1
- package/docs/functions/isDevEnabled.md +1 -1
- package/docs/functions/isOfflineUuid.md +1 -1
- package/docs/functions/isUrlWithTemplateParameters.md +1 -1
- package/docs/functions/launchWorkspace.md +1 -1
- package/docs/functions/launchWorkspaceGroup.md +1 -1
- package/docs/functions/makeUrl.md +1 -1
- package/docs/functions/messageOmrsServiceWorker.md +1 -1
- package/docs/functions/navigate.md +1 -1
- package/docs/functions/navigateAndLaunchWorkspace.md +1 -1
- package/docs/functions/oneOf.md +1 -1
- package/docs/functions/openmrsFetch.md +1 -1
- package/docs/functions/openmrsObservableFetch.md +1 -1
- package/docs/functions/provide.md +1 -1
- package/docs/functions/putDynamicOfflineData.md +1 -1
- package/docs/functions/putDynamicOfflineDataFor.md +1 -1
- package/docs/functions/queueSynchronizationItem.md +1 -1
- package/docs/functions/refetchCurrentUser.md +1 -1
- package/docs/functions/registerBreadcrumb.md +1 -1
- package/docs/functions/registerBreadcrumbs.md +1 -1
- package/docs/functions/registerContext.md +2 -2
- package/docs/functions/registerFeatureFlag.md +1 -1
- package/docs/functions/registerOfflinePatientHandler.md +1 -1
- package/docs/functions/removeDynamicOfflineData.md +1 -1
- package/docs/functions/removeDynamicOfflineDataFor.md +1 -1
- package/docs/functions/renderExtension.md +1 -1
- package/docs/functions/saveVisit.md +1 -1
- package/docs/functions/setCurrentVisit.md +1 -1
- package/docs/functions/setLeftNav.md +1 -1
- package/docs/functions/setSessionLocation.md +1 -1
- package/docs/functions/setUserLanguage.md +1 -1
- package/docs/functions/setUserProperties.md +1 -1
- package/docs/functions/setupDynamicOfflineDataHandler.md +1 -1
- package/docs/functions/setupOfflineSync.md +1 -1
- package/docs/functions/showActionableNotification.md +1 -1
- package/docs/functions/showModal.md +1 -1
- package/docs/functions/showNotification.md +1 -1
- package/docs/functions/showSnackbar.md +1 -1
- package/docs/functions/showToast.md +1 -1
- package/docs/functions/subscribeTo.md +2 -2
- package/docs/functions/subscribeToContext.md +2 -2
- package/docs/functions/syncAllDynamicOfflineData.md +1 -1
- package/docs/functions/syncDynamicOfflineData.md +1 -1
- package/docs/functions/syncOfflinePatientData.md +1 -1
- package/docs/functions/toLocationObject.md +1 -1
- package/docs/functions/toVisitTypeObject.md +1 -1
- package/docs/functions/translateFrom.md +1 -1
- package/docs/functions/unregisterContext.md +1 -1
- package/docs/functions/unsetLeftNav.md +1 -1
- package/docs/functions/updateContext.md +2 -2
- package/docs/functions/updateVisit.md +1 -1
- package/docs/functions/useAbortController.md +1 -1
- package/docs/functions/useAppContext.md +2 -2
- package/docs/functions/useAssignedExtensionIds.md +1 -1
- package/docs/functions/useAssignedExtensions.md +1 -1
- package/docs/functions/useAttachments.md +1 -1
- package/docs/functions/useBodyScrollLock.md +1 -1
- package/docs/functions/useConfig.md +1 -1
- package/docs/functions/useConnectivity.md +1 -1
- package/docs/functions/useDebounce.md +1 -1
- package/docs/functions/useDefineAppContext.md +2 -2
- package/docs/functions/useEmrConfiguration.md +1 -1
- package/docs/functions/useExtensionSlotMeta.md +1 -1
- package/docs/functions/useExtensionSlotStore.md +1 -1
- package/docs/functions/useFeatureFlag.md +1 -1
- package/docs/functions/useFhirFetchAll.md +1 -1
- package/docs/functions/useFhirInfinite.md +1 -1
- package/docs/functions/useFhirPagination.md +1 -1
- package/docs/functions/useLayoutType.md +1 -1
- package/docs/functions/useLeftNav.md +1 -1
- package/docs/functions/useLeftNavStore.md +1 -1
- package/docs/functions/useLocations.md +1 -1
- package/docs/functions/useOnClickOutside.md +1 -1
- package/docs/functions/useOnVisible.md +1 -1
- package/docs/functions/useOpenmrsFetchAll.md +1 -1
- package/docs/functions/useOpenmrsInfinite.md +1 -1
- package/docs/functions/useOpenmrsPagination.md +1 -1
- package/docs/functions/useOpenmrsSWR.md +1 -1
- package/docs/functions/usePagination.md +1 -1
- package/docs/functions/usePatient.md +1 -1
- package/docs/functions/usePatientPhoto.md +1 -1
- package/docs/functions/usePrimaryIdentifierCode.md +1 -1
- package/docs/functions/useRenderableExtensions.md +1 -1
- package/docs/functions/useSession.md +1 -1
- package/docs/functions/useStore.md +4 -4
- package/docs/functions/useStoreWithActions.md +1 -1
- package/docs/functions/useVisit.md +1 -1
- package/docs/functions/useVisitContextStore.md +1 -1
- package/docs/functions/useVisitTypes.md +1 -1
- package/docs/functions/useWorkspaces.md +1 -1
- package/docs/functions/userHasAccess.md +1 -1
- package/docs/functions/validator.md +1 -1
- package/docs/interfaces/ActionMenuButtonProps.md +7 -7
- package/docs/interfaces/ActionableNotificationDescriptor.md +27 -27
- package/docs/interfaces/AssignedExtension.md +9 -9
- package/docs/interfaces/Attachment.md +8 -8
- package/docs/interfaces/AttachmentResponse.md +7 -7
- package/docs/interfaces/AuditInfo.md +13 -13
- package/docs/interfaces/BreadcrumbRegistration.md +3 -3
- package/docs/interfaces/BreadcrumbSettings.md +5 -5
- package/docs/interfaces/CancelLoading.md +2 -2
- package/docs/interfaces/ClearDynamicRoutesMessage.md +2 -2
- package/docs/interfaces/CloseWorkspaceOptions.md +4 -4
- package/docs/interfaces/ComponentConfig.md +4 -4
- package/docs/interfaces/Concept.md +18 -18
- package/docs/interfaces/ConceptClass.md +9 -9
- package/docs/interfaces/ConceptDatatype.md +10 -10
- package/docs/interfaces/ConceptName.md +10 -10
- package/docs/interfaces/Config.md +1 -1
- package/docs/interfaces/ConfigObject.md +3 -3
- package/docs/interfaces/ConfigSchema.md +4 -4
- package/docs/interfaces/ConfigurableLinkProps.md +4 -4
- package/docs/interfaces/ConnectedExtension.md +6 -6
- package/docs/interfaces/CurrentPatientOptions.md +2 -2
- package/docs/interfaces/DashboardExtensionProps.md +5 -5
- package/docs/interfaces/DefaultWorkspaceProps.md +5 -5
- package/docs/interfaces/Diagnosis.md +9 -9
- package/docs/interfaces/DisplayConditionsConfigObject.md +5 -5
- package/docs/interfaces/DynamicOfflineData.md +6 -6
- package/docs/interfaces/DynamicOfflineDataHandler.md +6 -6
- package/docs/interfaces/DynamicOfflineDataSyncState.md +6 -6
- package/docs/interfaces/EmrApiConfigurationResponse.md +53 -53
- package/docs/interfaces/Encounter.md +10 -10
- package/docs/interfaces/EncounterProvider.md +3 -3
- package/docs/interfaces/EncounterRole.md +4 -4
- package/docs/interfaces/EncounterType.md +4 -4
- package/docs/interfaces/ErrorStateProps.md +3 -3
- package/docs/interfaces/ExtensionData.md +4 -4
- package/docs/interfaces/ExtensionMeta.md +1 -1
- package/docs/interfaces/ExtensionRegistration.md +10 -10
- package/docs/interfaces/ExtensionSlotBaseProps.md +5 -5
- package/docs/interfaces/ExtensionSlotConfig.md +5 -5
- package/docs/interfaces/ExtensionSlotConfigObject.md +4 -4
- package/docs/interfaces/ExtensionSlotConfigureValueObject.md +1 -1
- package/docs/interfaces/ExtensionSlotProps.md +6 -6
- package/docs/interfaces/ExtensionSlotState.md +3 -3
- package/docs/interfaces/ExtensionStore.md +2 -2
- package/docs/interfaces/FHIRCode.md +4 -4
- package/docs/interfaces/FHIRLocationResource.md +2 -2
- package/docs/interfaces/FHIRResource.md +2 -2
- package/docs/interfaces/FetchConfig.md +3 -3
- package/docs/interfaces/FetchError.md +3 -3
- package/docs/interfaces/FetchHeaders.md +1 -1
- package/docs/interfaces/FetchResponse.md +2 -2
- package/docs/interfaces/FetchResponseJson.md +1 -1
- package/docs/interfaces/LeftNavStore.md +5 -5
- package/docs/interfaces/Link.md +4 -4
- package/docs/interfaces/Location.md +30 -30
- package/docs/interfaces/LoggedInUser.md +12 -12
- package/docs/interfaces/LoggedInUserFetchResponse.md +2 -2
- package/docs/interfaces/MessageServiceWorkerResult.md +4 -4
- package/docs/interfaces/NavigateOptions.md +3 -3
- package/docs/interfaces/NewVisitPayload.md +8 -8
- package/docs/interfaces/NotificationDescriptor.md +8 -8
- package/docs/interfaces/Obs.md +18 -18
- package/docs/interfaces/OfflineModeResult.md +4 -4
- package/docs/interfaces/OfflinePatientArgs.md +3 -3
- package/docs/interfaces/OfflinePatientDataSyncHandler.md +3 -3
- package/docs/interfaces/OfflinePatientDataSyncState.md +7 -7
- package/docs/interfaces/OfflinePatientDataSyncStore.md +3 -3
- package/docs/interfaces/OmrsServiceWorkerMessage.md +2 -2
- package/docs/interfaces/OnImportMapChangedMessage.md +3 -3
- package/docs/interfaces/OnlyThePatient.md +2 -2
- package/docs/interfaces/OpenWorkspace.md +7 -7
- package/docs/interfaces/OpenmrsAppContextProps.md +4 -4
- package/docs/interfaces/OpenmrsDatePickerProps.md +15 -15
- package/docs/interfaces/OpenmrsResource.md +6 -6
- package/docs/interfaces/OpenmrsResourceStrict.md +6 -6
- package/docs/interfaces/PageHeaderContentProps.md +4 -4
- package/docs/interfaces/PageHeaderWrapperProps.md +3 -3
- package/docs/interfaces/Patient.md +4 -4
- package/docs/interfaces/PatientBannerActionsMenuProps.md +5 -5
- package/docs/interfaces/PatientBannerToggleContactDetailsButtonProps.md +4 -4
- package/docs/interfaces/PatientIdentifier.md +6 -6
- package/docs/interfaces/PatientIdentifierType.md +10 -10
- package/docs/interfaces/PatientPhotoProps.md +3 -3
- package/docs/interfaces/PatientWithFullResponse.md +2 -2
- package/docs/interfaces/Person.md +22 -22
- package/docs/interfaces/PersonAddress.md +32 -32
- package/docs/interfaces/PersonAttribute.md +9 -9
- package/docs/interfaces/PersonName.md +16 -16
- package/docs/interfaces/PrimaryIdentifier.md +2 -2
- package/docs/interfaces/Privilege.md +4 -4
- package/docs/interfaces/Prompt.md +6 -6
- package/docs/interfaces/QueueItemDescriptor.md +5 -5
- package/docs/interfaces/RegisterDynamicRouteMessage.md +5 -5
- package/docs/interfaces/ResponsiveWrapperProps.md +2 -2
- package/docs/interfaces/Role.md +4 -4
- package/docs/interfaces/Session.md +8 -8
- package/docs/interfaces/SessionLocation.md +4 -4
- package/docs/interfaces/SetLeftNavParams.md +5 -5
- package/docs/interfaces/SnackbarDescriptor.md +10 -10
- package/docs/interfaces/SnackbarMeta.md +11 -11
- package/docs/interfaces/StyleguideConfigObject.md +10 -10
- package/docs/interfaces/SyncItem.md +8 -8
- package/docs/interfaces/SyncProcessOptions.md +6 -6
- package/docs/interfaces/ToastDescriptor.md +7 -7
- package/docs/interfaces/ToastNotificationMeta.md +8 -8
- package/docs/interfaces/UploadedFile.md +8 -8
- package/docs/interfaces/UseConfigOptions.md +2 -2
- package/docs/interfaces/UsePatientPhotoResult.md +4 -4
- package/docs/interfaces/UseServerFetchAllOptions.md +5 -5
- package/docs/interfaces/UseServerInfiniteOptions.md +4 -4
- package/docs/interfaces/UseServerPaginationOptions.md +4 -4
- package/docs/interfaces/User.md +6 -6
- package/docs/interfaces/UserHasAccessProps.md +4 -4
- package/docs/interfaces/Visit.md +10 -10
- package/docs/interfaces/VisitItem.md +5 -5
- package/docs/interfaces/VisitReturnType.md +8 -8
- package/docs/interfaces/VisitStoreState.md +4 -4
- package/docs/interfaces/VisitType.md +4 -4
- package/docs/interfaces/WorkspaceContainerProps.md +6 -6
- package/docs/interfaces/WorkspaceRegistration.md +12 -12
- package/docs/interfaces/WorkspacesInfo.md +12 -8
- package/docs/type-aliases/ActionFunction.md +1 -1
- package/docs/type-aliases/ActionableNotificationType.md +1 -1
- package/docs/type-aliases/Actions.md +1 -1
- package/docs/type-aliases/ArgumentsTuple.md +1 -1
- package/docs/type-aliases/BoundActions.md +1 -1
- package/docs/type-aliases/ConfigValue.md +1 -1
- package/docs/type-aliases/ContextCallback.md +2 -2
- package/docs/type-aliases/CoreTranslationKey.md +1 -1
- package/docs/type-aliases/CurrentPatient.md +1 -1
- package/docs/type-aliases/DefaultEvaluateReturnType.md +1 -1
- package/docs/type-aliases/ExtensionProps.md +1 -1
- package/docs/type-aliases/IconProps.md +4 -4
- package/docs/type-aliases/InlineNotificationType.md +1 -1
- package/docs/type-aliases/Key.md +1 -1
- package/docs/type-aliases/KnownOmrsServiceWorkerMessages.md +1 -1
- package/docs/type-aliases/LayoutType.md +1 -1
- package/docs/type-aliases/LoadedSessionStore.md +3 -3
- package/docs/type-aliases/NullablePatient.md +1 -1
- package/docs/type-aliases/OfflineMode.md +1 -1
- package/docs/type-aliases/OmrsOfflineCachingStrategy.md +1 -1
- package/docs/type-aliases/OmrsOfflineHttpHeaderNames.md +1 -1
- package/docs/type-aliases/OmrsOfflineHttpHeaders.md +4 -4
- package/docs/type-aliases/PageHeaderProps.md +1 -1
- package/docs/type-aliases/PatientUuid.md +1 -1
- package/docs/type-aliases/PictogramProps.md +3 -3
- package/docs/type-aliases/ProvidedConfig.md +3 -3
- package/docs/type-aliases/ResourceName.md +1 -1
- package/docs/type-aliases/SessionStore.md +1 -1
- package/docs/type-aliases/SnackbarType.md +1 -1
- package/docs/type-aliases/SvgIconProps.md +3 -3
- package/docs/type-aliases/SvgPictogramProps.md +3 -3
- package/docs/type-aliases/TemplateParams.md +1 -1
- package/docs/type-aliases/ToastType.md +1 -1
- package/docs/type-aliases/UnloadedSessionStore.md +3 -3
- package/docs/type-aliases/UpdateVisitPayload.md +1 -1
- package/docs/type-aliases/UseOpenmrsSWROptions.md +5 -5
- package/docs/type-aliases/Validator.md +1 -1
- package/docs/type-aliases/ValidatorFunction.md +1 -1
- package/docs/type-aliases/VariablesMap.md +1 -1
- package/docs/variables/ActionMenuButton.md +1 -1
- package/docs/variables/ActivityIcon.md +1 -1
- package/docs/variables/AddIcon.md +1 -1
- package/docs/variables/AllergiesIcon.md +1 -1
- package/docs/variables/AppointmentsPictogram.md +1 -1
- package/docs/variables/ArrowDownIcon.md +1 -1
- package/docs/variables/ArrowLeftIcon.md +1 -1
- package/docs/variables/ArrowRightIcon.md +1 -1
- package/docs/variables/ArrowUpIcon.md +1 -1
- package/docs/variables/AttachmentIcon.md +1 -1
- package/docs/variables/BabyIcon.md +1 -1
- package/docs/variables/CalendarHeatMapIcon.md +1 -1
- package/docs/variables/CalendarIcon.md +1 -1
- package/docs/variables/CaretDownIcon.md +1 -1
- package/docs/variables/CaretLeftIcon.md +1 -1
- package/docs/variables/CaretRightIcon.md +1 -1
- package/docs/variables/CaretUpIcon.md +1 -1
- package/docs/variables/ChartAverageIcon.md +1 -1
- package/docs/variables/CheckmarkFilledIcon.md +1 -1
- package/docs/variables/CheckmarkOutlineIcon.md +1 -1
- package/docs/variables/ChemistryIcon.md +1 -1
- package/docs/variables/ChevronDownIcon.md +1 -1
- package/docs/variables/ChevronLeftIcon.md +1 -1
- package/docs/variables/ChevronRightIcon.md +1 -1
- package/docs/variables/ChevronUpIcon.md +1 -1
- package/docs/variables/CloseFilledIcon.md +1 -1
- package/docs/variables/CloseIcon.md +1 -1
- package/docs/variables/CloseOutlineIcon.md +1 -1
- package/docs/variables/ConditionsIcon.md +1 -1
- package/docs/variables/DiagnosisTags.md +1 -1
- package/docs/variables/DocumentAttachmentIcon.md +1 -1
- package/docs/variables/DocumentIcon.md +1 -1
- package/docs/variables/DownloadIcon.md +1 -1
- package/docs/variables/DrugOrderIcon.md +1 -1
- package/docs/variables/EditIcon.md +1 -1
- package/docs/variables/ErrorState.md +1 -1
- package/docs/variables/EventScheduleIcon.md +1 -1
- package/docs/variables/EventsIcon.md +1 -1
- package/docs/variables/Extension.md +1 -1
- package/docs/variables/GenderFemaleIcon.md +1 -1
- package/docs/variables/GenderMaleIcon.md +1 -1
- package/docs/variables/GenderOtherIcon.md +1 -1
- package/docs/variables/GenderUnknownIcon.md +1 -1
- package/docs/variables/GenericOrderTypeIcon.md +1 -1
- package/docs/variables/GroupAccessIcon.md +1 -1
- package/docs/variables/GroupIcon.md +1 -1
- package/docs/variables/HomePictogram.md +1 -1
- package/docs/variables/HospitalBedIcon.md +1 -1
- package/docs/variables/Icon.md +1 -1
- package/docs/variables/ImageMedicalIcon.md +1 -1
- package/docs/variables/InPatientPictogram.md +1 -1
- package/docs/variables/InformationFilledIcon.md +1 -1
- package/docs/variables/InformationIcon.md +1 -1
- package/docs/variables/InformationSquareIcon.md +1 -1
- package/docs/variables/InventoryManagementIcon.md +1 -1
- package/docs/variables/LabOrderIcon.md +1 -1
- package/docs/variables/LaboratoryPictogram.md +1 -1
- package/docs/variables/LeftNavMenu.md +1 -1
- package/docs/variables/ListCheckedIcon.md +1 -1
- package/docs/variables/LocationIcon.md +1 -1
- package/docs/variables/LocationPicker.md +1 -1
- package/docs/variables/MaterialOrderIcon.md +1 -1
- package/docs/variables/MaximizeIcon.md +1 -1
- package/docs/variables/MaybeIcon.md +1 -1
- package/docs/variables/MaybePictogram.md +1 -1
- package/docs/variables/MedicationIcon.md +1 -1
- package/docs/variables/MessageQueueIcon.md +1 -1
- package/docs/variables/MicroscopeIcon.md +1 -1
- package/docs/variables/MoneyIcon.md +1 -1
- package/docs/variables/MotherIcon.md +1 -1
- package/docs/variables/MovementIcon.md +1 -1
- package/docs/variables/OpenmrsDatePicker.md +1 -1
- package/docs/variables/OverflowMenuHorizontalIcon.md +1 -1
- package/docs/variables/OverflowMenuVerticalIcon.md +1 -1
- package/docs/variables/PageHeader.md +1 -1
- package/docs/variables/PageHeaderContent.md +1 -1
- package/docs/variables/PasswordIcon.md +1 -1
- package/docs/variables/PatientListsPictogram.md +1 -1
- package/docs/variables/PedestrianFamilyIcon.md +1 -1
- package/docs/variables/PenIcon.md +1 -1
- package/docs/variables/PharmacyPictogram.md +1 -1
- package/docs/variables/Pictogram.md +1 -1
- package/docs/variables/PrinterIcon.md +1 -1
- package/docs/variables/ProcedureOrderIcon.md +1 -1
- package/docs/variables/ProgramsIcon.md +1 -1
- package/docs/variables/RadiologyIcon.md +1 -1
- package/docs/variables/ReferralOrderIcon.md +1 -1
- package/docs/variables/RegistrationPictogram.md +1 -1
- package/docs/variables/RenderIfValueIsTruthy.md +1 -1
- package/docs/variables/RenewIcon.md +1 -1
- package/docs/variables/ReportIcon.md +1 -1
- package/docs/variables/ResetIcon.md +1 -1
- package/docs/variables/ResponsiveWrapper.md +1 -1
- package/docs/variables/SaveIcon.md +1 -1
- package/docs/variables/SearchIcon.md +1 -1
- package/docs/variables/ServiceQueuesPictogram.md +1 -1
- package/docs/variables/ShoppingCartAddItemIcon.md +1 -1
- package/docs/variables/ShoppingCartArrowDownIcon.md +1 -1
- package/docs/variables/ShoppingCartIcon.md +1 -1
- package/docs/variables/StickyNoteAddIcon.md +1 -1
- package/docs/variables/StockManagementPictogram.md +1 -1
- package/docs/variables/SwitcherIcon.md +1 -1
- package/docs/variables/SyringeIcon.md +1 -1
- package/docs/variables/TableIcon.md +1 -1
- package/docs/variables/TableOfContentsIcon.md +1 -1
- package/docs/variables/TimeIcon.md +1 -1
- package/docs/variables/ToolsIcon.md +1 -1
- package/docs/variables/TranslateIcon.md +1 -1
- package/docs/variables/TrashCanIcon.md +1 -1
- package/docs/variables/TreeViewAltIcon.md +1 -1
- package/docs/variables/UserAvatarIcon.md +1 -1
- package/docs/variables/UserFollowIcon.md +1 -1
- package/docs/variables/UserHasAccess.md +1 -1
- package/docs/variables/UserIcon.md +1 -1
- package/docs/variables/UserXrayIcon.md +1 -1
- package/docs/variables/ViewIcon.md +1 -1
- package/docs/variables/ViewOffIcon.md +1 -1
- package/docs/variables/WarningIcon.md +1 -1
- package/docs/variables/attachmentUrl.md +1 -1
- package/docs/variables/backendDependencies.md +1 -1
- package/docs/variables/defaultVisitCustomRepresentation.md +1 -1
- package/docs/variables/fhirBaseUrl.md +1 -1
- package/docs/variables/getAsyncExtensionLifecycle.md +1 -1
- package/docs/variables/getStartedVisit.md +1 -1
- package/docs/variables/isUrl.md +1 -1
- package/docs/variables/offlineUuidPrefix.md +1 -1
- package/docs/variables/omrsOfflineCachingStrategyHttpHeaderName.md +1 -1
- package/docs/variables/omrsOfflineResponseBodyHttpHeaderName.md +1 -1
- package/docs/variables/omrsOfflineResponseStatusHttpHeaderName.md +1 -1
- package/docs/variables/restBaseUrl.md +1 -1
- package/docs/variables/sessionEndpoint.md +1 -1
- package/docs/variables/useConnectedExtensions.md +1 -1
- package/docs/variables/useExtensionStore.md +1 -1
- package/docs/variables/validators.md +1 -1
- package/package.json +21 -21
- package/typedoc.json +1 -0
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **provide**(`config`, `sourceName`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-config/src/module-config/module-config.ts:261](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-config/src/module-config/module-config.ts:261](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L261)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **putDynamicOfflineData**(`type`, `identifier`): `Promise`\<`void`\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:157](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:157](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L157)
|
8
8
|
|
9
9
|
Declares that dynamic offline data of the given [type](#putdynamicofflinedata) with the given [identifier](#putdynamicofflinedata)
|
10
10
|
should be made available offline for the currently logged in user.
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **putDynamicOfflineDataFor**(`userId`, `type`, `identifier`): `Promise`\<`void`\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:169](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:169](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L169)
|
8
8
|
|
9
9
|
Declares that dynamic offline data of the given [type](#putdynamicofflinedatafor) with the given [identifier](#putdynamicofflinedatafor)
|
10
10
|
should be made available offline for the user with the given ID.
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **queueSynchronizationItem**\<`T`\>(`type`, `content`, `descriptor?`): `Promise`\<`number`\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/sync.ts:261](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/sync.ts:261](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L261)
|
8
8
|
|
9
9
|
Enqueues a new item in the sync queue and associates the item with the currently signed in user.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **refetchCurrentUser**(`username?`, `password?`): `Promise`\<[`SessionStore`](../type-aliases/SessionStore.md)\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-api/src/current-user.ts:163](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-api/src/current-user.ts:163](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L163)
|
8
8
|
|
9
9
|
The `refetchCurrentUser` function causes a network request to redownload
|
10
10
|
the user. All subscribers to the current user will be notified of the
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **registerBreadcrumb**(`breadcrumb`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-navigation/src/breadcrumbs/db.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-navigation/src/breadcrumbs/db.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/breadcrumbs/db.ts#L18)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **registerBreadcrumbs**(`breadcrumbs`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-navigation/src/breadcrumbs/db.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-navigation/src/breadcrumbs/db.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/breadcrumbs/db.ts#L22)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **registerContext**\<`T`\>(`namespace`, `initialValue`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-context/src/context.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-context/src/context.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-context/src/context.ts#L29)
|
8
8
|
|
9
9
|
Used by callers to register a new namespace in the application context. Attempting to register
|
10
10
|
an already-registered namespace will display a warning and make no modifications to the state.
|
@@ -13,7 +13,7 @@ an already-registered namespace will display a warning and make no modifications
|
|
13
13
|
|
14
14
|
### T
|
15
15
|
|
16
|
-
`T` *extends* `
|
16
|
+
`T` *extends* `Record`\<`string` \| `number` \| `symbol`, `unknown`\> = `Record`\<`string` \| `number` \| `symbol`, `any`\>
|
17
17
|
|
18
18
|
## Parameters
|
19
19
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **registerFeatureFlag**(`flagName`, `label`, `description`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-feature-flags/src/feature-flags.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-feature-flags/src/feature-flags.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-feature-flags/src/feature-flags.ts#L54)
|
8
8
|
|
9
9
|
This function creates a feature flag. Call it in top-level code anywhere. It will
|
10
10
|
not reset whether the flag is enabled or not, so it's safe to call it multiple times.
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **registerOfflinePatientHandler**(`identifier`, `handler`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L45)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **removeDynamicOfflineData**(`type`, `identifier`): `Promise`\<`void`\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:201](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:201](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L201)
|
8
8
|
|
9
9
|
Declares that dynamic offline data of the given [type](#removedynamicofflinedata) with the given [identifier](#removedynamicofflinedata)
|
10
10
|
no longer needs to be available offline for the currently logged in user.
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **removeDynamicOfflineDataFor**(`userId`, `type`, `identifier`): `Promise`\<`void`\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:213](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:213](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L213)
|
8
8
|
|
9
9
|
Declares that dynamic offline data of the given [type](#removedynamicofflinedatafor) with the given [identifier](#removedynamicofflinedatafor)
|
10
10
|
no longer needs to be available offline for the user with the given ID.
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **renderExtension**(`domElement`, `extensionSlotName`, `extensionSlotModuleName`, `extensionId`, `renderFunction`, `additionalProps`): `Promise`\<`null` \| `Parcel`\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-extensions/src/render.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-extensions/src/render.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/render.ts#L18)
|
8
8
|
|
9
9
|
Mounts into a DOM node (representing an extension slot)
|
10
10
|
a lazy-loaded component from *any* frontend module
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **saveVisit**(`payload`, `abortController`): `Promise`\<`FetchResponse`\<[`Visit`](../interfaces/Visit.md)\>\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:81](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:81](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L81)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **setCurrentVisit**(`patientUuid`, `visitUuid`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:61](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:61](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L61)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **setLeftNav**(`__namedParameters`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-extensions/src/left-nav.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-extensions/src/left-nav.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L37)
|
8
8
|
|
9
9
|
Sets the current left nav context. Must be paired with [unsetLeftNav](unsetLeftNav.md).
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **setSessionLocation**(`locationUuid`, `abortController`): `Promise`\<`any`\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-api/src/current-user.ts:
|
7
|
+
Defined in: [packages/framework/esm-api/src/current-user.ts:231](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L231)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **setUserLanguage**(`data`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-api/src/current-user.ts:116](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-api/src/current-user.ts:116](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L116)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **setUserProperties**(`userUuid`, `userProperties`, `abortController?`): `Promise`\<[`SessionStore`](../type-aliases/SessionStore.md)\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-api/src/current-user.ts:
|
7
|
+
Defined in: [packages/framework/esm-api/src/current-user.ts:244](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L244)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **setupDynamicOfflineDataHandler**(`handler`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:113](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:113](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L113)
|
8
8
|
|
9
9
|
Sets up a handler for synchronizing dynamic offline data.
|
10
10
|
See [DynamicOfflineDataHandler](../interfaces/DynamicOfflineDataHandler.md) for details.
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **setupOfflineSync**\<`T`\>(`type`, `dependsOn`, `process`, `options`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/sync.ts:365](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/sync.ts:365](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L365)
|
8
8
|
|
9
9
|
Registers a new synchronization handler which is able to synchronize data of a specific type.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **showActionableNotification**(`notification`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/notifications/index.tsx:85](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/notifications/index.tsx:85](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/index.tsx#L85)
|
8
8
|
|
9
9
|
Displays an actionable notification in the UI.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **showModal**(`modalName`, `props`, `onClose`): () => `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/modals/index.tsx:200](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/modals/index.tsx:200](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/modals/index.tsx#L200)
|
8
8
|
|
9
9
|
Shows a modal dialog.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **showNotification**(`notification`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/notifications/index.tsx:43](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/notifications/index.tsx:43](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/index.tsx#L43)
|
8
8
|
|
9
9
|
Displays an inline notification in the UI.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **showSnackbar**(`snackbar`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/snackbars/index.tsx:32](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/snackbars/index.tsx:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/index.tsx#L32)
|
8
8
|
|
9
9
|
Displays a snack bar notification in the UI.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **showToast**(`toast`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/toasts/index.tsx:36](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/toasts/index.tsx:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/index.tsx#L36)
|
8
8
|
|
9
9
|
Displays a toast notification in the UI.
|
10
10
|
|
@@ -6,7 +6,7 @@
|
|
6
6
|
|
7
7
|
> **subscribeTo**\<`T`, `U`\>(`store`, `handle`): () => `void`
|
8
8
|
|
9
|
-
Defined in: [packages/framework/esm-state/src/state.ts:109](https://github.com/openmrs/openmrs-esm-core/blob/
|
9
|
+
Defined in: [packages/framework/esm-state/src/state.ts:109](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L109)
|
10
10
|
|
11
11
|
### Type Parameters
|
12
12
|
|
@@ -40,7 +40,7 @@ Defined in: [packages/framework/esm-state/src/state.ts:109](https://github.com/o
|
|
40
40
|
|
41
41
|
> **subscribeTo**\<`T`, `U`\>(`store`, `select`, `handle`): () => `void`
|
42
42
|
|
43
|
-
Defined in: [packages/framework/esm-state/src/state.ts:110](https://github.com/openmrs/openmrs-esm-core/blob/
|
43
|
+
Defined in: [packages/framework/esm-state/src/state.ts:110](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L110)
|
44
44
|
|
45
45
|
### Type Parameters
|
46
46
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **subscribeToContext**\<`T`\>(`namespace`, `callback`): () => `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-context/src/context.ts:
|
7
|
+
Defined in: [packages/framework/esm-context/src/context.ts:112](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-context/src/context.ts#L112)
|
8
8
|
|
9
9
|
Subscribes to updates of a given namespace. Note that the returned object is immutable.
|
10
10
|
|
@@ -12,7 +12,7 @@ Subscribes to updates of a given namespace. Note that the returned object is imm
|
|
12
12
|
|
13
13
|
### T
|
14
14
|
|
15
|
-
`T` *extends* `
|
15
|
+
`T` *extends* `Record`\<`string` \| `number` \| `symbol`, `unknown`\> = `Record`\<`string` \| `number` \| `symbol`, `any`\>
|
16
16
|
|
17
17
|
## Parameters
|
18
18
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **syncAllDynamicOfflineData**(`type`, `abortSignal?`): `Promise`\<`void`\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:241](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:241](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L241)
|
8
8
|
|
9
9
|
Synchronizes all offline data entries of the given [type](#syncalldynamicofflinedata) for the currently logged in user.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **syncDynamicOfflineData**(`type`, `identifier`, `abortSignal?`): `Promise`\<`void`\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:254](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:254](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L254)
|
8
8
|
|
9
9
|
Synchronizes a single offline data entry of the given [type](#syncdynamicofflinedata) for the currently logged in user.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **syncOfflinePatientData**(`patientUuid`): `Promise`\<`void`\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L62)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **toLocationObject**(`openmrsRestForm`): [`Location`](../interfaces/Location.md)
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-emr-api/src/location.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/location.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/location.ts#L7)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **toVisitTypeObject**(`openmrsRestForm`): [`VisitType`](../interfaces/VisitType.md)
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-type.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-type.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-type.ts#L7)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **translateFrom**(`moduleName`, `key`, `fallback?`, `options?`): `string`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-translations/src/index.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-translations/src/index.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-translations/src/index.ts#L40)
|
8
8
|
|
9
9
|
This function is for getting a translation from a specific module. Use this only if the
|
10
10
|
translation is neither in the app making the call, nor in the core translations.
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **unregisterContext**(`namespace`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-context/src/context.ts:
|
7
|
+
Defined in: [packages/framework/esm-context/src/context.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-context/src/context.ts#L47)
|
8
8
|
|
9
9
|
Used by caller to unregister a namespace in the application context. Unregistering a namespace
|
10
10
|
will remove the namespace and all associated data.
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **unsetLeftNav**(`name`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-extensions/src/left-nav.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-extensions/src/left-nav.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L46)
|
8
8
|
|
9
9
|
Unsets the left nav context if the current context is for the supplied name.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **updateContext**\<`T`\>(`namespace`, `update`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-context/src/context.ts:
|
7
|
+
Defined in: [packages/framework/esm-context/src/context.ts:88](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-context/src/context.ts#L88)
|
8
8
|
|
9
9
|
Updates a namespace in the global context. If the namespace does not exist, it is registered.
|
10
10
|
|
@@ -12,7 +12,7 @@ Updates a namespace in the global context. If the namespace does not exist, it i
|
|
12
12
|
|
13
13
|
### T
|
14
14
|
|
15
|
-
`T` *extends* `
|
15
|
+
`T` *extends* `Record`\<`string` \| `number` \| `symbol`, `unknown`\> = `Record`\<`string` \| `number` \| `symbol`, `any`\>
|
16
16
|
|
17
17
|
## Parameters
|
18
18
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **updateVisit**(`uuid`, `payload`, `abortController`): `Promise`\<`FetchResponse`\<[`Visit`](../interfaces/Visit.md)\>\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:92](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:92](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L92)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **useAbortController**(): `AbortController`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useAbortController.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useAbortController.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useAbortController.ts#L25)
|
8
8
|
|
9
9
|
**`Beta`**
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **useAppContext**\<`T`\>(`namespace`): `undefined` \| `Readonly`\<`T`\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useAppContext.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useAppContext.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useAppContext.ts#L26)
|
8
8
|
|
9
9
|
This hook is used to access a namespace within the overall AppContext, so that a component can
|
10
10
|
use any shared contextual values. A selector may be provided to further restrict the properties
|
@@ -14,7 +14,7 @@ returned from the namespace.
|
|
14
14
|
|
15
15
|
### T
|
16
16
|
|
17
|
-
`T` *extends* `
|
17
|
+
`T` *extends* `Record`\<`string` \| `number` \| `symbol`, `unknown`\> = `Record`\<`string` \| `number` \| `symbol`, `any`\>
|
18
18
|
|
19
19
|
The type of the value stored in the namespace
|
20
20
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **useAssignedExtensionIds**(`slotName`): `string`[]
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts#L13)
|
8
8
|
|
9
9
|
Gets the assigned extension ids for a given extension slot name.
|
10
10
|
Does not consider if offline or online.
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **useAssignedExtensions**(`slotName`): `AssignedExtension`[]
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useAssignedExtensions.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useAssignedExtensions.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useAssignedExtensions.ts#L8)
|
8
8
|
|
9
9
|
Gets the assigned extensions for a given extension slot name.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **useAttachments**(`patientUuid`, `includeEncounterless`): `object`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useAttachments.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useAttachments.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useAttachments.ts#L7)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **useBodyScrollLock**(`active`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useBodyScrollLock.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useBodyScrollLock.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useBodyScrollLock.ts#L4)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **useConfig**\<`T`\>(`options?`): `T`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useConfig.ts:145](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useConfig.ts:145](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useConfig.ts#L145)
|
8
8
|
|
9
9
|
Use this React Hook to obtain your module's configuration.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **useConnectivity**(): `boolean`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useConnectivity.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useConnectivity.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useConnectivity.ts#L6)
|
8
8
|
|
9
9
|
## Returns
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **useDebounce**\<`T`\>(`value`, `delay`): `T`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useDebounce.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useDebounce.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useDebounce.ts#L32)
|
8
8
|
|
9
9
|
This hook debounces a state variable. That state variable can then be used as the
|
10
10
|
value of a controlled input, while the return value of this hook is used for making
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **useDefineAppContext**\<`T`\>(`namespace`, `value?`): (`update`) => `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useDefineAppContext.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useDefineAppContext.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useDefineAppContext.ts#L37)
|
8
8
|
|
9
9
|
This hook is used to register a namespace in the AppContext. The component that registers the
|
10
10
|
namespace is responsible for updating the value associated with the namespace. The namespace
|
@@ -14,7 +14,7 @@ will be automatically removed when the component using this hook is unmounted.
|
|
14
14
|
|
15
15
|
### T
|
16
16
|
|
17
|
-
`T` *extends* `
|
17
|
+
`T` *extends* `Record`\<`string` \| `number` \| `symbol`, `unknown`\> = `Record`\<`string` \| `number` \| `symbol`, `any`\>
|
18
18
|
|
19
19
|
The type of the value of the namespace
|
20
20
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **useEmrConfiguration**(): `object`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useEmrConfiguration.ts:158](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useEmrConfiguration.ts:158](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useEmrConfiguration.ts#L158)
|
8
8
|
|
9
9
|
React hook for fetching and managing OpenMRS EMR configuration
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **useExtensionSlotMeta**\<`T`\>(`extensionSlotName`): `object`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useExtensionSlotMeta.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useExtensionSlotMeta.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useExtensionSlotMeta.ts#L10)
|
8
8
|
|
9
9
|
Extract meta data from all extension for a given extension slot.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **useExtensionSlotStore**(`slot`): `ExtensionSlotState`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useExtensionSlotStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useExtensionSlotStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useExtensionSlotStore.ts#L5)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **useFeatureFlag**(`flagName`): `boolean`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useFeatureFlag.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useFeatureFlag.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useFeatureFlag.ts#L18)
|
8
8
|
|
9
9
|
Use this function to tell whether a feature flag is toggled on or off.
|
10
10
|
|