@openmrs/esm-framework 6.3.1-pre.3106 → 6.3.1-pre.3119
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build.log +1 -1
- package/dist/openmrs-esm-framework.js +2 -2
- package/dist/openmrs-esm-framework.js.map +1 -1
- package/docs/API.md +310 -8579
- package/docs/classes/OpenmrsFetchError.md +88 -117
- package/docs/enumerations/Type.md +77 -0
- package/docs/enumerations/VisitMode.md +29 -0
- package/docs/enumerations/VisitStatus.md +21 -0
- package/docs/functions/ConfigurableLink.md +19 -0
- package/docs/functions/CustomOverflowMenu.md +17 -0
- package/docs/functions/DashboardExtension.md +17 -0
- package/docs/functions/ExtensionSlot.md +46 -0
- package/docs/functions/OpenmrsAppContext.md +36 -0
- package/docs/functions/PatientBannerActionsMenu.md +17 -0
- package/docs/functions/PatientBannerContactDetails.md +17 -0
- package/docs/functions/PatientBannerPatientIdentifiers.md +17 -0
- package/docs/functions/PatientBannerPatientInfo.md +17 -0
- package/docs/functions/PatientBannerToggleContactDetailsButton.md +17 -0
- package/docs/functions/PatientPhoto.md +19 -0
- package/docs/functions/WorkspaceContainer.md +55 -0
- package/docs/functions/age.md +32 -0
- package/docs/functions/attach.md +40 -0
- package/docs/functions/beginEditSynchronizationItem.md +22 -0
- package/docs/functions/canAccessStorage.md +25 -0
- package/docs/functions/canBeginEditSynchronizationItemsOfType.md +22 -0
- package/docs/functions/clearCurrentUser.md +11 -0
- package/docs/functions/closeWorkspace.md +27 -0
- package/docs/functions/compile.md +30 -0
- package/docs/functions/convertToLocaleCalendar.md +25 -0
- package/docs/functions/createAttachment.md +21 -0
- package/docs/functions/createErrorHandler.md +21 -0
- package/docs/functions/createGlobalStore.md +36 -0
- package/docs/functions/createUseStore.md +66 -0
- package/docs/functions/defineConfigSchema.md +33 -0
- package/docs/functions/defineExtensionConfigSchema.md +38 -0
- package/docs/functions/deleteAttachmentPermanently.md +21 -0
- package/docs/functions/deleteSynchronizationItem.md +21 -0
- package/docs/functions/detach.md +25 -0
- package/docs/functions/detachAll.md +21 -0
- package/docs/functions/dispatchNotificationShown.md +17 -0
- package/docs/functions/dispatchPrecacheStaticDependencies.md +17 -0
- package/docs/functions/displayName.md +21 -0
- package/docs/functions/evaluate.md +84 -0
- package/docs/functions/evaluateAsBoolean.md +31 -0
- package/docs/functions/evaluateAsBooleanAsync.md +31 -0
- package/docs/functions/evaluateAsNumber.md +31 -0
- package/docs/functions/evaluateAsNumberAsync.md +31 -0
- package/docs/functions/evaluateAsType.md +46 -0
- package/docs/functions/evaluateAsTypeAsync.md +46 -0
- package/docs/functions/evaluateAsync.md +87 -0
- package/docs/functions/extractVariableNames.md +50 -0
- package/docs/functions/fetchCurrentPatient.md +25 -0
- package/docs/functions/filterBreadcrumbs.md +21 -0
- package/docs/functions/formatDate.md +39 -0
- package/docs/functions/formatDatetime.md +29 -0
- package/docs/functions/formatPartialDate.md +39 -0
- package/docs/functions/formatPatientName.md +23 -0
- package/docs/functions/formatTime.md +20 -0
- package/docs/functions/formattedName.md +21 -0
- package/docs/functions/generateOfflineUuid.md +13 -0
- package/docs/functions/getAssignedExtensions.md +23 -0
- package/docs/functions/getAsyncLifecycle.md +31 -0
- package/docs/functions/getAttachmentByUuid.md +21 -0
- package/docs/functions/getAttachments.md +25 -0
- package/docs/functions/getBreadcrumbs.md +11 -0
- package/docs/functions/getBreadcrumbsFor.md +17 -0
- package/docs/functions/getConfig.md +31 -0
- package/docs/functions/getContext.md +29 -0
- package/docs/functions/getCoreTranslation.md +35 -0
- package/docs/functions/getCurrentOfflineMode.md +11 -0
- package/docs/functions/getCurrentUser.md +154 -0
- package/docs/functions/getDefaultCalendar.md +21 -0
- package/docs/functions/getDefaultsFromConfigSchema.md +32 -0
- package/docs/functions/getDynamicOfflineDataEntries.md +28 -0
- package/docs/functions/getDynamicOfflineDataEntriesFor.md +34 -0
- package/docs/functions/getDynamicOfflineDataHandlers.md +13 -0
- package/docs/functions/getExtensionNameFromId.md +30 -0
- package/docs/functions/getExtensionStore.md +14 -0
- package/docs/functions/getFeatureFlag.md +21 -0
- package/docs/functions/getFhirServerPaginationHandlers.md +17 -0
- package/docs/functions/getFullSynchronizationItems.md +27 -0
- package/docs/functions/getFullSynchronizationItemsFor.md +33 -0
- package/docs/functions/getGlobalStore.md +36 -0
- package/docs/functions/getHistory.md +13 -0
- package/docs/functions/getLifecycle.md +27 -0
- package/docs/functions/getLocale.md +15 -0
- package/docs/functions/getLocations.md +21 -0
- package/docs/functions/getLoggedInUser.md +11 -0
- package/docs/functions/getOfflinePatientDataStore.md +15 -0
- package/docs/functions/getPatientName.md +26 -0
- package/docs/functions/getSessionLocation.md +11 -0
- package/docs/functions/getSessionStore.md +11 -0
- package/docs/functions/getSyncLifecycle.md +31 -0
- package/docs/functions/getSynchronizationItem.md +27 -0
- package/docs/functions/getSynchronizationItems.md +27 -0
- package/docs/functions/getVisitStore.md +11 -0
- package/docs/functions/getVisitTypes.md +11 -0
- package/docs/functions/getVisitsForPatient.md +29 -0
- package/docs/functions/goBackInHistory.md +25 -0
- package/docs/functions/importDynamic.md +58 -0
- package/docs/functions/inRange.md +27 -0
- package/docs/functions/interpolateString.md +34 -0
- package/docs/functions/interpolateUrl.md +48 -0
- package/docs/functions/isDesktop.md +17 -0
- package/docs/functions/isDevEnabled.md +11 -0
- package/docs/functions/isOfflineUuid.md +19 -0
- package/docs/functions/isOmrsDateStrict.md +20 -0
- package/docs/functions/isOmrsDateToday.md +19 -0
- package/docs/functions/isOnline.md +17 -0
- package/docs/functions/isUrlWithTemplateParameters.md +22 -0
- package/docs/functions/isVersionSatisfied.md +21 -0
- package/docs/functions/launchWorkspace.md +56 -0
- package/docs/functions/launchWorkspaceGroup.md +38 -0
- package/docs/functions/makeUrl.md +26 -0
- package/docs/functions/messageOmrsServiceWorker.md +23 -0
- package/docs/functions/navigate.md +48 -0
- package/docs/functions/navigateAndLaunchWorkspace.md +33 -0
- package/docs/functions/oneOf.md +21 -0
- package/docs/functions/openmrsFetch.md +75 -0
- package/docs/functions/openmrsObservableFetch.md +55 -0
- package/docs/functions/parseDate.md +20 -0
- package/docs/functions/provide.md +21 -0
- package/docs/functions/putDynamicOfflineData.md +28 -0
- package/docs/functions/putDynamicOfflineDataFor.md +34 -0
- package/docs/functions/queueSynchronizationItem.md +39 -0
- package/docs/functions/refetchCurrentUser.md +33 -0
- package/docs/functions/registerBreadcrumb.md +17 -0
- package/docs/functions/registerBreadcrumbs.md +17 -0
- package/docs/functions/registerContext.md +34 -0
- package/docs/functions/registerDefaultCalendar.md +33 -0
- package/docs/functions/registerFeatureFlag.md +36 -0
- package/docs/functions/registerOfflinePatientHandler.md +25 -0
- package/docs/functions/removeDynamicOfflineData.md +28 -0
- package/docs/functions/removeDynamicOfflineDataFor.md +34 -0
- package/docs/functions/renderExtension.md +41 -0
- package/docs/functions/reportError.md +17 -0
- package/docs/functions/retry.md +44 -0
- package/docs/functions/saveVisit.md +21 -0
- package/docs/functions/selectPreferredName.md +46 -0
- package/docs/functions/setCurrentVisit.md +21 -0
- package/docs/functions/setLeftNav.md +23 -0
- package/docs/functions/setSessionLocation.md +21 -0
- package/docs/functions/setUserLanguage.md +17 -0
- package/docs/functions/setUserProperties.md +23 -0
- package/docs/functions/setupDynamicOfflineDataHandler.md +22 -0
- package/docs/functions/setupOfflineSync.md +49 -0
- package/docs/functions/shallowEqual.md +32 -0
- package/docs/functions/showActionableNotification.md +21 -0
- package/docs/functions/showModal.md +44 -0
- package/docs/functions/showNotification.md +21 -0
- package/docs/functions/showSnackbar.md +21 -0
- package/docs/functions/showToast.md +21 -0
- package/docs/functions/subscribeActionableNotificationShown.md +21 -0
- package/docs/functions/subscribeConnectivity.md +21 -0
- package/docs/functions/subscribeConnectivityChanged.md +21 -0
- package/docs/functions/subscribeNotificationShown.md +21 -0
- package/docs/functions/subscribePrecacheStaticDependencies.md +21 -0
- package/docs/functions/subscribeSnackbarShown.md +21 -0
- package/docs/functions/subscribeTo.md +75 -0
- package/docs/functions/subscribeToContext.md +39 -0
- package/docs/functions/subscribeToastShown.md +21 -0
- package/docs/functions/syncAllDynamicOfflineData.md +27 -0
- package/docs/functions/syncDynamicOfflineData.md +33 -0
- package/docs/functions/syncOfflinePatientData.md +21 -0
- package/docs/functions/toDateObjectStrict.md +20 -0
- package/docs/functions/toLocationObject.md +17 -0
- package/docs/functions/toOmrsIsoString.md +23 -0
- package/docs/functions/toVisitTypeObject.md +17 -0
- package/docs/functions/translateFrom.md +55 -0
- package/docs/functions/unregisterContext.md +20 -0
- package/docs/functions/unsetLeftNav.md +23 -0
- package/docs/functions/updateContext.md +29 -0
- package/docs/functions/updateVisit.md +25 -0
- package/docs/functions/useAbortController.md +32 -0
- package/docs/functions/useAppContext.md +43 -0
- package/docs/functions/useAssignedExtensionIds.md +26 -0
- package/docs/functions/useAssignedExtensions.md +21 -0
- package/docs/functions/useAttachments.md +41 -0
- package/docs/functions/useBodyScrollLock.md +17 -0
- package/docs/functions/useConfig.md +27 -0
- package/docs/functions/useConnectivity.md +11 -0
- package/docs/functions/useDebounce.md +57 -0
- package/docs/functions/useDefineAppContext.md +70 -0
- package/docs/functions/useEmrConfiguration.md +35 -0
- package/docs/functions/useExtensionSlotMeta.md +25 -0
- package/docs/functions/useExtensionSlotStore.md +17 -0
- package/docs/functions/useFeatureFlag.md +30 -0
- package/docs/functions/useFhirFetchAll.md +44 -0
- package/docs/functions/useFhirInfinite.md +46 -0
- package/docs/functions/useFhirPagination.md +129 -0
- package/docs/functions/useLayoutType.md +11 -0
- package/docs/functions/useLeftNav.md +17 -0
- package/docs/functions/useLeftNavStore.md +11 -0
- package/docs/functions/useLocations.md +21 -0
- package/docs/functions/useOnClickOutside.md +27 -0
- package/docs/functions/useOnVisible.md +28 -0
- package/docs/functions/useOpenmrsFetchAll.md +46 -0
- package/docs/functions/useOpenmrsInfinite.md +54 -0
- package/docs/functions/useOpenmrsPagination.md +140 -0
- package/docs/functions/useOpenmrsSWR.md +71 -0
- package/docs/functions/usePagination.md +89 -0
- package/docs/functions/usePatient.md +38 -0
- package/docs/functions/usePatientPhoto.md +17 -0
- package/docs/functions/usePrimaryIdentifierCode.md +23 -0
- package/docs/functions/useRenderableExtensions.md +43 -0
- package/docs/functions/useSession.md +19 -0
- package/docs/functions/useStore.md +131 -0
- package/docs/functions/useStoreWithActions.md +33 -0
- package/docs/functions/useVisit.md +41 -0
- package/docs/functions/useVisitContextStore.md +23 -0
- package/docs/functions/useVisitTypes.md +11 -0
- package/docs/functions/useWorkspaces.md +11 -0
- package/docs/functions/userHasAccess.md +27 -0
- package/docs/functions/validator.md +44 -0
- package/docs/interfaces/ActionMenuButtonProps.md +33 -57
- package/docs/interfaces/ActionableNotificationDescriptor.md +32 -62
- package/docs/interfaces/AssignedExtension.md +30 -57
- package/docs/interfaces/Attachment.md +23 -47
- package/docs/interfaces/AttachmentResponse.md +20 -41
- package/docs/interfaces/AuditInfo.md +49 -88
- package/docs/interfaces/BreadcrumbRegistration.md +8 -17
- package/docs/interfaces/BreadcrumbSettings.md +18 -33
- package/docs/interfaces/CancelLoading.md +6 -10
- package/docs/interfaces/ClearDynamicRoutesMessage.md +9 -17
- package/docs/interfaces/CloseWorkspaceOptions.md +18 -29
- package/docs/interfaces/ComponentConfig.md +11 -23
- package/docs/interfaces/Concept.md +83 -131
- package/docs/interfaces/ConceptClass.md +46 -67
- package/docs/interfaces/ConceptDatatype.md +50 -74
- package/docs/interfaces/ConceptName.md +50 -74
- package/docs/interfaces/Config.md +4 -2
- package/docs/interfaces/ConfigObject.md +12 -21
- package/docs/interfaces/ConfigSchema.md +15 -27
- package/docs/interfaces/ConfigurableLinkProps.md +24 -4314
- package/docs/interfaces/ConnectedExtension.md +25 -41
- package/docs/interfaces/ConnectivityChangedEvent.md +4 -10
- package/docs/interfaces/CurrentPatientOptions.md +9 -18
- package/docs/interfaces/DashboardExtensionProps.md +13 -28
- package/docs/interfaces/DefaultWorkspaceProps.md +44 -51
- package/docs/interfaces/Diagnosis.md +80 -104
- package/docs/interfaces/DisplayConditionsConfigObject.md +18 -33
- package/docs/interfaces/DynamicOfflineData.md +23 -41
- package/docs/interfaces/DynamicOfflineDataHandler.md +47 -54
- package/docs/interfaces/DynamicOfflineDataSyncState.md +29 -39
- package/docs/interfaces/EmrApiConfigurationResponse.md +243 -350
- package/docs/interfaces/Encounter.md +67 -110
- package/docs/interfaces/EncounterProvider.md +39 -61
- package/docs/interfaces/EncounterRole.md +43 -68
- package/docs/interfaces/EncounterType.md +43 -68
- package/docs/interfaces/ErrorStateProps.md +7 -16
- package/docs/interfaces/ExtensionData.md +10 -22
- package/docs/interfaces/ExtensionMeta.md +4 -2
- package/docs/interfaces/ExtensionRegistration.md +36 -69
- package/docs/interfaces/ExtensionSlotBaseProps.md +35 -35
- package/docs/interfaces/ExtensionSlotConfig.md +17 -32
- package/docs/interfaces/ExtensionSlotConfigObject.md +14 -26
- package/docs/interfaces/ExtensionSlotConfigureValueObject.md +4 -2
- package/docs/interfaces/ExtensionSlotProps.md +3520 -0
- package/docs/interfaces/ExtensionSlotState.md +9 -18
- package/docs/interfaces/ExtensionStore.md +5 -11
- package/docs/interfaces/FHIRCode.md +11 -23
- package/docs/interfaces/FHIRLocationResource.md +25 -18
- package/docs/interfaces/FHIRResource.md +105 -41
- package/docs/interfaces/FeatureFlagDefinition.md +14 -26
- package/docs/interfaces/FetchConfig.md +80 -117
- package/docs/interfaces/FetchError.md +8 -21
- package/docs/interfaces/FetchHeaders.md +4 -2
- package/docs/interfaces/FetchResponse.md +124 -130
- package/docs/interfaces/FetchResponseJson.md +4 -2
- package/docs/interfaces/ImportMap.md +4 -10
- package/docs/interfaces/LeftNavStore.md +14 -29
- package/docs/interfaces/Link.md +11 -23
- package/docs/interfaces/Location.md +147 -250
- package/docs/interfaces/LoggedInUser.md +68 -70
- package/docs/interfaces/LoggedInUserFetchResponse.md +120 -128
- package/docs/interfaces/MessageServiceWorkerResult.md +17 -29
- package/docs/interfaces/NavigateOptions.md +9 -18
- package/docs/interfaces/NewVisitPayload.md +32 -48
- package/docs/interfaces/NotificationDescriptor.md +31 -58
- package/docs/interfaces/Obs.md +99 -166
- package/docs/interfaces/OfflineModeResult.md +11 -23
- package/docs/interfaces/OfflinePatientArgs.md +13 -20
- package/docs/interfaces/OfflinePatientDataSyncHandler.md +17 -27
- package/docs/interfaces/OfflinePatientDataSyncState.md +29 -51
- package/docs/interfaces/OfflinePatientDataSyncStore.md +13 -20
- package/docs/interfaces/OmrsServiceWorkerMessage.md +13 -23
- package/docs/interfaces/OnImportMapChangedMessage.md +12 -23
- package/docs/interfaces/OnlyThePatient.md +9 -17
- package/docs/interfaces/OpenWorkspace.md +116 -170
- package/docs/interfaces/OpenmrsAppContextProps.md +14 -23
- package/docs/interfaces/OpenmrsAppRoutes.md +41 -71
- package/docs/interfaces/OpenmrsDatePickerProps.md +346 -483
- package/docs/interfaces/OpenmrsResource.md +39 -57
- package/docs/interfaces/OpenmrsResourceStrict.md +27 -51
- package/docs/interfaces/PageHeaderContentProps.md +12 -24
- package/docs/interfaces/PageHeaderWrapperProps.md +9 -18
- package/docs/interfaces/Patient.md +41 -70
- package/docs/interfaces/PatientBannerActionsMenuProps.md +15 -30
- package/docs/interfaces/PatientBannerToggleContactDetailsButtonProps.md +17 -32
- package/docs/interfaces/PatientIdentifier.md +49 -84
- package/docs/interfaces/PatientIdentifierType.md +65 -112
- package/docs/interfaces/PatientPhotoProps.md +8 -17
- package/docs/interfaces/PatientWithFullResponse.md +9 -17
- package/docs/interfaces/Person.md +96 -160
- package/docs/interfaces/PersonAddress.md +136 -230
- package/docs/interfaces/PersonAttribute.md +43 -68
- package/docs/interfaces/PersonName.md +72 -118
- package/docs/interfaces/PrecacheStaticDependenciesEvent.md +3 -1
- package/docs/interfaces/PrimaryIdentifier.md +5 -11
- package/docs/interfaces/Privilege.md +11 -23
- package/docs/interfaces/Prompt.md +20 -41
- package/docs/interfaces/QueueItemDescriptor.md +23 -30
- package/docs/interfaces/RegisterDynamicRouteMessage.md +21 -38
- package/docs/interfaces/ResourceLoader.md +10 -14
- package/docs/interfaces/ResponsiveWrapperProps.md +5 -11
- package/docs/interfaces/RetryOptions.md +36 -37
- package/docs/interfaces/Role.md +10 -22
- package/docs/interfaces/Session.md +31 -54
- package/docs/interfaces/SessionLocation.md +10 -22
- package/docs/interfaces/SetLeftNavParams.md +15 -30
- package/docs/interfaces/ShowActionableNotificationEvent.md +26 -50
- package/docs/interfaces/ShowNotificationEvent.md +20 -38
- package/docs/interfaces/ShowSnackbarEvent.md +34 -64
- package/docs/interfaces/ShowToastEvent.md +22 -43
- package/docs/interfaces/SnackbarDescriptor.md +41 -76
- package/docs/interfaces/SnackbarMeta.md +55 -93
- package/docs/interfaces/SpaConfig.md +30 -40
- package/docs/interfaces/StyleguideConfigObject.md +39 -70
- package/docs/interfaces/SyncItem.md +34 -57
- package/docs/interfaces/SyncProcessOptions.md +22 -40
- package/docs/interfaces/ToastDescriptor.md +29 -55
- package/docs/interfaces/ToastNotificationMeta.md +40 -69
- package/docs/interfaces/UploadedFile.md +25 -49
- package/docs/interfaces/UseConfigOptions.md +6 -12
- package/docs/interfaces/UsePatientPhotoResult.md +12 -24
- package/docs/interfaces/UseServerFetchAllOptions.md +41 -61
- package/docs/interfaces/UseServerInfiniteOptions.md +29 -46
- package/docs/interfaces/UseServerPaginationOptions.md +26 -41
- package/docs/interfaces/User.md +34 -46
- package/docs/interfaces/UserHasAccessProps.md +13 -25
- package/docs/interfaces/Visit.md +36 -66
- package/docs/interfaces/VisitItem.md +16 -31
- package/docs/interfaces/VisitReturnType.md +24 -51
- package/docs/interfaces/VisitStoreState.md +14 -26
- package/docs/interfaces/VisitType.md +11 -23
- package/docs/interfaces/WorkspaceContainerProps.md +20 -38
- package/docs/interfaces/WorkspaceGroupDefinition.md +10 -19
- package/docs/interfaces/WorkspaceRegistration.md +43 -82
- package/docs/interfaces/WorkspacesInfo.md +30 -40
- package/docs/type-aliases/ActionFunction.md +27 -0
- package/docs/type-aliases/ActionableNotificationType.md +7 -0
- package/docs/type-aliases/Actions.md +13 -0
- package/docs/type-aliases/ArgumentsTuple.md +7 -0
- package/docs/type-aliases/BoundActions.md +17 -0
- package/docs/type-aliases/ConfigValue.md +7 -0
- package/docs/type-aliases/ContextCallback.md +23 -0
- package/docs/type-aliases/CoreTranslationKey.md +7 -0
- package/docs/type-aliases/CurrentPatient.md +7 -0
- package/docs/type-aliases/DateInput.md +7 -0
- package/docs/type-aliases/DefaultEvaluateReturnType.md +9 -0
- package/docs/type-aliases/ExtensionDefinition.md +69 -0
- package/docs/type-aliases/ExtensionProps.md +13 -0
- package/docs/type-aliases/FormatDateMode.md +7 -0
- package/docs/type-aliases/FormatDateOptions.md +102 -0
- package/docs/type-aliases/IconProps.md +31 -0
- package/docs/type-aliases/InlineNotificationType.md +7 -0
- package/docs/type-aliases/Key.md +7 -0
- package/docs/type-aliases/KnownOmrsServiceWorkerMessages.md +7 -0
- package/docs/type-aliases/LayoutType.md +7 -0
- package/docs/type-aliases/LoadedSessionStore.md +23 -0
- package/docs/type-aliases/ModalDefinition.md +17 -0
- package/docs/type-aliases/NameUse.md +7 -0
- package/docs/type-aliases/NullablePatient.md +7 -0
- package/docs/type-aliases/OfflineMode.md +7 -0
- package/docs/type-aliases/OmrsOfflineCachingStrategy.md +12 -0
- package/docs/type-aliases/OmrsOfflineHttpHeaderNames.md +7 -0
- package/docs/type-aliases/OmrsOfflineHttpHeaders.md +44 -0
- package/docs/type-aliases/OpenmrsRoutes.md +10 -0
- package/docs/type-aliases/PageDefinition.md +41 -0
- package/docs/type-aliases/PageHeaderProps.md +7 -0
- package/docs/type-aliases/PatientUuid.md +7 -0
- package/docs/type-aliases/PictogramProps.md +23 -0
- package/docs/type-aliases/ProvidedConfig.md +23 -0
- package/docs/type-aliases/ResourceName.md +7 -0
- package/docs/type-aliases/SessionStore.md +7 -0
- package/docs/type-aliases/SnackbarType.md +7 -0
- package/docs/type-aliases/SpaEnvironment.md +7 -0
- package/docs/type-aliases/SvgIconProps.md +23 -0
- package/docs/type-aliases/SvgPictogramProps.md +27 -0
- package/docs/type-aliases/TemplateParams.md +11 -0
- package/docs/type-aliases/ToastType.md +7 -0
- package/docs/type-aliases/UnloadedSessionStore.md +23 -0
- package/docs/type-aliases/UpdateVisitPayload.md +7 -0
- package/docs/type-aliases/UseOpenmrsSWROptions.md +39 -0
- package/docs/type-aliases/Validator.md +17 -0
- package/docs/type-aliases/ValidatorFunction.md +17 -0
- package/docs/type-aliases/VariablesMap.md +13 -0
- package/docs/type-aliases/WorkspaceDefinition.md +78 -0
- package/docs/type-aliases/WorkspaceWindowState.md +7 -0
- package/docs/variables/ActionMenuButton.md +7 -0
- package/docs/variables/ActivityIcon.md +7 -0
- package/docs/variables/AddIcon.md +7 -0
- package/docs/variables/AllergiesIcon.md +7 -0
- package/docs/variables/AppointmentsPictogram.md +7 -0
- package/docs/variables/ArrowDownIcon.md +7 -0
- package/docs/variables/ArrowLeftIcon.md +7 -0
- package/docs/variables/ArrowRightIcon.md +7 -0
- package/docs/variables/ArrowUpIcon.md +7 -0
- package/docs/variables/AttachmentIcon.md +7 -0
- package/docs/variables/BabyIcon.md +7 -0
- package/docs/variables/CalendarHeatMapIcon.md +7 -0
- package/docs/variables/CalendarIcon.md +7 -0
- package/docs/variables/CaretDownIcon.md +7 -0
- package/docs/variables/CaretLeftIcon.md +7 -0
- package/docs/variables/CaretRightIcon.md +7 -0
- package/docs/variables/CaretUpIcon.md +7 -0
- package/docs/variables/ChartAverageIcon.md +7 -0
- package/docs/variables/CheckmarkFilledIcon.md +7 -0
- package/docs/variables/CheckmarkOutlineIcon.md +7 -0
- package/docs/variables/ChemistryIcon.md +7 -0
- package/docs/variables/ChevronDownIcon.md +7 -0
- package/docs/variables/ChevronLeftIcon.md +7 -0
- package/docs/variables/ChevronRightIcon.md +7 -0
- package/docs/variables/ChevronUpIcon.md +7 -0
- package/docs/variables/CloseFilledIcon.md +7 -0
- package/docs/variables/CloseIcon.md +7 -0
- package/docs/variables/CloseOutlineIcon.md +7 -0
- package/docs/variables/ConditionsIcon.md +11 -0
- package/docs/variables/DiagnosisTags.md +11 -0
- package/docs/variables/DocumentAttachmentIcon.md +7 -0
- package/docs/variables/DocumentIcon.md +7 -0
- package/docs/variables/DownloadIcon.md +7 -0
- package/docs/variables/DrugOrderIcon.md +7 -0
- package/docs/variables/EditIcon.md +7 -0
- package/docs/variables/ErrorState.md +7 -0
- package/docs/variables/EventScheduleIcon.md +7 -0
- package/docs/variables/EventsIcon.md +7 -0
- package/docs/variables/Extension.md +15 -0
- package/docs/variables/GenderFemaleIcon.md +7 -0
- package/docs/variables/GenderMaleIcon.md +7 -0
- package/docs/variables/GenderOtherIcon.md +7 -0
- package/docs/variables/GenderUnknownIcon.md +7 -0
- package/docs/variables/GenericOrderTypeIcon.md +7 -0
- package/docs/variables/GroupAccessIcon.md +7 -0
- package/docs/variables/GroupIcon.md +7 -0
- package/docs/variables/HomePictogram.md +7 -0
- package/docs/variables/HospitalBedIcon.md +7 -0
- package/docs/variables/Icon.md +9 -0
- package/docs/variables/ImageMedicalIcon.md +7 -0
- package/docs/variables/InPatientPictogram.md +7 -0
- package/docs/variables/InformationFilledIcon.md +7 -0
- package/docs/variables/InformationIcon.md +7 -0
- package/docs/variables/InformationSquareIcon.md +7 -0
- package/docs/variables/InventoryManagementIcon.md +7 -0
- package/docs/variables/LabOrderIcon.md +7 -0
- package/docs/variables/LaboratoryPictogram.md +7 -0
- package/docs/variables/LeftNavMenu.md +13 -0
- package/docs/variables/ListCheckedIcon.md +7 -0
- package/docs/variables/LocationIcon.md +7 -0
- package/docs/variables/LocationPicker.md +7 -0
- package/docs/variables/MaterialOrderIcon.md +7 -0
- package/docs/variables/MaximizeIcon.md +7 -0
- package/docs/variables/MaybeIcon.md +16 -0
- package/docs/variables/MaybePictogram.md +16 -0
- package/docs/variables/MedicationIcon.md +7 -0
- package/docs/variables/MessageQueueIcon.md +7 -0
- package/docs/variables/MicroscopeIcon.md +7 -0
- package/docs/variables/MoneyIcon.md +9 -0
- package/docs/variables/MotherIcon.md +7 -0
- package/docs/variables/MovementIcon.md +7 -0
- package/docs/variables/OpenmrsDatePicker.md +9 -0
- package/docs/variables/OverflowMenuHorizontalIcon.md +7 -0
- package/docs/variables/OverflowMenuVerticalIcon.md +7 -0
- package/docs/variables/PageHeader.md +30 -0
- package/docs/variables/PageHeaderContent.md +21 -0
- package/docs/variables/PasswordIcon.md +7 -0
- package/docs/variables/PatientListsPictogram.md +7 -0
- package/docs/variables/PedestrianFamilyIcon.md +7 -0
- package/docs/variables/PenIcon.md +7 -0
- package/docs/variables/PharmacyPictogram.md +7 -0
- package/docs/variables/Pictogram.md +9 -0
- package/docs/variables/PrinterIcon.md +7 -0
- package/docs/variables/ProcedureOrderIcon.md +7 -0
- package/docs/variables/ProgramsIcon.md +7 -0
- package/docs/variables/RadiologyIcon.md +7 -0
- package/docs/variables/ReferralOrderIcon.md +7 -0
- package/docs/variables/RegistrationPictogram.md +7 -0
- package/docs/variables/RenderIfValueIsTruthy.md +21 -0
- package/docs/variables/RenewIcon.md +7 -0
- package/docs/variables/ReportIcon.md +7 -0
- package/docs/variables/ResetIcon.md +7 -0
- package/docs/variables/ResponsiveWrapper.md +11 -0
- package/docs/variables/SaveIcon.md +7 -0
- package/docs/variables/SearchIcon.md +7 -0
- package/docs/variables/ServiceQueuesPictogram.md +7 -0
- package/docs/variables/ShoppingCartAddItemIcon.md +11 -0
- package/docs/variables/ShoppingCartArrowDownIcon.md +9 -0
- package/docs/variables/ShoppingCartIcon.md +9 -0
- package/docs/variables/StickyNoteAddIcon.md +9 -0
- package/docs/variables/StockManagementPictogram.md +7 -0
- package/docs/variables/SwitcherIcon.md +7 -0
- package/docs/variables/SyringeIcon.md +7 -0
- package/docs/variables/TableIcon.md +7 -0
- package/docs/variables/TableOfContentsIcon.md +9 -0
- package/docs/variables/TimeIcon.md +9 -0
- package/docs/variables/ToolsIcon.md +7 -0
- package/docs/variables/TranslateIcon.md +7 -0
- package/docs/variables/TrashCanIcon.md +7 -0
- package/docs/variables/TreeViewAltIcon.md +7 -0
- package/docs/variables/UserAvatarIcon.md +9 -0
- package/docs/variables/UserFollowIcon.md +7 -0
- package/docs/variables/UserHasAccess.md +35 -0
- package/docs/variables/UserIcon.md +7 -0
- package/docs/variables/UserXrayIcon.md +11 -0
- package/docs/variables/ViewIcon.md +7 -0
- package/docs/variables/ViewOffIcon.md +7 -0
- package/docs/variables/WarningIcon.md +7 -0
- package/docs/variables/attachmentUrl.md +7 -0
- package/docs/variables/backendDependencies.md +17 -0
- package/docs/variables/defaultVisitCustomRepresentation.md +7 -0
- package/docs/variables/fhirBaseUrl.md +7 -0
- package/docs/variables/getAsyncExtensionLifecycle.md +35 -0
- package/docs/variables/getStartedVisit.md +9 -0
- package/docs/variables/isUrl.md +9 -0
- package/docs/variables/offlineUuidPrefix.md +7 -0
- package/docs/variables/omrsOfflineCachingStrategyHttpHeaderName.md +7 -0
- package/docs/variables/omrsOfflineResponseBodyHttpHeaderName.md +7 -0
- package/docs/variables/omrsOfflineResponseStatusHttpHeaderName.md +7 -0
- package/docs/variables/restBaseUrl.md +7 -0
- package/docs/variables/sessionEndpoint.md +7 -0
- package/docs/variables/useConnectedExtensions.md +25 -0
- package/docs/variables/useExtensionStore.md +55 -0
- package/docs/variables/validators.md +78 -0
- package/package.json +24 -20
- package/rspack.config.cjs +1 -8
- package/tsconfig.build.json +2 -1
- package/typedoc.json +16 -3
- package/docs/.nojekyll +0 -1
- package/docs/enums/Type.md +0 -107
- package/docs/enums/VisitMode.md +0 -41
- package/docs/enums/VisitStatus.md +0 -30
- package/docs/interfaces/OldExtensionSlotBaseProps.md +0 -67
@@ -1,122 +1,97 @@
|
|
1
|
-
[
|
1
|
+
[O3 Framework](../API.md) / EncounterType
|
2
2
|
|
3
3
|
# Interface: EncounterType
|
4
4
|
|
5
|
-
|
5
|
+
Defined in: [packages/framework/esm-emr-api/src/types/encounter-resource.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/encounter-resource.ts#L21)
|
6
6
|
|
7
|
-
|
8
|
-
|
9
|
-
↳ **`EncounterType`**
|
7
|
+
## Extends
|
10
8
|
|
11
|
-
|
9
|
+
- `OpenmrsResource`
|
12
10
|
|
13
|
-
|
11
|
+
## Indexable
|
14
12
|
|
15
|
-
|
16
|
-
- [description](EncounterType.md#description)
|
17
|
-
- [display](EncounterType.md#display)
|
18
|
-
- [links](EncounterType.md#links)
|
19
|
-
- [name](EncounterType.md#name)
|
20
|
-
- [resourceVersion](EncounterType.md#resourceversion)
|
21
|
-
- [retired](EncounterType.md#retired)
|
22
|
-
- [uuid](EncounterType.md#uuid)
|
13
|
+
\[`anythingElse`: `string`\]: `any`
|
23
14
|
|
24
15
|
## Properties
|
25
16
|
|
26
|
-
### auditInfo
|
27
|
-
|
28
|
-
• `Optional` **auditInfo**: `AuditInfo`
|
17
|
+
### auditInfo?
|
29
18
|
|
30
|
-
|
19
|
+
> `optional` **auditInfo**: `AuditInfo`
|
31
20
|
|
32
|
-
|
21
|
+
Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:14
|
33
22
|
|
34
|
-
####
|
23
|
+
#### Inherited from
|
35
24
|
|
36
|
-
|
25
|
+
`OpenmrsResource.auditInfo`
|
37
26
|
|
38
|
-
|
27
|
+
***
|
39
28
|
|
40
|
-
### description
|
29
|
+
### description?
|
41
30
|
|
42
|
-
|
31
|
+
> `optional` **description**: `string`
|
43
32
|
|
44
|
-
|
33
|
+
Defined in: [packages/framework/esm-emr-api/src/types/encounter-resource.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/encounter-resource.ts#L23)
|
45
34
|
|
46
|
-
|
35
|
+
***
|
47
36
|
|
48
|
-
|
37
|
+
### display?
|
49
38
|
|
50
|
-
|
39
|
+
> `optional` **display**: `string`
|
51
40
|
|
52
|
-
|
41
|
+
Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:12
|
53
42
|
|
54
43
|
#### Inherited from
|
55
44
|
|
56
|
-
OpenmrsResource.display
|
45
|
+
`OpenmrsResource.display`
|
57
46
|
|
58
|
-
|
47
|
+
***
|
59
48
|
|
60
|
-
|
49
|
+
### links?
|
61
50
|
|
62
|
-
|
51
|
+
> `optional` **links**: `Link`[]
|
63
52
|
|
64
|
-
|
65
|
-
|
66
|
-
• `Optional` **links**: `Link`[]
|
53
|
+
Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:13
|
67
54
|
|
68
55
|
#### Inherited from
|
69
56
|
|
70
|
-
OpenmrsResource.links
|
71
|
-
|
72
|
-
#### Defined in
|
57
|
+
`OpenmrsResource.links`
|
73
58
|
|
74
|
-
|
59
|
+
***
|
75
60
|
|
76
|
-
|
61
|
+
### name?
|
77
62
|
|
78
|
-
|
63
|
+
> `optional` **name**: `string`
|
79
64
|
|
80
|
-
|
65
|
+
Defined in: [packages/framework/esm-emr-api/src/types/encounter-resource.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/encounter-resource.ts#L22)
|
81
66
|
|
82
|
-
|
67
|
+
***
|
83
68
|
|
84
|
-
|
69
|
+
### resourceVersion?
|
85
70
|
|
86
|
-
|
71
|
+
> `optional` **resourceVersion**: `string`
|
87
72
|
|
88
|
-
|
89
|
-
|
90
|
-
• `Optional` **resourceVersion**: `string`
|
73
|
+
Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:15
|
91
74
|
|
92
75
|
#### Inherited from
|
93
76
|
|
94
|
-
OpenmrsResource.resourceVersion
|
95
|
-
|
96
|
-
#### Defined in
|
97
|
-
|
98
|
-
packages/framework/esm-api/dist/types/openmrs-resource.d.ts:15
|
99
|
-
|
100
|
-
___
|
77
|
+
`OpenmrsResource.resourceVersion`
|
101
78
|
|
102
|
-
|
79
|
+
***
|
103
80
|
|
104
|
-
|
81
|
+
### retired?
|
105
82
|
|
106
|
-
|
83
|
+
> `optional` **retired**: `boolean`
|
107
84
|
|
108
|
-
[packages/framework/esm-emr-api/src/types/encounter-resource.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/encounter-resource.ts#L24)
|
85
|
+
Defined in: [packages/framework/esm-emr-api/src/types/encounter-resource.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/encounter-resource.ts#L24)
|
109
86
|
|
110
|
-
|
87
|
+
***
|
111
88
|
|
112
89
|
### uuid
|
113
90
|
|
114
|
-
|
91
|
+
> **uuid**: `string`
|
115
92
|
|
116
|
-
|
117
|
-
|
118
|
-
OpenmrsResource.uuid
|
93
|
+
Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:11
|
119
94
|
|
120
|
-
####
|
95
|
+
#### Inherited from
|
121
96
|
|
122
|
-
|
97
|
+
`OpenmrsResource.uuid`
|
@@ -1,30 +1,21 @@
|
|
1
|
-
[
|
1
|
+
[O3 Framework](../API.md) / ErrorStateProps
|
2
2
|
|
3
3
|
# Interface: ErrorStateProps
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
### Properties
|
8
|
-
|
9
|
-
- [error](ErrorStateProps.md#error)
|
10
|
-
- [headerTitle](ErrorStateProps.md#headertitle)
|
5
|
+
Defined in: [packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L7)
|
11
6
|
|
12
7
|
## Properties
|
13
8
|
|
14
9
|
### error
|
15
10
|
|
16
|
-
|
11
|
+
> **error**: `any`
|
17
12
|
|
18
|
-
|
13
|
+
Defined in: [packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L8)
|
19
14
|
|
20
|
-
|
21
|
-
|
22
|
-
___
|
15
|
+
***
|
23
16
|
|
24
17
|
### headerTitle
|
25
18
|
|
26
|
-
|
27
|
-
|
28
|
-
#### Defined in
|
19
|
+
> **headerTitle**: `string`
|
29
20
|
|
30
|
-
[packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L9)
|
21
|
+
Defined in: [packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L9)
|
@@ -1,41 +1,29 @@
|
|
1
|
-
[
|
1
|
+
[O3 Framework](../API.md) / ExtensionData
|
2
2
|
|
3
3
|
# Interface: ExtensionData
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
### Properties
|
8
|
-
|
9
|
-
- [extensionId](ExtensionData.md#extensionid)
|
10
|
-
- [extensionSlotModuleName](ExtensionData.md#extensionslotmodulename)
|
11
|
-
- [extensionSlotName](ExtensionData.md#extensionslotname)
|
5
|
+
Defined in: [packages/framework/esm-extensions/src/types.ts:1](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L1)
|
12
6
|
|
13
7
|
## Properties
|
14
8
|
|
15
9
|
### extensionId
|
16
10
|
|
17
|
-
|
18
|
-
|
19
|
-
#### Defined in
|
11
|
+
> **extensionId**: `string`
|
20
12
|
|
21
|
-
[packages/framework/esm-extensions/src/types.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L4)
|
13
|
+
Defined in: [packages/framework/esm-extensions/src/types.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L4)
|
22
14
|
|
23
|
-
|
15
|
+
***
|
24
16
|
|
25
17
|
### extensionSlotModuleName
|
26
18
|
|
27
|
-
|
19
|
+
> **extensionSlotModuleName**: `string`
|
28
20
|
|
29
|
-
|
21
|
+
Defined in: [packages/framework/esm-extensions/src/types.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L3)
|
30
22
|
|
31
|
-
|
32
|
-
|
33
|
-
___
|
23
|
+
***
|
34
24
|
|
35
25
|
### extensionSlotName
|
36
26
|
|
37
|
-
|
38
|
-
|
39
|
-
#### Defined in
|
27
|
+
> **extensionSlotName**: `string`
|
40
28
|
|
41
|
-
[packages/framework/esm-extensions/src/types.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L2)
|
29
|
+
Defined in: [packages/framework/esm-extensions/src/types.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L2)
|
@@ -1,7 +1,9 @@
|
|
1
|
-
[
|
1
|
+
[O3 Framework](../API.md) / ExtensionMeta
|
2
2
|
|
3
3
|
# Interface: ExtensionMeta
|
4
4
|
|
5
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L8)
|
6
|
+
|
5
7
|
## Indexable
|
6
8
|
|
7
|
-
|
9
|
+
\[`_`: `string`\]: `any`
|
@@ -1,114 +1,81 @@
|
|
1
|
-
[
|
1
|
+
[O3 Framework](../API.md) / ExtensionRegistration
|
2
2
|
|
3
3
|
# Interface: ExtensionRegistration
|
4
4
|
|
5
|
-
|
5
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L12)
|
6
6
|
|
7
|
-
|
7
|
+
## Properties
|
8
8
|
|
9
|
-
|
10
|
-
- [meta](ExtensionRegistration.md#meta)
|
11
|
-
- [moduleName](ExtensionRegistration.md#modulename)
|
12
|
-
- [name](ExtensionRegistration.md#name)
|
13
|
-
- [offline](ExtensionRegistration.md#offline)
|
14
|
-
- [online](ExtensionRegistration.md#online)
|
15
|
-
- [order](ExtensionRegistration.md#order)
|
16
|
-
- [privileges](ExtensionRegistration.md#privileges)
|
9
|
+
### featureFlag?
|
17
10
|
|
18
|
-
|
11
|
+
> `readonly` `optional` **featureFlag**: `string`
|
19
12
|
|
20
|
-
|
13
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L21)
|
21
14
|
|
22
|
-
|
23
|
-
|
24
|
-
### featureFlag
|
25
|
-
|
26
|
-
• `Optional` `Readonly` **featureFlag**: `string`
|
27
|
-
|
28
|
-
#### Defined in
|
29
|
-
|
30
|
-
[packages/framework/esm-extensions/src/store.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L21)
|
31
|
-
|
32
|
-
___
|
15
|
+
***
|
33
16
|
|
34
17
|
### meta
|
35
18
|
|
36
|
-
|
37
|
-
|
38
|
-
#### Defined in
|
19
|
+
> `readonly` **meta**: `Readonly`\<[`ExtensionMeta`](ExtensionMeta.md)\>
|
39
20
|
|
40
|
-
[packages/framework/esm-extensions/src/store.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L16)
|
21
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L16)
|
41
22
|
|
42
|
-
|
23
|
+
***
|
43
24
|
|
44
25
|
### moduleName
|
45
26
|
|
46
|
-
|
27
|
+
> `readonly` **moduleName**: `string`
|
47
28
|
|
48
|
-
|
29
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L15)
|
49
30
|
|
50
|
-
|
51
|
-
|
52
|
-
___
|
31
|
+
***
|
53
32
|
|
54
33
|
### name
|
55
34
|
|
56
|
-
|
57
|
-
|
58
|
-
#### Defined in
|
35
|
+
> `readonly` **name**: `string`
|
59
36
|
|
60
|
-
[packages/framework/esm-extensions/src/store.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L13)
|
37
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L13)
|
61
38
|
|
62
|
-
|
39
|
+
***
|
63
40
|
|
64
|
-
### offline
|
41
|
+
### offline?
|
65
42
|
|
66
|
-
|
43
|
+
> `readonly` `optional` **offline**: `boolean`
|
67
44
|
|
68
|
-
|
45
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L19)
|
69
46
|
|
70
|
-
|
47
|
+
***
|
71
48
|
|
72
|
-
|
49
|
+
### online?
|
73
50
|
|
74
|
-
|
51
|
+
> `readonly` `optional` **online**: `boolean`
|
75
52
|
|
76
|
-
|
53
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L18)
|
77
54
|
|
78
|
-
|
55
|
+
***
|
79
56
|
|
80
|
-
|
57
|
+
### order?
|
81
58
|
|
82
|
-
|
59
|
+
> `readonly` `optional` **order**: `number`
|
83
60
|
|
84
|
-
|
61
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L17)
|
85
62
|
|
86
|
-
|
63
|
+
***
|
87
64
|
|
88
|
-
|
65
|
+
### privileges?
|
89
66
|
|
90
|
-
[
|
67
|
+
> `readonly` `optional` **privileges**: `string` \| `string`[]
|
91
68
|
|
92
|
-
|
93
|
-
|
94
|
-
### privileges
|
95
|
-
|
96
|
-
• `Optional` `Readonly` **privileges**: `string` \| `string`[]
|
97
|
-
|
98
|
-
#### Defined in
|
99
|
-
|
100
|
-
[packages/framework/esm-extensions/src/store.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L20)
|
69
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L20)
|
101
70
|
|
102
71
|
## Methods
|
103
72
|
|
104
|
-
### load
|
73
|
+
### load()
|
105
74
|
|
106
|
-
|
75
|
+
> **load**(): `Promise`\<`object` & `LifeCycles`\>
|
107
76
|
|
108
|
-
|
109
|
-
|
110
|
-
`Promise`<{ `default?`: `LifeCycles`<{}\> } & `LifeCycles`<{}\>\>
|
77
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L14)
|
111
78
|
|
112
|
-
####
|
79
|
+
#### Returns
|
113
80
|
|
114
|
-
|
81
|
+
`Promise`\<`object` & `LifeCycles`\>
|
@@ -1,67 +1,67 @@
|
|
1
|
-
[
|
1
|
+
[O3 Framework](../API.md) / ExtensionSlotBaseProps
|
2
2
|
|
3
3
|
# Interface: ExtensionSlotBaseProps
|
4
4
|
|
5
|
-
|
5
|
+
Defined in: [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L8)
|
6
6
|
|
7
|
-
|
7
|
+
## Extended by
|
8
8
|
|
9
|
-
- [
|
10
|
-
- [name](ExtensionSlotBaseProps.md#name)
|
11
|
-
- [state](ExtensionSlotBaseProps.md#state)
|
9
|
+
- [`ExtensionSlotProps`](ExtensionSlotProps.md)
|
12
10
|
|
13
|
-
|
11
|
+
## Properties
|
14
12
|
|
15
|
-
|
13
|
+
### ~~extensionSlotName?~~
|
16
14
|
|
17
|
-
|
15
|
+
> `optional` **extensionSlotName**: `string`
|
18
16
|
|
19
|
-
|
17
|
+
Defined in: [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L15)
|
20
18
|
|
21
|
-
|
19
|
+
The name of the extension slot
|
22
20
|
|
23
|
-
|
21
|
+
#### Deprecated
|
24
22
|
|
25
|
-
|
23
|
+
Use `name`
|
26
24
|
|
27
|
-
|
28
|
-
|
29
|
-
___
|
25
|
+
***
|
30
26
|
|
31
27
|
### name
|
32
28
|
|
33
|
-
|
34
|
-
|
35
|
-
#### Defined in
|
36
|
-
|
37
|
-
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L9)
|
29
|
+
> **name**: `string`
|
38
30
|
|
39
|
-
|
31
|
+
Defined in: [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L10)
|
40
32
|
|
41
|
-
|
33
|
+
The name of the extension slot
|
42
34
|
|
43
|
-
|
35
|
+
***
|
44
36
|
|
45
|
-
|
37
|
+
### select()?
|
46
38
|
|
47
|
-
[
|
39
|
+
> `optional` **select**: (`extensions`) => `AssignedExtension`[]
|
48
40
|
|
49
|
-
|
41
|
+
Defined in: [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L20)
|
50
42
|
|
51
|
-
|
52
|
-
|
53
|
-
▸ `Optional` **select**(`extensions`): `AssignedExtension`[]
|
43
|
+
An optional function for filtering or otherwise modifying
|
44
|
+
the list of extensions that will be rendered.
|
54
45
|
|
55
46
|
#### Parameters
|
56
47
|
|
57
|
-
|
58
|
-
|
59
|
-
|
48
|
+
##### extensions
|
49
|
+
|
50
|
+
`AssignedExtension`[]
|
60
51
|
|
61
52
|
#### Returns
|
62
53
|
|
63
54
|
`AssignedExtension`[]
|
64
55
|
|
65
|
-
|
56
|
+
***
|
57
|
+
|
58
|
+
### state?
|
59
|
+
|
60
|
+
> `optional` **state**: `Record`\<`string` \| `number` \| `symbol`, `unknown`\>
|
61
|
+
|
62
|
+
Defined in: [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L27)
|
66
63
|
|
67
|
-
|
64
|
+
Only works if no children are provided*. Passes data
|
65
|
+
through as props to the extensions that are mounted here. If `ExtensionSlot`
|
66
|
+
has children, you must pass the state through the `state` param of the
|
67
|
+
`Extension` component.
|
@@ -1,52 +1,37 @@
|
|
1
|
-
[
|
1
|
+
[O3 Framework](../API.md) / ExtensionSlotConfig
|
2
2
|
|
3
3
|
# Interface: ExtensionSlotConfig
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
### Properties
|
8
|
-
|
9
|
-
- [add](ExtensionSlotConfig.md#add)
|
10
|
-
- [configure](ExtensionSlotConfig.md#configure)
|
11
|
-
- [order](ExtensionSlotConfig.md#order)
|
12
|
-
- [remove](ExtensionSlotConfig.md#remove)
|
5
|
+
Defined in: [packages/framework/esm-config/src/types.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L48)
|
13
6
|
|
14
7
|
## Properties
|
15
8
|
|
16
|
-
### add
|
17
|
-
|
18
|
-
• `Optional` **add**: `string`[]
|
19
|
-
|
20
|
-
#### Defined in
|
21
|
-
|
22
|
-
[packages/framework/esm-config/src/types.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L49)
|
23
|
-
|
24
|
-
___
|
9
|
+
### add?
|
25
10
|
|
26
|
-
|
11
|
+
> `optional` **add**: `string`[]
|
27
12
|
|
28
|
-
|
13
|
+
Defined in: [packages/framework/esm-config/src/types.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L49)
|
29
14
|
|
30
|
-
|
15
|
+
***
|
31
16
|
|
32
|
-
|
17
|
+
### configure?
|
33
18
|
|
34
|
-
|
19
|
+
> `optional` **configure**: [`ExtensionSlotConfigureValueObject`](ExtensionSlotConfigureValueObject.md)
|
35
20
|
|
36
|
-
|
21
|
+
Defined in: [packages/framework/esm-config/src/types.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L52)
|
37
22
|
|
38
|
-
|
23
|
+
***
|
39
24
|
|
40
|
-
|
25
|
+
### order?
|
41
26
|
|
42
|
-
[
|
27
|
+
> `optional` **order**: `string`[]
|
43
28
|
|
44
|
-
|
29
|
+
Defined in: [packages/framework/esm-config/src/types.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L51)
|
45
30
|
|
46
|
-
|
31
|
+
***
|
47
32
|
|
48
|
-
|
33
|
+
### remove?
|
49
34
|
|
50
|
-
|
35
|
+
> `optional` **remove**: `string`[]
|
51
36
|
|
52
|
-
[packages/framework/esm-config/src/types.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L50)
|
37
|
+
Defined in: [packages/framework/esm-config/src/types.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L50)
|
@@ -1,47 +1,35 @@
|
|
1
|
-
[
|
1
|
+
[O3 Framework](../API.md) / ExtensionSlotConfigObject
|
2
2
|
|
3
3
|
# Interface: ExtensionSlotConfigObject
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
### Properties
|
8
|
-
|
9
|
-
- [add](ExtensionSlotConfigObject.md#add)
|
10
|
-
- [order](ExtensionSlotConfigObject.md#order)
|
11
|
-
- [remove](ExtensionSlotConfigObject.md#remove)
|
5
|
+
Defined in: [packages/framework/esm-config/src/types.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L59)
|
12
6
|
|
13
7
|
## Properties
|
14
8
|
|
15
|
-
### add
|
9
|
+
### add?
|
16
10
|
|
17
|
-
|
11
|
+
> `optional` **add**: `string`[]
|
18
12
|
|
19
|
-
|
13
|
+
Defined in: [packages/framework/esm-config/src/types.ts:61](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L61)
|
20
14
|
|
21
|
-
|
15
|
+
Additional extension IDs to assign to this slot, in addition to those `attach`ed in code.
|
22
16
|
|
23
|
-
|
17
|
+
***
|
24
18
|
|
25
|
-
|
19
|
+
### order?
|
26
20
|
|
27
|
-
|
21
|
+
> `optional` **order**: `string`[]
|
28
22
|
|
29
|
-
|
23
|
+
Defined in: [packages/framework/esm-config/src/types.ts:65](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L65)
|
30
24
|
|
31
25
|
Overrides the default ordering of extensions.
|
32
26
|
|
33
|
-
|
27
|
+
***
|
34
28
|
|
35
|
-
|
29
|
+
### remove?
|
36
30
|
|
37
|
-
|
31
|
+
> `optional` **remove**: `string`[]
|
38
32
|
|
39
|
-
|
40
|
-
|
41
|
-
• `Optional` **remove**: `string`[]
|
33
|
+
Defined in: [packages/framework/esm-config/src/types.ts:63](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L63)
|
42
34
|
|
43
35
|
Extension IDs which were `attach`ed to the slot but which should not be assigned.
|
44
|
-
|
45
|
-
#### Defined in
|
46
|
-
|
47
|
-
[packages/framework/esm-config/src/types.ts:63](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L63)
|