(feat) O3-1422 / O3-2724: Move workspace system into the framework #979

brandones · 2024-04-19T04:09:44Z

See openmrs/openmrs-esm-home#201 and openmrs/openmrs-esm-patient-management#1103 for Overlays.

See openmrs/openmrs-esm-patient-chart#1796 for the patient chart change.

Requirements

This PR has a title that briefly describes the work done including the ticket number. Ensure your PR title includes a conventional commit label (such as feat, fix, or chore, among others). See existing PR titles for inspiration.

For changes to apps

My work conforms to the O3 Styleguide and design documentation.

If applicable

My work includes tests or is validated by existing tests.
I have updated the esm-framework mock to reflect any API changes I have made.

Summary

This consolidates the workspace and overlay systems. Workspaces are now declared in the routes.json file. The workspace rendering is handled by a component that can be used in any app. The Patient Chart style workspace is implemented as WorkspaceWindow, and overlay-style workspaces are implemented as WorkspaceOverlay.

Most of this code comes from patient-management and patient-chart.

There should be no functional change.

I'm not sure if I should add mocks. I imagine it will become clear as I fix the tests for the other repos.

Screenshots

workspace-drugs.mp4

workspace-sidebar-tablet.mp4

Related Issue

https://openmrs.atlassian.net/browse/O3-1421
https://openmrs.atlassian.net/browse/O3-2724

...es/framework/esm-styleguide/src/workspaces/notification/workspace-notification.component.tsx

vasharma05 · 2024-04-19T05:58:52Z

So happy to see the PR 🥳

github-actions · 2024-04-19T15:20:48Z

Size Change: -15.4 kB (0%)

Total Size: 3.72 MB

Filename	Size	Change
`packages/apps/esm-devtools-app/dist/889.js`	206 kB	+51.1 kB (+33%)	🚨
`packages/apps/esm-implementer-tools-app/dist/889.js`	206 kB	+51.1 kB (+33%)	🚨
`packages/apps/esm-login-app/dist/889.js`	206 kB	+51.1 kB (+33%)	🚨
`packages/apps/esm-offline-tools-app/dist/889.js`	206 kB	+51.1 kB (+33%)	🚨
`packages/apps/esm-primary-navigation-app/dist/889.js`	206 kB	+51.1 kB (+33%)	🚨
`packages/framework/esm-framework/dist/openmrs-esm-framework.js`	474 kB	+32.2 kB (+7%)	🔍
`packages/framework/esm-styleguide/dist/openmrs-esm-styleguide.js`	103 kB	+50.7 kB (+96%)	🆘
`packages/shell/esm-app-shell/dist/openmrs.df598b4990222626.js`	0 B	-368 kB (removed)	🏆

ℹ️ View Unchanged

Filename	Size	Change
`packages/apps/esm-devtools-app/dist/630.js`	2.69 kB	0 B
`packages/apps/esm-devtools-app/dist/667.js`	6.96 kB	0 B
`packages/apps/esm-devtools-app/dist/735.js`	2.63 kB	0 B
`packages/apps/esm-devtools-app/dist/788.js`	42.9 kB	0 B
`packages/apps/esm-devtools-app/dist/875.js`	9.86 kB	+97 B (+1%)
`packages/apps/esm-devtools-app/dist/884.js`	15.2 kB	0 B
`packages/apps/esm-devtools-app/dist/961.js`	25.3 kB	0 B
`packages/apps/esm-devtools-app/dist/988.js`	328 B	0 B
`packages/apps/esm-devtools-app/dist/main.js`	3.14 kB	0 B
`packages/apps/esm-devtools-app/dist/openmrs-esm-devtools-app.js`	3.19 kB	0 B
`packages/apps/esm-implementer-tools-app/dist/271.js`	716 B	0 B
`packages/apps/esm-implementer-tools-app/dist/319.js`	633 B	0 B
`packages/apps/esm-implementer-tools-app/dist/426.js`	24.8 kB	0 B
`packages/apps/esm-implementer-tools-app/dist/460.js`	735 B	0 B
`packages/apps/esm-implementer-tools-app/dist/482.js`	15.2 kB	0 B
`packages/apps/esm-implementer-tools-app/dist/528.js`	133 kB	+782 B (+1%)
`packages/apps/esm-implementer-tools-app/dist/56.js`	3.07 kB	0 B
`packages/apps/esm-implementer-tools-app/dist/560.js`	13.8 kB	+107 B (+1%)
`packages/apps/esm-implementer-tools-app/dist/574.js`	560 B	0 B
`packages/apps/esm-implementer-tools-app/dist/587.js`	2.92 kB	0 B
`packages/apps/esm-implementer-tools-app/dist/620.js`	126 kB	0 B
`packages/apps/esm-implementer-tools-app/dist/625.js`	562 B	0 B
`packages/apps/esm-implementer-tools-app/dist/644.js`	717 B	0 B
`packages/apps/esm-implementer-tools-app/dist/657.js`	7.01 kB	0 B
`packages/apps/esm-implementer-tools-app/dist/71.js`	6.97 kB	0 B
`packages/apps/esm-implementer-tools-app/dist/72.js`	61.2 kB	0 B
`packages/apps/esm-implementer-tools-app/dist/735.js`	2.63 kB	0 B
`packages/apps/esm-implementer-tools-app/dist/757.js`	560 B	0 B
`packages/apps/esm-implementer-tools-app/dist/767.js`	10.4 kB	0 B
`packages/apps/esm-implementer-tools-app/dist/788.js`	42.9 kB	0 B
`packages/apps/esm-implementer-tools-app/dist/791.js`	284 B	0 B
`packages/apps/esm-implementer-tools-app/dist/807.js`	559 B	0 B
`packages/apps/esm-implementer-tools-app/dist/833.js`	681 B	0 B
`packages/apps/esm-implementer-tools-app/dist/main.js`	77.6 kB	+101 B (0%)
`packages/apps/esm-implementer-tools-app/dist/openmrs-esm-implementer-tools-app.js`	3.31 kB	0 B
`packages/apps/esm-login-app/dist/111.js`	1.22 kB	0 B
`packages/apps/esm-login-app/dist/126.js`	2.5 kB	0 B
`packages/apps/esm-login-app/dist/173.js`	1.22 kB	0 B
`packages/apps/esm-login-app/dist/224.js`	256 B	0 B
`packages/apps/esm-login-app/dist/236.js`	272 B	0 B
`packages/apps/esm-login-app/dist/240.js`	364 B	0 B
`packages/apps/esm-login-app/dist/271.js`	718 B	0 B
`packages/apps/esm-login-app/dist/272.js`	264 B	0 B
`packages/apps/esm-login-app/dist/319.js`	679 B	0 B
`packages/apps/esm-login-app/dist/336.js`	234 B	0 B
`packages/apps/esm-login-app/dist/363.js`	30.5 kB	+418 B (+1%)
`packages/apps/esm-login-app/dist/460.js`	737 B	0 B
`packages/apps/esm-login-app/dist/539.js`	298 B	0 B
`packages/apps/esm-login-app/dist/56.js`	3.06 kB	0 B
`packages/apps/esm-login-app/dist/574.js`	577 B	0 B
`packages/apps/esm-login-app/dist/625.js`	579 B	0 B
`packages/apps/esm-login-app/dist/627.js`	257 B	0 B
`packages/apps/esm-login-app/dist/63.js`	16.5 kB	0 B
`packages/apps/esm-login-app/dist/644.js`	718 B	0 B
`packages/apps/esm-login-app/dist/667.js`	6.96 kB	0 B
`packages/apps/esm-login-app/dist/673.js`	284 B	0 B
`packages/apps/esm-login-app/dist/735.js`	2.63 kB	0 B
`packages/apps/esm-login-app/dist/757.js`	660 B	0 B
`packages/apps/esm-login-app/dist/788.js`	42.9 kB	0 B
`packages/apps/esm-login-app/dist/807.js`	897 B	0 B
`packages/apps/esm-login-app/dist/833.js`	684 B	0 B
`packages/apps/esm-login-app/dist/836.js`	22.5 kB	0 B
`packages/apps/esm-login-app/dist/884.js`	15.2 kB	0 B
`packages/apps/esm-login-app/dist/main.js`	57 kB	+438 B (+1%)
`packages/apps/esm-login-app/dist/openmrs-esm-login-app.js`	3.37 kB	0 B
`packages/apps/esm-offline-tools-app/dist/271.js`	1.18 kB	0 B
`packages/apps/esm-offline-tools-app/dist/319.js`	1.13 kB	0 B
`packages/apps/esm-offline-tools-app/dist/430.js`	55.4 kB	0 B
`packages/apps/esm-offline-tools-app/dist/460.js`	1.29 kB	0 B
`packages/apps/esm-offline-tools-app/dist/56.js`	3.07 kB	0 B
`packages/apps/esm-offline-tools-app/dist/574.js`	1.04 kB	0 B
`packages/apps/esm-offline-tools-app/dist/625.js`	1.04 kB	0 B
`packages/apps/esm-offline-tools-app/dist/63.js`	16.5 kB	0 B
`packages/apps/esm-offline-tools-app/dist/644.js`	1.18 kB	0 B
`packages/apps/esm-offline-tools-app/dist/667.js`	6.96 kB	0 B
`packages/apps/esm-offline-tools-app/dist/735.js`	2.63 kB	0 B
`packages/apps/esm-offline-tools-app/dist/757.js`	1.2 kB	0 B
`packages/apps/esm-offline-tools-app/dist/788.js`	42.9 kB	0 B
`packages/apps/esm-offline-tools-app/dist/807.js`	1.11 kB	0 B
`packages/apps/esm-offline-tools-app/dist/833.js`	1.21 kB	0 B
`packages/apps/esm-offline-tools-app/dist/884.js`	15.2 kB	0 B
`packages/apps/esm-offline-tools-app/dist/922.js`	90.9 kB	+9.7 kB (+12%)	⚠️
`packages/apps/esm-offline-tools-app/dist/main.js`	146 kB	+9.83 kB (+7%)	🔍
`packages/apps/esm-offline-tools-app/dist/openmrs-esm-offline-tools-app.js`	3.29 kB	0 B
`packages/apps/esm-primary-navigation-app/dist/271.js`	267 B	0 B
`packages/apps/esm-primary-navigation-app/dist/319.js`	237 B	0 B
`packages/apps/esm-primary-navigation-app/dist/460.js`	264 B	0 B
`packages/apps/esm-primary-navigation-app/dist/574.js`	230 B	0 B
`packages/apps/esm-primary-navigation-app/dist/625.js`	232 B	0 B
`packages/apps/esm-primary-navigation-app/dist/63.js`	16.5 kB	0 B
`packages/apps/esm-primary-navigation-app/dist/644.js`	267 B	0 B
`packages/apps/esm-primary-navigation-app/dist/667.js`	6.97 kB	0 B
`packages/apps/esm-primary-navigation-app/dist/735.js`	2.64 kB	0 B
`packages/apps/esm-primary-navigation-app/dist/757.js`	238 B	0 B
`packages/apps/esm-primary-navigation-app/dist/762.js`	7.61 kB	+125 B (+2%)
`packages/apps/esm-primary-navigation-app/dist/780.js`	22.3 kB	0 B
`packages/apps/esm-primary-navigation-app/dist/788.js`	42.9 kB	0 B
`packages/apps/esm-primary-navigation-app/dist/807.js`	290 B	0 B
`packages/apps/esm-primary-navigation-app/dist/833.js`	257 B	0 B
`packages/apps/esm-primary-navigation-app/dist/884.js`	15.2 kB	0 B
`packages/apps/esm-primary-navigation-app/dist/958.js`	22.7 kB	+494 B (+2%)
`packages/apps/esm-primary-navigation-app/dist/main.js`	46.5 kB	+487 B (+1%)
`packages/apps/esm-primary-navigation-app/dist/openmrs-esm-primary-navigation-app.js`	3.23 kB	0 B
`packages/framework/esm-api/dist/openmrs-esm-api.js`	16.2 kB	0 B
`packages/framework/esm-config/dist/openmrs-esm-module-config.js`	8.02 kB	0 B
`packages/framework/esm-dynamic-loading/dist/openmrs-esm-dynamic-loading.js`	2.75 kB	0 B
`packages/framework/esm-error-handling/dist/openmrs-esm-error-handling.js`	889 B	0 B
`packages/framework/esm-extensions/dist/openmrs-esm-extensions.js`	8.1 kB	0 B
`packages/framework/esm-feature-flags/dist/openmrs-esm-feature-flags.js`	1.67 kB	0 B
`packages/framework/esm-framework/dist/126.openmrs-esm-framework.js`	2.47 kB	0 B
`packages/framework/esm-framework/dist/278.openmrs-esm-framework.js`	14.5 kB	0 B
`packages/framework/esm-framework/dist/530.openmrs-esm-framework.js`	2.92 kB	0 B
`packages/framework/esm-framework/dist/619.openmrs-esm-framework.js`	6.49 kB	0 B
`packages/framework/esm-framework/dist/645.openmrs-esm-framework.js`	9.31 kB	0 B
`packages/framework/esm-framework/dist/680.openmrs-esm-framework.js`	6.13 kB	0 B
`packages/framework/esm-framework/dist/735.openmrs-esm-framework.js`	2.66 kB	0 B
`packages/framework/esm-framework/dist/788.openmrs-esm-framework.js`	42.9 kB	0 B
`packages/framework/esm-globals/dist/openmrs-esm-globals.js`	770 B	0 B
`packages/framework/esm-navigation/dist/openmrs-esm-navigation.js`	9.35 kB	0 B
`packages/framework/esm-offline/dist/openmrs-esm-offline.js`	34.4 kB	0 B
`packages/framework/esm-react-utils/dist/openmrs-esm-react-utils.js`	15.1 kB	+13 B (0%)
`packages/framework/esm-routes/dist/openmrs-esm-utils.js`	1.46 kB	0 B
`packages/framework/esm-state/dist/openmrs-esm-state.js`	888 B	0 B
`packages/framework/esm-translations/dist/openmrs-esm-core-translations.js`	1.59 kB	+251 B (+19%)	⚠️
`packages/framework/esm-utils/dist/openmrs-esm-utils.js`	11.1 kB	0 B
`packages/shell/esm-app-shell/dist/09971d368741a718.js`	0 B	-6.8 kB (removed)	🏆
`packages/shell/esm-app-shell/dist/11c63b65f96a8718.js`	499 B	0 B
`packages/shell/esm-app-shell/dist/1e0131662341578e.js`	645 B	0 B
`packages/shell/esm-app-shell/dist/2916d0aa7a9d5dc8.js`	544 B	0 B
`packages/shell/esm-app-shell/dist/4a3e954c45d63305.js`	645 B	0 B
`packages/shell/esm-app-shell/dist/4b4f127f96a81072.js`	0 B	-1.58 kB (removed)	🏆
`packages/shell/esm-app-shell/dist/56c2295bc732ae32.js`	722 B	0 B
`packages/shell/esm-app-shell/dist/5f5f9cd52166aff3.js`	6.98 kB	0 B
`packages/shell/esm-app-shell/dist/651172ae1548469c.js`	499 B	0 B
`packages/shell/esm-app-shell/dist/98343ad4bb547c48.js`	499 B	0 B
`packages/shell/esm-app-shell/dist/b66a463116735f62.js`	3.81 kB	0 B
`packages/shell/esm-app-shell/dist/ba933133ad512cac.js`	499 B	0 B
`packages/shell/esm-app-shell/dist/dae6aa8bf297bfda.js`	0 B	-499 B (removed)	🏆
`packages/shell/esm-app-shell/dist/fa27473813e2db69.js`	1.58 kB	0 B
`packages/shell/esm-app-shell/dist/fa89289c9d9645c9.js`	519 B	0 B
`packages/shell/esm-app-shell/dist/openmrs.e143126ca6bdaf77.js`	384 kB	0 B
`packages/shell/esm-app-shell/dist/service-worker.js`	45.9 kB	+5 B (0%)
`packages/tooling/openmrs/dist/cli.js`	2.88 kB	0 B
`packages/tooling/openmrs/dist/commands/assemble.js`	2.82 kB	0 B
`packages/tooling/openmrs/dist/commands/build.js`	1.34 kB	0 B
`packages/tooling/openmrs/dist/commands/debug.js`	545 B	0 B
`packages/tooling/openmrs/dist/commands/develop.js`	2.59 kB	0 B
`packages/tooling/openmrs/dist/commands/index.js`	438 B	0 B
`packages/tooling/openmrs/dist/commands/start.js`	851 B	0 B
`packages/tooling/openmrs/dist/index.js`	517 B	0 B
`packages/tooling/openmrs/dist/runner.js`	637 B	0 B
`packages/tooling/openmrs/dist/utils/config.js`	728 B	0 B
`packages/tooling/openmrs/dist/utils/debugger.js`	576 B	0 B
`packages/tooling/openmrs/dist/utils/dependencies.js`	648 B	0 B
`packages/tooling/openmrs/dist/utils/helpers.js`	395 B	0 B
`packages/tooling/openmrs/dist/utils/importmap.js`	3.07 kB	0 B
`packages/tooling/openmrs/dist/utils/index.js`	444 B	0 B
`packages/tooling/openmrs/dist/utils/logger.js`	368 B	0 B
`packages/tooling/openmrs/dist/utils/npmConfig.js`	830 B	0 B
`packages/tooling/openmrs/dist/utils/untar.js`	722 B	0 B
`packages/tooling/openmrs/dist/utils/variables.js`	192 B	0 B
`packages/tooling/openmrs/dist/utils/webpack.js`	278 B	0 B
`packages/tooling/webpack-config/dist/index.js`	3.58 kB	0 B

_{compressed-size-action}

denniskigen

Excellent. Thanks, @brandones!

packages/framework/esm-styleguide/src/workspaces/overlay/workspace-overlay.component.tsx

packages/framework/esm-styleguide/src/workspaces/window/workspace-window.component.tsx

packages/framework/esm-styleguide/src/workspaces/action-menu/action-menu.component.tsx

Co-authored-by: Dennis Kigen <kigen.work@gmail.com>

vasharma05 and others added 16 commits April 19, 2024 00:03

Added new overlay component and 'showOverlay' API to display overlays

96797c9

Updated API

c4f6409

Renamed overlays to workspaces

cfcce9b

Completed the workflow for workspaces

4aadea9

Start creating a consolidated workspace library

a24011a

First draft workspace system

d4e0690

Workspace system mostly working

3a65b4d

Get overlay looking and working right on desktop

21f03cc

Get the overlay styles correct

2659267

Move workspace translations into core translations

aabb35f

Make workspaces defined in routes.json

694302b

Fix problem with slot names; add action menu / siderail

c92fbb2

Write API documentation

6a6e6f3

Add ActionMenuButton, adapted from SiderailButton

a075b5d

Fix tests

81831a6

Fix lint errors for tests

5669a92

github-advanced-security bot found potential problems Apr 19, 2024

View reviewed changes

...es/framework/esm-styleguide/src/workspaces/notification/workspace-notification.component.tsx Fixed Show resolved Hide resolved

brandones mentioned this pull request Apr 19, 2024

(feat) O3-1422 / O3-2724: Move workspace system into the framework openmrs/openmrs-esm-patient-chart#1796

Merged

3 tasks

Fixup

948ff29

Fix isChildOfHeader error

cd9d412

brandones requested review from ibacher and denniskigen April 19, 2024 15:28

denniskigen approved these changes Apr 19, 2024

View reviewed changes

packages/framework/esm-styleguide/src/workspaces/overlay/workspace-overlay.component.tsx Outdated Show resolved Hide resolved

packages/framework/esm-styleguide/src/workspaces/window/workspace-window.component.tsx Outdated Show resolved Hide resolved

denniskigen reviewed Apr 19, 2024

View reviewed changes

packages/framework/esm-styleguide/src/workspaces/action-menu/action-menu.component.tsx Show resolved Hide resolved

Ensure aria-labels are translated; don't use t in core

f9fb219

Co-authored-by: Dennis Kigen <kigen.work@gmail.com>

brandones force-pushed the O3-2724 branch from 4bfdf8e to f9fb219 Compare April 20, 2024 15:45

brandones merged commit eeb48a4 into main Apr 20, 2024
10 checks passed

brandones deleted the O3-2724 branch April 20, 2024 15:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(feat) O3-1422 / O3-2724: Move workspace system into the framework #979

(feat) O3-1422 / O3-2724: Move workspace system into the framework #979

brandones commented Apr 19, 2024 •

edited

vasharma05 commented Apr 19, 2024

github-actions bot commented Apr 19, 2024 •

edited

denniskigen left a comment

(feat) O3-1422 / O3-2724: Move workspace system into the framework #979

(feat) O3-1422 / O3-2724: Move workspace system into the framework #979

Conversation

brandones commented Apr 19, 2024 • edited

Requirements

For changes to apps

If applicable

Summary

Screenshots

Related Issue

vasharma05 commented Apr 19, 2024

github-actions bot commented Apr 19, 2024 • edited

denniskigen left a comment

Choose a reason for hiding this comment

brandones commented Apr 19, 2024 •

edited

github-actions bot commented Apr 19, 2024 •

edited