@openmrs/esm-framework 6.3.1-pre.3092 → 6.3.1-pre.3104

package/docs/interfaces/WorkspaceRegistration.md

@@ -1,138 +1,99 @@
-[@openmrs/esm-framework](../API.md) / WorkspaceRegistration
+[O3 Framework](../API.md) / WorkspaceRegistration
 
 # Interface: WorkspaceRegistration
 
-See [WorkspaceDefinition](../API.md#workspacedefinition) for more information about these properties
+Defined in: [packages/framework/esm-extensions/src/workspaces.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/workspaces.ts#L9)
 
-## Table of contents
-
-### Properties
-
-- [canHide](WorkspaceRegistration.md#canhide)
-- [canMaximize](WorkspaceRegistration.md#canmaximize)
-- [groups](WorkspaceRegistration.md#groups)
-- [moduleName](WorkspaceRegistration.md#modulename)
-- [name](WorkspaceRegistration.md#name)
-- [preferredWindowSize](WorkspaceRegistration.md#preferredwindowsize)
-- [title](WorkspaceRegistration.md#title)
-- [titleNode](WorkspaceRegistration.md#titlenode)
-- [type](WorkspaceRegistration.md#type)
-- [width](WorkspaceRegistration.md#width)
-
-### Methods
-
-- [load](WorkspaceRegistration.md#load)
+See [[WorkspaceDefinition]] for more information about these properties
 
 ## Properties
 
 ### canHide
 
-• **canHide**: `boolean`
+> **canHide**: `boolean`
 
-#### Defined in
+Defined in: [packages/framework/esm-extensions/src/workspaces.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/workspaces.ts#L14)
 
-[packages/framework/esm-extensions/src/workspaces.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L14)
-
-___
+***
 
 ### canMaximize
 
-• **canMaximize**: `boolean`
-
-#### Defined in
+> **canMaximize**: `boolean`
 
-[packages/framework/esm-extensions/src/workspaces.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L15)
+Defined in: [packages/framework/esm-extensions/src/workspaces.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/workspaces.ts#L15)
 
-___
+***
 
 ### groups
 
-• **groups**: `string`[]
+> **groups**: `string`[]
 
-#### Defined in
+Defined in: [packages/framework/esm-extensions/src/workspaces.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/workspaces.ts#L20)
 
-[packages/framework/esm-extensions/src/workspaces.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L20)
+***
 
-___
+### load()
 
-### moduleName
+> **load**: () => `Promise`\<`object` & `LifeCycles`\>
 
-• **moduleName**: `string`
+Defined in: [packages/framework/esm-extensions/src/workspaces.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/workspaces.ts#L18)
 
-#### Defined in
+#### Returns
 
-[packages/framework/esm-extensions/src/workspaces.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L19)
+`Promise`\<`object` & `LifeCycles`\>
 
-___
+***
 
-### name
+### moduleName
 
-• **name**: `string`
+> **moduleName**: `string`
 
-#### Defined in
+Defined in: [packages/framework/esm-extensions/src/workspaces.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/workspaces.ts#L19)
 
-[packages/framework/esm-extensions/src/workspaces.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L10)
+***
 
-___
+### name
 
-### preferredWindowSize
+> **name**: `string`
 
-• **preferredWindowSize**: [`WorkspaceWindowState`](../API.md#workspacewindowstate)
+Defined in: [packages/framework/esm-extensions/src/workspaces.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/workspaces.ts#L10)
 
-#### Defined in
+***
 
-[packages/framework/esm-extensions/src/workspaces.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L17)
+### preferredWindowSize
 
-___
+> **preferredWindowSize**: [`WorkspaceWindowState`](../type-aliases/WorkspaceWindowState.md)
 
-### title
+Defined in: [packages/framework/esm-extensions/src/workspaces.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/workspaces.ts#L17)
 
-• **title**: `string`
+***
 
-#### Defined in
+### title
 
-[packages/framework/esm-extensions/src/workspaces.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L11)
+> **title**: `string`
 
-___
+Defined in: [packages/framework/esm-extensions/src/workspaces.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/workspaces.ts#L11)
 
-### titleNode
+***
 
-• `Optional` **titleNode**: `ReactNode`
+### titleNode?
 
-#### Defined in
+> `optional` **titleNode**: `ReactNode`
 
-[packages/framework/esm-extensions/src/workspaces.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L12)
+Defined in: [packages/framework/esm-extensions/src/workspaces.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/workspaces.ts#L12)
 
-___
+***
 
 ### type
 
-• **type**: `string`
-
-#### Defined in
+> **type**: `string`
 
-[packages/framework/esm-extensions/src/workspaces.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L13)
+Defined in: [packages/framework/esm-extensions/src/workspaces.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/workspaces.ts#L13)
 
-___
+***
 
 ### width
 
-• **width**: ``"narrow"`` \| ``"wider"`` \| ``"extra-wide"``
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/workspaces.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L16)
-
-## Methods
-
-### load
-
-▸ **load**(): `Promise`<{ `default?`: `LifeCycles`<{}\>  } & `LifeCycles`<{}\>\>
-
-#### Returns
-
-`Promise`<{ `default?`: `LifeCycles`<{}\>  } & `LifeCycles`<{}\>\>
-
-#### Defined in
+> **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
 
-[packages/framework/esm-extensions/src/workspaces.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L18)
+Defined in: [packages/framework/esm-extensions/src/workspaces.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/workspaces.ts#L16)

package/docs/interfaces/WorkspacesInfo.md

@@ -1,71 +1,57 @@
-[@openmrs/esm-framework](../API.md) / WorkspacesInfo
+[O3 Framework](../API.md) / WorkspacesInfo
 
 # Interface: WorkspacesInfo
 
-## Table of contents
+Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:535](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L535)
 
-### Workspace Properties
-
-- [active](WorkspacesInfo.md#active)
-- [prompt](WorkspacesInfo.md#prompt)
-- [workspaceGroup](WorkspacesInfo.md#workspacegroup)
-- [workspaceWindowState](WorkspacesInfo.md#workspacewindowstate)
-- [workspaces](WorkspacesInfo.md#workspaces)
-
-## Workspace Properties
+## Properties
 
 ### active
 
-• **active**: `boolean`
+> **active**: `boolean`
 
-#### Defined in
+Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:536](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L536)
 
-[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:536](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L536)
-
-___
+***
 
 ### prompt
 
-• **prompt**: ``null`` \| [`Prompt`](Prompt.md)
+> **prompt**: `null` \| [`Prompt`](Prompt.md)
 
-#### Defined in
+Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:537](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L537)
 
-[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:537](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L537)
+***
 
-___
+### workspaceGroup?
 
-### workspaceGroup
+> `optional` **workspaceGroup**: `object`
 
-• `Optional` **workspaceGroup**: `Object`
+Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:540](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L540)
 
-#### Type declaration
+#### cleanup?
 
-| Name | Type |
-| :------ | :------ |
-| `cleanup?` | `Function` |
-| `members` | `string`[] |
-| `name` | `string` |
+> `optional` **cleanup**: `Function`
 
-#### Defined in
+#### members
 
-[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:540](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L540)
+> **members**: `string`[]
 
-___
+#### name
 
-### workspaceWindowState
+> **name**: `string`
 
-• **workspaceWindowState**: [`WorkspaceWindowState`](../API.md#workspacewindowstate)
+***
 
-#### Defined in
+### workspaces
 
-[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:538](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L538)
+> **workspaces**: [`OpenWorkspace`](OpenWorkspace.md)[]
 
-___
+Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:539](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L539)
 
-### workspaces
+***
 
-• **workspaces**: [`OpenWorkspace`](OpenWorkspace.md)[]
+### workspaceWindowState
 
-#### Defined in
+> **workspaceWindowState**: [`WorkspaceWindowState`](../type-aliases/WorkspaceWindowState.md)
 
-[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:539](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L539)
+Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:538](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L538)

package/docs/type-aliases/ActionFunction.md

@@ -0,0 +1,27 @@
+[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

@@ -0,0 +1,7 @@
+[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

@@ -0,0 +1,13 @@
+[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

@@ -0,0 +1,7 @@
+[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

@@ -0,0 +1,17 @@
+[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

@@ -0,0 +1,7 @@
+[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

@@ -0,0 +1,23 @@
+[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

@@ -0,0 +1,7 @@
+[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

@@ -0,0 +1,7 @@
+[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

@@ -0,0 +1,7 @@
+[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

@@ -0,0 +1,9 @@
+[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

@@ -0,0 +1,69 @@
+[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

@@ -0,0 +1,13 @@
+[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

@@ -0,0 +1,7 @@
+[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

@@ -0,0 +1,102 @@
+[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

@@ -0,0 +1,31 @@
+[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)