@openmrs/esm-framework 6.3.1-pre.3092 → 6.3.1-pre.3104

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.
Files changed (542) hide show
  1. package/.turbo/turbo-build.log +1 -1
  2. package/dist/openmrs-esm-framework.js +2 -2
  3. package/dist/openmrs-esm-framework.js.map +1 -1
  4. package/docs/API.md +310 -8579
  5. package/docs/classes/OpenmrsFetchError.md +88 -117
  6. package/docs/enumerations/Type.md +77 -0
  7. package/docs/enumerations/VisitMode.md +29 -0
  8. package/docs/enumerations/VisitStatus.md +21 -0
  9. package/docs/functions/ConfigurableLink.md +19 -0
  10. package/docs/functions/CustomOverflowMenu.md +17 -0
  11. package/docs/functions/DashboardExtension.md +17 -0
  12. package/docs/functions/ExtensionSlot.md +46 -0
  13. package/docs/functions/OpenmrsAppContext.md +36 -0
  14. package/docs/functions/PatientBannerActionsMenu.md +17 -0
  15. package/docs/functions/PatientBannerContactDetails.md +17 -0
  16. package/docs/functions/PatientBannerPatientIdentifiers.md +17 -0
  17. package/docs/functions/PatientBannerPatientInfo.md +17 -0
  18. package/docs/functions/PatientBannerToggleContactDetailsButton.md +17 -0
  19. package/docs/functions/PatientPhoto.md +19 -0
  20. package/docs/functions/WorkspaceContainer.md +55 -0
  21. package/docs/functions/age.md +32 -0
  22. package/docs/functions/attach.md +40 -0
  23. package/docs/functions/beginEditSynchronizationItem.md +22 -0
  24. package/docs/functions/canAccessStorage.md +25 -0
  25. package/docs/functions/canBeginEditSynchronizationItemsOfType.md +22 -0
  26. package/docs/functions/clearCurrentUser.md +11 -0
  27. package/docs/functions/closeWorkspace.md +27 -0
  28. package/docs/functions/compile.md +30 -0
  29. package/docs/functions/convertToLocaleCalendar.md +25 -0
  30. package/docs/functions/createAttachment.md +21 -0
  31. package/docs/functions/createErrorHandler.md +21 -0
  32. package/docs/functions/createGlobalStore.md +36 -0
  33. package/docs/functions/createUseStore.md +66 -0
  34. package/docs/functions/defineConfigSchema.md +33 -0
  35. package/docs/functions/defineExtensionConfigSchema.md +38 -0
  36. package/docs/functions/deleteAttachmentPermanently.md +21 -0
  37. package/docs/functions/deleteSynchronizationItem.md +21 -0
  38. package/docs/functions/detach.md +25 -0
  39. package/docs/functions/detachAll.md +21 -0
  40. package/docs/functions/dispatchNotificationShown.md +17 -0
  41. package/docs/functions/dispatchPrecacheStaticDependencies.md +17 -0
  42. package/docs/functions/displayName.md +21 -0
  43. package/docs/functions/evaluate.md +84 -0
  44. package/docs/functions/evaluateAsBoolean.md +31 -0
  45. package/docs/functions/evaluateAsBooleanAsync.md +31 -0
  46. package/docs/functions/evaluateAsNumber.md +31 -0
  47. package/docs/functions/evaluateAsNumberAsync.md +31 -0
  48. package/docs/functions/evaluateAsType.md +46 -0
  49. package/docs/functions/evaluateAsTypeAsync.md +46 -0
  50. package/docs/functions/evaluateAsync.md +87 -0
  51. package/docs/functions/extractVariableNames.md +50 -0
  52. package/docs/functions/fetchCurrentPatient.md +25 -0
  53. package/docs/functions/filterBreadcrumbs.md +21 -0
  54. package/docs/functions/formatDate.md +39 -0
  55. package/docs/functions/formatDatetime.md +29 -0
  56. package/docs/functions/formatPartialDate.md +39 -0
  57. package/docs/functions/formatPatientName.md +23 -0
  58. package/docs/functions/formatTime.md +20 -0
  59. package/docs/functions/formattedName.md +21 -0
  60. package/docs/functions/generateOfflineUuid.md +13 -0
  61. package/docs/functions/getAssignedExtensions.md +23 -0
  62. package/docs/functions/getAsyncLifecycle.md +31 -0
  63. package/docs/functions/getAttachmentByUuid.md +21 -0
  64. package/docs/functions/getAttachments.md +25 -0
  65. package/docs/functions/getBreadcrumbs.md +11 -0
  66. package/docs/functions/getBreadcrumbsFor.md +17 -0
  67. package/docs/functions/getConfig.md +31 -0
  68. package/docs/functions/getContext.md +29 -0
  69. package/docs/functions/getCoreTranslation.md +35 -0
  70. package/docs/functions/getCurrentOfflineMode.md +11 -0
  71. package/docs/functions/getCurrentUser.md +154 -0
  72. package/docs/functions/getDefaultCalendar.md +21 -0
  73. package/docs/functions/getDefaultsFromConfigSchema.md +32 -0
  74. package/docs/functions/getDynamicOfflineDataEntries.md +28 -0
  75. package/docs/functions/getDynamicOfflineDataEntriesFor.md +34 -0
  76. package/docs/functions/getDynamicOfflineDataHandlers.md +13 -0
  77. package/docs/functions/getExtensionNameFromId.md +30 -0
  78. package/docs/functions/getExtensionStore.md +14 -0
  79. package/docs/functions/getFeatureFlag.md +21 -0
  80. package/docs/functions/getFhirServerPaginationHandlers.md +17 -0
  81. package/docs/functions/getFullSynchronizationItems.md +27 -0
  82. package/docs/functions/getFullSynchronizationItemsFor.md +33 -0
  83. package/docs/functions/getGlobalStore.md +36 -0
  84. package/docs/functions/getHistory.md +13 -0
  85. package/docs/functions/getLifecycle.md +27 -0
  86. package/docs/functions/getLocale.md +15 -0
  87. package/docs/functions/getLocations.md +21 -0
  88. package/docs/functions/getLoggedInUser.md +11 -0
  89. package/docs/functions/getOfflinePatientDataStore.md +15 -0
  90. package/docs/functions/getPatientName.md +26 -0
  91. package/docs/functions/getSessionLocation.md +11 -0
  92. package/docs/functions/getSessionStore.md +11 -0
  93. package/docs/functions/getSyncLifecycle.md +31 -0
  94. package/docs/functions/getSynchronizationItem.md +27 -0
  95. package/docs/functions/getSynchronizationItems.md +27 -0
  96. package/docs/functions/getVisitStore.md +11 -0
  97. package/docs/functions/getVisitTypes.md +11 -0
  98. package/docs/functions/getVisitsForPatient.md +29 -0
  99. package/docs/functions/goBackInHistory.md +25 -0
  100. package/docs/functions/importDynamic.md +58 -0
  101. package/docs/functions/inRange.md +27 -0
  102. package/docs/functions/interpolateString.md +34 -0
  103. package/docs/functions/interpolateUrl.md +48 -0
  104. package/docs/functions/isDesktop.md +17 -0
  105. package/docs/functions/isDevEnabled.md +11 -0
  106. package/docs/functions/isOfflineUuid.md +19 -0
  107. package/docs/functions/isOmrsDateStrict.md +20 -0
  108. package/docs/functions/isOmrsDateToday.md +19 -0
  109. package/docs/functions/isOnline.md +17 -0
  110. package/docs/functions/isUrlWithTemplateParameters.md +22 -0
  111. package/docs/functions/isVersionSatisfied.md +21 -0
  112. package/docs/functions/launchWorkspace.md +56 -0
  113. package/docs/functions/launchWorkspaceGroup.md +38 -0
  114. package/docs/functions/makeUrl.md +26 -0
  115. package/docs/functions/messageOmrsServiceWorker.md +23 -0
  116. package/docs/functions/navigate.md +48 -0
  117. package/docs/functions/navigateAndLaunchWorkspace.md +33 -0
  118. package/docs/functions/oneOf.md +21 -0
  119. package/docs/functions/openmrsFetch.md +75 -0
  120. package/docs/functions/openmrsObservableFetch.md +55 -0
  121. package/docs/functions/parseDate.md +20 -0
  122. package/docs/functions/provide.md +21 -0
  123. package/docs/functions/putDynamicOfflineData.md +28 -0
  124. package/docs/functions/putDynamicOfflineDataFor.md +34 -0
  125. package/docs/functions/queueSynchronizationItem.md +39 -0
  126. package/docs/functions/refetchCurrentUser.md +33 -0
  127. package/docs/functions/registerBreadcrumb.md +17 -0
  128. package/docs/functions/registerBreadcrumbs.md +17 -0
  129. package/docs/functions/registerContext.md +34 -0
  130. package/docs/functions/registerDefaultCalendar.md +33 -0
  131. package/docs/functions/registerFeatureFlag.md +36 -0
  132. package/docs/functions/registerOfflinePatientHandler.md +25 -0
  133. package/docs/functions/removeDynamicOfflineData.md +28 -0
  134. package/docs/functions/removeDynamicOfflineDataFor.md +34 -0
  135. package/docs/functions/renderExtension.md +41 -0
  136. package/docs/functions/reportError.md +17 -0
  137. package/docs/functions/retry.md +44 -0
  138. package/docs/functions/saveVisit.md +21 -0
  139. package/docs/functions/selectPreferredName.md +46 -0
  140. package/docs/functions/setCurrentVisit.md +21 -0
  141. package/docs/functions/setLeftNav.md +23 -0
  142. package/docs/functions/setSessionLocation.md +21 -0
  143. package/docs/functions/setUserLanguage.md +17 -0
  144. package/docs/functions/setUserProperties.md +23 -0
  145. package/docs/functions/setupDynamicOfflineDataHandler.md +22 -0
  146. package/docs/functions/setupOfflineSync.md +49 -0
  147. package/docs/functions/shallowEqual.md +32 -0
  148. package/docs/functions/showActionableNotification.md +21 -0
  149. package/docs/functions/showModal.md +44 -0
  150. package/docs/functions/showNotification.md +21 -0
  151. package/docs/functions/showSnackbar.md +21 -0
  152. package/docs/functions/showToast.md +21 -0
  153. package/docs/functions/subscribeActionableNotificationShown.md +21 -0
  154. package/docs/functions/subscribeConnectivity.md +21 -0
  155. package/docs/functions/subscribeConnectivityChanged.md +21 -0
  156. package/docs/functions/subscribeNotificationShown.md +21 -0
  157. package/docs/functions/subscribePrecacheStaticDependencies.md +21 -0
  158. package/docs/functions/subscribeSnackbarShown.md +21 -0
  159. package/docs/functions/subscribeTo.md +75 -0
  160. package/docs/functions/subscribeToContext.md +39 -0
  161. package/docs/functions/subscribeToastShown.md +21 -0
  162. package/docs/functions/syncAllDynamicOfflineData.md +27 -0
  163. package/docs/functions/syncDynamicOfflineData.md +33 -0
  164. package/docs/functions/syncOfflinePatientData.md +21 -0
  165. package/docs/functions/toDateObjectStrict.md +20 -0
  166. package/docs/functions/toLocationObject.md +17 -0
  167. package/docs/functions/toOmrsIsoString.md +23 -0
  168. package/docs/functions/toVisitTypeObject.md +17 -0
  169. package/docs/functions/translateFrom.md +55 -0
  170. package/docs/functions/unregisterContext.md +20 -0
  171. package/docs/functions/unsetLeftNav.md +23 -0
  172. package/docs/functions/updateContext.md +29 -0
  173. package/docs/functions/updateVisit.md +25 -0
  174. package/docs/functions/useAbortController.md +32 -0
  175. package/docs/functions/useAppContext.md +43 -0
  176. package/docs/functions/useAssignedExtensionIds.md +26 -0
  177. package/docs/functions/useAssignedExtensions.md +21 -0
  178. package/docs/functions/useAttachments.md +41 -0
  179. package/docs/functions/useBodyScrollLock.md +17 -0
  180. package/docs/functions/useConfig.md +27 -0
  181. package/docs/functions/useConnectivity.md +11 -0
  182. package/docs/functions/useDebounce.md +57 -0
  183. package/docs/functions/useDefineAppContext.md +70 -0
  184. package/docs/functions/useEmrConfiguration.md +35 -0
  185. package/docs/functions/useExtensionSlotMeta.md +25 -0
  186. package/docs/functions/useExtensionSlotStore.md +17 -0
  187. package/docs/functions/useFeatureFlag.md +30 -0
  188. package/docs/functions/useFhirFetchAll.md +44 -0
  189. package/docs/functions/useFhirInfinite.md +46 -0
  190. package/docs/functions/useFhirPagination.md +129 -0
  191. package/docs/functions/useLayoutType.md +11 -0
  192. package/docs/functions/useLeftNav.md +17 -0
  193. package/docs/functions/useLeftNavStore.md +11 -0
  194. package/docs/functions/useLocations.md +21 -0
  195. package/docs/functions/useOnClickOutside.md +27 -0
  196. package/docs/functions/useOnVisible.md +28 -0
  197. package/docs/functions/useOpenmrsFetchAll.md +46 -0
  198. package/docs/functions/useOpenmrsInfinite.md +54 -0
  199. package/docs/functions/useOpenmrsPagination.md +140 -0
  200. package/docs/functions/useOpenmrsSWR.md +71 -0
  201. package/docs/functions/usePagination.md +89 -0
  202. package/docs/functions/usePatient.md +38 -0
  203. package/docs/functions/usePatientPhoto.md +17 -0
  204. package/docs/functions/usePrimaryIdentifierCode.md +23 -0
  205. package/docs/functions/useRenderableExtensions.md +43 -0
  206. package/docs/functions/useSession.md +19 -0
  207. package/docs/functions/useStore.md +131 -0
  208. package/docs/functions/useStoreWithActions.md +33 -0
  209. package/docs/functions/useVisit.md +41 -0
  210. package/docs/functions/useVisitContextStore.md +23 -0
  211. package/docs/functions/useVisitTypes.md +11 -0
  212. package/docs/functions/useWorkspaces.md +11 -0
  213. package/docs/functions/userHasAccess.md +27 -0
  214. package/docs/functions/validator.md +44 -0
  215. package/docs/interfaces/ActionMenuButtonProps.md +33 -57
  216. package/docs/interfaces/ActionableNotificationDescriptor.md +37 -67
  217. package/docs/interfaces/AssignedExtension.md +30 -57
  218. package/docs/interfaces/Attachment.md +23 -47
  219. package/docs/interfaces/AttachmentResponse.md +20 -41
  220. package/docs/interfaces/AuditInfo.md +49 -88
  221. package/docs/interfaces/BreadcrumbRegistration.md +8 -17
  222. package/docs/interfaces/BreadcrumbSettings.md +18 -33
  223. package/docs/interfaces/CancelLoading.md +6 -10
  224. package/docs/interfaces/ClearDynamicRoutesMessage.md +9 -17
  225. package/docs/interfaces/CloseWorkspaceOptions.md +18 -29
  226. package/docs/interfaces/ComponentConfig.md +11 -23
  227. package/docs/interfaces/Concept.md +83 -131
  228. package/docs/interfaces/ConceptClass.md +46 -67
  229. package/docs/interfaces/ConceptDatatype.md +50 -74
  230. package/docs/interfaces/ConceptName.md +50 -74
  231. package/docs/interfaces/Config.md +4 -2
  232. package/docs/interfaces/ConfigObject.md +12 -21
  233. package/docs/interfaces/ConfigSchema.md +15 -27
  234. package/docs/interfaces/ConfigurableLinkProps.md +24 -4314
  235. package/docs/interfaces/ConnectedExtension.md +25 -41
  236. package/docs/interfaces/ConnectivityChangedEvent.md +4 -10
  237. package/docs/interfaces/CurrentPatientOptions.md +9 -18
  238. package/docs/interfaces/DashboardExtensionProps.md +13 -28
  239. package/docs/interfaces/DefaultWorkspaceProps.md +44 -51
  240. package/docs/interfaces/Diagnosis.md +80 -104
  241. package/docs/interfaces/DisplayConditionsConfigObject.md +18 -33
  242. package/docs/interfaces/DynamicOfflineData.md +23 -41
  243. package/docs/interfaces/DynamicOfflineDataHandler.md +47 -54
  244. package/docs/interfaces/DynamicOfflineDataSyncState.md +29 -39
  245. package/docs/interfaces/EmrApiConfigurationResponse.md +243 -350
  246. package/docs/interfaces/Encounter.md +67 -110
  247. package/docs/interfaces/EncounterProvider.md +39 -61
  248. package/docs/interfaces/EncounterRole.md +43 -68
  249. package/docs/interfaces/EncounterType.md +43 -68
  250. package/docs/interfaces/ErrorStateProps.md +7 -16
  251. package/docs/interfaces/ExtensionData.md +10 -22
  252. package/docs/interfaces/ExtensionMeta.md +4 -2
  253. package/docs/interfaces/ExtensionRegistration.md +36 -69
  254. package/docs/interfaces/ExtensionSlotBaseProps.md +35 -35
  255. package/docs/interfaces/ExtensionSlotConfig.md +17 -32
  256. package/docs/interfaces/ExtensionSlotConfigObject.md +14 -26
  257. package/docs/interfaces/ExtensionSlotConfigureValueObject.md +4 -2
  258. package/docs/interfaces/ExtensionSlotProps.md +3520 -0
  259. package/docs/interfaces/ExtensionSlotState.md +9 -18
  260. package/docs/interfaces/ExtensionStore.md +5 -11
  261. package/docs/interfaces/FHIRCode.md +11 -23
  262. package/docs/interfaces/FHIRLocationResource.md +25 -18
  263. package/docs/interfaces/FHIRResource.md +105 -41
  264. package/docs/interfaces/FeatureFlagDefinition.md +14 -26
  265. package/docs/interfaces/FetchConfig.md +80 -117
  266. package/docs/interfaces/FetchError.md +8 -21
  267. package/docs/interfaces/FetchHeaders.md +4 -2
  268. package/docs/interfaces/FetchResponse.md +124 -130
  269. package/docs/interfaces/FetchResponseJson.md +4 -2
  270. package/docs/interfaces/ImportMap.md +4 -10
  271. package/docs/interfaces/LeftNavStore.md +14 -29
  272. package/docs/interfaces/Link.md +11 -23
  273. package/docs/interfaces/Location.md +147 -250
  274. package/docs/interfaces/LoggedInUser.md +68 -70
  275. package/docs/interfaces/LoggedInUserFetchResponse.md +120 -128
  276. package/docs/interfaces/MessageServiceWorkerResult.md +17 -29
  277. package/docs/interfaces/NavigateOptions.md +9 -18
  278. package/docs/interfaces/NewVisitPayload.md +32 -48
  279. package/docs/interfaces/NotificationDescriptor.md +31 -58
  280. package/docs/interfaces/Obs.md +99 -166
  281. package/docs/interfaces/OfflineModeResult.md +11 -23
  282. package/docs/interfaces/OfflinePatientArgs.md +13 -20
  283. package/docs/interfaces/OfflinePatientDataSyncHandler.md +17 -27
  284. package/docs/interfaces/OfflinePatientDataSyncState.md +29 -51
  285. package/docs/interfaces/OfflinePatientDataSyncStore.md +13 -20
  286. package/docs/interfaces/OmrsServiceWorkerMessage.md +13 -23
  287. package/docs/interfaces/OnImportMapChangedMessage.md +12 -23
  288. package/docs/interfaces/OnlyThePatient.md +9 -17
  289. package/docs/interfaces/OpenWorkspace.md +116 -170
  290. package/docs/interfaces/OpenmrsAppContextProps.md +14 -23
  291. package/docs/interfaces/OpenmrsAppRoutes.md +41 -71
  292. package/docs/interfaces/OpenmrsDatePickerProps.md +346 -483
  293. package/docs/interfaces/OpenmrsResource.md +39 -57
  294. package/docs/interfaces/OpenmrsResourceStrict.md +27 -51
  295. package/docs/interfaces/PageHeaderContentProps.md +12 -24
  296. package/docs/interfaces/PageHeaderWrapperProps.md +9 -18
  297. package/docs/interfaces/Patient.md +41 -70
  298. package/docs/interfaces/PatientBannerActionsMenuProps.md +15 -30
  299. package/docs/interfaces/PatientBannerToggleContactDetailsButtonProps.md +17 -32
  300. package/docs/interfaces/PatientIdentifier.md +49 -84
  301. package/docs/interfaces/PatientIdentifierType.md +65 -112
  302. package/docs/interfaces/PatientPhotoProps.md +8 -17
  303. package/docs/interfaces/PatientWithFullResponse.md +9 -17
  304. package/docs/interfaces/Person.md +96 -160
  305. package/docs/interfaces/PersonAddress.md +136 -230
  306. package/docs/interfaces/PersonAttribute.md +43 -68
  307. package/docs/interfaces/PersonName.md +72 -118
  308. package/docs/interfaces/PrecacheStaticDependenciesEvent.md +3 -1
  309. package/docs/interfaces/PrimaryIdentifier.md +5 -11
  310. package/docs/interfaces/Privilege.md +11 -23
  311. package/docs/interfaces/Prompt.md +20 -41
  312. package/docs/interfaces/QueueItemDescriptor.md +23 -30
  313. package/docs/interfaces/RegisterDynamicRouteMessage.md +21 -38
  314. package/docs/interfaces/ResourceLoader.md +10 -14
  315. package/docs/interfaces/ResponsiveWrapperProps.md +5 -11
  316. package/docs/interfaces/RetryOptions.md +36 -37
  317. package/docs/interfaces/Role.md +10 -22
  318. package/docs/interfaces/Session.md +31 -54
  319. package/docs/interfaces/SessionLocation.md +10 -22
  320. package/docs/interfaces/SetLeftNavParams.md +15 -30
  321. package/docs/interfaces/ShowActionableNotificationEvent.md +26 -50
  322. package/docs/interfaces/ShowNotificationEvent.md +20 -38
  323. package/docs/interfaces/ShowSnackbarEvent.md +34 -64
  324. package/docs/interfaces/ShowToastEvent.md +22 -43
  325. package/docs/interfaces/SnackbarDescriptor.md +41 -76
  326. package/docs/interfaces/SnackbarMeta.md +55 -93
  327. package/docs/interfaces/SpaConfig.md +30 -40
  328. package/docs/interfaces/StyleguideConfigObject.md +39 -70
  329. package/docs/interfaces/SyncItem.md +34 -57
  330. package/docs/interfaces/SyncProcessOptions.md +22 -40
  331. package/docs/interfaces/ToastDescriptor.md +29 -55
  332. package/docs/interfaces/ToastNotificationMeta.md +40 -69
  333. package/docs/interfaces/UploadedFile.md +25 -49
  334. package/docs/interfaces/UseConfigOptions.md +6 -12
  335. package/docs/interfaces/UsePatientPhotoResult.md +12 -24
  336. package/docs/interfaces/UseServerFetchAllOptions.md +41 -61
  337. package/docs/interfaces/UseServerInfiniteOptions.md +29 -46
  338. package/docs/interfaces/UseServerPaginationOptions.md +26 -41
  339. package/docs/interfaces/User.md +34 -46
  340. package/docs/interfaces/UserHasAccessProps.md +13 -25
  341. package/docs/interfaces/Visit.md +36 -66
  342. package/docs/interfaces/VisitItem.md +16 -31
  343. package/docs/interfaces/VisitReturnType.md +24 -51
  344. package/docs/interfaces/VisitStoreState.md +14 -26
  345. package/docs/interfaces/VisitType.md +11 -23
  346. package/docs/interfaces/WorkspaceContainerProps.md +20 -38
  347. package/docs/interfaces/WorkspaceGroupDefinition.md +10 -19
  348. package/docs/interfaces/WorkspaceRegistration.md +43 -82
  349. package/docs/interfaces/WorkspacesInfo.md +26 -40
  350. package/docs/type-aliases/ActionFunction.md +27 -0
  351. package/docs/type-aliases/ActionableNotificationType.md +7 -0
  352. package/docs/type-aliases/Actions.md +13 -0
  353. package/docs/type-aliases/ArgumentsTuple.md +7 -0
  354. package/docs/type-aliases/BoundActions.md +17 -0
  355. package/docs/type-aliases/ConfigValue.md +7 -0
  356. package/docs/type-aliases/ContextCallback.md +23 -0
  357. package/docs/type-aliases/CoreTranslationKey.md +7 -0
  358. package/docs/type-aliases/CurrentPatient.md +7 -0
  359. package/docs/type-aliases/DateInput.md +7 -0
  360. package/docs/type-aliases/DefaultEvaluateReturnType.md +9 -0
  361. package/docs/type-aliases/ExtensionDefinition.md +69 -0
  362. package/docs/type-aliases/ExtensionProps.md +13 -0
  363. package/docs/type-aliases/FormatDateMode.md +7 -0
  364. package/docs/type-aliases/FormatDateOptions.md +102 -0
  365. package/docs/type-aliases/IconProps.md +31 -0
  366. package/docs/type-aliases/InlineNotificationType.md +7 -0
  367. package/docs/type-aliases/Key.md +7 -0
  368. package/docs/type-aliases/KnownOmrsServiceWorkerMessages.md +7 -0
  369. package/docs/type-aliases/LayoutType.md +7 -0
  370. package/docs/type-aliases/LoadedSessionStore.md +23 -0
  371. package/docs/type-aliases/ModalDefinition.md +17 -0
  372. package/docs/type-aliases/NameUse.md +7 -0
  373. package/docs/type-aliases/NullablePatient.md +7 -0
  374. package/docs/type-aliases/OfflineMode.md +7 -0
  375. package/docs/type-aliases/OmrsOfflineCachingStrategy.md +12 -0
  376. package/docs/type-aliases/OmrsOfflineHttpHeaderNames.md +7 -0
  377. package/docs/type-aliases/OmrsOfflineHttpHeaders.md +44 -0
  378. package/docs/type-aliases/OpenmrsRoutes.md +10 -0
  379. package/docs/type-aliases/PageDefinition.md +41 -0
  380. package/docs/type-aliases/PageHeaderProps.md +7 -0
  381. package/docs/type-aliases/PatientUuid.md +7 -0
  382. package/docs/type-aliases/PictogramProps.md +23 -0
  383. package/docs/type-aliases/ProvidedConfig.md +23 -0
  384. package/docs/type-aliases/ResourceName.md +7 -0
  385. package/docs/type-aliases/SessionStore.md +7 -0
  386. package/docs/type-aliases/SnackbarType.md +7 -0
  387. package/docs/type-aliases/SpaEnvironment.md +7 -0
  388. package/docs/type-aliases/SvgIconProps.md +23 -0
  389. package/docs/type-aliases/SvgPictogramProps.md +27 -0
  390. package/docs/type-aliases/TemplateParams.md +11 -0
  391. package/docs/type-aliases/ToastType.md +7 -0
  392. package/docs/type-aliases/UnloadedSessionStore.md +23 -0
  393. package/docs/type-aliases/UpdateVisitPayload.md +7 -0
  394. package/docs/type-aliases/UseOpenmrsSWROptions.md +39 -0
  395. package/docs/type-aliases/Validator.md +17 -0
  396. package/docs/type-aliases/ValidatorFunction.md +17 -0
  397. package/docs/type-aliases/VariablesMap.md +13 -0
  398. package/docs/type-aliases/WorkspaceDefinition.md +78 -0
  399. package/docs/type-aliases/WorkspaceWindowState.md +7 -0
  400. package/docs/variables/ActionMenuButton.md +7 -0
  401. package/docs/variables/ActivityIcon.md +7 -0
  402. package/docs/variables/AddIcon.md +7 -0
  403. package/docs/variables/AllergiesIcon.md +7 -0
  404. package/docs/variables/AppointmentsPictogram.md +7 -0
  405. package/docs/variables/ArrowDownIcon.md +7 -0
  406. package/docs/variables/ArrowLeftIcon.md +7 -0
  407. package/docs/variables/ArrowRightIcon.md +7 -0
  408. package/docs/variables/ArrowUpIcon.md +7 -0
  409. package/docs/variables/AttachmentIcon.md +7 -0
  410. package/docs/variables/BabyIcon.md +7 -0
  411. package/docs/variables/CalendarHeatMapIcon.md +7 -0
  412. package/docs/variables/CalendarIcon.md +7 -0
  413. package/docs/variables/CaretDownIcon.md +7 -0
  414. package/docs/variables/CaretLeftIcon.md +7 -0
  415. package/docs/variables/CaretRightIcon.md +7 -0
  416. package/docs/variables/CaretUpIcon.md +7 -0
  417. package/docs/variables/ChartAverageIcon.md +7 -0
  418. package/docs/variables/CheckmarkFilledIcon.md +7 -0
  419. package/docs/variables/CheckmarkOutlineIcon.md +7 -0
  420. package/docs/variables/ChemistryIcon.md +7 -0
  421. package/docs/variables/ChevronDownIcon.md +7 -0
  422. package/docs/variables/ChevronLeftIcon.md +7 -0
  423. package/docs/variables/ChevronRightIcon.md +7 -0
  424. package/docs/variables/ChevronUpIcon.md +7 -0
  425. package/docs/variables/CloseFilledIcon.md +7 -0
  426. package/docs/variables/CloseIcon.md +7 -0
  427. package/docs/variables/CloseOutlineIcon.md +7 -0
  428. package/docs/variables/ConditionsIcon.md +11 -0
  429. package/docs/variables/DiagnosisTags.md +11 -0
  430. package/docs/variables/DocumentAttachmentIcon.md +7 -0
  431. package/docs/variables/DocumentIcon.md +7 -0
  432. package/docs/variables/DownloadIcon.md +7 -0
  433. package/docs/variables/DrugOrderIcon.md +7 -0
  434. package/docs/variables/EditIcon.md +7 -0
  435. package/docs/variables/ErrorState.md +7 -0
  436. package/docs/variables/EventScheduleIcon.md +7 -0
  437. package/docs/variables/EventsIcon.md +7 -0
  438. package/docs/variables/Extension.md +15 -0
  439. package/docs/variables/GenderFemaleIcon.md +7 -0
  440. package/docs/variables/GenderMaleIcon.md +7 -0
  441. package/docs/variables/GenderOtherIcon.md +7 -0
  442. package/docs/variables/GenderUnknownIcon.md +7 -0
  443. package/docs/variables/GenericOrderTypeIcon.md +7 -0
  444. package/docs/variables/GroupAccessIcon.md +7 -0
  445. package/docs/variables/GroupIcon.md +7 -0
  446. package/docs/variables/HomePictogram.md +7 -0
  447. package/docs/variables/HospitalBedIcon.md +7 -0
  448. package/docs/variables/Icon.md +9 -0
  449. package/docs/variables/ImageMedicalIcon.md +7 -0
  450. package/docs/variables/InPatientPictogram.md +7 -0
  451. package/docs/variables/InformationFilledIcon.md +7 -0
  452. package/docs/variables/InformationIcon.md +7 -0
  453. package/docs/variables/InformationSquareIcon.md +7 -0
  454. package/docs/variables/InventoryManagementIcon.md +7 -0
  455. package/docs/variables/LabOrderIcon.md +7 -0
  456. package/docs/variables/LaboratoryPictogram.md +7 -0
  457. package/docs/variables/LeftNavMenu.md +13 -0
  458. package/docs/variables/ListCheckedIcon.md +7 -0
  459. package/docs/variables/LocationIcon.md +7 -0
  460. package/docs/variables/LocationPicker.md +7 -0
  461. package/docs/variables/MaterialOrderIcon.md +7 -0
  462. package/docs/variables/MaximizeIcon.md +7 -0
  463. package/docs/variables/MaybeIcon.md +16 -0
  464. package/docs/variables/MaybePictogram.md +16 -0
  465. package/docs/variables/MedicationIcon.md +7 -0
  466. package/docs/variables/MessageQueueIcon.md +7 -0
  467. package/docs/variables/MicroscopeIcon.md +7 -0
  468. package/docs/variables/MoneyIcon.md +9 -0
  469. package/docs/variables/MotherIcon.md +7 -0
  470. package/docs/variables/MovementIcon.md +7 -0
  471. package/docs/variables/OpenmrsDatePicker.md +9 -0
  472. package/docs/variables/OverflowMenuHorizontalIcon.md +7 -0
  473. package/docs/variables/OverflowMenuVerticalIcon.md +7 -0
  474. package/docs/variables/PageHeader.md +30 -0
  475. package/docs/variables/PageHeaderContent.md +21 -0
  476. package/docs/variables/PasswordIcon.md +7 -0
  477. package/docs/variables/PatientListsPictogram.md +7 -0
  478. package/docs/variables/PedestrianFamilyIcon.md +7 -0
  479. package/docs/variables/PenIcon.md +7 -0
  480. package/docs/variables/PharmacyPictogram.md +7 -0
  481. package/docs/variables/Pictogram.md +9 -0
  482. package/docs/variables/PrinterIcon.md +7 -0
  483. package/docs/variables/ProcedureOrderIcon.md +7 -0
  484. package/docs/variables/ProgramsIcon.md +7 -0
  485. package/docs/variables/RadiologyIcon.md +7 -0
  486. package/docs/variables/ReferralOrderIcon.md +7 -0
  487. package/docs/variables/RegistrationPictogram.md +7 -0
  488. package/docs/variables/RenderIfValueIsTruthy.md +21 -0
  489. package/docs/variables/RenewIcon.md +7 -0
  490. package/docs/variables/ReportIcon.md +7 -0
  491. package/docs/variables/ResetIcon.md +7 -0
  492. package/docs/variables/ResponsiveWrapper.md +11 -0
  493. package/docs/variables/SaveIcon.md +7 -0
  494. package/docs/variables/SearchIcon.md +7 -0
  495. package/docs/variables/ServiceQueuesPictogram.md +7 -0
  496. package/docs/variables/ShoppingCartAddItemIcon.md +11 -0
  497. package/docs/variables/ShoppingCartArrowDownIcon.md +9 -0
  498. package/docs/variables/ShoppingCartIcon.md +9 -0
  499. package/docs/variables/StickyNoteAddIcon.md +9 -0
  500. package/docs/variables/StockManagementPictogram.md +7 -0
  501. package/docs/variables/SwitcherIcon.md +7 -0
  502. package/docs/variables/SyringeIcon.md +7 -0
  503. package/docs/variables/TableIcon.md +7 -0
  504. package/docs/variables/TableOfContentsIcon.md +9 -0
  505. package/docs/variables/TimeIcon.md +9 -0
  506. package/docs/variables/ToolsIcon.md +7 -0
  507. package/docs/variables/TranslateIcon.md +7 -0
  508. package/docs/variables/TrashCanIcon.md +7 -0
  509. package/docs/variables/TreeViewAltIcon.md +7 -0
  510. package/docs/variables/UserAvatarIcon.md +9 -0
  511. package/docs/variables/UserFollowIcon.md +7 -0
  512. package/docs/variables/UserHasAccess.md +35 -0
  513. package/docs/variables/UserIcon.md +7 -0
  514. package/docs/variables/UserXrayIcon.md +11 -0
  515. package/docs/variables/ViewIcon.md +7 -0
  516. package/docs/variables/ViewOffIcon.md +7 -0
  517. package/docs/variables/WarningIcon.md +7 -0
  518. package/docs/variables/attachmentUrl.md +7 -0
  519. package/docs/variables/backendDependencies.md +17 -0
  520. package/docs/variables/defaultVisitCustomRepresentation.md +7 -0
  521. package/docs/variables/fhirBaseUrl.md +7 -0
  522. package/docs/variables/getAsyncExtensionLifecycle.md +35 -0
  523. package/docs/variables/getStartedVisit.md +9 -0
  524. package/docs/variables/isUrl.md +9 -0
  525. package/docs/variables/offlineUuidPrefix.md +7 -0
  526. package/docs/variables/omrsOfflineCachingStrategyHttpHeaderName.md +7 -0
  527. package/docs/variables/omrsOfflineResponseBodyHttpHeaderName.md +7 -0
  528. package/docs/variables/omrsOfflineResponseStatusHttpHeaderName.md +7 -0
  529. package/docs/variables/restBaseUrl.md +7 -0
  530. package/docs/variables/sessionEndpoint.md +7 -0
  531. package/docs/variables/useConnectedExtensions.md +25 -0
  532. package/docs/variables/useExtensionStore.md +55 -0
  533. package/docs/variables/validators.md +78 -0
  534. package/package.json +24 -20
  535. package/rspack.config.cjs +1 -8
  536. package/tsconfig.build.json +2 -1
  537. package/typedoc.json +16 -4
  538. package/docs/.nojekyll +0 -1
  539. package/docs/enums/Type.md +0 -107
  540. package/docs/enums/VisitMode.md +0 -41
  541. package/docs/enums/VisitStatus.md +0 -30
  542. package/docs/interfaces/OldExtensionSlotBaseProps.md +0 -67
package/docs/interfaces/SnackbarMeta.md CHANGED
@@ -1,167 +1,129 @@
1
- [@openmrs/esm-framework](../API.md) / SnackbarMeta
1
+ [O3 Framework](../API.md) / SnackbarMeta
2
2
 
3
3
  # Interface: SnackbarMeta
4
4
 
5
- ## Hierarchy
5
+ Defined in: [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:25](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L25)
6
6
 
7
- - [`SnackbarDescriptor`](SnackbarDescriptor.md)
8
-
9
- ↳ **`SnackbarMeta`**
10
-
11
- ## Table of contents
12
-
13
- ### UI Properties
7
+ ## Extends
14
8
 
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)
24
-
25
- ### UI Methods
9
+ - [`SnackbarDescriptor`](SnackbarDescriptor.md)
26
10
 
27
- - [onActionButtonClick](SnackbarMeta.md#onactionbuttonclick)
11
+ ## Properties
28
12
 
29
- ## UI Properties
13
+ ### actionButtonLabel?
30
14
 
31
- ### actionButtonLabel
15
+ > `optional` **actionButtonLabel**: `string`
32
16
 
33
- • `Optional` **actionButtonLabel**: `string`
17
+ Defined in: [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L14)
34
18
 
35
19
  #### Inherited from
36
20
 
37
- [SnackbarDescriptor](SnackbarDescriptor.md).[actionButtonLabel](SnackbarDescriptor.md#actionbuttonlabel)
38
-
39
- #### Defined in
21
+ [`SnackbarDescriptor`](SnackbarDescriptor.md).[`actionButtonLabel`](SnackbarDescriptor.md#actionbuttonlabel)
40
22
 
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)
23
+ ***
42
24
 
43
- ___
25
+ ### autoClose?
44
26
 
45
- ### autoClose
27
+ > `optional` **autoClose**: `boolean`
46
28
 
47
- • `Optional` **autoClose**: `boolean`
29
+ Defined in: [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:21](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L21)
48
30
 
49
31
  #### Inherited from
50
32
 
51
- [SnackbarDescriptor](SnackbarDescriptor.md).[autoClose](SnackbarDescriptor.md#autoclose)
33
+ [`SnackbarDescriptor`](SnackbarDescriptor.md).[`autoClose`](SnackbarDescriptor.md#autoclose)
52
34
 
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
- ___
35
+ ***
58
36
 
59
37
  ### id
60
38
 
61
- • **id**: `number`
39
+ > **id**: `number`
62
40
 
63
- #### Defined in
41
+ Defined in: [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:26](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L26)
64
42
 
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)
43
+ ***
66
44
 
67
- ___
45
+ ### isLowContrast?
68
46
 
69
- ### isLowContrast
47
+ > `optional` **isLowContrast**: `boolean`
70
48
 
71
- • `Optional` **isLowContrast**: `boolean`
49
+ Defined in: [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L15)
72
50
 
73
51
  #### Inherited from
74
52
 
75
- [SnackbarDescriptor](SnackbarDescriptor.md).[isLowContrast](SnackbarDescriptor.md#islowcontrast)
76
-
77
- #### Defined in
53
+ [`SnackbarDescriptor`](SnackbarDescriptor.md).[`isLowContrast`](SnackbarDescriptor.md#islowcontrast)
78
54
 
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)
55
+ ***
80
56
 
81
- ___
57
+ ### kind?
82
58
 
83
- ### kind
59
+ > `optional` **kind**: `string`
84
60
 
85
- • `Optional` **kind**: `string`
61
+ Defined in: [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L16)
86
62
 
87
63
  #### Inherited from
88
64
 
89
- [SnackbarDescriptor](SnackbarDescriptor.md).[kind](SnackbarDescriptor.md#kind)
65
+ [`SnackbarDescriptor`](SnackbarDescriptor.md).[`kind`](SnackbarDescriptor.md#kind)
90
66
 
91
- #### Defined in
67
+ ***
92
68
 
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)
69
+ ### onActionButtonClick()?
94
70
 
95
- ___
71
+ > `optional` **onActionButtonClick**: () => `void`
96
72
 
97
- ### progressActionLabel
73
+ Defined in: [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L17)
98
74
 
99
- • `Optional` **progressActionLabel**: `string`
75
+ #### Returns
100
76
 
101
- #### Inherited from
77
+ `void`
102
78
 
103
- [SnackbarDescriptor](SnackbarDescriptor.md).[progressActionLabel](SnackbarDescriptor.md#progressactionlabel)
79
+ #### Inherited from
104
80
 
105
- #### Defined in
81
+ [`SnackbarDescriptor`](SnackbarDescriptor.md).[`onActionButtonClick`](SnackbarDescriptor.md#onactionbuttonclick)
106
82
 
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)
83
+ ***
108
84
 
109
- ___
85
+ ### progressActionLabel?
110
86
 
111
- ### subtitle
87
+ > `optional` **progressActionLabel**: `string`
112
88
 
113
- • `Optional` **subtitle**: `ReactNode`
89
+ Defined in: [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L18)
114
90
 
115
91
  #### Inherited from
116
92
 
117
- [SnackbarDescriptor](SnackbarDescriptor.md).[subtitle](SnackbarDescriptor.md#subtitle)
118
-
119
- #### Defined in
93
+ [`SnackbarDescriptor`](SnackbarDescriptor.md).[`progressActionLabel`](SnackbarDescriptor.md#progressactionlabel)
120
94
 
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)
95
+ ***
122
96
 
123
- ___
97
+ ### subtitle?
124
98
 
125
- ### timeoutInMs
99
+ > `optional` **subtitle**: `ReactNode`
126
100
 
127
- • `Optional` **timeoutInMs**: `number`
101
+ Defined in: [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L19)
128
102
 
129
103
  #### Inherited from
130
104
 
131
- [SnackbarDescriptor](SnackbarDescriptor.md).[timeoutInMs](SnackbarDescriptor.md#timeoutinms)
132
-
133
- #### Defined in
105
+ [`SnackbarDescriptor`](SnackbarDescriptor.md).[`subtitle`](SnackbarDescriptor.md#subtitle)
134
106
 
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)
107
+ ***
136
108
 
137
- ___
109
+ ### timeoutInMs?
138
110
 
139
- ### title
111
+ > `optional` **timeoutInMs**: `number`
140
112
 
141
- • **title**: `string`
113
+ Defined in: [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:20](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L20)
142
114
 
143
115
  #### Inherited from
144
116
 
145
- [SnackbarDescriptor](SnackbarDescriptor.md).[title](SnackbarDescriptor.md#title)
146
-
147
- #### Defined in
148
-
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)
117
+ [`SnackbarDescriptor`](SnackbarDescriptor.md).[`timeoutInMs`](SnackbarDescriptor.md#timeoutinms)
150
118
 
151
- ## UI Methods
119
+ ***
152
120
 
153
- ### onActionButtonClick
154
-
155
- ▸ `Optional` **onActionButtonClick**(): `void`
121
+ ### title
156
122
 
157
- #### Returns
123
+ > **title**: `string`
158
124
 
159
- `void`
125
+ Defined in: [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L22)
160
126
 
161
127
  #### Inherited from
162
128
 
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)
129
+ [`SnackbarDescriptor`](SnackbarDescriptor.md).[`title`](SnackbarDescriptor.md#title)
package/docs/interfaces/SpaConfig.md CHANGED
@@ -1,79 +1,69 @@
1
- [@openmrs/esm-framework](../API.md) / SpaConfig
1
+ [O3 Framework](../API.md) / SpaConfig
2
2
 
3
3
  # Interface: SpaConfig
4
4
 
5
- The configuration passed to the app shell initialization function
6
-
7
- ## Table of contents
8
-
9
- ### Properties
5
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:80
10
6
 
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)
7
+ The configuration passed to the app shell initialization function
16
8
 
17
9
  ## Properties
18
10
 
19
11
  ### apiUrl
20
12
 
21
- • **apiUrl**: `string`
13
+ > **apiUrl**: `string`
22
14
 
23
- The base path or URL for the OpenMRS API / endpoints.
15
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:84
24
16
 
25
- #### Defined in
17
+ The base path or URL for the OpenMRS API / endpoints.
26
18
 
27
- packages/framework/esm-globals/dist/types.d.ts:84
19
+ ***
28
20
 
29
- ___
21
+ ### configUrls?
30
22
 
31
- ### configUrls
23
+ > `optional` **configUrls**: `string`[]
32
24
 
33
- • `Optional` **configUrls**: `string`[]
25
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:97
34
26
 
35
27
  URLs of configurations to load in the system.
36
28
 
37
- #### Defined in
29
+ ***
38
30
 
39
- packages/framework/esm-globals/dist/types.d.ts:97
31
+ ### env?
40
32
 
41
- ___
33
+ > `optional` **env**: [`SpaEnvironment`](../type-aliases/SpaEnvironment.md)
42
34
 
43
- ### env
44
-
45
- • `Optional` **env**: [`SpaEnvironment`](../API.md#spaenvironment)
35
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:93
46
36
 
47
37
  The environment to use.
48
38
 
49
- **`default`** production
39
+ #### Default
50
40
 
51
- #### Defined in
41
+ ```ts
42
+ production
43
+ ```
52
44
 
53
- packages/framework/esm-globals/dist/types.d.ts:93
45
+ ***
54
46
 
55
- ___
47
+ ### offline?
56
48
 
57
- ### offline
49
+ > `optional` **offline**: `boolean`
58
50
 
59
- • `Optional` **offline**: `boolean`
51
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:102
60
52
 
61
53
  Defines if offline should be supported by installing a service worker.
62
54
 
63
- **`default`** true
64
-
65
- #### Defined in
55
+ #### Default
66
56
 
67
- packages/framework/esm-globals/dist/types.d.ts:102
57
+ ```ts
58
+ true
59
+ ```
68
60
 
69
- ___
61
+ ***
70
62
 
71
63
  ### spaPath
72
64
 
73
- • **spaPath**: `string`
65
+ > **spaPath**: `string`
74
66
 
75
- The base path for the SPA root path.
67
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:88
76
68
 
77
- #### Defined in
78
-
79
- packages/framework/esm-globals/dist/types.d.ts:88
69
+ The base path for the SPA root path.
package/docs/interfaces/StyleguideConfigObject.md CHANGED
@@ -1,128 +1,97 @@
1
- [@openmrs/esm-framework](../API.md) / StyleguideConfigObject
1
+ [O3 Framework](../API.md) / StyleguideConfigObject
2
2
 
3
3
  # Interface: StyleguideConfigObject
4
4
 
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)
5
+ Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/config-schema.ts#L3)
18
6
 
19
7
  ## Properties
20
8
 
21
9
  ### Brand color #1
22
10
 
23
- • **Brand color #1**: `string`
24
-
25
- #### Defined in
11
+ > **Brand color #1**: `string`
26
12
 
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)
13
+ Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/config-schema.ts#L4)
28
14
 
29
- ___
15
+ ***
30
16
 
31
17
  ### Brand color #2
32
18
 
33
- • **Brand color #2**: `string`
19
+ > **Brand color #2**: `string`
34
20
 
35
- #### Defined in
21
+ Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/config-schema.ts#L5)
36
22
 
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
- ___
23
+ ***
40
24
 
41
25
  ### Brand color #3
42
26
 
43
- • **Brand color #3**: `string`
44
-
45
- #### Defined in
27
+ > **Brand color #3**: `string`
46
28
 
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)
29
+ Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/config-schema.ts#L6)
48
30
 
49
- ___
31
+ ***
50
32
 
51
33
  ### diagnosisTags
52
34
 
53
- • **diagnosisTags**: `Object`
35
+ > **diagnosisTags**: `object`
54
36
 
55
- #### Type declaration
37
+ Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/config-schema.ts#L18)
56
38
 
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"`` |
39
+ #### primaryColor
61
40
 
62
- #### Defined in
41
+ > **primaryColor**: `"blue"` \| `"cyan"` \| `"gray"` \| `"green"` \| `"magenta"` \| `"purple"` \| `"red"` \| `"teal"` \| `"warm-gray"` \| `"cool-gray"` \| `"high-contrast"` \| `"outline"`
63
42
 
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)
43
+ #### secondaryColor
65
44
 
66
- ___
45
+ > **secondaryColor**: `"blue"` \| `"cyan"` \| `"gray"` \| `"green"` \| `"magenta"` \| `"purple"` \| `"red"` \| `"teal"` \| `"warm-gray"` \| `"cool-gray"` \| `"high-contrast"` \| `"outline"`
67
46
 
68
- ### excludePatientIdentifierCodeTypes
47
+ ***
69
48
 
70
- • **excludePatientIdentifierCodeTypes**: `Object`
49
+ ### excludePatientIdentifierCodeTypes
71
50
 
72
- #### Type declaration
51
+ > **excludePatientIdentifierCodeTypes**: `object`
73
52
 
74
- | Name | Type |
75
- | :------ | :------ |
76
- | `uuids` | `string`[] |
53
+ Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/config-schema.ts#L7)
77
54
 
78
- #### Defined in
55
+ #### uuids
79
56
 
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)
57
+ > **uuids**: `string`[]
81
58
 
82
- ___
59
+ ***
83
60
 
84
61
  ### implementationName
85
62
 
86
- • **implementationName**: `string`
87
-
88
- #### Defined in
63
+ > **implementationName**: `string`
89
64
 
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)
65
+ Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/config-schema.ts#L10)
91
66
 
92
- ___
67
+ ***
93
68
 
94
69
  ### patientPhotoConceptUuid
95
70
 
96
- • **patientPhotoConceptUuid**: `string`
97
-
98
- #### Defined in
71
+ > **patientPhotoConceptUuid**: `string`
99
72
 
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)
73
+ Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/config-schema.ts#L11)
101
74
 
102
- ___
75
+ ***
103
76
 
104
77
  ### preferredCalendar
105
78
 
106
- • **preferredCalendar**: `Object`
79
+ > **preferredCalendar**: `object`
107
80
 
108
- #### Index signature
81
+ Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/config-schema.ts#L12)
109
82
 
110
- ▪ [key: `string`]: `string`
83
+ #### Index Signature
111
84
 
112
- #### Defined in
85
+ \[`key`: `string`\]: `string`
113
86
 
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
- ___
87
+ ***
117
88
 
118
89
  ### preferredDateLocale
119
90
 
120
- • **preferredDateLocale**: `Object`
121
-
122
- #### Index signature
91
+ > **preferredDateLocale**: `object`
123
92
 
124
- ▪ [key: `string`]: `string`
93
+ Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/config-schema.ts#L15)
125
94
 
126
- #### Defined in
95
+ #### Index Signature
127
96
 
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)
97
+ \[`key`: `string`\]: `string`
package/docs/interfaces/SyncItem.md CHANGED
@@ -1,102 +1,79 @@
1
- [@openmrs/esm-framework](../API.md) / SyncItem
1
+ [O3 Framework](../API.md) / SyncItem
2
2
 
3
- # Interface: SyncItem<T\>
3
+ # Interface: SyncItem\<T\>
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)
4
6
 
5
7
  Defines an item queued up in the offline synchronization queue.
6
8
  A `SyncItem` contains both meta information about the item in the sync queue, as well as the
7
9
  actual data to be synchronized (i.e. the item's `content`).
8
10
 
9
- ## Type parameters
10
-
11
- | Name | Type |
12
- | :------ | :------ |
13
- | `T` | `any` |
11
+ ## Type Parameters
14
12
 
15
- ## Table of contents
13
+ ### T
16
14
 
17
- ### Offline Properties
15
+ `T` = `any`
18
16
 
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
17
+ ## Properties
28
18
 
29
19
  ### content
30
20
 
31
- • **content**: `T`
32
-
33
- #### Defined in
21
+ > **content**: `T`
34
22
 
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)
23
+ Defined in: [packages/framework/esm-offline/src/sync.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/sync.ts#L16)
36
24
 
37
- ___
25
+ ***
38
26
 
39
27
  ### createdOn
40
28
 
41
- • **createdOn**: `Date`
29
+ > **createdOn**: `Date`
42
30
 
43
- #### Defined in
31
+ Defined in: [packages/framework/esm-offline/src/sync.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/sync.ts#L17)
44
32
 
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
- ___
33
+ ***
48
34
 
49
35
  ### descriptor
50
36
 
51
- • **descriptor**: [`QueueItemDescriptor`](QueueItemDescriptor.md)
52
-
53
- #### Defined in
37
+ > **descriptor**: [`QueueItemDescriptor`](QueueItemDescriptor.md)
54
38
 
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)
39
+ Defined in: [packages/framework/esm-offline/src/sync.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/sync.ts#L18)
56
40
 
57
- ___
41
+ ***
58
42
 
59
- ### id
43
+ ### id?
60
44
 
61
- • `Optional` **id**: `number`
45
+ > `optional` **id**: `number`
62
46
 
63
- #### Defined in
47
+ Defined in: [packages/framework/esm-offline/src/sync.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/sync.ts#L13)
64
48
 
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)
49
+ ***
66
50
 
67
- ___
51
+ ### lastError?
68
52
 
69
- ### lastError
53
+ > `optional` **lastError**: `object`
70
54
 
71
- • `Optional` **lastError**: `Object`
55
+ Defined in: [packages/framework/esm-offline/src/sync.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/sync.ts#L19)
72
56
 
73
- #### Type declaration
57
+ #### message?
74
58
 
75
- | Name | Type |
76
- | :------ | :------ |
77
- | `message?` | `string` |
78
- | `name?` | `string` |
59
+ > `optional` **message**: `string`
79
60
 
80
- #### Defined in
61
+ #### name?
81
62
 
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)
63
+ > `optional` **name**: `string`
83
64
 
84
- ___
65
+ ***
85
66
 
86
67
  ### type
87
68
 
88
- • **type**: `string`
69
+ > **type**: `string`
89
70
 
90
- #### Defined in
71
+ Defined in: [packages/framework/esm-offline/src/sync.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/sync.ts#L15)
91
72
 
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
- ___
73
+ ***
95
74
 
96
75
  ### userId
97
76
 
98
- • **userId**: `string`
99
-
100
- #### Defined in
77
+ > **userId**: `string`
101
78
 
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)
79
+ Defined in: [packages/framework/esm-offline/src/sync.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/sync.ts#L14)