npm - @openmrs/esm-react-utils - Versions diffs - 3.1.15-pre.693 → 3.1.15-pre.709 - Mend

@openmrs/esm-react-utils 3.1.15-pre.693 → 3.1.15-pre.709

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 (13) hide show

package/README.md +0 -2
package/package.json +7 -8
package/docs/API.md +0 -957
package/docs/interfaces/ComponentConfig.md +0 -30
package/docs/interfaces/ComponentDecoratorOptions.md +0 -52
package/docs/interfaces/ConfigurableLinkProps.md +0 -25
package/docs/interfaces/ExtensionData.md +0 -41
package/docs/interfaces/ExtensionProps.md +0 -44
package/docs/interfaces/ExtensionSlotBaseProps.md +0 -54
package/docs/interfaces/OpenmrsReactComponentProps.md +0 -19
package/docs/interfaces/OpenmrsReactComponentState.md +0 -41
package/docs/interfaces/UserHasAccessProps.md +0 -19
package/typedoc.json +0 -7

package/README.md CHANGED Viewed

@@ -1,5 +1,3 @@
 # openmrs-esm-react-utils
 `openmrs-esm-react-utils` brings extended support for React into the OpenMRS frontend.
-[API Docs](docs/API.md)

package/package.json CHANGED Viewed

@@ -1,13 +1,12 @@
 {
   "name": "@openmrs/esm-react-utils",
-  "version": "3.1.15-pre.693",
+  "version": "3.1.15-pre.709",
   "license": "MPL-2.0",
   "description": "React utilities for OpenMRS.",
   "browser": "dist/openmrs-esm-react-utils.js",
   "main": "src/index.ts",
   "source": true,
   "scripts": {
-    "document": "../../../document.sh esm-react-utils",
     "test": "jest --passWithNoTests",
     "build": "webpack --mode=production",
     "analyze": "webpack --mode=production --env analyze=true",
@@ -54,11 +53,11 @@
     "react-i18next": "11.x"
   },
   "devDependencies": {
-    "@openmrs/esm-api": "^3.1.15-pre.693",
-    "@openmrs/esm-config": "^3.1.15-pre.693",
-    "@openmrs/esm-error-handling": "^3.1.15-pre.693",
-    "@openmrs/esm-extensions": "^3.1.15-pre.693",
-    "@openmrs/esm-globals": "^3.1.15-pre.693",
+    "@openmrs/esm-api": "^3.1.15-pre.709",
+    "@openmrs/esm-config": "^3.1.15-pre.709",
+    "@openmrs/esm-error-handling": "^3.1.15-pre.709",
+    "@openmrs/esm-extensions": "^3.1.15-pre.709",
+    "@openmrs/esm-globals": "^3.1.15-pre.709",
     "i18next": "^19.6.0",
     "react": "^16.13.1",
     "react-dom": "^16.13.1",
@@ -66,5 +65,5 @@
     "rxjs": "^6.5.3",
     "unistore": "^3.5.2"
   },
-  "gitHead": "4348b79bf1c23aea131af938164ef9dbfd4e68d7"
+  "gitHead": "20e905827ceb11c90871b5e28a7bd56ab4fbab18"
 }

package/docs/API.md DELETED Viewed

@@ -1,957 +0,0 @@
-[Back to README.md](../README.md)
-# @openmrs/esm-react-utils
-## Table of contents
-### Interfaces
-- [ComponentConfig](interfaces/ComponentConfig.md)
-- [ComponentDecoratorOptions](interfaces/ComponentDecoratorOptions.md)
-- [ConfigurableLinkProps](interfaces/ConfigurableLinkProps.md)
-- [ExtensionData](interfaces/ExtensionData.md)
-- [ExtensionProps](interfaces/ExtensionProps.md)
-- [ExtensionSlotBaseProps](interfaces/ExtensionSlotBaseProps.md)
-- [OpenmrsReactComponentProps](interfaces/OpenmrsReactComponentProps.md)
-- [OpenmrsReactComponentState](interfaces/OpenmrsReactComponentState.md)
-- [UserHasAccessProps](interfaces/UserHasAccessProps.md)
-### Type aliases
-- [Actions](API.md#actions)
-- [BoundActions](API.md#boundactions)
-- [ExtensionSlotProps](API.md#extensionslotprops)
-- [LayoutType](API.md#layouttype)
-### Navigation Variables
-- [ConfigurableLink](API.md#configurablelink)
-### Other Variables
-- [ComponentContext](API.md#componentcontext)
-- [Extension](API.md#extension)
-- [ExtensionSlot](API.md#extensionslot)
-- [UserHasAccess](API.md#userhasaccess)
-### Functions
-- [createUseStore](API.md#createusestore)
-- [getAsyncExtensionLifecycle](API.md#getasyncextensionlifecycle)
-- [getAsyncLifecycle](API.md#getasynclifecycle)
-- [getLifecycle](API.md#getlifecycle)
-- [getSyncLifecycle](API.md#getsynclifecycle)
-- [openmrsComponentDecorator](API.md#openmrscomponentdecorator)
-- [useAssignedExtensionIds](API.md#useassignedextensionids)
-- [useAttachedExtensionIds](API.md#useattachedextensionids)
-- [useBodyScrollLock](API.md#usebodyscrolllock)
-- [useConfig](API.md#useconfig)
-- [useConnectedExtensions](API.md#useconnectedextensions)
-- [useConnectivity](API.md#useconnectivity)
-- [useCurrentPatient](API.md#usecurrentpatient)
-- [useExtension](API.md#useextension)
-- [useExtensionSlot](API.md#useextensionslot)
-- [useExtensionSlotConfig](API.md#useextensionslotconfig)
-- [useExtensionSlotMeta](API.md#useextensionslotmeta)
-- [useExtensionStore](API.md#useextensionstore)
-- [useForceUpdate](API.md#useforceupdate)
-- [useLayoutType](API.md#uselayouttype)
-- [useLocations](API.md#uselocations)
-- [useNavigationContext](API.md#usenavigationcontext)
-- [useOnClickOutside](API.md#useonclickoutside)
-- [usePagination](API.md#usepagination)
-- [useSessionUser](API.md#usesessionuser)
-- [useStore](API.md#usestore)
-- [useStoreState](API.md#usestorestate)
-- [useVisit](API.md#usevisit)
-- [useVisitTypes](API.md#usevisittypes)
-## Type aliases
-### Actions
-Ƭ **Actions**: `Function` \| { [key: string]: `Function`;  }
-#### Defined in
-[packages/framework/esm-react-utils/src/createUseStore.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/createUseStore.ts#L4)
-___
-### BoundActions
-Ƭ **BoundActions**: `Object`
-#### Index signature
-▪ [key: `string`]: `BoundAction`
-#### Defined in
-[packages/framework/esm-react-utils/src/createUseStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/createUseStore.ts#L5)
-___
-### ExtensionSlotProps
-Ƭ **ExtensionSlotProps**: [`ExtensionSlotBaseProps`](interfaces/ExtensionSlotBaseProps.md) & `React.HTMLAttributes`<`HTMLDivElement`\>
-#### Defined in
-[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:54](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L54)
-___
-### LayoutType
-Ƭ **LayoutType**: ``"tablet"`` \| ``"phone"`` \| ``"desktop"``
-#### Defined in
-[packages/framework/esm-react-utils/src/useLayoutType.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useLayoutType.ts#L3)
-## Navigation Variables
-### ConfigurableLink
-• `Const` **ConfigurableLink**: `React.FC`<[`ConfigurableLinkProps`](interfaces/ConfigurableLinkProps.md)\>
-A React link component which calls [[navigate]] when clicked
-**`param`** The target path or URL. Supports interpolation. See [[navigate]]
-**`param`** Inline elements within the link
-**`param`** Any other valid props for an <a> tag except `href` and `onClick`
-#### Defined in
-[packages/framework/esm-react-utils/src/ConfigurableLink.tsx:32](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ConfigurableLink.tsx#L32)
-___
-## Other Variables
-### ComponentContext
-• `Const` **ComponentContext**: `Context`<[`ComponentConfig`](interfaces/ComponentConfig.md)\>
-Available to all components. Provided by `openmrsComponentDecorator`.
-#### Defined in
-[packages/framework/esm-react-utils/src/ComponentContext.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ComponentContext.ts#L17)
-___
-### Extension
-• `Const` **Extension**: `React.FC`<[`ExtensionProps`](interfaces/ExtensionProps.md)\>
-Represents the position in the DOM where each extension within
-an extension slot is rendered.
-Renders once for each extension attached to that extension slot.
-Usage of this component *must* have an ancestor `<ExtensionSlot>`,
-and *must* only be used once within that `<ExtensionSlot>`.
-#### Defined in
-[packages/framework/esm-react-utils/src/Extension.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L22)
-___
-### ExtensionSlot
-• `Const` **ExtensionSlot**: `React.FC`<[`ExtensionSlotProps`](API.md#extensionslotprops)\>
-#### Defined in
-[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L57)
-___
-### UserHasAccess
-• `Const` **UserHasAccess**: `React.FC`<[`UserHasAccessProps`](interfaces/UserHasAccessProps.md)\>
-#### Defined in
-[packages/framework/esm-react-utils/src/UserHasAccess.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L8)
-## Functions
-### createUseStore
-▸ **createUseStore**<`T`\>(`store`): () => `T`(`actions`: [`Actions`](API.md#actions)) => `T` & [`BoundActions`](API.md#boundactions)(`actions?`: [`Actions`](API.md#actions)) => `T` & [`BoundActions`](API.md#boundactions)
-#### Type parameters
-| Name |
-| :------ |
-| `T` |
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `store` | `Store`<`T`\> |
-#### Returns
-`fn`
-▸ (): `T`
-##### Returns
-`T`
-▸ (`actions`): `T` & [`BoundActions`](API.md#boundactions)
-##### Parameters
-| Name | Type |
-| :------ | :------ |
-| `actions` | [`Actions`](API.md#actions) |
-##### Returns
-`T` & [`BoundActions`](API.md#boundactions)
-▸ (`actions?`): `T` & [`BoundActions`](API.md#boundactions)
-##### Parameters
-| Name | Type |
-| :------ | :------ |
-| `actions?` | [`Actions`](API.md#actions) |
-##### Returns
-`T` & [`BoundActions`](API.md#boundactions)
-#### Defined in
-[packages/framework/esm-react-utils/src/createUseStore.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/createUseStore.ts#L21)
-___
-### getAsyncExtensionLifecycle
-▸ `Const` **getAsyncExtensionLifecycle**<`T`\>(`lazy`, `options`): () => `Promise`<`ReactAppOrParcel`<`any`\>\>
-**`deprecated`** Use getAsyncLifecycle instead.
-#### Type parameters
-| Name |
-| :------ |
-| `T` |
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `lazy` | () => `Promise`<`Object`\> |
-| `options` | [`ComponentDecoratorOptions`](interfaces/ComponentDecoratorOptions.md) |
-#### Returns
-`fn`
-▸ (): `Promise`<`ReactAppOrParcel`<`any`\>\>
-##### Returns
-`Promise`<`ReactAppOrParcel`<`any`\>\>
-#### Defined in
-[packages/framework/esm-react-utils/src/getLifecycle.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/getLifecycle.ts#L38)
-___
-### getAsyncLifecycle
-▸ **getAsyncLifecycle**<`T`\>(`lazy`, `options`): () => `Promise`<`ReactAppOrParcel`<`any`\>\>
-#### Type parameters
-| Name |
-| :------ |
-| `T` |
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `lazy` | () => `Promise`<`Object`\> |
-| `options` | [`ComponentDecoratorOptions`](interfaces/ComponentDecoratorOptions.md) |
-#### Returns
-`fn`
-▸ (): `Promise`<`ReactAppOrParcel`<`any`\>\>
-##### Returns
-`Promise`<`ReactAppOrParcel`<`any`\>\>
-#### Defined in
-[packages/framework/esm-react-utils/src/getLifecycle.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/getLifecycle.ts#L20)
-___
-### getLifecycle
-▸ **getLifecycle**<`T`\>(`Component`, `options`): `ReactAppOrParcel`<`any`\>
-#### Type parameters
-| Name |
-| :------ |
-| `T` |
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `Component` | `React.ComponentType`<`T`\> |
-| `options` | [`ComponentDecoratorOptions`](interfaces/ComponentDecoratorOptions.md) |
-#### Returns
-`ReactAppOrParcel`<`any`\>
-#### Defined in
-[packages/framework/esm-react-utils/src/getLifecycle.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/getLifecycle.ts#L9)
-___
-### getSyncLifecycle
-▸ **getSyncLifecycle**<`T`\>(`Component`, `options`): () => `Promise`<`ReactAppOrParcel`<`any`\>\>
-#### Type parameters
-| Name |
-| :------ |
-| `T` |
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `Component` | `React.ComponentType`<`T`\> |
-| `options` | [`ComponentDecoratorOptions`](interfaces/ComponentDecoratorOptions.md) |
-#### Returns
-`fn`
-▸ (): `Promise`<`ReactAppOrParcel`<`any`\>\>
-##### Returns
-`Promise`<`ReactAppOrParcel`<`any`\>\>
-#### Defined in
-[packages/framework/esm-react-utils/src/getLifecycle.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/getLifecycle.ts#L28)
-___
-### openmrsComponentDecorator
-▸ **openmrsComponentDecorator**(`userOpts`): (`Comp`: `ComponentType`<`Object`\>) => `ComponentType`<`any`\>
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `userOpts` | [`ComponentDecoratorOptions`](interfaces/ComponentDecoratorOptions.md) |
-#### Returns
-`fn`
-▸ (`Comp`): `ComponentType`<`any`\>
-##### Parameters
-| Name | Type |
-| :------ | :------ |
-| `Comp` | `ComponentType`<`Object`\> |
-##### Returns
-`ComponentType`<`any`\>
-#### Defined in
-[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:71](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L71)
-___
-### useAssignedExtensionIds
-▸ **useAssignedExtensionIds**(`extensionSlotName`): `string`[]
-Gets the assigned extension ids for a given extension slot name.
-Does not consider if offline or online.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `extensionSlotName` | `string` | The name of the slot to get the assigned IDs for. |
-#### Returns
-`string`[]
-#### Defined in
-[packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts#L11)
-___
-### useAttachedExtensionIds
-▸ **useAttachedExtensionIds**(`extensionSlotName`): `string`[]
-Gets the assigned extension ids for the given slot.
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `extensionSlotName` | `string` |
-#### Returns
-`string`[]
-#### Defined in
-[packages/framework/esm-react-utils/src/useAttachedExtensionIds.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useAttachedExtensionIds.ts#L11)
-___
-### useBodyScrollLock
-▸ **useBodyScrollLock**(`active`): `void`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `active` | `boolean` |
-#### Returns
-`void`
-#### Defined in
-[packages/framework/esm-react-utils/src/useBodyScrollLock.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useBodyScrollLock.ts#L3)
-___
-### useConfig
-▸ **useConfig**(): `Object`
-Use this React Hook to obtain your module's configuration.
-#### Returns
-`Object`
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `constructor` | `Function` | The initial value of Object.prototype.constructor is the standard built-in Object constructor. |
-| `hasOwnProperty` | (`v`: `PropertyKey`) => `boolean` | - |
-| `isPrototypeOf` | (`v`: `Object`) => `boolean` | - |
-| `propertyIsEnumerable` | (`v`: `PropertyKey`) => `boolean` | - |
-| `toLocaleString` | () => `string` | - |
-| `toString` | () => `string` | - |
-| `valueOf` | () => `Object` | - |
-#### Defined in
-[packages/framework/esm-react-utils/src/useConfig.ts:103](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useConfig.ts#L103)
-___
-### useConnectedExtensions
-▸ **useConnectedExtensions**(`extensionSlotName`): `ExtensionRegistration`[]
-Gets the assigned extension for a given extension slot name.
-Considers if offline or online.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `extensionSlotName` | `string` | The name of the slot to get the assigned extensions for. |
-#### Returns
-`ExtensionRegistration`[]
-#### Defined in
-[packages/framework/esm-react-utils/src/useConnectedExtensions.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useConnectedExtensions.ts#L31)
-___
-### useConnectivity
-▸ **useConnectivity**(): `boolean`
-#### Returns
-`boolean`
-#### Defined in
-[packages/framework/esm-react-utils/src/useConnectivity.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useConnectivity.ts#L4)
-___
-### useCurrentPatient
-▸ **useCurrentPatient**(`patientUuid?`): [`boolean`, `NullablePatient`, `PatientUuid`, `Error` \| ``null``]
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `patientUuid` | `PatientUuid` |
-#### Returns
-[`boolean`, `NullablePatient`, `PatientUuid`, `Error` \| ``null``]
-#### Defined in
-[packages/framework/esm-react-utils/src/useCurrentPatient.ts:79](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useCurrentPatient.ts#L79)
-___
-### useExtension
-▸ **useExtension**<`TRef`\>(`state?`): [`RefObject`<`TRef`\>, [`ExtensionData`](interfaces/ExtensionData.md) \| `undefined`]
-#### Type parameters
-| Name | Type |
-| :------ | :------ |
-| `TRef` | extends `HTMLElement` |
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `state?` | `Record`<`string`, `any`\> |
-#### Returns
-[`RefObject`<`TRef`\>, [`ExtensionData`](interfaces/ExtensionData.md) \| `undefined`]
-#### Defined in
-[packages/framework/esm-react-utils/src/useExtension.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtension.ts#L5)
-___
-### useExtensionSlot
-▸ **useExtensionSlot**(`extensionSlotName`): `Object`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `extensionSlotName` | `string` |
-#### Returns
-`Object`
-| Name | Type |
-| :------ | :------ |
-| `extensionSlotModuleName` | `string` |
-| `extensionSlotName` | `string` |
-| `extensions` | `ExtensionRegistration`[] |
-#### Defined in
-[packages/framework/esm-react-utils/src/useExtensionSlot.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionSlot.ts#L9)
-___
-### useExtensionSlotConfig
-▸ **useExtensionSlotConfig**(`extensionSlotName`): `ExtensionSlotConfigObject`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `extensionSlotName` | `string` |
-#### Returns
-`ExtensionSlotConfigObject`
-#### Defined in
-[packages/framework/esm-react-utils/src/useExtensionSlotConfig.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionSlotConfig.ts#L16)
-___
-### useExtensionSlotMeta
-▸ **useExtensionSlotMeta**<`T`\>(`extensionSlotName`): `Object`
-Extract meta data from all extension for a given extension slot.
-#### Type parameters
-| Name | Type |
-| :------ | :------ |
-| `T` | `ExtensionMeta` |
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `extensionSlotName` | `string` |
-#### Returns
-`Object`
-#### Defined in
-[packages/framework/esm-react-utils/src/useExtensionSlotMeta.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionSlotMeta.ts#L9)
-___
-### useExtensionStore
-▸ `Const` **useExtensionStore**(): `T`
-#### Returns
-`T`
-#### Defined in
-[packages/framework/esm-react-utils/src/useExtensionStore.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionStore.ts#L4)
-▸ `Const` **useExtensionStore**(`actions`): `T` & [`BoundActions`](API.md#boundactions)
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `actions` | [`Actions`](API.md#actions) |
-#### Returns
-`T` & [`BoundActions`](API.md#boundactions)
-#### Defined in
-[packages/framework/esm-react-utils/src/useExtensionStore.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionStore.ts#L4)
-▸ `Const` **useExtensionStore**(`actions?`): `T` & [`BoundActions`](API.md#boundactions)
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `actions?` | [`Actions`](API.md#actions) |
-#### Returns
-`T` & [`BoundActions`](API.md#boundactions)
-#### Defined in
-[packages/framework/esm-react-utils/src/useExtensionStore.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionStore.ts#L4)
-___
-### useForceUpdate
-▸ **useForceUpdate**(): () => `void`
-#### Returns
-`fn`
-▸ (): `void`
-##### Returns
-`void`
-#### Defined in
-[packages/framework/esm-react-utils/src/useForceUpdate.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useForceUpdate.ts#L3)
-___
-### useLayoutType
-▸ **useLayoutType**(): [`LayoutType`](API.md#layouttype)
-#### Returns
-[`LayoutType`](API.md#layouttype)
-#### Defined in
-[packages/framework/esm-react-utils/src/useLayoutType.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useLayoutType.ts#L22)
-___
-### useLocations
-▸ **useLocations**(): `Location`[]
-#### Returns
-`Location`[]
-#### Defined in
-[packages/framework/esm-react-utils/src/useLocations.tsx:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useLocations.tsx#L4)
-___
-### useNavigationContext
-▸ **useNavigationContext**(`context`): `void`
-**`deprecated`** Don't use this anymore.
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `context` | `NavigationContext` |
-#### Returns
-`void`
-#### Defined in
-[packages/framework/esm-react-utils/src/useNavigationContext.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useNavigationContext.ts#L10)
-___
-### useOnClickOutside
-▸ **useOnClickOutside**<`T`\>(`handler`, `active?`): `RefObject`<`T`\>
-#### Type parameters
-| Name | Type |
-| :------ | :------ |
-| `T` | extends `HTMLElement``HTMLElement` |
-#### Parameters
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `handler` | (`event`: `Event`) => `void` | `undefined` |
-| `active` | `boolean` | `true` |
-#### Returns
-`RefObject`<`T`\>
-#### Defined in
-[packages/framework/esm-react-utils/src/useOnClickOutside.tsx:3](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useOnClickOutside.tsx#L3)
-___
-### usePagination
-▸ **usePagination**<`T`\>(`data?`, `resultsPerPage?`): `Object`
-#### Type parameters
-| Name |
-| :------ |
-| `T` |
-#### Parameters
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `data` | `T`[] | `[]` |
-| `resultsPerPage` | `number` | `undefined` |
-#### Returns
-`Object`
-| Name | Type |
-| :------ | :------ |
-| `currentPage` | `number` |
-| `paginated` | `boolean` |
-| `results` | `T`[] |
-| `showNextButton` | `boolean` |
-| `showPreviousButton` | `boolean` |
-| `totalPages` | `number` |
-| `goTo` | (`page`: `number`) => `void` |
-| `goToNext` | () => `void` |
-| `goToPrevious` | () => `void` |
-#### Defined in
-[packages/framework/esm-react-utils/src/usePagination.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/usePagination.ts#L5)
-___
-### useSessionUser
-▸ **useSessionUser**(): ``null`` \| `SessionUser`
-#### Returns
-``null`` \| `SessionUser`
-#### Defined in
-[packages/framework/esm-react-utils/src/useSessionUser.tsx:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useSessionUser.tsx#L4)
-___
-### useStore
-▸ **useStore**<`T`\>(`store`): `T`
-#### Type parameters
-| Name |
-| :------ |
-| `T` |
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `store` | `Store`<`T`\> |
-#### Returns
-`T`
-#### Defined in
-[packages/framework/esm-react-utils/src/useStore.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useStore.ts#L4)
-▸ **useStore**<`T`\>(`store`, `actions`): `T` & [`BoundActions`](API.md#boundactions)
-#### Type parameters
-| Name |
-| :------ |
-| `T` |
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `store` | `Store`<`T`\> |
-| `actions` | [`Actions`](API.md#actions) |
-#### Returns
-`T` & [`BoundActions`](API.md#boundactions)
-#### Defined in
-[packages/framework/esm-react-utils/src/useStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useStore.ts#L5)
-___
-### useStoreState
-▸ **useStoreState**<`T`, `U`\>(`store`, `select`): `U`
-#### Type parameters
-| Name |
-| :------ |
-| `T` |
-| `U` |
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `store` | `Store`<`T`\> |
-| `select` | (`state`: `T`) => `U` |
-#### Returns
-`U`
-#### Defined in
-[packages/framework/esm-react-utils/src/useStoreState.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useStoreState.ts#L5)
-___
-### useVisit
-▸ **useVisit**(`patientUuid`): `Object`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `patientUuid` | `string` |
-#### Returns
-`Object`
-| Name | Type |
-| :------ | :------ |
-| `currentVisit` | ``null`` \| `Visit` |
-| `error` | ``null`` |
-#### Defined in
-[packages/framework/esm-react-utils/src/useVisit.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useVisit.ts#L11)
-___
-### useVisitTypes
-▸ **useVisitTypes**(): `VisitType`[]
-#### Returns
-`VisitType`[]
-#### Defined in
-[packages/framework/esm-react-utils/src/useVisitTypes.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useVisitTypes.ts#L4)

package/docs/interfaces/ComponentConfig.md DELETED Viewed

@@ -1,30 +0,0 @@
-[@openmrs/esm-react-utils](../API.md) / ComponentConfig
-# Interface: ComponentConfig
-## Table of contents
-### Properties
-- [extension](ComponentConfig.md#extension)
-- [moduleName](ComponentConfig.md#modulename)
-## Properties
-### extension
-• `Optional` **extension**: [`ExtensionData`](ExtensionData.md)
-#### Defined in
-[packages/framework/esm-react-utils/src/ComponentContext.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ComponentContext.ts#L11)
-___
-### moduleName
-• **moduleName**: `string`
-#### Defined in
-[packages/framework/esm-react-utils/src/ComponentContext.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ComponentContext.ts#L10)

package/docs/interfaces/ComponentDecoratorOptions.md DELETED Viewed

@@ -1,52 +0,0 @@
-[@openmrs/esm-react-utils](../API.md) / ComponentDecoratorOptions
-# Interface: ComponentDecoratorOptions
-## Table of contents
-### Properties
-- [disableTranslations](ComponentDecoratorOptions.md#disabletranslations)
-- [featureName](ComponentDecoratorOptions.md#featurename)
-- [moduleName](ComponentDecoratorOptions.md#modulename)
-- [strictMode](ComponentDecoratorOptions.md#strictmode)
-## Properties
-### disableTranslations
-• `Optional` **disableTranslations**: `boolean`
-#### Defined in
-[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L57)
-___
-### featureName
-• **featureName**: `string`
-#### Defined in
-[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:56](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L56)
-___
-### moduleName
-• **moduleName**: `string`
-#### Defined in
-[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L55)
-___
-### strictMode
-• `Optional` **strictMode**: `boolean`
-#### Defined in
-[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L58)

package/docs/interfaces/ConfigurableLinkProps.md DELETED Viewed

@@ -1,25 +0,0 @@
-[@openmrs/esm-react-utils](../API.md) / ConfigurableLinkProps
-# Interface: ConfigurableLinkProps
-## Hierarchy
-- `AnchorHTMLAttributes`<`HTMLAnchorElement`\>
-  ↳ **`ConfigurableLinkProps`**
-## Table of contents
-### Properties
-- [to](ConfigurableLinkProps.md#to)
-## Properties
-### to
-• **to**: `string`
-#### Defined in
-[packages/framework/esm-react-utils/src/ConfigurableLink.tsx:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ConfigurableLink.tsx#L21)

package/docs/interfaces/ExtensionData.md DELETED Viewed

@@ -1,41 +0,0 @@
-[@openmrs/esm-react-utils](../API.md) / ExtensionData
-# Interface: ExtensionData
-## Table of contents
-### Properties
-- [extensionId](ExtensionData.md#extensionid)
-- [extensionSlotModuleName](ExtensionData.md#extensionslotmodulename)
-- [extensionSlotName](ExtensionData.md#extensionslotname)
-## Properties
-### extensionId
-• **extensionId**: `string`
-#### Defined in
-[packages/framework/esm-react-utils/src/ComponentContext.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ComponentContext.ts#L6)
-___
-### extensionSlotModuleName
-• **extensionSlotModuleName**: `string`
-#### Defined in
-[packages/framework/esm-react-utils/src/ComponentContext.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ComponentContext.ts#L5)
-___
-### extensionSlotName
-• **extensionSlotName**: `string`
-#### Defined in
-[packages/framework/esm-react-utils/src/ComponentContext.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ComponentContext.ts#L4)

package/docs/interfaces/ExtensionProps.md DELETED Viewed

@@ -1,44 +0,0 @@
-[@openmrs/esm-react-utils](../API.md) / ExtensionProps
-# Interface: ExtensionProps
-## Table of contents
-### Properties
-- [state](ExtensionProps.md#state)
-### Methods
-- [wrap](ExtensionProps.md#wrap)
-## Properties
-### state
-• `Optional` **state**: `Record`<`string`, `any`\>
-#### Defined in
-[packages/framework/esm-react-utils/src/Extension.tsx:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L6)
-## Methods
-### wrap
-▸ `Optional` **wrap**(`slot`, `extension`): ``null`` \| `ReactElement`<`any`, `any`\>
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `slot` | `ReactNode` |
-| `extension` | [`ExtensionData`](ExtensionData.md) |
-#### Returns
-``null`` \| `ReactElement`<`any`, `any`\>
-#### Defined in
-[packages/framework/esm-react-utils/src/Extension.tsx:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L7)

package/docs/interfaces/ExtensionSlotBaseProps.md DELETED Viewed

@@ -1,54 +0,0 @@
-[@openmrs/esm-react-utils](../API.md) / ExtensionSlotBaseProps
-# Interface: ExtensionSlotBaseProps
-## Table of contents
-### Properties
-- [extensionSlotName](ExtensionSlotBaseProps.md#extensionslotname)
-- [state](ExtensionSlotBaseProps.md#state)
-### Methods
-- [select](ExtensionSlotBaseProps.md#select)
-## Properties
-### extensionSlotName
-• **extensionSlotName**: `string`
-#### Defined in
-[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:47](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L47)
-___
-### state
-• `Optional` **state**: `Record`<`string`, `any`\>
-#### Defined in
-[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:51](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L51)
-## Methods
-### select
-▸ `Optional` **select**(`extensions`): `ExtensionRegistration`[]
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `extensions` | `ExtensionRegistration`[] |
-#### Returns
-`ExtensionRegistration`[]
-#### Defined in
-[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:48](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L48)

package/docs/interfaces/OpenmrsReactComponentProps.md DELETED Viewed

@@ -1,19 +0,0 @@
-[@openmrs/esm-react-utils](../API.md) / OpenmrsReactComponentProps
-# Interface: OpenmrsReactComponentProps
-## Table of contents
-### Properties
-- [\_extensionContext](OpenmrsReactComponentProps.md#_extensioncontext)
-## Properties
-### \_extensionContext
-• `Optional` **\_extensionContext**: [`ExtensionData`](ExtensionData.md)
-#### Defined in
-[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:62](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L62)

package/docs/interfaces/OpenmrsReactComponentState.md DELETED Viewed

@@ -1,41 +0,0 @@
-[@openmrs/esm-react-utils](../API.md) / OpenmrsReactComponentState
-# Interface: OpenmrsReactComponentState
-## Table of contents
-### Properties
-- [caughtError](OpenmrsReactComponentState.md#caughterror)
-- [caughtErrorInfo](OpenmrsReactComponentState.md#caughterrorinfo)
-- [config](OpenmrsReactComponentState.md#config)
-## Properties
-### caughtError
-• **caughtError**: `any`
-#### Defined in
-[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:66](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L66)
-___
-### caughtErrorInfo
-• **caughtErrorInfo**: `any`
-#### Defined in
-[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:67](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L67)
-___
-### config
-• **config**: [`ComponentConfig`](ComponentConfig.md)
-#### Defined in
-[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:68](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L68)

package/docs/interfaces/UserHasAccessProps.md DELETED Viewed

@@ -1,19 +0,0 @@
-[@openmrs/esm-react-utils](../API.md) / UserHasAccessProps
-# Interface: UserHasAccessProps
-## Table of contents
-### Properties
-- [privilege](UserHasAccessProps.md#privilege)
-## Properties
-### privilege
-• **privilege**: `string`
-#### Defined in
-[packages/framework/esm-react-utils/src/UserHasAccess.tsx:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L5)

package/typedoc.json DELETED Viewed

@@ -1,7 +0,0 @@
-{
-  "out": "docs",
-  "readme": "none",
-  "excludeInternal": true,
-  "gitRevision": "master",
-  "entryDocument": "API.md"
-}