Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

(Feat) O3-2801 Icons across O3 Navigation MVP #2121

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+52 −2
Open

(Feat) O3-2801 Icons across O3 Navigation MVP #2121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a29a0f3
O3-2801 Icons across O3 Navigation MVP
Munyua123 Nov 28, 2024
6a6feb4
Merge branch 'main' into patient-chart-icons
Munyua123 Dec 2, 2024
0b8d576
Merge branch 'main' into patient-chart-icons
Munyua123 Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 44 additions & 2 deletions packages/esm-patient-common-lib/src/dashboards/DashboardExtension.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,22 @@ import classNames from 'classnames';
import last from 'lodash-es/last';
import { useTranslation } from 'react-i18next';
import { useLocation } from 'react-router-dom';
import { ConfigurableLink } from '@openmrs/esm-framework';
import {
ConfigurableLink,
ActivityIcon,
ShoppingCartIcon,
MedicationIcon,
ChartAverageIcon,
CalendarHeatMapIcon,
WarningIcon,
ListCheckedIcon,
DocumentAttachmentIcon,
EventScheduleIcon,
ReportIcon,
SyringeIcon,
ProgramsIcon,
} from '@openmrs/esm-framework';
import styles from './dashboard-extension.scss';

export interface DashboardExtensionProps {
path: string;
Expand All @@ -22,13 +37,40 @@ export const DashboardExtension = ({
const location = useLocation();
const navLink = useMemo(() => decodeURIComponent(last(location.pathname.split('/'))), [location.pathname]);

type MenuTitle = keyof typeof MenuIcons;

const MenuIcons = {
'Patient Summary': ReportIcon,
'Vitals & Biometrics': ActivityIcon,
Medications: MedicationIcon,
Orders: ShoppingCartIcon,
Results: ChartAverageIcon,
Visits: CalendarHeatMapIcon,
Allergies: WarningIcon,
Conditions: ListCheckedIcon,
Immunizations: SyringeIcon,
Attachments: DocumentAttachmentIcon,
Programs: ProgramsIcon,
Appointments: EventScheduleIcon,
} as const;

const menuIcon = (title: MenuTitle) => {
const Icon = MenuIcons[title];
return Icon ? <Icon className={styles.icon} /> : null;
};
Comment on lines +40 to +60
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's no good reason for these to be located inside this component. They would be better located outside of it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly, though, I think this might not be the right way to design things. This works, but only for providing icons for known menu titles, which is bad for extensibility. Better would be to update the DashboardExtensionProps to take a string of the name icon and just render it like:

document.getElementById(`omrs-icon-${icon}`) ? <Icon className={styles.icon} icon={`omrs-icon-${icon}`} /> : null;


const renderIcon = menuIcon(title as MenuTitle);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No weird edge-cases and we don't have to lie to TypeScript:

Suggested change
const renderIcon = menuIcon(title as MenuTitle);
const renderIcon = Object.keys(MenuIcons).includes(title) ? menuIcon(title) : null;


return (
<div key={path}>
<ConfigurableLink
className={classNames('cds--side-nav__link', { 'active-left-nav-link': path === navLink })}
to={`${basePath}/${encodeURIComponent(path)}`}
>
{t(title)}
<span className={styles.menu}>
{renderIcon}
<span>{t(title)}</span>
</span>
</ConfigurableLink>
</div>
);
Expand Down
8 changes: 8 additions & 0 deletions packages/esm-patient-common-lib/src/dashboards/dashboard-extension.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.menu {
display: flex;
align-items: center;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think centering is the right option here. The items should flex from the start regardless of the width of the container.

Suggested change
align-items: center;
align-items: start;

}

.icon {
margin-right: 0.5rem;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use the Carbon spacing tokens for things like this (use @carbon/layout; margin: layout.$spacing-03;

}
Empty file removed packages/esm-patient-common-lib/src/dashboards/dashboardextension.scss
View file
Open in desktop
Empty file.