API.md

Back to README.md

@openmrs/esm-react-utils

Table of contents

Interfaces

• ComponentConfig
• ComponentDecoratorOptions
• ConfigurableLinkProps
• ExtensionData
• ExtensionProps
• ExtensionSlotBaseProps
• OpenmrsReactComponentProps
• OpenmrsReactComponentState
• UserHasAccessProps

Type aliases

• Actions
• BoundActions
• ExtensionSlotProps
• LayoutType

Navigation Variables

• ConfigurableLink

Other Variables

• ComponentContext
• Extension
• ExtensionSlot
• UserHasAccess

Functions

• createUseStore
• getAsyncExtensionLifecycle
• getAsyncLifecycle
• getLifecycle
• getSyncLifecycle
• openmrsComponentDecorator
• useAssignedExtensionIds
• useAttachedExtensionIds
• useConfig
• useConnectedExtensions
• useConnectivity
• useCurrentPatient
• useExtension
• useExtensionSlot
• useExtensionSlotConfig
• useExtensionSlotMeta
• useExtensionStore
• useForceUpdate
• useLayoutType
• useLocations
• useNavigationContext
• usePagination
• useSessionUser
• useStore
• useStoreState
• useVisit
• useVisitTypes

Type aliases

Actions

Ƭ Actions: Function | { [key: string]: Function; }

Defined in

packages/framework/esm-react-utils/src/createUseStore.ts:4

---

BoundActions

Ƭ BoundActions: Object

Index signature

▪ [key: string]: BoundAction

Defined in

packages/framework/esm-react-utils/src/createUseStore.ts:5

---

ExtensionSlotProps

Ƭ ExtensionSlotProps: ExtensionSlotBaseProps & React.HTMLAttributes<HTMLDivElement>

Defined in

packages/framework/esm-react-utils/src/ExtensionSlot.tsx:54

---

LayoutType

Ƭ LayoutType: "tablet" | "phone" | "desktop"

Defined in

packages/framework/esm-react-utils/src/useLayoutType.ts:3

Navigation Variables

ConfigurableLink

• Const ConfigurableLink: React.FC<ConfigurableLinkProps>

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 tag except href and onClick

Defined in

packages/framework/esm-react-utils/src/ConfigurableLink.tsx:32

---

Other Variables

ComponentContext

• Const ComponentContext: Context<ComponentConfig>

Available to all components. Provided by openmrsComponentDecorator.

Defined in

packages/framework/esm-react-utils/src/ComponentContext.ts:17

---

Extension

• Const Extension: React.FC<ExtensionProps>

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>.

Defined in

packages/framework/esm-react-utils/src/Extension.tsx:21

---

ExtensionSlot

• Const ExtensionSlot: React.FC<ExtensionSlotProps>

Defined in

packages/framework/esm-react-utils/src/ExtensionSlot.tsx:57

---

UserHasAccess

• Const UserHasAccess: React.FC<UserHasAccessProps>

Defined in

packages/framework/esm-react-utils/src/UserHasAccess.tsx:8

Functions

createUseStore

▸ createUseStore<T>(store): () => T(actions: Actions) => T & BoundActions(actions?: Actions) => T & BoundActions

Type parameters

Name
T

Parameters

Name	Type
store	Store<T>

Returns

fn

▸ (): T

Returns

T

▸ (actions): T & BoundActions

Parameters

Name	Type
actions	Actions

Returns

T & BoundActions

▸ (actions?): T & BoundActions

Parameters

Name	Type
actions?	Actions

Returns

T & BoundActions

Defined in

packages/framework/esm-react-utils/src/createUseStore.ts:21

---

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

Returns

fn

▸ (): Promise<ReactAppOrParcel<any>>

Returns

Promise<ReactAppOrParcel<any>>

Defined in

packages/framework/esm-react-utils/src/getLifecycle.ts:38

---

getAsyncLifecycle

▸ getAsyncLifecycle<T>(lazy, options): () => Promise<ReactAppOrParcel<any>>

Type parameters

Name
T

Parameters

Name	Type
lazy	() => Promise<Object>
options	ComponentDecoratorOptions

Returns

fn

▸ (): Promise<ReactAppOrParcel<any>>

Returns

Promise<ReactAppOrParcel<any>>

Defined in

packages/framework/esm-react-utils/src/getLifecycle.ts:20

---

getLifecycle

▸ getLifecycle<T>(Component, options): ReactAppOrParcel<any>

Type parameters

Name
T

Parameters

Name	Type
Component	React.ComponentType<T>
options	ComponentDecoratorOptions

Returns

ReactAppOrParcel<any>

Defined in

packages/framework/esm-react-utils/src/getLifecycle.ts:9

---

getSyncLifecycle

▸ getSyncLifecycle<T>(Component, options): () => Promise<ReactAppOrParcel<any>>

Type parameters

Name
T

Parameters

Name	Type
Component	React.ComponentType<T>
options	ComponentDecoratorOptions

Returns

fn

▸ (): Promise<ReactAppOrParcel<any>>

Returns

Promise<ReactAppOrParcel<any>>

Defined in

packages/framework/esm-react-utils/src/getLifecycle.ts:28

---

openmrsComponentDecorator

▸ openmrsComponentDecorator(userOpts): (Comp: ComponentType<Object>) => ComponentType<any>

Parameters

Name	Type
userOpts	ComponentDecoratorOptions

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

---

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

---

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

---

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:104

---

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

---

useConnectivity

▸ useConnectivity(): boolean

Returns

boolean

Defined in

packages/framework/esm-react-utils/src/useConnectivity.ts:4

---

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

---

useExtension

▸ useExtension<TRef>(state?): [RefObject<TRef>, ExtensionData | undefined]

Type parameters

Name	Type
TRef	TRef: HTMLElement

Parameters

Name	Type
state?	Record<string, any>

Returns

[RefObject<TRef>, ExtensionData | undefined]

Defined in

packages/framework/esm-react-utils/src/useExtension.ts:5

---

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

---

useExtensionSlotConfig

▸ useExtensionSlotConfig(extensionSlotName): ExtensionSlotConfigObject

Parameters

Name	Type
extensionSlotName	string

Returns

ExtensionSlotConfigObject

Defined in

packages/framework/esm-react-utils/src/useExtensionSlotConfig.ts:16

---

useExtensionSlotMeta

▸ useExtensionSlotMeta(extensionSlotName): Object

Extract meta data from all extension for a given extension slot.

Parameters

Name	Type
extensionSlotName	string

Returns

Object

Defined in

packages/framework/esm-react-utils/src/useExtensionSlotMeta.ts:8

---

useExtensionStore

▸ Const useExtensionStore(): T

Returns

T

Defined in

packages/framework/esm-react-utils/src/useExtensionStore.ts:4

▸ Const useExtensionStore(actions): T & BoundActions

Parameters

Name	Type
actions	Actions

Returns

T & BoundActions

Defined in

packages/framework/esm-react-utils/src/useExtensionStore.ts:4

▸ Const useExtensionStore(actions?): T & BoundActions

Parameters

Name	Type
actions?	Actions

Returns

T & BoundActions

Defined in

packages/framework/esm-react-utils/src/useExtensionStore.ts:4

---

useForceUpdate

▸ useForceUpdate(): () => void

Returns

fn

▸ (): void

Returns

void

Defined in

packages/framework/esm-react-utils/src/useForceUpdate.ts:3

---

useLayoutType

▸ useLayoutType(): LayoutType

Returns

LayoutType

Defined in

packages/framework/esm-react-utils/src/useLayoutType.ts:22

---

useLocations

▸ useLocations(): Location[]

Returns

Location[]

Defined in

packages/framework/esm-react-utils/src/useLocations.tsx:4

---

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

---

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

---

useSessionUser

▸ useSessionUser(): null | SessionUser

Returns

null | SessionUser

Defined in

packages/framework/esm-react-utils/src/useSessionUser.tsx:4

---

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

▸ useStore<T>(store, actions): T & BoundActions

Type parameters

Name
T

Parameters

Name	Type
store	Store<T>
actions	Actions

Returns

T & BoundActions

Defined in

packages/framework/esm-react-utils/src/useStore.ts:5

---

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

---

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

---

useVisitTypes

▸ useVisitTypes(): VisitType[]

Returns

VisitType[]

Defined in

packages/framework/esm-react-utils/src/useVisitTypes.ts:4