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

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/EmptyCardIllustration.md

@@ -0,0 +1,23 @@
+[O3 Framework](../API.md) / EmptyCardIllustration
+
+# Function: EmptyCardIllustration()
+
+> **EmptyCardIllustration**(`__namedParameters`): `Element`
+
+Defined in: [packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx#L18)
+
+## Parameters
+
+### \_\_namedParameters
+
+#### height?
+
+`string` = `'64'`
+
+#### width?
+
+`string` = `'64'`
+
+## Returns
+
+`Element`

package/docs/functions/createDashboard.md

@@ -0,0 +1,29 @@
+[O3 Framework](../API.md) / createDashboard
+
+# Function: createDashboard()
+
+> **createDashboard**(`props`): (`__namedParameters`) => `Element`
+
+Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:53](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L53)
+
+## Parameters
+
+### props
+
+`Omit`\<[`DashboardExtensionProps`](../interfaces/DashboardExtensionProps.md), `"basePath"`\>
+
+## Returns
+
+> (`__namedParameters`): `Element`
+
+### Parameters
+
+#### \_\_namedParameters
+
+##### basePath
+
+`string`
+
+### 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/DashboardExtensionProps.md

@@ -6,17 +6,17 @@ Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx
 
 ## Properties
 
-### basePath
+### basePath?
 
-> **basePath**: `string`
+> `optional` **basePath**: `string`
 
 Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L13)
 
 ***
 
-### icon
+### icon?
 
-> **icon**: `"omrs-icon-activity"` \| `"omrs-icon-add"` \| `"omrs-icon-arrow-down"` \| `"omrs-icon-arrow-left"` \| `"omrs-icon-arrow-right"` \| `"omrs-icon-arrow-up"` \| `"omrs-icon-baby"` \| `"omrs-icon-calendar-heat-map"` \| `"omrs-icon-calendar"` \| `"omrs-icon-caret-down"` \| `"omrs-icon-caret-left"` \| `"omrs-icon-caret-right"` \| `"omrs-icon-caret-up"` \| `"omrs-icon-chart-average"` \| `"omrs-icon-checkmark-filled"` \| `"omrs-icon-checkmark-outline"` \| `"omrs-icon-chemistry"` \| `"omrs-icon-chevron-down"` \| `"omrs-icon-chevron-left"` \| `"omrs-icon-chevron-right"` \| `"omrs-icon-chevron-up"` \| `"omrs-icon-close"` \| `"omrs-icon-close-filled"` \| `"omrs-icon-close-outline"` \| `"omrs-icon-document"` \| `"omrs-icon-document-attachment"` \| `"omrs-icon-download"` \| `"omrs-icon-drug-order"` \| `"omrs-icon-edit"` \| `"omrs-icon-event-schedule"` \| `"omrs-icon-events"` \| `"omrs-icon-gender-female"` \| `"omrs-icon-gender-male"` \| `"omrs-icon-gender-other"` \| `"omrs-icon-gender-unknown"` \| `"omrs-icon-generic-order-type"` \| `"omrs-icon-group"` \| `"omrs-icon-group-access"` \| `"omrs-icon-hospital-bed"` \| `"omrs-icon-image-medical"` \| `"omrs-icon-information"` \| `"omrs-icon-information-filled"` \| `"omrs-icon-information-square"` \| `"omrs-icon-inventory-management"` \| `"omrs-icon-lab-order"` \| `"omrs-icon-list-checked"` \| `"omrs-icon-location"` \| `"omrs-icon-material-order"` \| `"omrs-icon-maximize"` \| `"omrs-icon-medication"` \| `"omrs-icon-message-queue"` \| `"omrs-icon-microscope"` \| `"omrs-icon-money"` \| `"omrs-icon-mother"` \| `"omrs-icon-movement"` \| `"omrs-icon-overflow-menu--horizontal"` \| `"omrs-icon-overflow-menu--vertical"` \| `"omrs-icon-password"` \| `"omrs-icon-pedestrian-family"` \| `"omrs-icon-pen"` \| `"omrs-icon-printer"` \| `"omrs-icon-procedure-order"` \| `"omrs-icon-programs"` \| `"omrs-icon-renew"` \| `"omrs-icon-referral-order"` \| `"omrs-icon-report"` \| `"omrs-icon-reset"` \| `"omrs-icon-save"` \| `"omrs-icon-search"` \| `"omrs-icon-settings"` \| `"omrs-icon-shopping-cart"` \| `"omrs-icon-shopping-cart--arrow-down"` \| `"omrs-icon-sticky-note-add"` \| `"omrs-icon-switcher"` \| `"omrs-icon-syringe"` \| `"omrs-icon-table-of-contents"` \| `"omrs-icon-table"` \| `"omrs-icon-time"` \| `"omrs-icon-tools"` \| `"omrs-icon-translate"` \| `"omrs-icon-trash-can"` \| `"omrs-icon-tree-view--alt"` \| `"omrs-icon-user-avatar"` \| `"omrs-icon-user-follow"` \| `"omrs-icon-user-xray"` \| `"omrs-icon-user"` \| `"omrs-icon-view-off"` \| `"omrs-icon-view"` \| `"omrs-icon-warning"`
+> `optional` **icon**: `"omrs-icon-activity"` \| `"omrs-icon-add"` \| `"omrs-icon-arrow-down"` \| `"omrs-icon-arrow-left"` \| `"omrs-icon-arrow-right"` \| `"omrs-icon-arrow-up"` \| `"omrs-icon-baby"` \| `"omrs-icon-calendar-heat-map"` \| `"omrs-icon-calendar"` \| `"omrs-icon-caret-down"` \| `"omrs-icon-caret-left"` \| `"omrs-icon-caret-right"` \| `"omrs-icon-caret-up"` \| `"omrs-icon-chart-average"` \| `"omrs-icon-checkmark-filled"` \| `"omrs-icon-checkmark-outline"` \| `"omrs-icon-chemistry"` \| `"omrs-icon-chevron-down"` \| `"omrs-icon-chevron-left"` \| `"omrs-icon-chevron-right"` \| `"omrs-icon-chevron-up"` \| `"omrs-icon-close"` \| `"omrs-icon-close-filled"` \| `"omrs-icon-close-outline"` \| `"omrs-icon-document"` \| `"omrs-icon-document-attachment"` \| `"omrs-icon-download"` \| `"omrs-icon-drug-order"` \| `"omrs-icon-edit"` \| `"omrs-icon-event-schedule"` \| `"omrs-icon-events"` \| `"omrs-icon-gender-female"` \| `"omrs-icon-gender-male"` \| `"omrs-icon-gender-other"` \| `"omrs-icon-gender-unknown"` \| `"omrs-icon-generic-order-type"` \| `"omrs-icon-group"` \| `"omrs-icon-group-access"` \| `"omrs-icon-hospital-bed"` \| `"omrs-icon-image-medical"` \| `"omrs-icon-information"` \| `"omrs-icon-information-filled"` \| `"omrs-icon-information-square"` \| `"omrs-icon-inventory-management"` \| `"omrs-icon-lab-order"` \| `"omrs-icon-list-checked"` \| `"omrs-icon-location"` \| `"omrs-icon-material-order"` \| `"omrs-icon-maximize"` \| `"omrs-icon-medication"` \| `"omrs-icon-message-queue"` \| `"omrs-icon-microscope"` \| `"omrs-icon-money"` \| `"omrs-icon-mother"` \| `"omrs-icon-movement"` \| `"omrs-icon-overflow-menu--horizontal"` \| `"omrs-icon-overflow-menu--vertical"` \| `"omrs-icon-password"` \| `"omrs-icon-pedestrian-family"` \| `"omrs-icon-pen"` \| `"omrs-icon-printer"` \| `"omrs-icon-procedure-order"` \| `"omrs-icon-programs"` \| `"omrs-icon-renew"` \| `"omrs-icon-referral-order"` \| `"omrs-icon-report"` \| `"omrs-icon-reset"` \| `"omrs-icon-save"` \| `"omrs-icon-search"` \| `"omrs-icon-settings"` \| `"omrs-icon-shopping-cart"` \| `"omrs-icon-shopping-cart--arrow-down"` \| `"omrs-icon-sticky-note-add"` \| `"omrs-icon-switcher"` \| `"omrs-icon-syringe"` \| `"omrs-icon-table-of-contents"` \| `"omrs-icon-table"` \| `"omrs-icon-time"` \| `"omrs-icon-tools"` \| `"omrs-icon-translate"` \| `"omrs-icon-trash-can"` \| `"omrs-icon-tree-view--alt"` \| `"omrs-icon-user-avatar"` \| `"omrs-icon-user-follow"` \| `"omrs-icon-user-xray"` \| `"omrs-icon-user"` \| `"omrs-icon-view-off"` \| `"omrs-icon-view"` \| `"omrs-icon-warning"`
 
 Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L14)
 

package/docs/interfaces/Drug.md

@@ -0,0 +1,97 @@
+[O3 Framework](../API.md) / Drug
+
+# Interface: Drug
+
+Defined in: [packages/framework/esm-emr-api/src/types/drug-resource.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/drug-resource.ts#L3)
+
+## Extends
+
+- `OpenmrsResource`
+
+## Indexable
+
+\[`anythingElse`: `string`\]: `any`
+
+## Properties
+
+### auditInfo?
+
+> `optional` **auditInfo**: `AuditInfo`
+
+Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:14
+
+#### Inherited from
+
+`OpenmrsResource.auditInfo`
+
+***
+
+### concept
+
+> **concept**: `Concept`
+
+Defined in: [packages/framework/esm-emr-api/src/types/drug-resource.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/drug-resource.ts#L6)
+
+***
+
+### display
+
+> **display**: `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/drug-resource.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/drug-resource.ts#L8)
+
+#### Overrides
+
+`OpenmrsResource.display`
+
+***
+
+### dosageForm
+
+> **dosageForm**: `OpenmrsResource`
+
+Defined in: [packages/framework/esm-emr-api/src/types/drug-resource.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/drug-resource.ts#L7)
+
+***
+
+### links?
+
+> `optional` **links**: `Link`[]
+
+Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:13
+
+#### Inherited from
+
+`OpenmrsResource.links`
+
+***
+
+### resourceVersion?
+
+> `optional` **resourceVersion**: `string`
+
+Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:15
+
+#### Inherited from
+
+`OpenmrsResource.resourceVersion`
+
+***
+
+### strength
+
+> **strength**: `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/drug-resource.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/drug-resource.ts#L5)
+
+***
+
+### uuid
+
+> **uuid**: `string`
+
+Defined in: [packages/framework/esm-emr-api/src/types/drug-resource.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/drug-resource.ts#L4)
+
+#### Overrides
+
+`OpenmrsResource.uuid`

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/ErrorStateProps.md

@@ -10,7 +10,9 @@ Defined in: [packages/framework/esm-styleguide/src/error-state/error-state.compo
 
 > **error**: `any`
 
-Defined in: [packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L8)
+Defined in: [packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L9)
+
+The error that caused this error card to be rendered. Expected to be a failed fetch result.
 
 ***
 
@@ -18,4 +20,6 @@ Defined in: [packages/framework/esm-styleguide/src/error-state/error-state.compo
 
 > **headerTitle**: `string`
 
-Defined in: [packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L9)
+Defined in: [packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L11)
+
+The title to use for this empty component. This must be a pre-translated string.