Commit 58f9519
authored
Create shared navigation components using module federation (#774)
### Summary & Motivation
This introduces shared navigation components using module federation to
enable consistent navigation across self-contained systems. The
implementation provides federated side menu, top menu, and common UI
components that can be shared between all self-contained systems.
- Create federated side menu and mobile menu components that work across
module boundaries.
- Implement federated top menu with user avatar, theme selector,
language switcher, and support options.
- Enable cross-system navigation with SPA reload only when navigating
between different systems.
- Make toast notifications work across module federation boundaries.
- Create shared support dialog using module federation to replace
account deletion functionality.
- Implement federated translation system to share translations between
self-contained systems.
- Fix various UI issues including mobile menu display, theme selector
alignment, and Safari navigation bugs.
- Improve mobile experience by showing theme, support, and language
switcher on login/signup pages.
- Centralize tooltip implementations and improve component
accessibility.
- Ensure federated module styles are properly loaded in host systems.
- Ensure translations in federated modules are loaded from the host
systems.
- Add platform configuration to restrict BackOffice menu option to
internal users.
### Downstream projects
1. Move your side menu configuration to the centralized location
- Add your side menu items to
`application/account-management/WebApp/federated-modules/sideMenu/NavigationMenuItems.tsx`
- Remove side menu items from your local components
This file now serves as the central configuration for all side menu
items across systems.
3. Update your `bootstrap.tsx` to use federated translations:
```diff
- import { Translation } from "@repo/infrastructure/translations/Translation";
+ import { createFederatedTranslation } from "@repo/infrastructure/translations/createFederatedTranslation";
- const { TranslationProvider } = await Translation.create(
+ const { TranslationProvider } = await createFederatedTranslation(
(locale) => import(`@/shared/translations/locale/${locale}.ts`)
);
```
4. Replace your side menu component with the federated version in your
main route:
```diff
- import { SharedSideMenu } from "@/shared/components/SharedSideMenu";
+ import FederatedSideMenu from "account-management/FederatedSideMenu";
- <SharedSideMenu ariaLabel={t`Toggle collapsed menu`} />
+ <FederatedSideMenu currentSystem="your-self-contained-system" />
```
5. Update your top menu component to use the federated version:
```diff
- import { LocaleSwitcher } from "@repo/infrastructure/translations/LocaleSwitcher";
- import { ThemeModeSelector } from "@repo/ui/theme/ThemeModeSelector";
- const AvatarButton = lazy(() => import("account-management/AvatarButton"));
+ const FederatedTopMenu = lazy(() => import("account-management/FederatedTopMenu"));
// Wrap your existing breadcrumbs or top menu content with FederatedTopMenu:
- <nav className="flex w-full items-center justify-between">
- {/* Your breadcrumbs and menu items */}
- </nav>
+ <Suspense fallback={<div className="h-12 w-full" />}>
+ <FederatedTopMenu>
+ {/* Your breadcrumbs */}
+ </FederatedTopMenu>
+ </Suspense>
```
6. Remove local implementations of SharedSideMenu and update imports
throughout your system.
7. Change the `internalEmailDomain` in
`application/shared-kernel/SharedKernel/Platform/platform-settings.jsonc`
to your own to only show BackOffice to internal users.
This change is part of a bigger redesign of the navigation, so please
look at this and other changes holistically.
### Checklist
- [x] I have added tests, or done manual regression tests
- [x] I have updated the documentation, if necessaryFile tree
48 files changed
+1384
-661
lines changed- application
- account-management
- Core/Features/Users
- Domain
- Tests/Users/Domain
- WebApp
- federated-modules
- common
- sideMenu
- topMenu
- routes
- (index)/-components
- admin
- account
- -components
- users
- back-office/WebApp
- routes/back-office
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
48 files changed
+1384
-661
lines changedLines changed: 3 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
| 2 | + | |
2 | 3 | | |
3 | 4 | | |
4 | 5 | | |
| |||
37 | 38 | | |
38 | 39 | | |
39 | 40 | | |
| 41 | + | |
| 42 | + | |
40 | 43 | | |
41 | 44 | | |
42 | 45 | | |
| |||
Lines changed: 2 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
35 | | - | |
| 35 | + | |
| 36 | + | |
36 | 37 | | |
37 | 38 | | |
38 | 39 | | |
Lines changed: 63 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
Lines changed: 133 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
Lines changed: 19 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
Lines changed: 44 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
0 commit comments