@openmrs/esm-framework 6.3.1-pre.3105 → 6.3.1-pre.3106
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build.log +1 -1
- package/dist/openmrs-esm-framework.js +2 -2
- package/dist/openmrs-esm-framework.js.map +1 -1
- package/docs/.nojekyll +1 -0
- package/docs/API.md +8579 -310
- package/docs/classes/OpenmrsFetchError.md +117 -88
- package/docs/enums/Type.md +107 -0
- package/docs/enums/VisitMode.md +41 -0
- package/docs/enums/VisitStatus.md +30 -0
- package/docs/interfaces/ActionMenuButtonProps.md +57 -33
- package/docs/interfaces/ActionableNotificationDescriptor.md +67 -37
- package/docs/interfaces/AssignedExtension.md +57 -30
- package/docs/interfaces/Attachment.md +47 -23
- package/docs/interfaces/AttachmentResponse.md +41 -20
- package/docs/interfaces/AuditInfo.md +88 -49
- package/docs/interfaces/BreadcrumbRegistration.md +17 -8
- package/docs/interfaces/BreadcrumbSettings.md +33 -18
- package/docs/interfaces/CancelLoading.md +10 -6
- package/docs/interfaces/ClearDynamicRoutesMessage.md +17 -9
- package/docs/interfaces/CloseWorkspaceOptions.md +29 -18
- package/docs/interfaces/ComponentConfig.md +23 -11
- package/docs/interfaces/Concept.md +131 -83
- package/docs/interfaces/ConceptClass.md +67 -46
- package/docs/interfaces/ConceptDatatype.md +74 -50
- package/docs/interfaces/ConceptName.md +74 -50
- package/docs/interfaces/Config.md +2 -4
- package/docs/interfaces/ConfigObject.md +21 -12
- package/docs/interfaces/ConfigSchema.md +27 -15
- package/docs/interfaces/ConfigurableLinkProps.md +4314 -24
- package/docs/interfaces/ConnectedExtension.md +41 -25
- package/docs/interfaces/ConnectivityChangedEvent.md +10 -4
- package/docs/interfaces/CurrentPatientOptions.md +18 -9
- package/docs/interfaces/DashboardExtensionProps.md +28 -13
- package/docs/interfaces/DefaultWorkspaceProps.md +51 -44
- package/docs/interfaces/Diagnosis.md +104 -80
- package/docs/interfaces/DisplayConditionsConfigObject.md +33 -18
- package/docs/interfaces/DynamicOfflineData.md +41 -23
- package/docs/interfaces/DynamicOfflineDataHandler.md +54 -47
- package/docs/interfaces/DynamicOfflineDataSyncState.md +39 -29
- package/docs/interfaces/EmrApiConfigurationResponse.md +350 -243
- package/docs/interfaces/Encounter.md +110 -67
- package/docs/interfaces/EncounterProvider.md +61 -39
- package/docs/interfaces/EncounterRole.md +68 -43
- package/docs/interfaces/EncounterType.md +68 -43
- package/docs/interfaces/ErrorStateProps.md +16 -7
- package/docs/interfaces/ExtensionData.md +22 -10
- package/docs/interfaces/ExtensionMeta.md +2 -4
- package/docs/interfaces/ExtensionRegistration.md +69 -36
- package/docs/interfaces/ExtensionSlotBaseProps.md +35 -35
- package/docs/interfaces/ExtensionSlotConfig.md +32 -17
- package/docs/interfaces/ExtensionSlotConfigObject.md +26 -14
- package/docs/interfaces/ExtensionSlotConfigureValueObject.md +2 -4
- package/docs/interfaces/ExtensionSlotState.md +18 -9
- package/docs/interfaces/ExtensionStore.md +11 -5
- package/docs/interfaces/FHIRCode.md +23 -11
- package/docs/interfaces/FHIRLocationResource.md +18 -25
- package/docs/interfaces/FHIRResource.md +41 -105
- package/docs/interfaces/FeatureFlagDefinition.md +26 -14
- package/docs/interfaces/FetchConfig.md +117 -80
- package/docs/interfaces/FetchError.md +21 -8
- package/docs/interfaces/FetchHeaders.md +2 -4
- package/docs/interfaces/FetchResponse.md +130 -124
- package/docs/interfaces/FetchResponseJson.md +2 -4
- package/docs/interfaces/ImportMap.md +10 -4
- package/docs/interfaces/LeftNavStore.md +29 -14
- package/docs/interfaces/Link.md +23 -11
- package/docs/interfaces/Location.md +250 -147
- package/docs/interfaces/LoggedInUser.md +70 -68
- package/docs/interfaces/LoggedInUserFetchResponse.md +128 -120
- package/docs/interfaces/MessageServiceWorkerResult.md +29 -17
- package/docs/interfaces/NavigateOptions.md +18 -9
- package/docs/interfaces/NewVisitPayload.md +48 -32
- package/docs/interfaces/NotificationDescriptor.md +58 -31
- package/docs/interfaces/Obs.md +166 -99
- package/docs/interfaces/OfflineModeResult.md +23 -11
- package/docs/interfaces/OfflinePatientArgs.md +20 -13
- package/docs/interfaces/OfflinePatientDataSyncHandler.md +27 -17
- package/docs/interfaces/OfflinePatientDataSyncState.md +51 -29
- package/docs/interfaces/OfflinePatientDataSyncStore.md +20 -13
- package/docs/interfaces/OldExtensionSlotBaseProps.md +67 -0
- package/docs/interfaces/OmrsServiceWorkerMessage.md +23 -13
- package/docs/interfaces/OnImportMapChangedMessage.md +23 -12
- package/docs/interfaces/OnlyThePatient.md +17 -9
- package/docs/interfaces/OpenWorkspace.md +170 -116
- package/docs/interfaces/OpenmrsAppContextProps.md +23 -14
- package/docs/interfaces/OpenmrsAppRoutes.md +71 -41
- package/docs/interfaces/OpenmrsDatePickerProps.md +483 -346
- package/docs/interfaces/OpenmrsResource.md +57 -39
- package/docs/interfaces/OpenmrsResourceStrict.md +51 -27
- package/docs/interfaces/PageHeaderContentProps.md +24 -12
- package/docs/interfaces/PageHeaderWrapperProps.md +18 -9
- package/docs/interfaces/Patient.md +70 -41
- package/docs/interfaces/PatientBannerActionsMenuProps.md +30 -15
- package/docs/interfaces/PatientBannerToggleContactDetailsButtonProps.md +32 -17
- package/docs/interfaces/PatientIdentifier.md +84 -49
- package/docs/interfaces/PatientIdentifierType.md +112 -65
- package/docs/interfaces/PatientPhotoProps.md +17 -8
- package/docs/interfaces/PatientWithFullResponse.md +17 -9
- package/docs/interfaces/Person.md +160 -96
- package/docs/interfaces/PersonAddress.md +230 -136
- package/docs/interfaces/PersonAttribute.md +68 -43
- package/docs/interfaces/PersonName.md +118 -72
- package/docs/interfaces/PrecacheStaticDependenciesEvent.md +1 -3
- package/docs/interfaces/PrimaryIdentifier.md +11 -5
- package/docs/interfaces/Privilege.md +23 -11
- package/docs/interfaces/Prompt.md +41 -20
- package/docs/interfaces/QueueItemDescriptor.md +30 -23
- package/docs/interfaces/RegisterDynamicRouteMessage.md +38 -21
- package/docs/interfaces/ResourceLoader.md +14 -10
- package/docs/interfaces/ResponsiveWrapperProps.md +11 -5
- package/docs/interfaces/RetryOptions.md +37 -36
- package/docs/interfaces/Role.md +22 -10
- package/docs/interfaces/Session.md +54 -31
- package/docs/interfaces/SessionLocation.md +22 -10
- package/docs/interfaces/SetLeftNavParams.md +30 -15
- package/docs/interfaces/ShowActionableNotificationEvent.md +50 -26
- package/docs/interfaces/ShowNotificationEvent.md +38 -20
- package/docs/interfaces/ShowSnackbarEvent.md +64 -34
- package/docs/interfaces/ShowToastEvent.md +43 -22
- package/docs/interfaces/SnackbarDescriptor.md +76 -41
- package/docs/interfaces/SnackbarMeta.md +93 -55
- package/docs/interfaces/SpaConfig.md +40 -30
- package/docs/interfaces/StyleguideConfigObject.md +70 -39
- package/docs/interfaces/SyncItem.md +57 -34
- package/docs/interfaces/SyncProcessOptions.md +40 -22
- package/docs/interfaces/ToastDescriptor.md +55 -29
- package/docs/interfaces/ToastNotificationMeta.md +69 -40
- package/docs/interfaces/UploadedFile.md +49 -25
- package/docs/interfaces/UseConfigOptions.md +12 -6
- package/docs/interfaces/UsePatientPhotoResult.md +24 -12
- package/docs/interfaces/UseServerFetchAllOptions.md +61 -41
- package/docs/interfaces/UseServerInfiniteOptions.md +46 -29
- package/docs/interfaces/UseServerPaginationOptions.md +41 -26
- package/docs/interfaces/User.md +46 -34
- package/docs/interfaces/UserHasAccessProps.md +25 -13
- package/docs/interfaces/Visit.md +66 -36
- package/docs/interfaces/VisitItem.md +31 -16
- package/docs/interfaces/VisitReturnType.md +51 -24
- package/docs/interfaces/VisitStoreState.md +26 -14
- package/docs/interfaces/VisitType.md +23 -11
- package/docs/interfaces/WorkspaceContainerProps.md +38 -20
- package/docs/interfaces/WorkspaceGroupDefinition.md +19 -10
- package/docs/interfaces/WorkspaceRegistration.md +82 -43
- package/docs/interfaces/WorkspacesInfo.md +40 -26
- package/package.json +20 -24
- package/rspack.config.cjs +8 -1
- package/tsconfig.build.json +1 -2
- package/typedoc.json +4 -16
- package/docs/enumerations/Type.md +0 -77
- package/docs/enumerations/VisitMode.md +0 -29
- package/docs/enumerations/VisitStatus.md +0 -21
- package/docs/functions/ConfigurableLink.md +0 -19
- package/docs/functions/CustomOverflowMenu.md +0 -17
- package/docs/functions/DashboardExtension.md +0 -17
- package/docs/functions/ExtensionSlot.md +0 -46
- package/docs/functions/OpenmrsAppContext.md +0 -36
- package/docs/functions/PatientBannerActionsMenu.md +0 -17
- package/docs/functions/PatientBannerContactDetails.md +0 -17
- package/docs/functions/PatientBannerPatientIdentifiers.md +0 -17
- package/docs/functions/PatientBannerPatientInfo.md +0 -17
- package/docs/functions/PatientBannerToggleContactDetailsButton.md +0 -17
- package/docs/functions/PatientPhoto.md +0 -19
- package/docs/functions/WorkspaceContainer.md +0 -55
- package/docs/functions/age.md +0 -32
- package/docs/functions/attach.md +0 -40
- package/docs/functions/beginEditSynchronizationItem.md +0 -22
- package/docs/functions/canAccessStorage.md +0 -25
- package/docs/functions/canBeginEditSynchronizationItemsOfType.md +0 -22
- package/docs/functions/clearCurrentUser.md +0 -11
- package/docs/functions/closeWorkspace.md +0 -27
- package/docs/functions/compile.md +0 -30
- package/docs/functions/convertToLocaleCalendar.md +0 -25
- package/docs/functions/createAttachment.md +0 -21
- package/docs/functions/createErrorHandler.md +0 -21
- package/docs/functions/createGlobalStore.md +0 -36
- package/docs/functions/createUseStore.md +0 -66
- package/docs/functions/defineConfigSchema.md +0 -33
- package/docs/functions/defineExtensionConfigSchema.md +0 -38
- package/docs/functions/deleteAttachmentPermanently.md +0 -21
- package/docs/functions/deleteSynchronizationItem.md +0 -21
- package/docs/functions/detach.md +0 -25
- package/docs/functions/detachAll.md +0 -21
- package/docs/functions/dispatchNotificationShown.md +0 -17
- package/docs/functions/dispatchPrecacheStaticDependencies.md +0 -17
- package/docs/functions/displayName.md +0 -21
- package/docs/functions/evaluate.md +0 -84
- package/docs/functions/evaluateAsBoolean.md +0 -31
- package/docs/functions/evaluateAsBooleanAsync.md +0 -31
- package/docs/functions/evaluateAsNumber.md +0 -31
- package/docs/functions/evaluateAsNumberAsync.md +0 -31
- package/docs/functions/evaluateAsType.md +0 -46
- package/docs/functions/evaluateAsTypeAsync.md +0 -46
- package/docs/functions/evaluateAsync.md +0 -87
- package/docs/functions/extractVariableNames.md +0 -50
- package/docs/functions/fetchCurrentPatient.md +0 -25
- package/docs/functions/filterBreadcrumbs.md +0 -21
- package/docs/functions/formatDate.md +0 -39
- package/docs/functions/formatDatetime.md +0 -29
- package/docs/functions/formatPartialDate.md +0 -39
- package/docs/functions/formatPatientName.md +0 -23
- package/docs/functions/formatTime.md +0 -20
- package/docs/functions/formattedName.md +0 -21
- package/docs/functions/generateOfflineUuid.md +0 -13
- package/docs/functions/getAssignedExtensions.md +0 -23
- package/docs/functions/getAsyncLifecycle.md +0 -31
- package/docs/functions/getAttachmentByUuid.md +0 -21
- package/docs/functions/getAttachments.md +0 -25
- package/docs/functions/getBreadcrumbs.md +0 -11
- package/docs/functions/getBreadcrumbsFor.md +0 -17
- package/docs/functions/getConfig.md +0 -31
- package/docs/functions/getContext.md +0 -29
- package/docs/functions/getCoreTranslation.md +0 -35
- package/docs/functions/getCurrentOfflineMode.md +0 -11
- package/docs/functions/getCurrentUser.md +0 -154
- package/docs/functions/getDefaultCalendar.md +0 -21
- package/docs/functions/getDefaultsFromConfigSchema.md +0 -32
- package/docs/functions/getDynamicOfflineDataEntries.md +0 -28
- package/docs/functions/getDynamicOfflineDataEntriesFor.md +0 -34
- package/docs/functions/getDynamicOfflineDataHandlers.md +0 -13
- package/docs/functions/getExtensionNameFromId.md +0 -30
- package/docs/functions/getExtensionStore.md +0 -14
- package/docs/functions/getFeatureFlag.md +0 -21
- package/docs/functions/getFhirServerPaginationHandlers.md +0 -17
- package/docs/functions/getFullSynchronizationItems.md +0 -27
- package/docs/functions/getFullSynchronizationItemsFor.md +0 -33
- package/docs/functions/getGlobalStore.md +0 -36
- package/docs/functions/getHistory.md +0 -13
- package/docs/functions/getLifecycle.md +0 -27
- package/docs/functions/getLocale.md +0 -15
- package/docs/functions/getLocations.md +0 -21
- package/docs/functions/getLoggedInUser.md +0 -11
- package/docs/functions/getOfflinePatientDataStore.md +0 -15
- package/docs/functions/getPatientName.md +0 -26
- package/docs/functions/getSessionLocation.md +0 -11
- package/docs/functions/getSessionStore.md +0 -11
- package/docs/functions/getSyncLifecycle.md +0 -31
- package/docs/functions/getSynchronizationItem.md +0 -27
- package/docs/functions/getSynchronizationItems.md +0 -27
- package/docs/functions/getVisitStore.md +0 -11
- package/docs/functions/getVisitTypes.md +0 -11
- package/docs/functions/getVisitsForPatient.md +0 -29
- package/docs/functions/goBackInHistory.md +0 -25
- package/docs/functions/importDynamic.md +0 -58
- package/docs/functions/inRange.md +0 -27
- package/docs/functions/interpolateString.md +0 -34
- package/docs/functions/interpolateUrl.md +0 -48
- package/docs/functions/isDesktop.md +0 -17
- package/docs/functions/isDevEnabled.md +0 -11
- package/docs/functions/isOfflineUuid.md +0 -19
- package/docs/functions/isOmrsDateStrict.md +0 -20
- package/docs/functions/isOmrsDateToday.md +0 -19
- package/docs/functions/isOnline.md +0 -17
- package/docs/functions/isUrlWithTemplateParameters.md +0 -22
- package/docs/functions/isVersionSatisfied.md +0 -21
- package/docs/functions/launchWorkspace.md +0 -56
- package/docs/functions/launchWorkspaceGroup.md +0 -38
- package/docs/functions/makeUrl.md +0 -26
- package/docs/functions/messageOmrsServiceWorker.md +0 -23
- package/docs/functions/navigate.md +0 -48
- package/docs/functions/navigateAndLaunchWorkspace.md +0 -33
- package/docs/functions/oneOf.md +0 -21
- package/docs/functions/openmrsFetch.md +0 -75
- package/docs/functions/openmrsObservableFetch.md +0 -55
- package/docs/functions/parseDate.md +0 -20
- package/docs/functions/provide.md +0 -21
- package/docs/functions/putDynamicOfflineData.md +0 -28
- package/docs/functions/putDynamicOfflineDataFor.md +0 -34
- package/docs/functions/queueSynchronizationItem.md +0 -39
- package/docs/functions/refetchCurrentUser.md +0 -33
- package/docs/functions/registerBreadcrumb.md +0 -17
- package/docs/functions/registerBreadcrumbs.md +0 -17
- package/docs/functions/registerContext.md +0 -34
- package/docs/functions/registerDefaultCalendar.md +0 -33
- package/docs/functions/registerFeatureFlag.md +0 -36
- package/docs/functions/registerOfflinePatientHandler.md +0 -25
- package/docs/functions/removeDynamicOfflineData.md +0 -28
- package/docs/functions/removeDynamicOfflineDataFor.md +0 -34
- package/docs/functions/renderExtension.md +0 -41
- package/docs/functions/reportError.md +0 -17
- package/docs/functions/retry.md +0 -44
- package/docs/functions/saveVisit.md +0 -21
- package/docs/functions/selectPreferredName.md +0 -46
- package/docs/functions/setCurrentVisit.md +0 -21
- package/docs/functions/setLeftNav.md +0 -23
- package/docs/functions/setSessionLocation.md +0 -21
- package/docs/functions/setUserLanguage.md +0 -17
- package/docs/functions/setUserProperties.md +0 -23
- package/docs/functions/setupDynamicOfflineDataHandler.md +0 -22
- package/docs/functions/setupOfflineSync.md +0 -49
- package/docs/functions/shallowEqual.md +0 -32
- package/docs/functions/showActionableNotification.md +0 -21
- package/docs/functions/showModal.md +0 -44
- package/docs/functions/showNotification.md +0 -21
- package/docs/functions/showSnackbar.md +0 -21
- package/docs/functions/showToast.md +0 -21
- package/docs/functions/subscribeActionableNotificationShown.md +0 -21
- package/docs/functions/subscribeConnectivity.md +0 -21
- package/docs/functions/subscribeConnectivityChanged.md +0 -21
- package/docs/functions/subscribeNotificationShown.md +0 -21
- package/docs/functions/subscribePrecacheStaticDependencies.md +0 -21
- package/docs/functions/subscribeSnackbarShown.md +0 -21
- package/docs/functions/subscribeTo.md +0 -75
- package/docs/functions/subscribeToContext.md +0 -39
- package/docs/functions/subscribeToastShown.md +0 -21
- package/docs/functions/syncAllDynamicOfflineData.md +0 -27
- package/docs/functions/syncDynamicOfflineData.md +0 -33
- package/docs/functions/syncOfflinePatientData.md +0 -21
- package/docs/functions/toDateObjectStrict.md +0 -20
- package/docs/functions/toLocationObject.md +0 -17
- package/docs/functions/toOmrsIsoString.md +0 -23
- package/docs/functions/toVisitTypeObject.md +0 -17
- package/docs/functions/translateFrom.md +0 -55
- package/docs/functions/unregisterContext.md +0 -20
- package/docs/functions/unsetLeftNav.md +0 -23
- package/docs/functions/updateContext.md +0 -29
- package/docs/functions/updateVisit.md +0 -25
- package/docs/functions/useAbortController.md +0 -32
- package/docs/functions/useAppContext.md +0 -43
- package/docs/functions/useAssignedExtensionIds.md +0 -26
- package/docs/functions/useAssignedExtensions.md +0 -21
- package/docs/functions/useAttachments.md +0 -41
- package/docs/functions/useBodyScrollLock.md +0 -17
- package/docs/functions/useConfig.md +0 -27
- package/docs/functions/useConnectivity.md +0 -11
- package/docs/functions/useDebounce.md +0 -57
- package/docs/functions/useDefineAppContext.md +0 -70
- package/docs/functions/useEmrConfiguration.md +0 -35
- package/docs/functions/useExtensionSlotMeta.md +0 -25
- package/docs/functions/useExtensionSlotStore.md +0 -17
- package/docs/functions/useFeatureFlag.md +0 -30
- package/docs/functions/useFhirFetchAll.md +0 -44
- package/docs/functions/useFhirInfinite.md +0 -46
- package/docs/functions/useFhirPagination.md +0 -129
- package/docs/functions/useLayoutType.md +0 -11
- package/docs/functions/useLeftNav.md +0 -17
- package/docs/functions/useLeftNavStore.md +0 -11
- package/docs/functions/useLocations.md +0 -21
- package/docs/functions/useOnClickOutside.md +0 -27
- package/docs/functions/useOnVisible.md +0 -28
- package/docs/functions/useOpenmrsFetchAll.md +0 -46
- package/docs/functions/useOpenmrsInfinite.md +0 -54
- package/docs/functions/useOpenmrsPagination.md +0 -140
- package/docs/functions/useOpenmrsSWR.md +0 -71
- package/docs/functions/usePagination.md +0 -89
- package/docs/functions/usePatient.md +0 -38
- package/docs/functions/usePatientPhoto.md +0 -17
- package/docs/functions/usePrimaryIdentifierCode.md +0 -23
- package/docs/functions/useRenderableExtensions.md +0 -43
- package/docs/functions/useSession.md +0 -19
- package/docs/functions/useStore.md +0 -131
- package/docs/functions/useStoreWithActions.md +0 -33
- package/docs/functions/useVisit.md +0 -41
- package/docs/functions/useVisitContextStore.md +0 -23
- package/docs/functions/useVisitTypes.md +0 -11
- package/docs/functions/useWorkspaces.md +0 -11
- package/docs/functions/userHasAccess.md +0 -27
- package/docs/functions/validator.md +0 -44
- package/docs/interfaces/ExtensionSlotProps.md +0 -3520
- package/docs/type-aliases/ActionFunction.md +0 -27
- package/docs/type-aliases/ActionableNotificationType.md +0 -7
- package/docs/type-aliases/Actions.md +0 -13
- package/docs/type-aliases/ArgumentsTuple.md +0 -7
- package/docs/type-aliases/BoundActions.md +0 -17
- package/docs/type-aliases/ConfigValue.md +0 -7
- package/docs/type-aliases/ContextCallback.md +0 -23
- package/docs/type-aliases/CoreTranslationKey.md +0 -7
- package/docs/type-aliases/CurrentPatient.md +0 -7
- package/docs/type-aliases/DateInput.md +0 -7
- package/docs/type-aliases/DefaultEvaluateReturnType.md +0 -9
- package/docs/type-aliases/ExtensionDefinition.md +0 -69
- package/docs/type-aliases/ExtensionProps.md +0 -13
- package/docs/type-aliases/FormatDateMode.md +0 -7
- package/docs/type-aliases/FormatDateOptions.md +0 -102
- package/docs/type-aliases/IconProps.md +0 -31
- package/docs/type-aliases/InlineNotificationType.md +0 -7
- package/docs/type-aliases/Key.md +0 -7
- package/docs/type-aliases/KnownOmrsServiceWorkerMessages.md +0 -7
- package/docs/type-aliases/LayoutType.md +0 -7
- package/docs/type-aliases/LoadedSessionStore.md +0 -23
- package/docs/type-aliases/ModalDefinition.md +0 -17
- package/docs/type-aliases/NameUse.md +0 -7
- package/docs/type-aliases/NullablePatient.md +0 -7
- package/docs/type-aliases/OfflineMode.md +0 -7
- package/docs/type-aliases/OmrsOfflineCachingStrategy.md +0 -12
- package/docs/type-aliases/OmrsOfflineHttpHeaderNames.md +0 -7
- package/docs/type-aliases/OmrsOfflineHttpHeaders.md +0 -44
- package/docs/type-aliases/OpenmrsRoutes.md +0 -10
- package/docs/type-aliases/PageDefinition.md +0 -41
- package/docs/type-aliases/PageHeaderProps.md +0 -7
- package/docs/type-aliases/PatientUuid.md +0 -7
- package/docs/type-aliases/PictogramProps.md +0 -23
- package/docs/type-aliases/ProvidedConfig.md +0 -23
- package/docs/type-aliases/ResourceName.md +0 -7
- package/docs/type-aliases/SessionStore.md +0 -7
- package/docs/type-aliases/SnackbarType.md +0 -7
- package/docs/type-aliases/SpaEnvironment.md +0 -7
- package/docs/type-aliases/SvgIconProps.md +0 -23
- package/docs/type-aliases/SvgPictogramProps.md +0 -27
- package/docs/type-aliases/TemplateParams.md +0 -11
- package/docs/type-aliases/ToastType.md +0 -7
- package/docs/type-aliases/UnloadedSessionStore.md +0 -23
- package/docs/type-aliases/UpdateVisitPayload.md +0 -7
- package/docs/type-aliases/UseOpenmrsSWROptions.md +0 -39
- package/docs/type-aliases/Validator.md +0 -17
- package/docs/type-aliases/ValidatorFunction.md +0 -17
- package/docs/type-aliases/VariablesMap.md +0 -13
- package/docs/type-aliases/WorkspaceDefinition.md +0 -78
- package/docs/type-aliases/WorkspaceWindowState.md +0 -7
- package/docs/variables/ActionMenuButton.md +0 -7
- package/docs/variables/ActivityIcon.md +0 -7
- package/docs/variables/AddIcon.md +0 -7
- package/docs/variables/AllergiesIcon.md +0 -7
- package/docs/variables/AppointmentsPictogram.md +0 -7
- package/docs/variables/ArrowDownIcon.md +0 -7
- package/docs/variables/ArrowLeftIcon.md +0 -7
- package/docs/variables/ArrowRightIcon.md +0 -7
- package/docs/variables/ArrowUpIcon.md +0 -7
- package/docs/variables/AttachmentIcon.md +0 -7
- package/docs/variables/BabyIcon.md +0 -7
- package/docs/variables/CalendarHeatMapIcon.md +0 -7
- package/docs/variables/CalendarIcon.md +0 -7
- package/docs/variables/CaretDownIcon.md +0 -7
- package/docs/variables/CaretLeftIcon.md +0 -7
- package/docs/variables/CaretRightIcon.md +0 -7
- package/docs/variables/CaretUpIcon.md +0 -7
- package/docs/variables/ChartAverageIcon.md +0 -7
- package/docs/variables/CheckmarkFilledIcon.md +0 -7
- package/docs/variables/CheckmarkOutlineIcon.md +0 -7
- package/docs/variables/ChemistryIcon.md +0 -7
- package/docs/variables/ChevronDownIcon.md +0 -7
- package/docs/variables/ChevronLeftIcon.md +0 -7
- package/docs/variables/ChevronRightIcon.md +0 -7
- package/docs/variables/ChevronUpIcon.md +0 -7
- package/docs/variables/CloseFilledIcon.md +0 -7
- package/docs/variables/CloseIcon.md +0 -7
- package/docs/variables/CloseOutlineIcon.md +0 -7
- package/docs/variables/ConditionsIcon.md +0 -11
- package/docs/variables/DiagnosisTags.md +0 -11
- package/docs/variables/DocumentAttachmentIcon.md +0 -7
- package/docs/variables/DocumentIcon.md +0 -7
- package/docs/variables/DownloadIcon.md +0 -7
- package/docs/variables/DrugOrderIcon.md +0 -7
- package/docs/variables/EditIcon.md +0 -7
- package/docs/variables/ErrorState.md +0 -7
- package/docs/variables/EventScheduleIcon.md +0 -7
- package/docs/variables/EventsIcon.md +0 -7
- package/docs/variables/Extension.md +0 -15
- package/docs/variables/GenderFemaleIcon.md +0 -7
- package/docs/variables/GenderMaleIcon.md +0 -7
- package/docs/variables/GenderOtherIcon.md +0 -7
- package/docs/variables/GenderUnknownIcon.md +0 -7
- package/docs/variables/GenericOrderTypeIcon.md +0 -7
- package/docs/variables/GroupAccessIcon.md +0 -7
- package/docs/variables/GroupIcon.md +0 -7
- package/docs/variables/HomePictogram.md +0 -7
- package/docs/variables/HospitalBedIcon.md +0 -7
- package/docs/variables/Icon.md +0 -9
- package/docs/variables/ImageMedicalIcon.md +0 -7
- package/docs/variables/InPatientPictogram.md +0 -7
- package/docs/variables/InformationFilledIcon.md +0 -7
- package/docs/variables/InformationIcon.md +0 -7
- package/docs/variables/InformationSquareIcon.md +0 -7
- package/docs/variables/InventoryManagementIcon.md +0 -7
- package/docs/variables/LabOrderIcon.md +0 -7
- package/docs/variables/LaboratoryPictogram.md +0 -7
- package/docs/variables/LeftNavMenu.md +0 -13
- package/docs/variables/ListCheckedIcon.md +0 -7
- package/docs/variables/LocationIcon.md +0 -7
- package/docs/variables/LocationPicker.md +0 -7
- package/docs/variables/MaterialOrderIcon.md +0 -7
- package/docs/variables/MaximizeIcon.md +0 -7
- package/docs/variables/MaybeIcon.md +0 -16
- package/docs/variables/MaybePictogram.md +0 -16
- package/docs/variables/MedicationIcon.md +0 -7
- package/docs/variables/MessageQueueIcon.md +0 -7
- package/docs/variables/MicroscopeIcon.md +0 -7
- package/docs/variables/MoneyIcon.md +0 -9
- package/docs/variables/MotherIcon.md +0 -7
- package/docs/variables/MovementIcon.md +0 -7
- package/docs/variables/OpenmrsDatePicker.md +0 -9
- package/docs/variables/OverflowMenuHorizontalIcon.md +0 -7
- package/docs/variables/OverflowMenuVerticalIcon.md +0 -7
- package/docs/variables/PageHeader.md +0 -30
- package/docs/variables/PageHeaderContent.md +0 -21
- package/docs/variables/PasswordIcon.md +0 -7
- package/docs/variables/PatientListsPictogram.md +0 -7
- package/docs/variables/PedestrianFamilyIcon.md +0 -7
- package/docs/variables/PenIcon.md +0 -7
- package/docs/variables/PharmacyPictogram.md +0 -7
- package/docs/variables/Pictogram.md +0 -9
- package/docs/variables/PrinterIcon.md +0 -7
- package/docs/variables/ProcedureOrderIcon.md +0 -7
- package/docs/variables/ProgramsIcon.md +0 -7
- package/docs/variables/RadiologyIcon.md +0 -7
- package/docs/variables/ReferralOrderIcon.md +0 -7
- package/docs/variables/RegistrationPictogram.md +0 -7
- package/docs/variables/RenderIfValueIsTruthy.md +0 -21
- package/docs/variables/RenewIcon.md +0 -7
- package/docs/variables/ReportIcon.md +0 -7
- package/docs/variables/ResetIcon.md +0 -7
- package/docs/variables/ResponsiveWrapper.md +0 -11
- package/docs/variables/SaveIcon.md +0 -7
- package/docs/variables/SearchIcon.md +0 -7
- package/docs/variables/ServiceQueuesPictogram.md +0 -7
- package/docs/variables/ShoppingCartAddItemIcon.md +0 -11
- package/docs/variables/ShoppingCartArrowDownIcon.md +0 -9
- package/docs/variables/ShoppingCartIcon.md +0 -9
- package/docs/variables/StickyNoteAddIcon.md +0 -9
- package/docs/variables/StockManagementPictogram.md +0 -7
- package/docs/variables/SwitcherIcon.md +0 -7
- package/docs/variables/SyringeIcon.md +0 -7
- package/docs/variables/TableIcon.md +0 -7
- package/docs/variables/TableOfContentsIcon.md +0 -9
- package/docs/variables/TimeIcon.md +0 -9
- package/docs/variables/ToolsIcon.md +0 -7
- package/docs/variables/TranslateIcon.md +0 -7
- package/docs/variables/TrashCanIcon.md +0 -7
- package/docs/variables/TreeViewAltIcon.md +0 -7
- package/docs/variables/UserAvatarIcon.md +0 -9
- package/docs/variables/UserFollowIcon.md +0 -7
- package/docs/variables/UserHasAccess.md +0 -35
- package/docs/variables/UserIcon.md +0 -7
- package/docs/variables/UserXrayIcon.md +0 -11
- package/docs/variables/ViewIcon.md +0 -7
- package/docs/variables/ViewOffIcon.md +0 -7
- package/docs/variables/WarningIcon.md +0 -7
- package/docs/variables/attachmentUrl.md +0 -7
- package/docs/variables/backendDependencies.md +0 -17
- package/docs/variables/defaultVisitCustomRepresentation.md +0 -7
- package/docs/variables/fhirBaseUrl.md +0 -7
- package/docs/variables/getAsyncExtensionLifecycle.md +0 -35
- package/docs/variables/getStartedVisit.md +0 -9
- package/docs/variables/isUrl.md +0 -9
- package/docs/variables/offlineUuidPrefix.md +0 -7
- package/docs/variables/omrsOfflineCachingStrategyHttpHeaderName.md +0 -7
- package/docs/variables/omrsOfflineResponseBodyHttpHeaderName.md +0 -7
- package/docs/variables/omrsOfflineResponseStatusHttpHeaderName.md +0 -7
- package/docs/variables/restBaseUrl.md +0 -7
- package/docs/variables/sessionEndpoint.md +0 -7
- package/docs/variables/useConnectedExtensions.md +0 -25
- package/docs/variables/useExtensionStore.md +0 -55
- package/docs/variables/validators.md +0 -78
@@ -1,129 +1,167 @@
|
|
1
|
-
[
|
1
|
+
[@openmrs/esm-framework](../API.md) / SnackbarMeta
|
2
2
|
|
3
3
|
# Interface: SnackbarMeta
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
## Extends
|
5
|
+
## Hierarchy
|
8
6
|
|
9
7
|
- [`SnackbarDescriptor`](SnackbarDescriptor.md)
|
10
8
|
|
11
|
-
|
9
|
+
↳ **`SnackbarMeta`**
|
10
|
+
|
11
|
+
## Table of contents
|
12
|
+
|
13
|
+
### UI Properties
|
14
|
+
|
15
|
+
- [actionButtonLabel](SnackbarMeta.md#actionbuttonlabel)
|
16
|
+
- [autoClose](SnackbarMeta.md#autoclose)
|
17
|
+
- [id](SnackbarMeta.md#id)
|
18
|
+
- [isLowContrast](SnackbarMeta.md#islowcontrast)
|
19
|
+
- [kind](SnackbarMeta.md#kind)
|
20
|
+
- [progressActionLabel](SnackbarMeta.md#progressactionlabel)
|
21
|
+
- [subtitle](SnackbarMeta.md#subtitle)
|
22
|
+
- [timeoutInMs](SnackbarMeta.md#timeoutinms)
|
23
|
+
- [title](SnackbarMeta.md#title)
|
12
24
|
|
13
|
-
###
|
25
|
+
### UI Methods
|
14
26
|
|
15
|
-
|
27
|
+
- [onActionButtonClick](SnackbarMeta.md#onactionbuttonclick)
|
16
28
|
|
17
|
-
|
29
|
+
## UI Properties
|
30
|
+
|
31
|
+
### actionButtonLabel
|
32
|
+
|
33
|
+
• `Optional` **actionButtonLabel**: `string`
|
18
34
|
|
19
35
|
#### Inherited from
|
20
36
|
|
21
|
-
[
|
37
|
+
[SnackbarDescriptor](SnackbarDescriptor.md).[actionButtonLabel](SnackbarDescriptor.md#actionbuttonlabel)
|
38
|
+
|
39
|
+
#### Defined in
|
22
40
|
|
23
|
-
|
41
|
+
[packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L14)
|
24
42
|
|
25
|
-
|
43
|
+
___
|
26
44
|
|
27
|
-
|
45
|
+
### autoClose
|
28
46
|
|
29
|
-
|
47
|
+
• `Optional` **autoClose**: `boolean`
|
30
48
|
|
31
49
|
#### Inherited from
|
32
50
|
|
33
|
-
[
|
51
|
+
[SnackbarDescriptor](SnackbarDescriptor.md).[autoClose](SnackbarDescriptor.md#autoclose)
|
34
52
|
|
35
|
-
|
53
|
+
#### Defined in
|
54
|
+
|
55
|
+
[packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L21)
|
56
|
+
|
57
|
+
___
|
36
58
|
|
37
59
|
### id
|
38
60
|
|
39
|
-
|
61
|
+
• **id**: `number`
|
40
62
|
|
41
|
-
Defined in
|
63
|
+
#### Defined in
|
42
64
|
|
43
|
-
|
65
|
+
[packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L26)
|
44
66
|
|
45
|
-
|
67
|
+
___
|
46
68
|
|
47
|
-
|
69
|
+
### isLowContrast
|
48
70
|
|
49
|
-
|
71
|
+
• `Optional` **isLowContrast**: `boolean`
|
50
72
|
|
51
73
|
#### Inherited from
|
52
74
|
|
53
|
-
[
|
75
|
+
[SnackbarDescriptor](SnackbarDescriptor.md).[isLowContrast](SnackbarDescriptor.md#islowcontrast)
|
54
76
|
|
55
|
-
|
77
|
+
#### Defined in
|
56
78
|
|
57
|
-
|
79
|
+
[packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L15)
|
58
80
|
|
59
|
-
|
81
|
+
___
|
60
82
|
|
61
|
-
|
83
|
+
### kind
|
62
84
|
|
63
|
-
|
85
|
+
• `Optional` **kind**: `string`
|
64
86
|
|
65
|
-
|
87
|
+
#### Inherited from
|
66
88
|
|
67
|
-
|
89
|
+
[SnackbarDescriptor](SnackbarDescriptor.md).[kind](SnackbarDescriptor.md#kind)
|
68
90
|
|
69
|
-
|
91
|
+
#### Defined in
|
70
92
|
|
71
|
-
|
93
|
+
[packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L16)
|
72
94
|
|
73
|
-
|
95
|
+
___
|
74
96
|
|
75
|
-
|
97
|
+
### progressActionLabel
|
76
98
|
|
77
|
-
`
|
99
|
+
• `Optional` **progressActionLabel**: `string`
|
78
100
|
|
79
101
|
#### Inherited from
|
80
102
|
|
81
|
-
[
|
103
|
+
[SnackbarDescriptor](SnackbarDescriptor.md).[progressActionLabel](SnackbarDescriptor.md#progressactionlabel)
|
82
104
|
|
83
|
-
|
105
|
+
#### Defined in
|
84
106
|
|
85
|
-
|
107
|
+
[packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L18)
|
86
108
|
|
87
|
-
|
109
|
+
___
|
88
110
|
|
89
|
-
|
111
|
+
### subtitle
|
112
|
+
|
113
|
+
• `Optional` **subtitle**: `ReactNode`
|
90
114
|
|
91
115
|
#### Inherited from
|
92
116
|
|
93
|
-
[
|
117
|
+
[SnackbarDescriptor](SnackbarDescriptor.md).[subtitle](SnackbarDescriptor.md#subtitle)
|
118
|
+
|
119
|
+
#### Defined in
|
94
120
|
|
95
|
-
|
121
|
+
[packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L19)
|
96
122
|
|
97
|
-
|
123
|
+
___
|
98
124
|
|
99
|
-
|
125
|
+
### timeoutInMs
|
100
126
|
|
101
|
-
|
127
|
+
• `Optional` **timeoutInMs**: `number`
|
102
128
|
|
103
129
|
#### Inherited from
|
104
130
|
|
105
|
-
[
|
131
|
+
[SnackbarDescriptor](SnackbarDescriptor.md).[timeoutInMs](SnackbarDescriptor.md#timeoutinms)
|
132
|
+
|
133
|
+
#### Defined in
|
106
134
|
|
107
|
-
|
135
|
+
[packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L20)
|
108
136
|
|
109
|
-
|
137
|
+
___
|
110
138
|
|
111
|
-
|
139
|
+
### title
|
112
140
|
|
113
|
-
|
141
|
+
• **title**: `string`
|
114
142
|
|
115
143
|
#### Inherited from
|
116
144
|
|
117
|
-
[
|
145
|
+
[SnackbarDescriptor](SnackbarDescriptor.md).[title](SnackbarDescriptor.md#title)
|
118
146
|
|
119
|
-
|
147
|
+
#### Defined in
|
120
148
|
|
121
|
-
|
149
|
+
[packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L22)
|
150
|
+
|
151
|
+
## UI Methods
|
122
152
|
|
123
|
-
|
153
|
+
### onActionButtonClick
|
124
154
|
|
125
|
-
|
155
|
+
▸ `Optional` **onActionButtonClick**(): `void`
|
156
|
+
|
157
|
+
#### Returns
|
158
|
+
|
159
|
+
`void`
|
126
160
|
|
127
161
|
#### Inherited from
|
128
162
|
|
129
|
-
[
|
163
|
+
[SnackbarDescriptor](SnackbarDescriptor.md).[onActionButtonClick](SnackbarDescriptor.md#onactionbuttonclick)
|
164
|
+
|
165
|
+
#### Defined in
|
166
|
+
|
167
|
+
[packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L17)
|
@@ -1,69 +1,79 @@
|
|
1
|
-
[
|
1
|
+
[@openmrs/esm-framework](../API.md) / SpaConfig
|
2
2
|
|
3
3
|
# Interface: SpaConfig
|
4
4
|
|
5
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:80
|
6
|
-
|
7
5
|
The configuration passed to the app shell initialization function
|
8
6
|
|
7
|
+
## Table of contents
|
8
|
+
|
9
|
+
### Properties
|
10
|
+
|
11
|
+
- [apiUrl](SpaConfig.md#apiurl)
|
12
|
+
- [configUrls](SpaConfig.md#configurls)
|
13
|
+
- [env](SpaConfig.md#env)
|
14
|
+
- [offline](SpaConfig.md#offline)
|
15
|
+
- [spaPath](SpaConfig.md#spapath)
|
16
|
+
|
9
17
|
## Properties
|
10
18
|
|
11
19
|
### apiUrl
|
12
20
|
|
13
|
-
|
14
|
-
|
15
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:84
|
21
|
+
• **apiUrl**: `string`
|
16
22
|
|
17
23
|
The base path or URL for the OpenMRS API / endpoints.
|
18
24
|
|
19
|
-
|
25
|
+
#### Defined in
|
26
|
+
|
27
|
+
packages/framework/esm-globals/dist/types.d.ts:84
|
20
28
|
|
21
|
-
|
29
|
+
___
|
22
30
|
|
23
|
-
|
31
|
+
### configUrls
|
24
32
|
|
25
|
-
|
33
|
+
• `Optional` **configUrls**: `string`[]
|
26
34
|
|
27
35
|
URLs of configurations to load in the system.
|
28
36
|
|
29
|
-
|
37
|
+
#### Defined in
|
30
38
|
|
31
|
-
|
39
|
+
packages/framework/esm-globals/dist/types.d.ts:97
|
32
40
|
|
33
|
-
|
41
|
+
___
|
34
42
|
|
35
|
-
|
43
|
+
### env
|
44
|
+
|
45
|
+
• `Optional` **env**: [`SpaEnvironment`](../API.md#spaenvironment)
|
36
46
|
|
37
47
|
The environment to use.
|
38
48
|
|
39
|
-
|
49
|
+
**`default`** production
|
40
50
|
|
41
|
-
|
42
|
-
production
|
43
|
-
```
|
51
|
+
#### Defined in
|
44
52
|
|
45
|
-
|
53
|
+
packages/framework/esm-globals/dist/types.d.ts:93
|
46
54
|
|
47
|
-
|
55
|
+
___
|
48
56
|
|
49
|
-
|
57
|
+
### offline
|
50
58
|
|
51
|
-
|
59
|
+
• `Optional` **offline**: `boolean`
|
52
60
|
|
53
61
|
Defines if offline should be supported by installing a service worker.
|
54
62
|
|
55
|
-
|
63
|
+
**`default`** true
|
56
64
|
|
57
|
-
|
58
|
-
true
|
59
|
-
```
|
65
|
+
#### Defined in
|
60
66
|
|
61
|
-
|
67
|
+
packages/framework/esm-globals/dist/types.d.ts:102
|
62
68
|
|
63
|
-
|
69
|
+
___
|
64
70
|
|
65
|
-
|
71
|
+
### spaPath
|
66
72
|
|
67
|
-
|
73
|
+
• **spaPath**: `string`
|
68
74
|
|
69
75
|
The base path for the SPA root path.
|
76
|
+
|
77
|
+
#### Defined in
|
78
|
+
|
79
|
+
packages/framework/esm-globals/dist/types.d.ts:88
|
@@ -1,97 +1,128 @@
|
|
1
|
-
[
|
1
|
+
[@openmrs/esm-framework](../API.md) / StyleguideConfigObject
|
2
2
|
|
3
3
|
# Interface: StyleguideConfigObject
|
4
4
|
|
5
|
-
|
5
|
+
## Table of contents
|
6
|
+
|
7
|
+
### Properties
|
8
|
+
|
9
|
+
- [Brand color #1](StyleguideConfigObject.md#brand color #1)
|
10
|
+
- [Brand color #2](StyleguideConfigObject.md#brand color #2)
|
11
|
+
- [Brand color #3](StyleguideConfigObject.md#brand color #3)
|
12
|
+
- [diagnosisTags](StyleguideConfigObject.md#diagnosistags)
|
13
|
+
- [excludePatientIdentifierCodeTypes](StyleguideConfigObject.md#excludepatientidentifiercodetypes)
|
14
|
+
- [implementationName](StyleguideConfigObject.md#implementationname)
|
15
|
+
- [patientPhotoConceptUuid](StyleguideConfigObject.md#patientphotoconceptuuid)
|
16
|
+
- [preferredCalendar](StyleguideConfigObject.md#preferredcalendar)
|
17
|
+
- [preferredDateLocale](StyleguideConfigObject.md#preferreddatelocale)
|
6
18
|
|
7
19
|
## Properties
|
8
20
|
|
9
21
|
### Brand color #1
|
10
22
|
|
11
|
-
|
23
|
+
• **Brand color #1**: `string`
|
24
|
+
|
25
|
+
#### Defined in
|
12
26
|
|
13
|
-
|
27
|
+
[packages/framework/esm-styleguide/src/config-schema.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L4)
|
14
28
|
|
15
|
-
|
29
|
+
___
|
16
30
|
|
17
31
|
### Brand color #2
|
18
32
|
|
19
|
-
|
33
|
+
• **Brand color #2**: `string`
|
20
34
|
|
21
|
-
Defined in
|
35
|
+
#### Defined in
|
22
36
|
|
23
|
-
|
37
|
+
[packages/framework/esm-styleguide/src/config-schema.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L5)
|
38
|
+
|
39
|
+
___
|
24
40
|
|
25
41
|
### Brand color #3
|
26
42
|
|
27
|
-
|
43
|
+
• **Brand color #3**: `string`
|
28
44
|
|
29
|
-
Defined in
|
45
|
+
#### Defined in
|
30
46
|
|
31
|
-
|
47
|
+
[packages/framework/esm-styleguide/src/config-schema.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L6)
|
32
48
|
|
33
|
-
|
49
|
+
___
|
34
50
|
|
35
|
-
|
51
|
+
### diagnosisTags
|
36
52
|
|
37
|
-
|
53
|
+
• **diagnosisTags**: `Object`
|
38
54
|
|
39
|
-
####
|
55
|
+
#### Type declaration
|
40
56
|
|
41
|
-
|
57
|
+
| Name | Type |
|
58
|
+
| :------ | :------ |
|
59
|
+
| `primaryColor` | ``"blue"`` \| ``"cyan"`` \| ``"gray"`` \| ``"green"`` \| ``"magenta"`` \| ``"purple"`` \| ``"red"`` \| ``"teal"`` \| ``"warm-gray"`` \| ``"cool-gray"`` \| ``"high-contrast"`` \| ``"outline"`` |
|
60
|
+
| `secondaryColor` | ``"blue"`` \| ``"cyan"`` \| ``"gray"`` \| ``"green"`` \| ``"magenta"`` \| ``"purple"`` \| ``"red"`` \| ``"teal"`` \| ``"warm-gray"`` \| ``"cool-gray"`` \| ``"high-contrast"`` \| ``"outline"`` |
|
42
61
|
|
43
|
-
####
|
62
|
+
#### Defined in
|
44
63
|
|
45
|
-
|
64
|
+
[packages/framework/esm-styleguide/src/config-schema.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L18)
|
46
65
|
|
47
|
-
|
66
|
+
___
|
48
67
|
|
49
68
|
### excludePatientIdentifierCodeTypes
|
50
69
|
|
51
|
-
|
70
|
+
• **excludePatientIdentifierCodeTypes**: `Object`
|
52
71
|
|
53
|
-
|
72
|
+
#### Type declaration
|
54
73
|
|
55
|
-
|
74
|
+
| Name | Type |
|
75
|
+
| :------ | :------ |
|
76
|
+
| `uuids` | `string`[] |
|
56
77
|
|
57
|
-
|
78
|
+
#### Defined in
|
58
79
|
|
59
|
-
|
80
|
+
[packages/framework/esm-styleguide/src/config-schema.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L7)
|
81
|
+
|
82
|
+
___
|
60
83
|
|
61
84
|
### implementationName
|
62
85
|
|
63
|
-
|
86
|
+
• **implementationName**: `string`
|
87
|
+
|
88
|
+
#### Defined in
|
64
89
|
|
65
|
-
|
90
|
+
[packages/framework/esm-styleguide/src/config-schema.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L10)
|
66
91
|
|
67
|
-
|
92
|
+
___
|
68
93
|
|
69
94
|
### patientPhotoConceptUuid
|
70
95
|
|
71
|
-
|
96
|
+
• **patientPhotoConceptUuid**: `string`
|
97
|
+
|
98
|
+
#### Defined in
|
72
99
|
|
73
|
-
|
100
|
+
[packages/framework/esm-styleguide/src/config-schema.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L11)
|
74
101
|
|
75
|
-
|
102
|
+
___
|
76
103
|
|
77
104
|
### preferredCalendar
|
78
105
|
|
79
|
-
|
106
|
+
• **preferredCalendar**: `Object`
|
80
107
|
|
81
|
-
|
108
|
+
#### Index signature
|
82
109
|
|
83
|
-
|
110
|
+
▪ [key: `string`]: `string`
|
84
111
|
|
85
|
-
|
112
|
+
#### Defined in
|
86
113
|
|
87
|
-
|
114
|
+
[packages/framework/esm-styleguide/src/config-schema.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L12)
|
115
|
+
|
116
|
+
___
|
88
117
|
|
89
118
|
### preferredDateLocale
|
90
119
|
|
91
|
-
|
120
|
+
• **preferredDateLocale**: `Object`
|
121
|
+
|
122
|
+
#### Index signature
|
92
123
|
|
93
|
-
|
124
|
+
▪ [key: `string`]: `string`
|
94
125
|
|
95
|
-
####
|
126
|
+
#### Defined in
|
96
127
|
|
97
|
-
|
128
|
+
[packages/framework/esm-styleguide/src/config-schema.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L15)
|
@@ -1,79 +1,102 @@
|
|
1
|
-
[
|
1
|
+
[@openmrs/esm-framework](../API.md) / SyncItem
|
2
2
|
|
3
|
-
# Interface: SyncItem
|
4
|
-
|
5
|
-
Defined in: [packages/framework/esm-offline/src/sync.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/sync.ts#L12)
|
3
|
+
# Interface: SyncItem<T\>
|
6
4
|
|
7
5
|
Defines an item queued up in the offline synchronization queue.
|
8
6
|
A `SyncItem` contains both meta information about the item in the sync queue, as well as the
|
9
7
|
actual data to be synchronized (i.e. the item's `content`).
|
10
8
|
|
11
|
-
## Type
|
9
|
+
## Type parameters
|
10
|
+
|
11
|
+
| Name | Type |
|
12
|
+
| :------ | :------ |
|
13
|
+
| `T` | `any` |
|
12
14
|
|
13
|
-
|
15
|
+
## Table of contents
|
14
16
|
|
15
|
-
|
17
|
+
### Offline Properties
|
16
18
|
|
17
|
-
|
19
|
+
- [content](SyncItem.md#content)
|
20
|
+
- [createdOn](SyncItem.md#createdon)
|
21
|
+
- [descriptor](SyncItem.md#descriptor)
|
22
|
+
- [id](SyncItem.md#id)
|
23
|
+
- [lastError](SyncItem.md#lasterror)
|
24
|
+
- [type](SyncItem.md#type)
|
25
|
+
- [userId](SyncItem.md#userid)
|
26
|
+
|
27
|
+
## Offline Properties
|
18
28
|
|
19
29
|
### content
|
20
30
|
|
21
|
-
|
31
|
+
• **content**: `T`
|
32
|
+
|
33
|
+
#### Defined in
|
22
34
|
|
23
|
-
|
35
|
+
[packages/framework/esm-offline/src/sync.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L16)
|
24
36
|
|
25
|
-
|
37
|
+
___
|
26
38
|
|
27
39
|
### createdOn
|
28
40
|
|
29
|
-
|
41
|
+
• **createdOn**: `Date`
|
30
42
|
|
31
|
-
Defined in
|
43
|
+
#### Defined in
|
32
44
|
|
33
|
-
|
45
|
+
[packages/framework/esm-offline/src/sync.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L17)
|
46
|
+
|
47
|
+
___
|
34
48
|
|
35
49
|
### descriptor
|
36
50
|
|
37
|
-
|
51
|
+
• **descriptor**: [`QueueItemDescriptor`](QueueItemDescriptor.md)
|
52
|
+
|
53
|
+
#### Defined in
|
38
54
|
|
39
|
-
|
55
|
+
[packages/framework/esm-offline/src/sync.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L18)
|
40
56
|
|
41
|
-
|
57
|
+
___
|
42
58
|
|
43
|
-
### id
|
59
|
+
### id
|
44
60
|
|
45
|
-
|
61
|
+
• `Optional` **id**: `number`
|
46
62
|
|
47
|
-
Defined in
|
63
|
+
#### Defined in
|
48
64
|
|
49
|
-
|
65
|
+
[packages/framework/esm-offline/src/sync.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L13)
|
50
66
|
|
51
|
-
|
67
|
+
___
|
52
68
|
|
53
|
-
|
69
|
+
### lastError
|
54
70
|
|
55
|
-
|
71
|
+
• `Optional` **lastError**: `Object`
|
56
72
|
|
57
|
-
####
|
73
|
+
#### Type declaration
|
58
74
|
|
59
|
-
|
75
|
+
| Name | Type |
|
76
|
+
| :------ | :------ |
|
77
|
+
| `message?` | `string` |
|
78
|
+
| `name?` | `string` |
|
60
79
|
|
61
|
-
####
|
80
|
+
#### Defined in
|
62
81
|
|
63
|
-
|
82
|
+
[packages/framework/esm-offline/src/sync.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L19)
|
64
83
|
|
65
|
-
|
84
|
+
___
|
66
85
|
|
67
86
|
### type
|
68
87
|
|
69
|
-
|
88
|
+
• **type**: `string`
|
70
89
|
|
71
|
-
Defined in
|
90
|
+
#### Defined in
|
72
91
|
|
73
|
-
|
92
|
+
[packages/framework/esm-offline/src/sync.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L15)
|
93
|
+
|
94
|
+
___
|
74
95
|
|
75
96
|
### userId
|
76
97
|
|
77
|
-
|
98
|
+
• **userId**: `string`
|
99
|
+
|
100
|
+
#### Defined in
|
78
101
|
|
79
|
-
|
102
|
+
[packages/framework/esm-offline/src/sync.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L14)
|