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

package/docs/type-aliases/ActionFunction.md

@@ -1,27 +0,0 @@
-[O3 Framework](../API.md) / ActionFunction
-
-# Type Alias: ActionFunction()\<T\>
-
-> **ActionFunction**\<`T`\> = (`state`, ...`args`) => `Partial`\<`T`\>
-
-Defined in: [packages/framework/esm-react-utils/src/useStore.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useStore.ts#L6)
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Parameters
-
-### state
-
-`T`
-
-### args
-
-...`any`[]
-
-## Returns
-
-`Partial`\<`T`\>

package/docs/type-aliases/ActionableNotificationType.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / ActionableNotificationType
-
-# Type Alias: ActionableNotificationType
-
-> **ActionableNotificationType** = `"error"` \| `"info"` \| `"info-square"` \| `"success"` \| `"warning"` \| `"warning-alt"`
-
-Defined in: [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:24](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L24)

package/docs/type-aliases/Actions.md

@@ -1,13 +0,0 @@
-[O3 Framework](../API.md) / Actions
-
-# Type Alias: Actions\<T\>
-
-> **Actions**\<`T`\> = (`store`) => `ActionFunctionsRecord`\<`T`\> \| `ActionFunctionsRecord`\<`T`\>
-
-Defined in: [packages/framework/esm-react-utils/src/useStore.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useStore.ts#L10)
-
-## Type Parameters
-
-### T
-
-`T`

package/docs/type-aliases/ArgumentsTuple.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / ArgumentsTuple
-
-# Type Alias: ArgumentsTuple
-
-> **ArgumentsTuple** = \[`any`, `...unknown[]`\]
-
-Defined in: [packages/framework/esm-react-utils/src/useOpenmrsSWR.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useOpenmrsSWR.ts#L8)

package/docs/type-aliases/BoundActions.md

@@ -1,17 +0,0 @@
-[O3 Framework](../API.md) / BoundActions
-
-# Type Alias: BoundActions\<T, A\>
-
-> **BoundActions**\<`T`, `A`\> = `A` *extends* `ActionFunctionsRecord`\<`T`\> ? `BindFunctionsIn`\<`A`\> : `A` *extends* (`store`) => `ActionFunctionsRecord`\<`T`\> ? `BindFunctionsIn`\<`ActionFunctionsRecord`\<`T`\>\> : `never`
-
-Defined in: [packages/framework/esm-react-utils/src/useStore.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useStore.ts#L12)
-
-## Type Parameters
-
-### T
-
-`T`
-
-### A
-
-`A` *extends* [`Actions`](Actions.md)\<`T`\>

package/docs/type-aliases/ConfigValue.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / ConfigValue
-
-# Type Alias: ConfigValue
-
-> **ConfigValue** = `string` \| `number` \| `boolean` \| `void` \| `any`[] \| `object`
-
-Defined in: [packages/framework/esm-config/src/types.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/types.ts#L46)

package/docs/type-aliases/ContextCallback.md

@@ -1,23 +0,0 @@
-[O3 Framework](../API.md) / ContextCallback
-
-# Type Alias: ContextCallback()\<T\>
-
-> **ContextCallback**\<`T`\> = (`state`) => `void`
-
-Defined in: [packages/framework/esm-context/src/context.ts:95](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-context/src/context.ts#L95)
-
-## Type Parameters
-
-### T
-
-`T` *extends* `object` = \{ \}
-
-## Parameters
-
-### state
-
-`Readonly`\<`T`\> | `null` | `undefined`
-
-## Returns
-
-`void`

package/docs/type-aliases/CoreTranslationKey.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / CoreTranslationKey
-
-# Type Alias: CoreTranslationKey
-
-> **CoreTranslationKey** = keyof *typeof* `coreTranslations`
-
-Defined in: [packages/framework/esm-translations/src/index.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-translations/src/index.ts#L53)

package/docs/type-aliases/CurrentPatient.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / CurrentPatient
-
-# Type Alias: CurrentPatient
-
-> **CurrentPatient** = `fhir.Patient` \| `FetchResponse`\<`fhir.Patient`\>
-
-Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/current-patient.ts#L5)

package/docs/type-aliases/DateInput.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / DateInput
-
-# Type Alias: DateInput
-
-> **DateInput** = `string` \| `number` \| `Date`
-
-Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:6

package/docs/type-aliases/DefaultEvaluateReturnType.md

@@ -1,9 +0,0 @@
-[O3 Framework](../API.md) / DefaultEvaluateReturnType
-
-# Type Alias: DefaultEvaluateReturnType
-
-> **DefaultEvaluateReturnType** = `string` \| `number` \| `boolean` \| `Date` \| `null` \| `undefined`
-
-Defined in: [packages/framework/esm-expression-evaluator/src/evaluator.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-expression-evaluator/src/evaluator.ts#L31)
-
-The valid return types for `evaluate()` and `evaluateAsync()`

package/docs/type-aliases/ExtensionDefinition.md

@@ -1,69 +0,0 @@
-[O3 Framework](../API.md) / ExtensionDefinition
-
-# Type Alias: ExtensionDefinition
-
-> **ExtensionDefinition** = `object` & \{ `component`: `string`; \} \| \{ `component?`: `never`; \}
-
-Defined in: packages/framework/esm-globals/dist/types.d.ts:171
-
-A definition of an extension as extracted from an app's routes.json
-
-## Type declaration
-
-### featureFlag?
-
-> `optional` **featureFlag**: `string`
-
-If supplied, the extension will only be rendered when this feature flag is enabled.
-
-### meta?
-
-> `optional` **meta**: `object`
-
-Meta describes any properties that are passed down to the extension when it is loaded
-
-#### Index Signature
-
-\[`k`: `string`\]: `unknown`
-
-### name
-
-> **name**: `string`
-
-The name of this extension. This is used to refer to the extension in configuration.
-
-### offline?
-
-> `optional` **offline**: `boolean`
-
-Determines whether the component renders while the browser is not connected to the internet. If false, this page will never render while offline.
-
-### online?
-
-> `optional` **online**: `boolean`
-
-Determines whether the component renders while the browser is connected to the internet. If false, this page will never render while online.
-
-### order?
-
-> `optional` **order**: `number`
-
-Determines the order in which this component renders in its default extension slot. Note that this can be overridden by configuration.
-
-### privileges?
-
-> `optional` **privileges**: `string` \| `string`[]
-
-The user must have ANY of these privileges to see this extension.
-
-### slot?
-
-> `optional` **slot**: `string`
-
-If supplied, the slot that this extension is rendered into by default.
-
-### slots?
-
-> `optional` **slots**: `string`[]
-
-If supplied, the slots that this extension is rendered into by default.

package/docs/type-aliases/ExtensionProps.md

@@ -1,13 +0,0 @@
-[O3 Framework](../API.md) / ExtensionProps
-
-# Type Alias: ExtensionProps
-
-> **ExtensionProps** = `React.HTMLAttributes`\<`HTMLDivElement`\> & `object`
-
-Defined in: [packages/framework/esm-react-utils/src/Extension.tsx:7](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/Extension.tsx#L7)
-
-## Type declaration
-
-### state?
-
-> `optional` **state**: `Record`\<`string`, `unknown`\>

package/docs/type-aliases/FormatDateMode.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / FormatDateMode
-
-# Type Alias: FormatDateMode
-
-> **FormatDateMode** = `"standard"` \| `"wide"`
-
-Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:49

package/docs/type-aliases/FormatDateOptions.md

@@ -1,102 +0,0 @@
-[O3 Framework](../API.md) / FormatDateOptions
-
-# Type Alias: FormatDateOptions
-
-> **FormatDateOptions** = `object`
-
-Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:50
-
-## Properties
-
-### calendar?
-
-> `optional` **calendar**: `string`
-
-Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:54
-
-The calendar to use when formatting this date.
-
-***
-
-### day
-
-> **day**: `boolean`
-
-Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:70
-
-Whether to include the day number
-
-***
-
-### locale?
-
-> `optional` **locale**: `string`
-
-Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:58
-
-The locale to use when formatting this date
-
-***
-
-### mode
-
-> **mode**: [`FormatDateMode`](FormatDateMode.md)
-
-Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:63
-
-- `standard`: "03 Feb 2022"
-- `wide`:     "03 — Feb — 2022"
-
-***
-
-### month
-
-> **month**: `boolean`
-
-Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:72
-
-Whether to include the month number
-
-***
-
-### noToday
-
-> **noToday**: `boolean`
-
-Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:83
-
-Disables the special handling of dates that are today. If false
-(the default), then dates that are today will be formatted as "Today"
-in the locale language. If true, then dates that are today will be
-formatted the same as all other dates.
-
-***
-
-### numberingSystem?
-
-> `optional` **numberingSystem**: `string`
-
-Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:76
-
-The unicode numbering system to use
-
-***
-
-### time
-
-> **time**: `true` \| `false` \| `"for today"`
-
-Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:68
-
-Whether the time should be included in the output always (`true`),
-never (`false`), or only when the input date is today (`for today`).
-
-***
-
-### year
-
-> **year**: `boolean`
-
-Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:74
-
-Whether to include the year

package/docs/type-aliases/IconProps.md

@@ -1,31 +0,0 @@
-[O3 Framework](../API.md) / IconProps
-
-# Type Alias: IconProps
-
-> **IconProps** = `object`
-
-Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:7](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/icons/icons.tsx#L7)
-
-## Properties
-
-### className?
-
-> `optional` **className**: `Argument`
-
-Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/icons/icons.tsx#L8)
-
-***
-
-### fill?
-
-> `optional` **fill**: `string`
-
-Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/icons/icons.tsx#L9)
-
-***
-
-### size?
-
-> `optional` **size**: `number`
-
-Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/icons/icons.tsx#L10)

package/docs/type-aliases/InlineNotificationType.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / InlineNotificationType
-
-# Type Alias: InlineNotificationType
-
-> **InlineNotificationType** = `"error"` \| `"info"` \| `"info-square"` \| `"success"` \| `"warning"` \| `"warning-alt"`
-
-Defined in: [packages/framework/esm-styleguide/src/notifications/notification.component.tsx:23](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L23)

package/docs/type-aliases/Key.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / Key
-
-# Type Alias: Key
-
-> **Key** = `string` \| [`ArgumentsTuple`](ArgumentsTuple.md) \| `undefined` \| `null`
-
-Defined in: [packages/framework/esm-react-utils/src/useOpenmrsSWR.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useOpenmrsSWR.ts#L9)

package/docs/type-aliases/KnownOmrsServiceWorkerMessages.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / KnownOmrsServiceWorkerMessages
-
-# Type Alias: KnownOmrsServiceWorkerMessages
-
-> **KnownOmrsServiceWorkerMessages** = [`OnImportMapChangedMessage`](../interfaces/OnImportMapChangedMessage.md) \| [`ClearDynamicRoutesMessage`](../interfaces/ClearDynamicRoutesMessage.md) \| [`RegisterDynamicRouteMessage`](../interfaces/RegisterDynamicRouteMessage.md)
-
-Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/service-worker-messaging.ts#L41)

package/docs/type-aliases/LayoutType.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / LayoutType
-
-# Type Alias: LayoutType
-
-> **LayoutType** = `"phone"` \| `"tablet"` \| `"small-desktop"` \| `"large-desktop"`
-
-Defined in: [packages/framework/esm-react-utils/src/useLayoutType.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useLayoutType.ts#L4)

package/docs/type-aliases/LoadedSessionStore.md

@@ -1,23 +0,0 @@
-[O3 Framework](../API.md) / LoadedSessionStore
-
-# Type Alias: LoadedSessionStore
-
-> **LoadedSessionStore** = `object`
-
-Defined in: [packages/framework/esm-api/src/current-user.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/current-user.ts#L11)
-
-## Properties
-
-### loaded
-
-> **loaded**: `true`
-
-Defined in: [packages/framework/esm-api/src/current-user.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/current-user.ts#L12)
-
-***
-
-### session
-
-> **session**: [`Session`](../interfaces/Session.md)
-
-Defined in: [packages/framework/esm-api/src/current-user.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/current-user.ts#L13)

package/docs/type-aliases/ModalDefinition.md

@@ -1,17 +0,0 @@
-[O3 Framework](../API.md) / ModalDefinition
-
-# Type Alias: ModalDefinition
-
-> **ModalDefinition** = `object` & \{ `component`: `string`; \} \| \{ `component?`: `never`; \}
-
-Defined in: packages/framework/esm-globals/dist/types.d.ts:234
-
-A definition of a modal as extracted from an app's routes.json
-
-## Type declaration
-
-### name
-
-> **name**: `string`
-
-The name of this modal. This is used to launch the modal.

package/docs/type-aliases/NameUse.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / NameUse
-
-# Type Alias: NameUse
-
-> **NameUse** = `"usual"` \| `"official"` \| `"temp"` \| `"nickname"` \| `"anonymous"` \| `"old"` \| `"maiden"`
-
-Defined in: packages/framework/esm-globals/dist/types.d.ts:392

package/docs/type-aliases/NullablePatient.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / NullablePatient
-
-# Type Alias: NullablePatient
-
-> **NullablePatient** = `fhir.Patient` \| `null`
-
-Defined in: [packages/framework/esm-react-utils/src/usePatient.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/usePatient.ts#L6)

package/docs/type-aliases/OfflineMode.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / OfflineMode
-
-# Type Alias: OfflineMode
-
-> **OfflineMode** = `"on"` \| `"off"` \| `"unavailable"`
-
-Defined in: [packages/framework/esm-offline/src/mode.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/mode.ts#L34)

package/docs/type-aliases/OmrsOfflineCachingStrategy.md

@@ -1,12 +0,0 @@
-[O3 Framework](../API.md) / OmrsOfflineCachingStrategy
-
-# Type Alias: OmrsOfflineCachingStrategy
-
-> **OmrsOfflineCachingStrategy** = `"network-only-or-cache-only"` \| `"network-first"`
-
-Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/service-worker-http-headers.ts#L15)
-
-* `cache-or-network`: The default strategy, equal to the absence of this header.
-  The SW attempts to resolve the request via the network, but falls back to the cache if required.
-  The service worker decides the strategy to be used.
-* `network-first`: See https://developers.google.com/web/tools/workbox/modules/workbox-strategies#network_first_network_falling_back_to_cache.

package/docs/type-aliases/OmrsOfflineHttpHeaderNames.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / OmrsOfflineHttpHeaderNames
-
-# Type Alias: OmrsOfflineHttpHeaderNames
-
-> **OmrsOfflineHttpHeaderNames** = keyof [`OmrsOfflineHttpHeaders`](OmrsOfflineHttpHeaders.md)
-
-Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/service-worker-http-headers.ts#L40)

package/docs/type-aliases/OmrsOfflineHttpHeaders.md

@@ -1,44 +0,0 @@
-[O3 Framework](../API.md) / OmrsOfflineHttpHeaders
-
-# Type Alias: OmrsOfflineHttpHeaders
-
-> **OmrsOfflineHttpHeaders** = `object`
-
-Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/service-worker-http-headers.ts#L21)
-
-Defines the keys of the custom headers which can be appended to an HTTP request.
-HTTP requests with these headers are handled in a special way by the SPA's service worker.
-
-## Properties
-
-### x-omrs-offline-caching-strategy?
-
-> `optional` **x-omrs-offline-caching-strategy**: [`OmrsOfflineCachingStrategy`](OmrsOfflineCachingStrategy.md)
-
-Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/service-worker-http-headers.ts#L37)
-
-Instructs the service worker to use a specific caching strategy for this request.
-
-***
-
-### x-omrs-offline-response-body?
-
-> `optional` **x-omrs-offline-response-body**: `string`
-
-Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/service-worker-http-headers.ts#L27)
-
-If the client is offline and the request cannot be read from the cache (i.e. if there is no way
-to receive any kind of data for this request), the service worker will return a response with
-the body in this header.
-
-***
-
-### x-omrs-offline-response-status?
-
-> `optional` **x-omrs-offline-response-status**: `` `${number}` ``
-
-Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/service-worker-http-headers.ts#L33)
-
-If the client is offline and the request cannot be read from the cache (i.e. if there is no way
-to receive any kind of data for this request), the service worker will return a response with
-the status code defined in this header.

package/docs/type-aliases/OpenmrsRoutes.md

@@ -1,10 +0,0 @@
-[O3 Framework](../API.md) / OpenmrsRoutes
-
-# Type Alias: OpenmrsRoutes
-
-> **OpenmrsRoutes** = `Record`\<`string`, [`OpenmrsAppRoutes`](../interfaces/OpenmrsAppRoutes.md)\>
-
-Defined in: packages/framework/esm-globals/dist/types.d.ts:388
-
-This interfaces describes the format of the overall rotues.json loaded by the app shell.
-Basically, this is the same as the app routes, with each routes definition keyed by the app's name

package/docs/type-aliases/PageDefinition.md

@@ -1,41 +0,0 @@
-[O3 Framework](../API.md) / PageDefinition
-
-# Type Alias: PageDefinition
-
-> **PageDefinition** = `object` & \{ `route`: `string` \| `boolean`; `routeRegex?`: `never`; \} \| \{ `route?`: `never`; `routeRegex`: `string`; \}
-
-Defined in: packages/framework/esm-globals/dist/types.d.ts:113
-
-A definition of a page extracted from an app's routes.json
-
-## Type declaration
-
-### component
-
-> **component**: `string`
-
-The name of the component exported by this frontend module.
-
-### featureFlag?
-
-> `optional` **featureFlag**: `string`
-
-If supplied, the page will only be rendered when this feature flag is enabled.
-
-### offline?
-
-> `optional` **offline**: `boolean`
-
-Determines whether the component renders while the browser is not connected to the internet. If false, this page will never render while offline.
-
-### online?
-
-> `optional` **online**: `boolean`
-
-Determines whether the component renders while the browser is connected to the internet. If false, this page will never render while online.
-
-### order?
-
-> `optional` **order**: `number`
-
-Determines the order in which this page is rendered in the app-shell, which is useful for situations where DOM ordering matters.

package/docs/type-aliases/PageHeaderProps.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / PageHeaderProps
-
-# Type Alias: PageHeaderProps
-
-> **PageHeaderProps** = `XOR`\<[`PageHeaderWrapperProps`](../interfaces/PageHeaderWrapperProps.md), [`PageHeaderContentProps`](../interfaces/PageHeaderContentProps.md)\>
-
-Defined in: [packages/framework/esm-styleguide/src/page-header/page-header.component.tsx:30](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/page-header/page-header.component.tsx#L30)

package/docs/type-aliases/PatientUuid.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / PatientUuid
-
-# Type Alias: PatientUuid
-
-> **PatientUuid** = `string` \| `null`
-
-Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/current-patient.ts#L19)

package/docs/type-aliases/PictogramProps.md

@@ -1,23 +0,0 @@
-[O3 Framework](../API.md) / PictogramProps
-
-# Type Alias: PictogramProps
-
-> **PictogramProps** = `object`
-
-Defined in: [packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:7](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/pictograms/pictograms.tsx#L7)
-
-## Properties
-
-### className?
-
-> `optional` **className**: `Argument`
-
-Defined in: [packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/pictograms/pictograms.tsx#L8)
-
-***
-
-### size?
-
-> `optional` **size**: `number`
-
-Defined in: [packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/pictograms/pictograms.tsx#L9)