@openmrs/esm-framework 8.0.1-pre.3585 → 8.0.1-pre.3592

package/docs/API.md

@@ -195,7 +195,9 @@
 - [usePagination](functions/usePagination.md)
 - [useFhirPagination](functions/useFhirPagination.md)
 - [getFhirServerPaginationHandlers](functions/getFhirServerPaginationHandlers.md)
-- [ResponsiveWrapperProps](interfaces/ResponsiveWrapperProps.md)
+- [CustomOverflowMenu](functions/CustomOverflowMenu.md)
+- [PageHeaderContentProps](interfaces/PageHeaderContentProps.md)
+- [PageHeaderWrapperProps](interfaces/PageHeaderWrapperProps.md)
 - [PatientBannerPatientInfo](functions/PatientBannerPatientInfo.md)
 - [PatientBannerPatientIdentifiers](functions/PatientBannerPatientIdentifiers.md)
 - [PatientBannerActionsMenu](functions/PatientBannerActionsMenu.md)
@@ -207,24 +209,22 @@
 - [PatientPhotoProps](interfaces/PatientPhotoProps.md)
 - [usePatientPhoto](functions/usePatientPhoto.md)
 - [UsePatientPhotoResult](interfaces/UsePatientPhotoResult.md)
-- [CustomOverflowMenu](functions/CustomOverflowMenu.md)
-- [PageHeaderContentProps](interfaces/PageHeaderContentProps.md)
-- [PageHeaderWrapperProps](interfaces/PageHeaderWrapperProps.md)
+- [ResponsiveWrapperProps](interfaces/ResponsiveWrapperProps.md)
 - [useOpenmrsPagination](functions/useOpenmrsPagination.md)
 - [UseServerPaginationOptions](interfaces/UseServerPaginationOptions.md)
 - [useOpenmrsInfinite](functions/useOpenmrsInfinite.md)
 - [UseServerInfiniteOptions](interfaces/UseServerInfiniteOptions.md)
 - [useOpenmrsFetchAll](functions/useOpenmrsFetchAll.md)
 - [UseServerFetchAllOptions](interfaces/UseServerFetchAllOptions.md)
+- [showModal](functions/showModal.md)
 - [showNotification](functions/showNotification.md)
 - [showActionableNotification](functions/showActionableNotification.md)
-- [showToast](functions/showToast.md)
-- [showModal](functions/showModal.md)
-- [ToastDescriptor](interfaces/ToastDescriptor.md)
-- [ToastNotificationMeta](interfaces/ToastNotificationMeta.md)
 - [showSnackbar](functions/showSnackbar.md)
 - [SnackbarDescriptor](interfaces/SnackbarDescriptor.md)
 - [SnackbarMeta](interfaces/SnackbarMeta.md)
+- [showToast](functions/showToast.md)
+- [ToastDescriptor](interfaces/ToastDescriptor.md)
+- [ToastNotificationMeta](interfaces/ToastNotificationMeta.md)
 
 ## Config
 

package/docs/functions/CardHeader.md

@@ -0,0 +1,19 @@
+[O3 Framework](../API.md) / CardHeader
+
+# Function: CardHeader()
+
+> **CardHeader**(`__namedParameters`): `Element`
+
+Defined in: [packages/framework/esm-styleguide/src/cards/card-header.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/cards/card-header.component.tsx#L16)
+
+Re-usable header component for O3-style cards, like those found on the patient chart
+
+## Parameters
+
+### \_\_namedParameters
+
+[`CardHeaderProps`](../interfaces/CardHeaderProps.md)
+
+## Returns
+
+`Element`

package/docs/functions/getCoreTranslation.md

@@ -17,7 +17,7 @@ invalid key to this function will result in a type error.
 
 ### key
 
-`"error"` | `"delete"` | `"actions"` | `"actionableNotification"` | `"address"` | `"age"` | `"cancel"` | `"change"` | `"Clinic"` | `"close"` | `"closesActionableNotification"` | `"closeSnackbar"` | `"confirm"` | `"contactAdministratorIfIssuePersists"` | `"contactDetails"` | `"discardChanges"` | `"edit"` | `"errorCopy"` | `"errorLoadingLoginLocations"` | `"female"` | `"leftNavigation"` | `"loading"` | `"male"` | `"noResultsToDisplay"` | `"other"` | `"patientAvatarAlt"` | `"patientIdentifierSticker"` | `"patientLists"` | `"patientPhotoAlt"` | `"patientPhotoPlaceholder"` | `"print"` | `"printError"` | `"printErrorExplainer"` | `"printIdentifierSticker"` | `"printing"` | `"relationships"` | `"resetOverrides"` | `"save"` | `"scriptLoadingFailed"` | `"scriptLoadingError"` | `"searchForLocation"` | `"seeMoreLists"` | `"sex"` | `"showLess"` | `"showMore"` | `"snackbarNotification"` | `"toggleDevTools"` | `"unknown"` | `"yearAbbreviation"` | `"yearsAbbreviation"` | `"closeWorkspaces2PromptTitle"` | `"closeWorkspaces2PromptBody"` | `"closeAllOpenedWorkspaces"` | `"closingAllWorkspacesPromptBody"` | `"closingAllWorkspacesPromptTitle"` | `"discard"` | `"hide"` | `"maximize"` | `"minimize"` | `"openAnyway"` | `"unsavedChangesInOpenedWorkspace"` | `"unsavedChangesInWorkspace"` | `"unsavedChangesTitleText"` | `"workspaceHeader"` | `"address1"` | `"address2"` | `"address3"` | `"address4"` | `"address5"` | `"address6"` | `"city"` | `"cityVillage"` | `"country"` | `"countyDistrict"` | `"district"` | `"postalCode"` | `"state"` | `"stateProvince"`
+`"error"` | `"delete"` | `"actions"` | `"actionableNotification"` | `"address"` | `"age"` | `"cancel"` | `"change"` | `"Clinic"` | `"close"` | `"closesActionableNotification"` | `"closeSnackbar"` | `"confirm"` | `"contactAdministratorIfIssuePersists"` | `"contactDetails"` | `"discardChanges"` | `"edit"` | `"emptyStateText"` | `"errorCopy"` | `"errorLoadingLoginLocations"` | `"female"` | `"leftNavigation"` | `"loading"` | `"male"` | `"noResultsToDisplay"` | `"other"` | `"paginationItemsCount"` | `"paginationOfPages"` | `"patientAvatarAlt"` | `"patientIdentifierSticker"` | `"patientLists"` | `"patientPhotoAlt"` | `"patientPhotoPlaceholder"` | `"print"` | `"printError"` | `"printErrorExplainer"` | `"printIdentifierSticker"` | `"printing"` | `"recordNewEntry"` | `"relationships"` | `"resetOverrides"` | `"save"` | `"scriptLoadingFailed"` | `"scriptLoadingError"` | `"searchForLocation"` | `"seeAll"` | `"seeMoreLists"` | `"sex"` | `"showLess"` | `"showMore"` | `"snackbarNotification"` | `"toggleDevTools"` | `"unknown"` | `"yearAbbreviation"` | `"yearsAbbreviation"` | `"closeWorkspaces2PromptTitle"` | `"closeWorkspaces2PromptBody"` | `"closeAllOpenedWorkspaces"` | `"closingAllWorkspacesPromptBody"` | `"closingAllWorkspacesPromptTitle"` | `"discard"` | `"hide"` | `"maximize"` | `"minimize"` | `"openAnyway"` | `"unsavedChangesInOpenedWorkspace"` | `"unsavedChangesInWorkspace"` | `"unsavedChangesTitleText"` | `"workspaceHeader"` | `"address1"` | `"address2"` | `"address3"` | `"address4"` | `"address5"` | `"address6"` | `"city"` | `"cityVillage"` | `"country"` | `"countyDistrict"` | `"district"` | `"postalCode"` | `"state"` | `"stateProvince"`
 
 ### defaultText?
 

package/docs/functions/showSnackbar.md

@@ -4,7 +4,7 @@
 
 > **showSnackbar**(`snackbar`): `void`
 
-Defined in: [packages/framework/esm-styleguide/src/snackbars/index.tsx:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/index.tsx#L32)
+Defined in: [packages/framework/esm-styleguide/src/snackbars/index.tsx:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/index.tsx#L34)
 
 Displays a snack bar notification in the UI.
 

package/docs/functions/showToast.md

@@ -4,7 +4,7 @@
 
 > **showToast**(`toast`): `void`
 
-Defined in: [packages/framework/esm-styleguide/src/toasts/index.tsx:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/index.tsx#L36)
+Defined in: [packages/framework/esm-styleguide/src/toasts/index.tsx:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/index.tsx#L38)
 
 Displays a toast notification in the UI.
 

package/docs/interfaces/CardHeaderProps.md

@@ -0,0 +1,25 @@
+[O3 Framework](../API.md) / CardHeaderProps
+
+# Interface: CardHeaderProps
+
+Defined in: [packages/framework/esm-styleguide/src/cards/card-header.component.tsx:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/cards/card-header.component.tsx#L6)
+
+## Properties
+
+### children?
+
+> `optional` **children**: `ReactNode`
+
+Defined in: [packages/framework/esm-styleguide/src/cards/card-header.component.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/cards/card-header.component.tsx#L10)
+
+The contents of the card header to render if any.
+
+***
+
+### title
+
+> **title**: `string`
+
+Defined in: [packages/framework/esm-styleguide/src/cards/card-header.component.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/cards/card-header.component.tsx#L8)
+
+The title for this card. This must be a pre-translated string.

package/docs/interfaces/EmptyCardProps.md

@@ -0,0 +1,39 @@
+[O3 Framework](../API.md) / EmptyCardProps
+
+# Interface: EmptyCardProps
+
+Defined in: [packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx#L9)
+
+## Properties
+
+### displayText
+
+> **displayText**: `string`
+
+Defined in: [packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx#L11)
+
+The name of the type of item that would be displayed here if not empty. This must be a pre-translated string.
+
+***
+
+### headerTitle
+
+> **headerTitle**: `string`
+
+Defined in: [packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx#L13)
+
+The title to use for this empty component. This must be a pre-translated string.
+
+## Methods
+
+### launchForm()?
+
+> `optional` **launchForm**(): `void`
+
+Defined in: [packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx#L15)
+
+A callback to invoke when the user tries to record a new item.
+
+#### Returns
+
+`void`

package/docs/interfaces/ErrorCardProps.md

@@ -0,0 +1,25 @@
+[O3 Framework](../API.md) / ErrorCardProps
+
+# Interface: ErrorCardProps
+
+Defined in: [packages/framework/esm-styleguide/src/error-card/error-card.component.tsx:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-card/error-card.component.tsx#L7)
+
+## Properties
+
+### error
+
+> **error**: `any`
+
+Defined in: [packages/framework/esm-styleguide/src/error-card/error-card.component.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-card/error-card.component.tsx#L9)
+
+This is the error that triggered rendering the card. It is expected to be the error returned from `openmrsFetch()`
+
+***
+
+### headerTitle
+
+> **headerTitle**: `string`
+
+Defined in: [packages/framework/esm-styleguide/src/error-card/error-card.component.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-card/error-card.component.tsx#L11)
+
+The title for this card. This must be a pre-translated string.

package/docs/interfaces/PaginationProps.md

@@ -0,0 +1,95 @@
+[O3 Framework](../API.md) / PaginationProps
+
+# Interface: PaginationProps
+
+Defined in: [packages/framework/esm-styleguide/src/pagination/pagination.component.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pagination/pagination.component.tsx#L8)
+
+## Properties
+
+### currentItems
+
+> **currentItems**: `number`
+
+Defined in: [packages/framework/esm-styleguide/src/pagination/pagination.component.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pagination/pagination.component.tsx#L10)
+
+The count of current items displayed
+
+***
+
+### dashboardLinkLabel?
+
+> `optional` **dashboardLinkLabel**: `string`
+
+Defined in: [packages/framework/esm-styleguide/src/pagination/pagination.component.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pagination/pagination.component.tsx#L22)
+
+Optional text to display instead of the default "See all"
+
+***
+
+### dashboardLinkUrl?
+
+> `optional` **dashboardLinkUrl**: `string`
+
+Defined in: [packages/framework/esm-styleguide/src/pagination/pagination.component.tsx:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pagination/pagination.component.tsx#L20)
+
+An optional URL the user should be directed to if they click on the link to see all results
+
+***
+
+### onPageNumberChange()?
+
+> `optional` **onPageNumberChange**: (`data`) => `void`
+
+Defined in: [packages/framework/esm-styleguide/src/pagination/pagination.component.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pagination/pagination.component.tsx#L18)
+
+A callback to be called when the page changes
+
+#### Parameters
+
+##### data
+
+###### page
+
+`number`
+
+###### pageSize
+
+`number`
+
+###### ref?
+
+`RefObject`\<`any`\>
+
+#### Returns
+
+`void`
+
+***
+
+### pageNumber
+
+> **pageNumber**: `number`
+
+Defined in: [packages/framework/esm-styleguide/src/pagination/pagination.component.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pagination/pagination.component.tsx#L14)
+
+The current page number
+
+***
+
+### pageSize
+
+> **pageSize**: `number`
+
+Defined in: [packages/framework/esm-styleguide/src/pagination/pagination.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pagination/pagination.component.tsx#L16)
+
+The size of each page
+
+***
+
+### totalItems
+
+> **totalItems**: `number`
+
+Defined in: [packages/framework/esm-styleguide/src/pagination/pagination.component.tsx:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pagination/pagination.component.tsx#L12)
+
+The count of total items displayed

package/docs/variables/EmptyCard.md

@@ -0,0 +1,9 @@
+[O3 Framework](../API.md) / EmptyCard
+
+# Variable: EmptyCard
+
+> `const` **EmptyCard**: `React.FC`\<[`EmptyCardProps`](../interfaces/EmptyCardProps.md)\>
+
+Defined in: [packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx#L29)
+
+Re-usable card for displaying an empty state

package/docs/variables/ErrorCard.md

@@ -0,0 +1,9 @@
+[O3 Framework](../API.md) / ErrorCard
+
+# Variable: ErrorCard
+
+> `const` **ErrorCard**: `React.FC`\<[`ErrorCardProps`](../interfaces/ErrorCardProps.md)\>
+
+Defined in: [packages/framework/esm-styleguide/src/error-card/error-card.component.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-card/error-card.component.tsx#L17)
+
+Re-usable card for displaying a fetch error

package/docs/variables/Pagination.md

@@ -0,0 +1,9 @@
+[O3 Framework](../API.md) / Pagination
+
+# Variable: Pagination
+
+> `const` **Pagination**: `React.FC`\<[`PaginationProps`](../interfaces/PaginationProps.md)\>
+
+Defined in: [packages/framework/esm-styleguide/src/pagination/pagination.component.tsx:28](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pagination/pagination.component.tsx#L28)
+
+Re-usable pagination bar

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "8.0.1-pre.3585",
+  "version": "8.0.1-pre.3592",
   "license": "MPL-2.0",
   "type": "module",
   "module": "dist/openmrs-esm-framework.js",
@@ -60,24 +60,24 @@
     "access": "public"
   },
   "dependencies": {
-    "@openmrs/esm-api": "8.0.1-pre.3585",
-    "@openmrs/esm-config": "8.0.1-pre.3585",
-    "@openmrs/esm-context": "8.0.1-pre.3585",
-    "@openmrs/esm-dynamic-loading": "8.0.1-pre.3585",
-    "@openmrs/esm-emr-api": "8.0.1-pre.3585",
-    "@openmrs/esm-error-handling": "8.0.1-pre.3585",
-    "@openmrs/esm-expression-evaluator": "8.0.1-pre.3585",
-    "@openmrs/esm-extensions": "8.0.1-pre.3585",
-    "@openmrs/esm-feature-flags": "8.0.1-pre.3585",
-    "@openmrs/esm-globals": "8.0.1-pre.3585",
-    "@openmrs/esm-navigation": "8.0.1-pre.3585",
-    "@openmrs/esm-offline": "8.0.1-pre.3585",
-    "@openmrs/esm-react-utils": "8.0.1-pre.3585",
-    "@openmrs/esm-routes": "8.0.1-pre.3585",
-    "@openmrs/esm-state": "8.0.1-pre.3585",
-    "@openmrs/esm-styleguide": "8.0.1-pre.3585",
-    "@openmrs/esm-translations": "8.0.1-pre.3585",
-    "@openmrs/esm-utils": "8.0.1-pre.3585"
+    "@openmrs/esm-api": "8.0.1-pre.3592",
+    "@openmrs/esm-config": "8.0.1-pre.3592",
+    "@openmrs/esm-context": "8.0.1-pre.3592",
+    "@openmrs/esm-dynamic-loading": "8.0.1-pre.3592",
+    "@openmrs/esm-emr-api": "8.0.1-pre.3592",
+    "@openmrs/esm-error-handling": "8.0.1-pre.3592",
+    "@openmrs/esm-expression-evaluator": "8.0.1-pre.3592",
+    "@openmrs/esm-extensions": "8.0.1-pre.3592",
+    "@openmrs/esm-feature-flags": "8.0.1-pre.3592",
+    "@openmrs/esm-globals": "8.0.1-pre.3592",
+    "@openmrs/esm-navigation": "8.0.1-pre.3592",
+    "@openmrs/esm-offline": "8.0.1-pre.3592",
+    "@openmrs/esm-react-utils": "8.0.1-pre.3592",
+    "@openmrs/esm-routes": "8.0.1-pre.3592",
+    "@openmrs/esm-state": "8.0.1-pre.3592",
+    "@openmrs/esm-styleguide": "8.0.1-pre.3592",
+    "@openmrs/esm-translations": "8.0.1-pre.3592",
+    "@openmrs/esm-utils": "8.0.1-pre.3592"
   },
   "peerDependencies": {
     "dayjs": "1.x",
@@ -90,7 +90,7 @@
     "swr": "2.x"
   },
   "devDependencies": {
-    "@openmrs/typedoc-plugin-file-categories": "8.0.1-pre.3585",
+    "@openmrs/typedoc-plugin-file-categories": "8.0.1-pre.3592",
     "@rspack/cli": "^1.3.11",
     "@rspack/core": "^1.3.11",
     "@vitest/coverage-v8": "^4.0.7",