@openmrs/esm-styleguide/dist/icons/icons.d.ts

The styleguide for OpenMRS SPA

/** @category Icons */
import React from 'react';
import { type Argument } from 'classnames';
/** Array of all available OpenMRS icon IDs that can be used with the Icon component. */
export declare const iconIds: readonly ["omrs-icon-activity", "omrs-icon-add", "omrs-icon-arrow-down", "omrs-icon-arrow-left", "omrs-icon-arrow-right", "omrs-icon-arrow-up", "omrs-icon-baby", "omrs-icon-calendar-heat-map", "omrs-icon-calendar", "omrs-icon-caret-down", "omrs-icon-caret-left", "omrs-icon-caret-right", "omrs-icon-caret-up", "omrs-icon-chart-average", "omrs-icon-checkmark-filled", "omrs-icon-checkmark-outline", "omrs-icon-chemistry", "omrs-icon-chevron-down", "omrs-icon-chevron-left", "omrs-icon-chevron-right", "omrs-icon-chevron-up", "omrs-icon-close", "omrs-icon-close-filled", "omrs-icon-close-outline", "omrs-icon-document", "omrs-icon-document-attachment", "omrs-icon-download", "omrs-icon-drug-order", "omrs-icon-edit", "omrs-icon-event-schedule", "omrs-icon-events", "omrs-icon-gender-female", "omrs-icon-gender-male", "omrs-icon-gender-other", "omrs-icon-gender-unknown", "omrs-icon-generic-order-type", "omrs-icon-group", "omrs-icon-group-access", "omrs-icon-hospital-bed", "omrs-icon-image-medical", "omrs-icon-information", "omrs-icon-information-filled", "omrs-icon-information-square", "omrs-icon-inventory-management", "omrs-icon-lab-order", "omrs-icon-list-checked", "omrs-icon-location", "omrs-icon-material-order", "omrs-icon-maximize", "omrs-icon-medication", "omrs-icon-message-queue", "omrs-icon-microscope", "omrs-icon-money", "omrs-icon-mother", "omrs-icon-movement", "omrs-icon-overflow-menu--horizontal", "omrs-icon-overflow-menu--vertical", "omrs-icon-password", "omrs-icon-pedestrian-family", "omrs-icon-pen", "omrs-icon-printer", "omrs-icon-procedure-order", "omrs-icon-programs", "omrs-icon-renew", "omrs-icon-referral-order", "omrs-icon-report", "omrs-icon-reset", "omrs-icon-save", "omrs-icon-search", "omrs-icon-settings", "omrs-icon-shopping-cart", "omrs-icon-shopping-cart--arrow-down", "omrs-icon-sticky-note-add", "omrs-icon-switcher", "omrs-icon-syringe", "omrs-icon-table-of-contents", "omrs-icon-table", "omrs-icon-time", "omrs-icon-tools", "omrs-icon-translate", "omrs-icon-trash-can", "omrs-icon-tree-view--alt", "omrs-icon-user-avatar", "omrs-icon-user-follow", "omrs-icon-user-xray", "omrs-icon-user", "omrs-icon-view-off", "omrs-icon-view", "omrs-icon-warning"];
export type IconId = (typeof iconIds)[number];
export type IconProps = {
    className?: Argument;
    fill?: string;
    size?: number;
};
/**
 */
export declare const ActivityIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const AddIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const ArrowDownIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const ArrowLeftIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const ArrowRightIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const ArrowUpIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const BabyIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const CalendarHeatMapIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const CalendarIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const CaretDownIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const CaretLeftIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const CaretRightIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const CaretUpIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const ChartAverageIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const CheckmarkFilledIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const CheckmarkOutlineIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const ChemistryIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const ChevronDownIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const ChevronLeftIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const ChevronRightIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const ChevronUpIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const CloseIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const CloseFilledIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const CloseOutlineIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const DocumentIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const DocumentAttachmentIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const DownloadIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const DrugOrderIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const EditIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const EventScheduleIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const EventsIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const GenderFemaleIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const GenderMaleIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const GenderOtherIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const GenderUnknownIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const GenericOrderTypeIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const GroupIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const GroupAccessIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const HospitalBedIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const ImageMedicalIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const InformationIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const InformationFilledIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const InformationSquareIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const InventoryManagementIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const LabOrderIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const ListCheckedIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const LocationIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const MaterialOrderIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const MaximizeIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const MedicationIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const MessageQueueIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const MicroscopeIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 * Billing
 */
export declare const MoneyIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const MotherIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const MovementIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const OverflowMenuHorizontalIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const OverflowMenuVerticalIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
export declare const PasswordIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const PedestrianFamilyIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const PenIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const PrinterIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const ProcedureOrderIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const ProgramsIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const ReferralOrderIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const RenewIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const ReportIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const ResetIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const SaveIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const SearchIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const SettingsIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const SwitcherIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 * Order Basket, the UI to enter Orders for Medications, Referrals, Labs, Procedures and more
 */
export declare const ShoppingCartIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 * Used as a button to add an item to the Order basket from a search
 */
export declare const ShoppingCartArrowDownIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 * Used as action button to open ward in-patient note workspace
 */
export declare const StickyNoteAddIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const SyringeIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 * Used as a button to add an item to the Order basket from a search
 */
export declare const TableOfContentsIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const TableIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 * Lab investigations
 */
export declare const TimeIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const ToolsIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const TranslateIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const TrashCanIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const TreeViewAltIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 * User of OpenMRS e.g. My Account
 */
export declare const UserAvatarIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const UserFollowIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 * UserXray Icon
 *
 * `UserXrayIcon` is also used for imaging orders
 */
export declare const UserXrayIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const UserIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const ViewOffIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const ViewIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const WarningIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 */
export declare const AllergiesIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 *
 */
export declare const AttachmentIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 * Conditions
 *
 * Note this is an alias for ListCheckedIcon
 */
export declare const ConditionsIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 *
 */
export declare const RadiologyIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 * Used as a button to add an item to the Order basket from a search
 *
 * Note this is an alias for ShoppingCartArrowDownIcon
 */
export declare const ShoppingCartAddItemIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>>;
/**
 * This is a utility component that takes an `icon` and renders it if the sprite for the icon
 * is available. The goal is to make it easier to conditionally render configuration-specified icons.
 *
 * @example
 * ```tsx
 *   <MaybeIcon icon='omrs-icon-baby' className={styles.myIconStyles} />
 * ```
 */
export declare const MaybeIcon: React.MemoExoticComponent<React.ForwardRefExoticComponent<{
    icon: string | undefined;
    fallback?: React.ReactNode;
} & IconProps & React.RefAttributes<SVGSVGElement>>>;
export type SvgIconProps = {
    icon: IconId;
    iconProps: IconProps;
};
/**
 * This is a utility type for custom icons that use the svg-sprite-loader to bundle custom icons
 */
export declare const Icon: React.MemoExoticComponent<React.ForwardRefExoticComponent<SvgIconProps & React.RefAttributes<SVGSVGElement>>>;
//# sourceMappingURL=icons.d.ts.map