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

package/docs/variables/MaybePictogram.md

@@ -0,0 +1,16 @@
+[O3 Framework](../API.md) / MaybePictogram
+
+# Variable: MaybePictogram
+
+> `const` **MaybePictogram**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<`object` & [`PictogramProps`](../type-aliases/PictogramProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:75](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pictograms/pictograms.tsx#L75)
+
+This is a utility component that takes an `pictogram` and render it if the sprite for the pictogram
+is available. The goal is to make it easier to conditionally render configuration-specified pictograms.
+
+## Example
+
+```tsx
+  <MaybePictogram pictogram='omrs-icon-baby' className={styles.myPictogramStyles} />
+```

package/docs/variables/MedicationIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / MedicationIcon
+
+# Variable: MedicationIcon
+
+> `const` **MedicationIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:404](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L404)

package/docs/variables/MessageQueueIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / MessageQueueIcon
+
+# Variable: MessageQueueIcon
+
+> `const` **MessageQueueIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:412](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L412)

package/docs/variables/MicroscopeIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / MicroscopeIcon
+
+# Variable: MicroscopeIcon
+
+> `const` **MicroscopeIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:420](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L420)

package/docs/variables/MoneyIcon.md

@@ -0,0 +1,9 @@
+[O3 Framework](../API.md) / MoneyIcon
+
+# Variable: MoneyIcon
+
+> `const` **MoneyIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:429](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L429)
+
+Billing

package/docs/variables/MotherIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / MotherIcon
+
+# Variable: MotherIcon
+
+> `const` **MotherIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:437](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L437)

package/docs/variables/MovementIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / MovementIcon
+
+# Variable: MovementIcon
+
+> `const` **MovementIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:445](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L445)

package/docs/variables/OpenmrsDatePicker.md

@@ -0,0 +1,9 @@
+[O3 Framework](../API.md) / OpenmrsDatePicker
+
+# Variable: OpenmrsDatePicker
+
+> `const` **OpenmrsDatePicker**: `ForwardRefExoticComponent`\<[`OpenmrsDatePickerProps`](../interfaces/OpenmrsDatePickerProps.md) & `RefAttributes`\<`HTMLDivElement`\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx:94](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/OpenmrsDatePicker.tsx#L94)
+
+A date picker component to select a single date. Based on React Aria, but styled to look like Carbon.

package/docs/variables/OverflowMenuHorizontalIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / OverflowMenuHorizontalIcon
+
+# Variable: OverflowMenuHorizontalIcon
+
+> `const` **OverflowMenuHorizontalIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:453](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L453)

package/docs/variables/OverflowMenuVerticalIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / OverflowMenuVerticalIcon
+
+# Variable: OverflowMenuVerticalIcon
+
+> `const` **OverflowMenuVerticalIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:461](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L461)

package/docs/variables/PageHeader.md

@@ -0,0 +1,30 @@
+[O3 Framework](../API.md) / PageHeader
+
+# Variable: PageHeader
+
+> `const` **PageHeader**: `React.FC`\<[`PageHeaderProps`](../type-aliases/PageHeaderProps.md)\>
+
+Defined in: [packages/framework/esm-styleguide/src/page-header/page-header.component.tsx:58](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/page-header/page-header.component.tsx#L58)
+
+The page header is typically located at the top of a dashboard. It includes a pictogram on the left,
+the name of the dashboard or page, and the `implementationName` from the configuration, which is typically
+the name of the clinic or the authority that is using the implementation. It can also include interactive
+content on the right-hand side. It can be used in two ways:
+
+1. Alone, in order to render just the page header, with no content on the right side:
+
+## Examples
+
+```tsx
+  <PageHeader title="My Dashboard" illustration={<Illustration />} />
+```
+
+2. Wrapped around the [[PageHeaderContent]] component, in order to render the page header on the left
+and some other content on the right side:
+
+```tsx
+  <PageHeader>
+    <PageHeaderContent title="My Dashboard" illustration={<Illustration />} />
+    <Button>Click me</Button>
+  </PageHeader>
+```

package/docs/variables/PageHeaderContent.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / PageHeaderContent
+
+# Variable: PageHeaderContent
+
+> `const` **PageHeaderContent**: `React.FC`\<[`PageHeaderContentProps`](../interfaces/PageHeaderContentProps.md)\>
+
+Defined in: [packages/framework/esm-styleguide/src/page-header/page-header.component.tsx:90](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/page-header/page-header.component.tsx#L90)
+
+The PageHeaderContent component should be used inside the [[PageHeader]] component. It is used if the page
+header should include some content on the right side, in addition to the pictogram and the name of the page.
+If only the page header is needed, without any additional content, the [[PageHeader]] component can be used
+on its own, and the PageHeaderContent component is not needed.
+
+## Example
+
+```tsx
+  <PageHeader>
+    <PageHeaderContent title="My Dashboard" illustration={<Illustration />} />
+    <Button>Click me</Button>
+  </PageHeader>
+```

package/docs/variables/PasswordIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / PasswordIcon
+
+# Variable: PasswordIcon
+
+> `const` **PasswordIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:684](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L684)

package/docs/variables/PatientListsPictogram.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / PatientListsPictogram
+
+# Variable: PatientListsPictogram
+
+> `const` **PatientListsPictogram**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`PictogramProps`](../type-aliases/PictogramProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pictograms/pictograms.tsx#L36)

package/docs/variables/PedestrianFamilyIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / PedestrianFamilyIcon
+
+# Variable: PedestrianFamilyIcon
+
+> `const` **PedestrianFamilyIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:469](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L469)

package/docs/variables/PenIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / PenIcon
+
+# Variable: PenIcon
+
+> `const` **PenIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:477](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L477)

package/docs/variables/PharmacyPictogram.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / PharmacyPictogram
+
+# Variable: PharmacyPictogram
+
+> `const` **PharmacyPictogram**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`PictogramProps`](../type-aliases/PictogramProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:42](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pictograms/pictograms.tsx#L42)

package/docs/variables/Pictogram.md

@@ -0,0 +1,9 @@
+[O3 Framework](../API.md) / Pictogram
+
+# Variable: Pictogram
+
+> `const` **Pictogram**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`SvgPictogramProps`](../type-aliases/SvgPictogramProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:118](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pictograms/pictograms.tsx#L118)
+
+This is a utility type for custom pictograms. Please maintain alphabetical order when adding new pictograms for readability.

package/docs/variables/PrinterIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / PrinterIcon
+
+# Variable: PrinterIcon
+
+> `const` **PrinterIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:485](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L485)

package/docs/variables/ProcedureOrderIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / ProcedureOrderIcon
+
+# Variable: ProcedureOrderIcon
+
+> `const` **ProcedureOrderIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:493](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L493)

package/docs/variables/ProgramsIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / ProgramsIcon
+
+# Variable: ProgramsIcon
+
+> `const` **ProgramsIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:501](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L501)

package/docs/variables/RadiologyIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / RadiologyIcon
+
+# Variable: RadiologyIcon
+
+> `const` **RadiologyIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\> = `ImageMedicalIcon`
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:744](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L744)

package/docs/variables/ReferralOrderIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / ReferralOrderIcon
+
+# Variable: ReferralOrderIcon
+
+> `const` **ReferralOrderIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:509](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L509)

package/docs/variables/RegistrationPictogram.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / RegistrationPictogram
+
+# Variable: RegistrationPictogram
+
+> `const` **RegistrationPictogram**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`PictogramProps`](../type-aliases/PictogramProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:48](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pictograms/pictograms.tsx#L48)

package/docs/variables/RenderIfValueIsTruthy.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / RenderIfValueIsTruthy
+
+# Variable: RenderIfValueIsTruthy
+
+> `const` **RenderIfValueIsTruthy**: `React.FC`\<`PropsWithChildren`\<\{ `fallback?`: `React.ReactNode`; `value`: `unknown`; \}\>\>
+
+Defined in: [packages/framework/esm-react-utils/src/RenderIfValueIsTruthy.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/RenderIfValueIsTruthy.tsx#L17)
+
+A really simple component that renders its children if the prop named `value` has a truthy value
+
+## Example
+
+```tsx
+<RenderIfValueIsTruthy value={variable}>
+ <Component value={variable} />
+</RenderIfValueIsTruthy>
+````
+
+@param props.value The value to check whether or not its truthy
+@param props.fallback What to render if the value is not truthy. If not specified, nothing will be rendered
+@param props.children The components to render if the `value` is truthy

package/docs/variables/RenewIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / RenewIcon
+
+# Variable: RenewIcon
+
+> `const` **RenewIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:517](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L517)

package/docs/variables/ReportIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / ReportIcon
+
+# Variable: ReportIcon
+
+> `const` **ReportIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:525](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L525)

package/docs/variables/ResetIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / ResetIcon
+
+# Variable: ResetIcon
+
+> `const` **ResetIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:533](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L533)

package/docs/variables/ResponsiveWrapper.md

@@ -0,0 +1,11 @@
+[O3 Framework](../API.md) / ResponsiveWrapper
+
+# Variable: ResponsiveWrapper
+
+> `const` **ResponsiveWrapper**: `React.FC`\<[`ResponsiveWrapperProps`](../interfaces/ResponsiveWrapperProps.md)\>
+
+Defined in: [packages/framework/esm-styleguide/src/responsive-wrapper/responsive-wrapper.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/responsive-wrapper/responsive-wrapper.component.tsx#L15)
+
+ResponsiveWrapper enables a responsive behavior for the component its wraps, providing a different rendering based on the current layout type.
+On desktop, it renders the children as is, while on a tablet, it wraps them in a Carbon Layer https://react.carbondesignsystem.com/?path=/docs/components-layer--overview component.
+This provides a light background for form inputs on tablets, in accordance with the design requirements.

package/docs/variables/SaveIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / SaveIcon
+
+# Variable: SaveIcon
+
+> `const` **SaveIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:549](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L549)

package/docs/variables/SearchIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / SearchIcon
+
+# Variable: SearchIcon
+
+> `const` **SearchIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:557](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L557)

package/docs/variables/ServiceQueuesPictogram.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / ServiceQueuesPictogram
+
+# Variable: ServiceQueuesPictogram
+
+> `const` **ServiceQueuesPictogram**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`PictogramProps`](../type-aliases/PictogramProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:54](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pictograms/pictograms.tsx#L54)

package/docs/variables/ShoppingCartAddItemIcon.md

@@ -0,0 +1,11 @@
+[O3 Framework](../API.md) / ShoppingCartAddItemIcon
+
+# Variable: ShoppingCartAddItemIcon
+
+> `const` **ShoppingCartAddItemIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\> = `ShoppingCartArrowDownIcon`
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:751](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L751)
+
+Used as a button to add an item to the Order basket from a search
+
+Note this is an alias for ShoppingCartArrowDownIcon

package/docs/variables/ShoppingCartArrowDownIcon.md

@@ -0,0 +1,9 @@
+[O3 Framework](../API.md) / ShoppingCartArrowDownIcon
+
+# Variable: ShoppingCartArrowDownIcon
+
+> `const` **ShoppingCartArrowDownIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:583](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L583)
+
+Used as a button to add an item to the Order basket from a search

package/docs/variables/ShoppingCartIcon.md

@@ -0,0 +1,9 @@
+[O3 Framework](../API.md) / ShoppingCartIcon
+
+# Variable: ShoppingCartIcon
+
+> `const` **ShoppingCartIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:574](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L574)
+
+Order Basket, the UI to enter Orders for Medications, Referrals, Labs, Procedures and more

package/docs/variables/StickyNoteAddIcon.md

@@ -0,0 +1,9 @@
+[O3 Framework](../API.md) / StickyNoteAddIcon
+
+# Variable: StickyNoteAddIcon
+
+> `const` **StickyNoteAddIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:592](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L592)
+
+Used as action button to open ward in-patient note workspace

package/docs/variables/StockManagementPictogram.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / StockManagementPictogram
+
+# Variable: StockManagementPictogram
+
+> `const` **StockManagementPictogram**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`PictogramProps`](../type-aliases/PictogramProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:60](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pictograms/pictograms.tsx#L60)

package/docs/variables/SwitcherIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / SwitcherIcon
+
+# Variable: SwitcherIcon
+
+> `const` **SwitcherIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:565](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L565)

package/docs/variables/SyringeIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / SyringeIcon
+
+# Variable: SyringeIcon
+
+> `const` **SyringeIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:600](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L600)

package/docs/variables/TableIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / TableIcon
+
+# Variable: TableIcon
+
+> `const` **TableIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:617](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L617)

package/docs/variables/TableOfContentsIcon.md

@@ -0,0 +1,9 @@
+[O3 Framework](../API.md) / TableOfContentsIcon
+
+# Variable: TableOfContentsIcon
+
+> `const` **TableOfContentsIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:609](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L609)
+
+Used as a button to add an item to the Order basket from a search

package/docs/variables/TimeIcon.md

@@ -0,0 +1,9 @@
+[O3 Framework](../API.md) / TimeIcon
+
+# Variable: TimeIcon
+
+> `const` **TimeIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:626](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L626)
+
+Lab investigations

package/docs/variables/ToolsIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / ToolsIcon
+
+# Variable: ToolsIcon
+
+> `const` **ToolsIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:634](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L634)

package/docs/variables/TranslateIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / TranslateIcon
+
+# Variable: TranslateIcon
+
+> `const` **TranslateIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:541](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L541)

package/docs/variables/TrashCanIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / TrashCanIcon
+
+# Variable: TrashCanIcon
+
+> `const` **TrashCanIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:642](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L642)

package/docs/variables/TreeViewAltIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / TreeViewAltIcon
+
+# Variable: TreeViewAltIcon
+
+> `const` **TreeViewAltIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:650](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L650)

package/docs/variables/UserAvatarIcon.md

@@ -0,0 +1,9 @@
+[O3 Framework](../API.md) / UserAvatarIcon
+
+# Variable: UserAvatarIcon
+
+> `const` **UserAvatarIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:659](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L659)
+
+User of OpenMRS e.g. My Account

package/docs/variables/UserFollowIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / UserFollowIcon
+
+# Variable: UserFollowIcon
+
+> `const` **UserFollowIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:667](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L667)

package/docs/variables/UserHasAccess.md

@@ -0,0 +1,35 @@
+[O3 Framework](../API.md) / UserHasAccess
+
+# Variable: UserHasAccess
+
+> `const` **UserHasAccess**: `React.FC`\<[`UserHasAccessProps`](../interfaces/UserHasAccessProps.md)\>
+
+Defined in: [packages/framework/esm-react-utils/src/UserHasAccess.tsx:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L40)
+
+A React component that renders its children only if the current user exists and has the privilege(s)
+specified by the `privilege` prop. This can be used not to render certain components when the user
+doesn't have the permission to use this.
+
+Note that for top-level extensions (i.e., the component that's the root of the extension), you don't
+need to use this component. Instead, when registering the extension, declare the required privileges
+as part of the extension registration. This is for use deeper in extensions or other components where
+a separate permission check might be needed.
+
+This can also be used to hide components when the current user is not logged in.
+
+## Example
+
+```ts
+<Form>
+  <UserHasAccess privilege='Form Finallizer'>
+    <Checkbox id="finalize-form" value={formFinalized} onChange={handleChange} />
+  </UserHasAccess>
+</Form>
+````
+
+@param props.privilege Either a string for a single required privilege or an array of strings for a
+  set of required privileges. Note that sets of required privileges must all be matched.
+@param props.fallback What to render if the user does not have access or if the user is not currently
+  logged in. If not provided, nothing will be rendered
+@param props.children The children to be rendered only if the user is logged in and has the required
+  privileges.

package/docs/variables/UserIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / UserIcon
+
+# Variable: UserIcon
+
+> `const` **UserIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:692](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L692)

package/docs/variables/UserXrayIcon.md

@@ -0,0 +1,11 @@
+[O3 Framework](../API.md) / UserXrayIcon
+
+# Variable: UserXrayIcon
+
+> `const` **UserXrayIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:678](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L678)
+
+UserXray Icon
+
+`UserXrayIcon` is also used for imaging orders

package/docs/variables/ViewIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / ViewIcon
+
+# Variable: ViewIcon
+
+> `const` **ViewIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:708](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L708)

package/docs/variables/ViewOffIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / ViewOffIcon
+
+# Variable: ViewOffIcon
+
+> `const` **ViewOffIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:700](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L700)

package/docs/variables/WarningIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / WarningIcon
+
+# Variable: WarningIcon
+
+> `const` **WarningIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:716](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L716)