@openmrs/esm-framework 6.3.1-pre.3106 → 6.3.1-pre.3119

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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 +32 -62
  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 +30 -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 -3
  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
@@ -1,701 +1,570 @@
1
- [@openmrs/esm-framework](../API.md) / OpenmrsDatePickerProps
1
+ [O3 Framework](../API.md) / OpenmrsDatePickerProps
2
2
 
3
3
  # Interface: OpenmrsDatePickerProps
4
4
 
5
+ Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:46](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L46)
6
+
5
7
  Properties for the OpenmrsDatePicker
6
8
 
7
- ## Hierarchy
8
-
9
- - `Omit`<`DatePickerProps`<`CalendarDate`\>, ``"className"`` \| ``"onChange"`` \| ``"defaultValue"`` \| ``"value"``\>
10
-
11
- ↳ **`OpenmrsDatePickerProps`**
12
-
13
- ## Table of contents
14
-
15
- ### Properties
16
-
17
- - [aria-describedby](OpenmrsDatePickerProps.md#aria-describedby)
18
- - [aria-details](OpenmrsDatePickerProps.md#aria-details)
19
- - [aria-label](OpenmrsDatePickerProps.md#aria-label)
20
- - [aria-labelledby](OpenmrsDatePickerProps.md#aria-labelledby)
21
- - [autoFocus](OpenmrsDatePickerProps.md#autofocus)
22
- - [children](OpenmrsDatePickerProps.md#children)
23
- - [className](OpenmrsDatePickerProps.md#classname)
24
- - [defaultOpen](OpenmrsDatePickerProps.md#defaultopen)
25
- - [defaultValue](OpenmrsDatePickerProps.md#defaultvalue)
26
- - [firstDayOfWeek](OpenmrsDatePickerProps.md#firstdayofweek)
27
- - [granularity](OpenmrsDatePickerProps.md#granularity)
28
- - [hideTimeZone](OpenmrsDatePickerProps.md#hidetimezone)
29
- - [hourCycle](OpenmrsDatePickerProps.md#hourcycle)
30
- - [id](OpenmrsDatePickerProps.md#id)
31
- - [invalid](OpenmrsDatePickerProps.md#invalid)
32
- - [invalidText](OpenmrsDatePickerProps.md#invalidtext)
33
- - [isDisabled](OpenmrsDatePickerProps.md#isdisabled)
34
- - [isInvalid](OpenmrsDatePickerProps.md#isinvalid)
35
- - [isOpen](OpenmrsDatePickerProps.md#isopen)
36
- - [isReadOnly](OpenmrsDatePickerProps.md#isreadonly)
37
- - [isRequired](OpenmrsDatePickerProps.md#isrequired)
38
- - [label](OpenmrsDatePickerProps.md#label)
39
- - [labelText](OpenmrsDatePickerProps.md#labeltext)
40
- - [light](OpenmrsDatePickerProps.md#light)
41
- - [maxDate](OpenmrsDatePickerProps.md#maxdate)
42
- - [maxValue](OpenmrsDatePickerProps.md#maxvalue)
43
- - [minDate](OpenmrsDatePickerProps.md#mindate)
44
- - [minValue](OpenmrsDatePickerProps.md#minvalue)
45
- - [name](OpenmrsDatePickerProps.md#name)
46
- - [pageBehavior](OpenmrsDatePickerProps.md#pagebehavior)
47
- - [placeholderValue](OpenmrsDatePickerProps.md#placeholdervalue)
48
- - [short](OpenmrsDatePickerProps.md#short)
49
- - [shouldCloseOnSelect](OpenmrsDatePickerProps.md#shouldcloseonselect)
50
- - [shouldForceLeadingZeros](OpenmrsDatePickerProps.md#shouldforceleadingzeros)
51
- - [size](OpenmrsDatePickerProps.md#size)
52
- - [slot](OpenmrsDatePickerProps.md#slot)
53
- - [style](OpenmrsDatePickerProps.md#style)
54
- - [validationBehavior](OpenmrsDatePickerProps.md#validationbehavior)
55
- - [value](OpenmrsDatePickerProps.md#value)
56
-
57
- ### Methods
58
-
59
- - [isDateUnavailable](OpenmrsDatePickerProps.md#isdateunavailable)
60
- - [onBlur](OpenmrsDatePickerProps.md#onblur)
61
- - [onChange](OpenmrsDatePickerProps.md#onchange)
62
- - [onChangeRaw](OpenmrsDatePickerProps.md#onchangeraw)
63
- - [onFocus](OpenmrsDatePickerProps.md#onfocus)
64
- - [onFocusChange](OpenmrsDatePickerProps.md#onfocuschange)
65
- - [onKeyDown](OpenmrsDatePickerProps.md#onkeydown)
66
- - [onKeyUp](OpenmrsDatePickerProps.md#onkeyup)
67
- - [onOpenChange](OpenmrsDatePickerProps.md#onopenchange)
68
- - [validate](OpenmrsDatePickerProps.md#validate)
9
+ ## Extends
10
+
11
+ - `Omit`\<`DatePickerProps`\<`CalendarDate`\>, `"className"` \| `"onChange"` \| `"defaultValue"` \| `"value"`\>
69
12
 
70
13
  ## Properties
71
14
 
72
- ### aria-describedby
15
+ ### aria-describedby?
16
+
17
+ > `optional` **aria-describedby**: `string`
73
18
 
74
- `Optional` **aria-describedby**: `string`
19
+ Defined in: node\_modules/@react-types/shared/src/dom.d.ts:40
75
20
 
76
21
  Identifies the element (or elements) that describes the object.
77
22
 
78
23
  #### Inherited from
79
24
 
80
- Omit.aria-describedby
25
+ `Omit.aria-describedby`
81
26
 
82
- #### Defined in
27
+ ***
83
28
 
84
- node_modules/@react-types/shared/src/dom.d.ts:40
29
+ ### aria-details?
85
30
 
86
- ___
31
+ > `optional` **aria-details**: `string`
87
32
 
88
- ### aria-details
89
-
90
- • `Optional` **aria-details**: `string`
33
+ Defined in: node\_modules/@react-types/shared/src/dom.d.ts:45
91
34
 
92
35
  Identifies the element (or elements) that provide a detailed, extended description for the object.
93
36
 
94
37
  #### Inherited from
95
38
 
96
- Omit.aria-details
97
-
98
- #### Defined in
39
+ `Omit.aria-details`
99
40
 
100
- node_modules/@react-types/shared/src/dom.d.ts:45
41
+ ***
101
42
 
102
- ___
43
+ ### aria-label?
103
44
 
104
- ### aria-label
45
+ > `optional` **aria-label**: `string`
105
46
 
106
- `Optional` **aria-label**: `string`
47
+ Defined in: node\_modules/@react-types/shared/src/dom.d.ts:30
107
48
 
108
49
  Defines a string value that labels the current element.
109
50
 
110
51
  #### Inherited from
111
52
 
112
- Omit.aria-label
113
-
114
- #### Defined in
53
+ `Omit.aria-label`
115
54
 
116
- node_modules/@react-types/shared/src/dom.d.ts:30
55
+ ***
117
56
 
118
- ___
57
+ ### aria-labelledby?
119
58
 
120
- ### aria-labelledby
59
+ > `optional` **aria-labelledby**: `string`
121
60
 
122
- `Optional` **aria-labelledby**: `string`
61
+ Defined in: node\_modules/@react-types/shared/src/dom.d.ts:35
123
62
 
124
63
  Identifies the element (or elements) that labels the current element.
125
64
 
126
65
  #### Inherited from
127
66
 
128
- Omit.aria-labelledby
67
+ `Omit.aria-labelledby`
129
68
 
130
- #### Defined in
69
+ ***
131
70
 
132
- node_modules/@react-types/shared/src/dom.d.ts:35
71
+ ### autoFocus?
133
72
 
134
- ___
73
+ > `optional` **autoFocus**: `boolean`
135
74
 
136
- ### autoFocus
137
-
138
- • `Optional` **autoFocus**: `boolean`
75
+ Defined in: node\_modules/@react-types/shared/src/events.d.ts:128
139
76
 
140
77
  Whether the element should receive focus on render.
141
78
 
142
79
  #### Inherited from
143
80
 
144
- Omit.autoFocus
145
-
146
- #### Defined in
81
+ `Omit.autoFocus`
147
82
 
148
- node_modules/@react-types/shared/src/events.d.ts:128
83
+ ***
149
84
 
150
- ___
85
+ ### children?
151
86
 
152
- ### children
87
+ > `optional` **children**: `ReactNode` \| (`values`) => `ReactNode`
153
88
 
154
- `Optional` **children**: `ReactNode` \| (`values`: `DatePickerRenderProps` & { `defaultChildren`: `ReactNode` }) => `ReactNode`
89
+ Defined in: node\_modules/react-aria-components/dist/types.d.ts:53
155
90
 
156
91
  The children of the component. A function may be provided to alter the children based on component state.
157
92
 
158
93
  #### Inherited from
159
94
 
160
- Omit.children
161
-
162
- #### Defined in
95
+ `Omit.children`
163
96
 
164
- node_modules/react-aria-components/dist/types.d.ts:53
97
+ ***
165
98
 
166
- ___
99
+ ### className?
167
100
 
168
- ### className
101
+ > `optional` **className**: `Argument`
169
102
 
170
- `Optional` **className**: `Argument`
103
+ Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:50](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L50)
171
104
 
172
105
  Any CSS classes to add to the outer div of the date picker
173
106
 
174
- #### Defined in
107
+ ***
175
108
 
176
- [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:50](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L50)
109
+ ### defaultOpen?
177
110
 
178
- ___
111
+ > `optional` **defaultOpen**: `boolean`
179
112
 
180
- ### defaultOpen
181
-
182
- • `Optional` **defaultOpen**: `boolean`
113
+ Defined in: node\_modules/@react-types/overlays/src/index.d.ts:112
183
114
 
184
115
  Whether the overlay is open by default (uncontrolled).
185
116
 
186
117
  #### Inherited from
187
118
 
188
- Omit.defaultOpen
189
-
190
- #### Defined in
119
+ `Omit.defaultOpen`
191
120
 
192
- node_modules/@react-types/overlays/src/index.d.ts:112
121
+ ***
193
122
 
194
- ___
123
+ ### defaultValue?
195
124
 
196
- ### defaultValue
125
+ > `optional` **defaultValue**: `DateInputValue`
197
126
 
198
- `Optional` **defaultValue**: `DateInputValue`
127
+ Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L52)
199
128
 
200
129
  The default value (uncontrolled)
201
130
 
202
- #### Defined in
203
-
204
- [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L52)
131
+ ***
205
132
 
206
- ___
133
+ ### firstDayOfWeek?
207
134
 
208
- ### firstDayOfWeek
135
+ > `optional` **firstDayOfWeek**: `"sun"` \| `"mon"` \| `"tue"` \| `"wed"` \| `"thu"` \| `"fri"` \| `"sat"`
209
136
 
210
- `Optional` **firstDayOfWeek**: ``"sun"`` \| ``"mon"`` \| ``"tue"`` \| ``"wed"`` \| ``"thu"`` \| ``"fri"`` \| ``"sat"``
137
+ Defined in: node\_modules/@react-types/datepicker/src/index.d.ts:78
211
138
 
212
139
  The day that starts the week.
213
140
 
214
141
  #### Inherited from
215
142
 
216
- Omit.firstDayOfWeek
143
+ `Omit.firstDayOfWeek`
217
144
 
218
- #### Defined in
145
+ ***
219
146
 
220
- node_modules/@react-types/datepicker/src/index.d.ts:78
147
+ ### granularity?
221
148
 
222
- ___
149
+ > `optional` **granularity**: `Granularity`
223
150
 
224
- ### granularity
225
-
226
- • `Optional` **granularity**: `Granularity`
151
+ Defined in: node\_modules/@react-types/datepicker/src/index.d.ts:52
227
152
 
228
153
  Determines the smallest unit that is displayed in the date picker. By default, this is `"day"` for dates, and `"minute"` for times.
229
154
 
230
155
  #### Inherited from
231
156
 
232
- Omit.granularity
233
-
234
- #### Defined in
157
+ `Omit.granularity`
235
158
 
236
- node_modules/@react-types/datepicker/src/index.d.ts:52
159
+ ***
237
160
 
238
- ___
161
+ ### hideTimeZone?
239
162
 
240
- ### hideTimeZone
163
+ > `optional` **hideTimeZone**: `boolean`
241
164
 
242
- `Optional` **hideTimeZone**: `boolean`
165
+ Defined in: node\_modules/@react-types/datepicker/src/index.d.ts:57
243
166
 
244
167
  Whether to hide the time zone abbreviation.
245
168
 
246
- **`default`** false
169
+ #### Default
247
170
 
248
- #### Inherited from
171
+ ```ts
172
+ false
173
+ ```
249
174
 
250
- Omit.hideTimeZone
175
+ #### Inherited from
251
176
 
252
- #### Defined in
177
+ `Omit.hideTimeZone`
253
178
 
254
- node_modules/@react-types/datepicker/src/index.d.ts:57
179
+ ***
255
180
 
256
- ___
181
+ ### hourCycle?
257
182
 
258
- ### hourCycle
183
+ > `optional` **hourCycle**: `12` \| `24`
259
184
 
260
- `Optional` **hourCycle**: ``12`` \| ``24``
185
+ Defined in: node\_modules/@react-types/datepicker/src/index.d.ts:50
261
186
 
262
187
  Whether to display the time in 12 or 24 hour format. By default, this is determined by the user's locale.
263
188
 
264
189
  #### Inherited from
265
190
 
266
- Omit.hourCycle
267
-
268
- #### Defined in
191
+ `Omit.hourCycle`
269
192
 
270
- node_modules/@react-types/datepicker/src/index.d.ts:50
193
+ ***
271
194
 
272
- ___
195
+ ### id?
273
196
 
274
- ### id
197
+ > `optional` **id**: `string`
275
198
 
276
- `Optional` **id**: `string`
199
+ Defined in: node\_modules/@react-types/shared/src/dom.d.ts:62
277
200
 
278
201
  The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id).
279
202
 
280
203
  #### Inherited from
281
204
 
282
- Omit.id
283
-
284
- #### Defined in
205
+ `Omit.id`
285
206
 
286
- node_modules/@react-types/shared/src/dom.d.ts:62
207
+ ***
287
208
 
288
- ___
209
+ ### invalid?
289
210
 
290
- ### invalid
211
+ > `optional` **invalid**: `boolean`
291
212
 
292
- `Optional` **invalid**: `boolean`
213
+ Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:54](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L54)
293
214
 
294
215
  Whether the input value is invalid.
295
216
 
296
- #### Defined in
217
+ ***
297
218
 
298
- [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:54](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L54)
219
+ ### invalidText?
299
220
 
300
- ___
221
+ > `optional` **invalidText**: `string`
301
222
 
302
- ### invalidText
303
-
304
- • `Optional` **invalidText**: `string`
223
+ Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:56](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L56)
305
224
 
306
225
  Text to show if the input is invalid e.g. an error message
307
226
 
308
- #### Defined in
227
+ ***
309
228
 
310
- [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:56](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L56)
229
+ ### isDateUnavailable()?
311
230
 
312
- ___
231
+ > `optional` **isDateUnavailable**: (`date`) => `boolean`
313
232
 
314
- ### isDisabled
233
+ Defined in: node\_modules/@react-types/datepicker/src/index.d.ts:46
315
234
 
316
- `Optional` **isDisabled**: `boolean`
235
+ Callback that is called for each date of the calendar. If it returns true, then the date is unavailable.
317
236
 
318
- Whether the input is disabled.
237
+ #### Parameters
238
+
239
+ ##### date
240
+
241
+ `DateValue`
242
+
243
+ #### Returns
244
+
245
+ `boolean`
319
246
 
320
247
  #### Inherited from
321
248
 
322
- Omit.isDisabled
249
+ `Omit.isDateUnavailable`
250
+
251
+ ***
252
+
253
+ ### isDisabled?
254
+
255
+ > `optional` **isDisabled**: `boolean`
256
+
257
+ Defined in: node\_modules/@react-types/shared/src/inputs.d.ts:60
258
+
259
+ Whether the input is disabled.
260
+
261
+ #### Inherited from
323
262
 
324
- #### Defined in
263
+ `Omit.isDisabled`
325
264
 
326
- node_modules/@react-types/shared/src/inputs.d.ts:60
265
+ ***
327
266
 
328
- ___
267
+ ### isInvalid?
329
268
 
330
- ### isInvalid
269
+ > `optional` **isInvalid**: `boolean`
331
270
 
332
- `Optional` **isInvalid**: `boolean`
271
+ Defined in: node\_modules/@react-types/shared/src/inputs.d.ts:25
333
272
 
334
273
  Whether the input value is invalid.
335
274
 
336
275
  #### Inherited from
337
276
 
338
- Omit.isInvalid
339
-
340
- #### Defined in
277
+ `Omit.isInvalid`
341
278
 
342
- node_modules/@react-types/shared/src/inputs.d.ts:25
279
+ ***
343
280
 
344
- ___
281
+ ### isOpen?
345
282
 
346
- ### isOpen
283
+ > `optional` **isOpen**: `boolean`
347
284
 
348
- `Optional` **isOpen**: `boolean`
285
+ Defined in: node\_modules/@react-types/overlays/src/index.d.ts:110
349
286
 
350
287
  Whether the overlay is open by default (controlled).
351
288
 
352
289
  #### Inherited from
353
290
 
354
- Omit.isOpen
291
+ `Omit.isOpen`
355
292
 
356
- #### Defined in
293
+ ***
357
294
 
358
- node_modules/@react-types/overlays/src/index.d.ts:110
295
+ ### isReadOnly?
359
296
 
360
- ___
297
+ > `optional` **isReadOnly**: `boolean`
361
298
 
362
- ### isReadOnly
363
-
364
- • `Optional` **isReadOnly**: `boolean`
299
+ Defined in: node\_modules/@react-types/shared/src/inputs.d.ts:62
365
300
 
366
301
  Whether the input can be selected but not changed by the user.
367
302
 
368
303
  #### Inherited from
369
304
 
370
- Omit.isReadOnly
371
-
372
- #### Defined in
305
+ `Omit.isReadOnly`
373
306
 
374
- node_modules/@react-types/shared/src/inputs.d.ts:62
307
+ ***
375
308
 
376
- ___
309
+ ### isRequired?
377
310
 
378
- ### isRequired
311
+ > `optional` **isRequired**: `boolean`
379
312
 
380
- `Optional` **isRequired**: `boolean`
313
+ Defined in: node\_modules/@react-types/shared/src/inputs.d.ts:23
381
314
 
382
315
  Whether user input is required on the input before form submission.
383
316
 
384
317
  #### Inherited from
385
318
 
386
- Omit.isRequired
387
-
388
- #### Defined in
319
+ `Omit.isRequired`
389
320
 
390
- node_modules/@react-types/shared/src/inputs.d.ts:23
321
+ ***
391
322
 
392
- ___
323
+ ### ~~label?~~
393
324
 
394
- ### label
325
+ > `optional` **label**: `string` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\>
395
326
 
396
- `Optional` **label**: `string` \| `ReactElement`<`any`, `string` \| `JSXElementConstructor`<`any`\>\>
327
+ Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:61](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L61)
397
328
 
398
329
  The label for this DatePicker element
399
330
 
400
- **`deprecated`** Use labelText instead
331
+ #### Deprecated
401
332
 
402
- #### Defined in
333
+ Use labelText instead
403
334
 
404
- [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:61](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L61)
335
+ ***
405
336
 
406
- ___
337
+ ### labelText?
407
338
 
408
- ### labelText
339
+ > `optional` **labelText**: `string` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\>
409
340
 
410
- `Optional` **labelText**: `string` \| `ReactElement`<`any`, `string` \| `JSXElementConstructor`<`any`\>\>
341
+ Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:63](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L63)
411
342
 
412
343
  The label for this DatePicker element.
413
344
 
414
- #### Defined in
345
+ ***
415
346
 
416
- [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:63](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L63)
347
+ ### light?
417
348
 
418
- ___
349
+ > `optional` **light**: `boolean`
419
350
 
420
- ### light
421
-
422
- • `Optional` **light**: `boolean`
351
+ Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:65](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L65)
423
352
 
424
353
  'true' to use the light version.
425
354
 
426
- #### Defined in
427
-
428
- [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:65](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L65)
355
+ ***
429
356
 
430
- ___
357
+ ### maxDate?
431
358
 
432
- ### maxDate
359
+ > `optional` **maxDate**: `DateInputValue`
433
360
 
434
- `Optional` **maxDate**: `DateInputValue`
361
+ Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:67](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L67)
435
362
 
436
363
  The latest date it is possible to select
437
364
 
438
- #### Defined in
439
-
440
- [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:67](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L67)
365
+ ***
441
366
 
442
- ___
367
+ ### maxValue?
443
368
 
444
- ### maxValue
369
+ > `optional` **maxValue**: `null` \| `DateValue`
445
370
 
446
- `Optional` **maxValue**: ``null`` \| `DateValue`
371
+ Defined in: node\_modules/@react-types/datepicker/src/index.d.ts:44
447
372
 
448
373
  The maximum allowed date that a user may select.
449
374
 
450
375
  #### Inherited from
451
376
 
452
- Omit.maxValue
377
+ `Omit.maxValue`
453
378
 
454
- #### Defined in
379
+ ***
455
380
 
456
- node_modules/@react-types/datepicker/src/index.d.ts:44
381
+ ### minDate?
457
382
 
458
- ___
383
+ > `optional` **minDate**: `DateInputValue`
459
384
 
460
- ### minDate
461
-
462
- • `Optional` **minDate**: `DateInputValue`
385
+ Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:69](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L69)
463
386
 
464
387
  The earliest date it is possible to select
465
388
 
466
- #### Defined in
467
-
468
- [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:69](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L69)
389
+ ***
469
390
 
470
- ___
391
+ ### minValue?
471
392
 
472
- ### minValue
393
+ > `optional` **minValue**: `null` \| `DateValue`
473
394
 
474
- `Optional` **minValue**: ``null`` \| `DateValue`
395
+ Defined in: node\_modules/@react-types/datepicker/src/index.d.ts:42
475
396
 
476
397
  The minimum allowed date that a user may select.
477
398
 
478
399
  #### Inherited from
479
400
 
480
- Omit.minValue
401
+ `Omit.minValue`
481
402
 
482
- #### Defined in
403
+ ***
483
404
 
484
- node_modules/@react-types/datepicker/src/index.d.ts:42
405
+ ### name?
485
406
 
486
- ___
407
+ > `optional` **name**: `string`
487
408
 
488
- ### name
489
-
490
- • `Optional` **name**: `string`
409
+ Defined in: node\_modules/@react-types/shared/src/dom.d.ts:130
491
410
 
492
411
  The name of the input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname).
493
412
 
494
413
  #### Inherited from
495
414
 
496
- Omit.name
497
-
498
- #### Defined in
499
-
500
- node_modules/@react-types/shared/src/dom.d.ts:130
501
-
502
- ___
503
-
504
- ### pageBehavior
505
-
506
- • `Optional` **pageBehavior**: `PageBehavior`
415
+ `Omit.name`
507
416
 
508
- Controls the behavior of paging. Pagination either works by advancing the visible page by visibleDuration (default) or one unit of visibleDuration.
417
+ ***
509
418
 
510
- **`default`** visible
419
+ ### onBlur()?
511
420
 
512
- #### Inherited from
421
+ > `optional` **onBlur**: (`e`) => `void`
513
422
 
514
- Omit.pageBehavior
423
+ Defined in: node\_modules/@react-types/shared/src/events.d.ts:87
515
424
 
516
- #### Defined in
425
+ Handler that is called when the element loses focus.
517
426
 
518
- node_modules/@react-types/datepicker/src/index.d.ts:74
427
+ #### Parameters
519
428
 
520
- ___
429
+ ##### e
521
430
 
522
- ### placeholderValue
431
+ `FocusEvent`\<`Element`\>
523
432
 
524
- `Optional` **placeholderValue**: ``null`` \| `CalendarDate`
433
+ #### Returns
525
434
 
526
- A placeholder date that influences the format of the placeholder shown when no value is selected. Defaults to today's date at midnight.
435
+ `void`
527
436
 
528
437
  #### Inherited from
529
438
 
530
- Omit.placeholderValue
531
-
532
- #### Defined in
533
-
534
- node_modules/@react-types/datepicker/src/index.d.ts:48
439
+ `Omit.onBlur`
535
440
 
536
- ___
441
+ ***
537
442
 
538
- ### short
539
-
540
- • `Optional` **short**: `boolean`
541
-
542
- 'true' to use the short version.
443
+ ### onChange()?
543
444
 
544
- #### Defined in
445
+ > `optional` **onChange**: (`value`) => `void`
545
446
 
546
- [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:77](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L77)
447
+ Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:71](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L71)
547
448
 
548
- ___
449
+ Handler that is called when the value changes.
549
450
 
550
- ### shouldCloseOnSelect
451
+ #### Parameters
551
452
 
552
- `Optional` **shouldCloseOnSelect**: `boolean` \| () => `boolean`
453
+ ##### value
553
454
 
554
- Determines whether the date picker popover should close automatically when a date is selected.
455
+ `undefined` | `null` | `Date`
555
456
 
556
- **`default`** true
557
-
558
- #### Inherited from
457
+ #### Returns
559
458
 
560
- Omit.shouldCloseOnSelect
459
+ `void`
561
460
 
562
- #### Defined in
461
+ ***
563
462
 
564
- node_modules/@react-stately/datepicker/dist/types.d.ts:21
463
+ ### onChangeRaw()?
565
464
 
566
- ___
465
+ > `optional` **onChangeRaw**: (`value`) => `void`
567
466
 
568
- ### shouldForceLeadingZeros
467
+ Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:73](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L73)
569
468
 
570
- `Optional` **shouldForceLeadingZeros**: `boolean`
469
+ Handler that is called when the value changes. Note that this provides types from @internationalized/date.
571
470
 
572
- Whether to always show leading zeros in the month, day, and hour fields.
573
- By default, this is determined by the user's locale.
471
+ #### Parameters
574
472
 
575
- #### Inherited from
473
+ ##### value
576
474
 
577
- Omit.shouldForceLeadingZeros
475
+ `null` | `DateValue`
578
476
 
579
- #### Defined in
477
+ #### Returns
580
478
 
581
- node_modules/@react-types/datepicker/src/index.d.ts:62
479
+ `void`
582
480
 
583
- ___
481
+ ***
584
482
 
585
- ### size
483
+ ### onFocus()?
586
484
 
587
- `Optional` **size**: ``"sm"`` \| ``"md"`` \| ``"lg"``
485
+ > `optional` **onFocus**: (`e`) => `void`
588
486
 
589
- Specifies the size of the input. Currently supports either `sm`, `md`, or `lg` as an option
487
+ Defined in: node\_modules/@react-types/shared/src/events.d.ts:85
590
488
 
591
- #### Defined in
489
+ Handler that is called when the element receives focus.
592
490
 
593
- [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:75](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L75)
491
+ #### Parameters
594
492
 
595
- ___
493
+ ##### e
596
494
 
597
- ### slot
495
+ `FocusEvent`\<`Element`\>
598
496
 
599
- `Optional` **slot**: ``null`` \| `string`
497
+ #### Returns
600
498
 
601
- A slot name for the component. Slots allow the component to receive props from a parent component.
602
- An explicit `null` value indicates that the local props completely override all props received from a parent.
499
+ `void`
603
500
 
604
501
  #### Inherited from
605
502
 
606
- Omit.slot
607
-
608
- #### Defined in
503
+ `Omit.onFocus`
609
504
 
610
- node_modules/react-aria-components/dist/types.d.ts:70
611
-
612
- ___
613
-
614
- ### style
615
-
616
- • `Optional` **style**: `CSSProperties` \| (`values`: `DatePickerRenderProps` & { `defaultStyle`: `CSSProperties` }) => `undefined` \| `CSSProperties`
617
-
618
- The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state.
505
+ ***
619
506
 
620
- #### Inherited from
507
+ ### onFocusChange()?
621
508
 
622
- Omit.style
509
+ > `optional` **onFocusChange**: (`isFocused`) => `void`
623
510
 
624
- #### Defined in
511
+ Defined in: node\_modules/@react-types/shared/src/events.d.ts:89
625
512
 
626
- node_modules/react-aria-components/dist/types.d.ts:47
513
+ Handler that is called when the element's focus status changes.
627
514
 
628
- ___
515
+ #### Parameters
629
516
 
630
- ### validationBehavior
517
+ ##### isFocused
631
518
 
632
- `Optional` **validationBehavior**: ``"aria"`` \| ``"native"``
519
+ `boolean`
633
520
 
634
- Whether to use native HTML form validation to prevent form submission
635
- when the value is missing or invalid, or mark the field as required
636
- or invalid via ARIA.
521
+ #### Returns
637
522
 
638
- **`default`** 'native'
523
+ `void`
639
524
 
640
525
  #### Inherited from
641
526
 
642
- Omit.validationBehavior
527
+ `Omit.onFocusChange`
643
528
 
644
- #### Defined in
529
+ ***
645
530
 
646
- node_modules/react-aria-components/dist/types.d.ts:81
531
+ ### onKeyDown()?
647
532
 
648
- ___
533
+ > `optional` **onKeyDown**: (`e`) => `void`
649
534
 
650
- ### value
651
-
652
- • `Optional` **value**: `DateInputValue`
653
-
654
- The value (controlled)
535
+ Defined in: node\_modules/@react-types/shared/src/events.d.ts:78
655
536
 
656
- #### Defined in
657
-
658
- [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:79](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L79)
659
-
660
- ## Methods
661
-
662
- ### isDateUnavailable
663
-
664
- ▸ `Optional` **isDateUnavailable**(`date`): `boolean`
665
-
666
- Callback that is called for each date of the calendar. If it returns true, then the date is unavailable.
537
+ Handler that is called when a key is pressed.
667
538
 
668
539
  #### Parameters
669
540
 
670
- | Name | Type |
671
- | :------ | :------ |
672
- | `date` | `DateValue` |
541
+ ##### e
542
+
543
+ `KeyboardEvent`
673
544
 
674
545
  #### Returns
675
546
 
676
- `boolean`
547
+ `void`
677
548
 
678
549
  #### Inherited from
679
550
 
680
- Omit.isDateUnavailable
681
-
682
- #### Defined in
551
+ `Omit.onKeyDown`
683
552
 
684
- node_modules/@react-types/datepicker/src/index.d.ts:46
553
+ ***
685
554
 
686
- ___
555
+ ### onKeyUp()?
687
556
 
688
- ### onBlur
557
+ > `optional` **onKeyUp**: (`e`) => `void`
689
558
 
690
- `Optional` **onBlur**(`e`): `void`
559
+ Defined in: node\_modules/@react-types/shared/src/events.d.ts:80
691
560
 
692
- Handler that is called when the element loses focus.
561
+ Handler that is called when a key is released.
693
562
 
694
563
  #### Parameters
695
564
 
696
- | Name | Type |
697
- | :------ | :------ |
698
- | `e` | `FocusEvent`<`Target`, `Element`\> |
565
+ ##### e
566
+
567
+ `KeyboardEvent`
699
568
 
700
569
  #### Returns
701
570
 
@@ -703,211 +572,205 @@ Handler that is called when the element loses focus.
703
572
 
704
573
  #### Inherited from
705
574
 
706
- Omit.onBlur
575
+ `Omit.onKeyUp`
707
576
 
708
- #### Defined in
577
+ ***
709
578
 
710
- node_modules/@react-types/shared/src/events.d.ts:87
579
+ ### onOpenChange()?
711
580
 
712
- ___
581
+ > `optional` **onOpenChange**: (`isOpen`) => `void`
713
582
 
714
- ### onChange
583
+ Defined in: node\_modules/@react-types/overlays/src/index.d.ts:114
715
584
 
716
- `Optional` **onChange**(`value`): `void`
717
-
718
- Handler that is called when the value changes.
585
+ Handler that is called when the overlay's open state changes.
719
586
 
720
587
  #### Parameters
721
588
 
722
- | Name | Type |
723
- | :------ | :------ |
724
- | `value` | `undefined` \| ``null`` \| `Date` |
589
+ ##### isOpen
590
+
591
+ `boolean`
725
592
 
726
593
  #### Returns
727
594
 
728
595
  `void`
729
596
 
730
- #### Defined in
597
+ #### Inherited from
731
598
 
732
- [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:71](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L71)
599
+ `Omit.onOpenChange`
733
600
 
734
- ___
601
+ ***
735
602
 
736
- ### onChangeRaw
603
+ ### pageBehavior?
737
604
 
738
- `Optional` **onChangeRaw**(`value`): `void`
605
+ > `optional` **pageBehavior**: `PageBehavior`
739
606
 
740
- Handler that is called when the value changes. Note that this provides types from @internationalized/date.
607
+ Defined in: node\_modules/@react-types/datepicker/src/index.d.ts:74
741
608
 
742
- #### Parameters
609
+ Controls the behavior of paging. Pagination either works by advancing the visible page by visibleDuration (default) or one unit of visibleDuration.
743
610
 
744
- | Name | Type |
745
- | :------ | :------ |
746
- | `value` | ``null`` \| `DateValue` |
611
+ #### Default
747
612
 
748
- #### Returns
613
+ ```ts
614
+ visible
615
+ ```
749
616
 
750
- `void`
617
+ #### Inherited from
751
618
 
752
- #### Defined in
619
+ `Omit.pageBehavior`
753
620
 
754
- [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:73](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L73)
621
+ ***
755
622
 
756
- ___
623
+ ### placeholderValue?
757
624
 
758
- ### onFocus
625
+ > `optional` **placeholderValue**: `null` \| `CalendarDate`
759
626
 
760
- `Optional` **onFocus**(`e`): `void`
627
+ Defined in: node\_modules/@react-types/datepicker/src/index.d.ts:48
761
628
 
762
- Handler that is called when the element receives focus.
629
+ A placeholder date that influences the format of the placeholder shown when no value is selected. Defaults to today's date at midnight.
763
630
 
764
- #### Parameters
631
+ #### Inherited from
765
632
 
766
- | Name | Type |
767
- | :------ | :------ |
768
- | `e` | `FocusEvent`<`Target`, `Element`\> |
633
+ `Omit.placeholderValue`
769
634
 
770
- #### Returns
635
+ ***
771
636
 
772
- `void`
637
+ ### short?
773
638
 
774
- #### Inherited from
639
+ > `optional` **short**: `boolean`
775
640
 
776
- Omit.onFocus
641
+ Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:77](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L77)
777
642
 
778
- #### Defined in
643
+ 'true' to use the short version.
779
644
 
780
- node_modules/@react-types/shared/src/events.d.ts:85
645
+ ***
781
646
 
782
- ___
647
+ ### shouldCloseOnSelect?
783
648
 
784
- ### onFocusChange
649
+ > `optional` **shouldCloseOnSelect**: `boolean` \| () => `boolean`
785
650
 
786
- `Optional` **onFocusChange**(`isFocused`): `void`
651
+ Defined in: node\_modules/@react-stately/datepicker/dist/types.d.ts:21
787
652
 
788
- Handler that is called when the element's focus status changes.
653
+ Determines whether the date picker popover should close automatically when a date is selected.
789
654
 
790
- #### Parameters
655
+ #### Default
791
656
 
792
- | Name | Type |
793
- | :------ | :------ |
794
- | `isFocused` | `boolean` |
657
+ ```ts
658
+ true
659
+ ```
795
660
 
796
- #### Returns
661
+ #### Inherited from
797
662
 
798
- `void`
663
+ `Omit.shouldCloseOnSelect`
799
664
 
800
- #### Inherited from
665
+ ***
801
666
 
802
- Omit.onFocusChange
667
+ ### shouldForceLeadingZeros?
803
668
 
804
- #### Defined in
669
+ > `optional` **shouldForceLeadingZeros**: `boolean`
805
670
 
806
- node_modules/@react-types/shared/src/events.d.ts:89
671
+ Defined in: node\_modules/@react-types/datepicker/src/index.d.ts:62
807
672
 
808
- ___
673
+ Whether to always show leading zeros in the month, day, and hour fields.
674
+ By default, this is determined by the user's locale.
809
675
 
810
- ### onKeyDown
676
+ #### Inherited from
811
677
 
812
- `Optional` **onKeyDown**(`e`): `void`
678
+ `Omit.shouldForceLeadingZeros`
813
679
 
814
- Handler that is called when a key is pressed.
680
+ ***
815
681
 
816
- #### Parameters
682
+ ### size?
817
683
 
818
- | Name | Type |
819
- | :------ | :------ |
820
- | `e` | `KeyboardEvent` |
684
+ > `optional` **size**: `"sm"` \| `"md"` \| `"lg"`
821
685
 
822
- #### Returns
686
+ Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:75](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L75)
823
687
 
824
- `void`
688
+ Specifies the size of the input. Currently supports either `sm`, `md`, or `lg` as an option
825
689
 
826
- #### Inherited from
690
+ ***
827
691
 
828
- Omit.onKeyDown
692
+ ### slot?
829
693
 
830
- #### Defined in
694
+ > `optional` **slot**: `null` \| `string`
831
695
 
832
- node_modules/@react-types/shared/src/events.d.ts:78
696
+ Defined in: node\_modules/react-aria-components/dist/types.d.ts:70
833
697
 
834
- ___
698
+ A slot name for the component. Slots allow the component to receive props from a parent component.
699
+ An explicit `null` value indicates that the local props completely override all props received from a parent.
835
700
 
836
- ### onKeyUp
701
+ #### Inherited from
837
702
 
838
- `Optional` **onKeyUp**(`e`): `void`
703
+ `Omit.slot`
839
704
 
840
- Handler that is called when a key is released.
705
+ ***
841
706
 
842
- #### Parameters
707
+ ### style?
843
708
 
844
- | Name | Type |
845
- | :------ | :------ |
846
- | `e` | `KeyboardEvent` |
709
+ > `optional` **style**: `CSSProperties` \| (`values`) => `undefined` \| `CSSProperties`
847
710
 
848
- #### Returns
711
+ Defined in: node\_modules/react-aria-components/dist/types.d.ts:47
849
712
 
850
- `void`
713
+ The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state.
851
714
 
852
715
  #### Inherited from
853
716
 
854
- Omit.onKeyUp
855
-
856
- #### Defined in
717
+ `Omit.style`
857
718
 
858
- node_modules/@react-types/shared/src/events.d.ts:80
719
+ ***
859
720
 
860
- ___
721
+ ### validate()?
861
722
 
862
- ### onOpenChange
723
+ > `optional` **validate**: (`value`) => `undefined` \| `null` \| `true` \| `ValidationError`
863
724
 
864
- `Optional` **onOpenChange**(`isOpen`): `void`
725
+ Defined in: node\_modules/@react-types/shared/src/inputs.d.ts:41
865
726
 
866
- Handler that is called when the overlay's open state changes.
727
+ A function that returns an error message if a given value is invalid.
728
+ Validation errors are displayed to the user when the form is submitted
729
+ if `validationBehavior="native"`. For realtime validation, use the `isInvalid`
730
+ prop instead.
867
731
 
868
732
  #### Parameters
869
733
 
870
- | Name | Type |
871
- | :------ | :------ |
872
- | `isOpen` | `boolean` |
734
+ ##### value
735
+
736
+ `CalendarDate`
873
737
 
874
738
  #### Returns
875
739
 
876
- `void`
740
+ `undefined` \| `null` \| `true` \| `ValidationError`
877
741
 
878
742
  #### Inherited from
879
743
 
880
- Omit.onOpenChange
744
+ `Omit.validate`
881
745
 
882
- #### Defined in
746
+ ***
883
747
 
884
- node_modules/@react-types/overlays/src/index.d.ts:114
748
+ ### validationBehavior?
885
749
 
886
- ___
750
+ > `optional` **validationBehavior**: `"aria"` \| `"native"`
887
751
 
888
- ### validate
752
+ Defined in: node\_modules/react-aria-components/dist/types.d.ts:81
889
753
 
890
- `Optional` **validate**(`value`): `undefined` \| ``null`` \| ``true`` \| `ValidationError`
754
+ Whether to use native HTML form validation to prevent form submission
755
+ when the value is missing or invalid, or mark the field as required
756
+ or invalid via ARIA.
891
757
 
892
- A function that returns an error message if a given value is invalid.
893
- Validation errors are displayed to the user when the form is submitted
894
- if `validationBehavior="native"`. For realtime validation, use the `isInvalid`
895
- prop instead.
758
+ #### Default
896
759
 
897
- #### Parameters
760
+ ```ts
761
+ 'native'
762
+ ```
898
763
 
899
- | Name | Type |
900
- | :------ | :------ |
901
- | `value` | `T` |
764
+ #### Inherited from
902
765
 
903
- #### Returns
766
+ `Omit.validationBehavior`
904
767
 
905
- `undefined` \| ``null`` \| ``true`` \| `ValidationError`
768
+ ***
906
769
 
907
- #### Inherited from
770
+ ### value?
908
771
 
909
- Omit.validate
772
+ > `optional` **value**: `DateInputValue`
910
773
 
911
- #### Defined in
774
+ Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:79](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L79)
912
775
 
913
- node_modules/@react-types/shared/src/inputs.d.ts:41
776
+ The value (controlled)