blob: 45a95f56a96a52e744e8f494f1fa46d211936fdc [file] [log] [blame]
Derick Montaguea2988f42020-01-17 13:46:30 -06001<template>
Yoshie Muranaka74f86872020-02-10 12:28:37 -08002 <div>
3 <div class="nav-container" :class="{ open: isNavigationOpen }">
Derick Montague68592032020-04-04 14:02:34 -05004 <nav ref="nav" :aria-label="$t('appNavigation.primaryNavigation')">
Yoshie Muranaka7d044352020-07-24 10:45:14 -07005 <b-nav vertical class="mb-4">
Ed Tanous7d6b44c2024-03-23 14:56:34 -07006 <template v-for="navItem in navigationItems">
Yoshie Muranakad329ec82020-08-11 18:24:59 -07007 <!-- Navigation items with no children -->
8 <b-nav-item
9 v-if="!navItem.children"
Ed Tanous7d6b44c2024-03-23 14:56:34 -070010 :key="navItem.index"
Yoshie Muranakad329ec82020-08-11 18:24:59 -070011 :to="navItem.route"
12 :data-test-id="`nav-item-${navItem.id}`"
Derick Montague2d589a72020-07-23 17:43:12 -050013 >
Yoshie Muranakad329ec82020-08-11 18:24:59 -070014 <component :is="navItem.icon" />
15 {{ navItem.label }}
16 </b-nav-item>
Derick Montague42c19892020-01-17 16:10:34 -060017
Yoshie Muranakad329ec82020-08-11 18:24:59 -070018 <!-- Navigation items with children -->
Ed Tanous7d6b44c2024-03-23 14:56:34 -070019 <li v-else :key="navItem.index" class="nav-item">
Yoshie Muranakad329ec82020-08-11 18:24:59 -070020 <b-button
21 v-b-toggle="`${navItem.id}`"
22 variant="link"
23 :data-test-id="`nav-button-${navItem.id}`"
Derick Montague2d589a72020-07-23 17:43:12 -050024 >
Yoshie Muranakad329ec82020-08-11 18:24:59 -070025 <component :is="navItem.icon" />
26 {{ navItem.label }}
27 <icon-expand class="icon-expand" />
28 </b-button>
29 <b-collapse :id="navItem.id" tag="ul" class="nav-item__nav">
Sukanya Pandeyfba4d622020-12-29 13:31:19 +053030 <li class="nav-item">
31 <router-link
Damian Celicoaeb19812022-11-24 02:00:53 +010032 v-for="(subNavItem, i) of filteredNavItem(navItem.children)"
Sukanya Pandeyfba4d622020-12-29 13:31:19 +053033 :key="i"
34 :to="subNavItem.route"
35 :data-test-id="`nav-item-${subNavItem.id}`"
36 class="nav-link"
37 >
38 {{ subNavItem.label }}
39 </router-link>
40 </li>
Yoshie Muranakad329ec82020-08-11 18:24:59 -070041 </b-collapse>
42 </li>
43 </template>
Yoshie Muranaka74f86872020-02-10 12:28:37 -080044 </b-nav>
45 </nav>
46 </div>
47 <transition name="fade">
48 <div
49 v-if="isNavigationOpen"
Derick Montaguead2ceb62020-04-24 18:11:04 -050050 id="nav-overlay"
Yoshie Muranaka74f86872020-02-10 12:28:37 -080051 class="nav-overlay"
52 @click="toggleIsOpen"
53 ></div>
54 </transition>
55 </div>
Derick Montaguea2988f42020-01-17 13:46:30 -060056</template>
57
58<script>
Yoshie Muranaka8263d852020-10-16 07:58:06 -070059//Do not change Mixin import.
60//Exact match alias set to support
61//dotenv customizations.
Yoshie Muranakad329ec82020-08-11 18:24:59 -070062import AppNavigationMixin from './AppNavigationMixin';
Ed Tanous883a0d52024-03-23 14:56:34 -070063import { useI18n } from 'vue-i18n';
Derick Montaguea2988f42020-01-17 13:46:30 -060064
65export default {
Derick Montaguee2fd1562019-12-20 13:26:53 -060066 name: 'AppNavigation',
Yoshie Muranakad329ec82020-08-11 18:24:59 -070067 mixins: [AppNavigationMixin],
Yoshie Muranaka74f86872020-02-10 12:28:37 -080068 data() {
69 return {
Ed Tanous883a0d52024-03-23 14:56:34 -070070 $t: useI18n().t,
Derick Montague602e98a2020-10-21 16:20:00 -050071 isNavigationOpen: false,
Damian Celicoaeb19812022-11-24 02:00:53 +010072 currentUserRole: null,
Yoshie Muranaka74f86872020-02-10 12:28:37 -080073 };
74 },
75 watch: {
Derick Montague602e98a2020-10-21 16:20:00 -050076 $route: function () {
Yoshie Muranaka74f86872020-02-10 12:28:37 -080077 this.isNavigationOpen = false;
78 },
Derick Montague602e98a2020-10-21 16:20:00 -050079 isNavigationOpen: function (isNavigationOpen) {
Sukanya Pandeyedb8a772020-10-29 11:33:42 +053080 this.$root.$emit('change-is-navigation-open', isNavigationOpen);
Derick Montague602e98a2020-10-21 16:20:00 -050081 },
Yoshie Muranaka74f86872020-02-10 12:28:37 -080082 },
83 mounted() {
Damian Celicoaeb19812022-11-24 02:00:53 +010084 this.getPrivilege();
Sukanya Pandeyedb8a772020-10-29 11:33:42 +053085 this.$root.$on('toggle-navigation', () => this.toggleIsOpen());
Yoshie Muranaka74f86872020-02-10 12:28:37 -080086 },
87 methods: {
88 toggleIsOpen() {
89 this.isNavigationOpen = !this.isNavigationOpen;
Derick Montague602e98a2020-10-21 16:20:00 -050090 },
Damian Celicoaeb19812022-11-24 02:00:53 +010091 getPrivilege() {
92 this.currentUserRole = this.$store?.getters['global/userPrivilege'];
93 },
94 filteredNavItem(navItem) {
95 if (this.currentUserRole) {
96 return navItem.filter(({ exclusiveToRoles }) => {
97 if (!exclusiveToRoles?.length) return true;
98 return exclusiveToRoles.includes(this.currentUserRole);
99 });
100 } else return navItem;
101 },
Derick Montague602e98a2020-10-21 16:20:00 -0500102 },
Derick Montaguea2988f42020-01-17 13:46:30 -0600103};
104</script>
Derick Montague42c19892020-01-17 16:10:34 -0600105
suryav972424b377d2025-01-24 15:06:35 +0530106<style scoped lang="scss">
Yoshie Muranaka71ac2302019-12-26 11:43:36 -0800107svg {
Derick Montague66f903f2020-02-28 11:22:31 -0600108 fill: currentColor;
109 height: 1.2rem;
110 width: 1.2rem;
Yoshie Muranaka71ac2302019-12-26 11:43:36 -0800111 margin-left: 0 !important; //!important overriding button specificity
112 vertical-align: text-bottom;
113 &:not(.icon-expand) {
114 margin-right: $spacer;
115 }
116}
117
118.nav {
SurenNeware057232b2020-06-08 20:53:26 +0530119 padding-top: $spacer / 4;
120 @include media-breakpoint-up($responsive-layout-bp) {
121 padding-top: $spacer;
122 }
Yoshie Muranaka71ac2302019-12-26 11:43:36 -0800123}
124
125.nav-item__nav {
Derick Montague42c19892020-01-17 16:10:34 -0600126 list-style: none;
127 padding-left: 0;
Yoshie Muranaka71ac2302019-12-26 11:43:36 -0800128 margin-left: 0;
129
Yoshie Muranaka85358ed2020-05-18 10:05:36 -0700130 .nav-item {
131 outline: none;
132 }
133
Yoshie Muranaka71ac2302019-12-26 11:43:36 -0800134 .nav-link {
135 padding-left: $spacer * 4;
Yoshie Muranaka85358ed2020-05-18 10:05:36 -0700136 outline: none;
Yoshie Muranaka71ac2302019-12-26 11:43:36 -0800137
138 &:not(.nav-link--current) {
139 font-weight: normal;
140 }
141 }
142}
143
144.btn-link {
Dixsie Wolmers30f11f82020-11-10 16:07:56 -0600145 display: inline-block;
Yoshie Muranaka71ac2302019-12-26 11:43:36 -0800146 width: 100%;
147 text-align: left;
148 text-decoration: none !important;
149 border-radius: 0;
150
151 &.collapsed {
152 .icon-expand {
153 transform: rotate(180deg);
154 }
155 }
Yoshie Muranaka71ac2302019-12-26 11:43:36 -0800156}
157
158.icon-expand {
159 float: right;
160 margin-top: $spacer / 4;
161}
162
163.btn-link,
164.nav-link {
165 position: relative;
166 font-weight: $headings-font-weight;
167 padding-left: $spacer; // defining consistent padding for links and buttons
168 padding-right: $spacer;
Yoshie Muranaka01da8182020-07-08 15:46:43 -0700169 color: theme-color('secondary');
Yoshie Muranaka71ac2302019-12-26 11:43:36 -0800170
171 &:hover {
SurenNeware1f8117f2020-09-22 19:28:56 +0530172 background-color: theme-color-level(dark, -10.5);
Yoshie Muranaka01da8182020-07-08 15:46:43 -0700173 color: theme-color('dark');
Yoshie Muranaka71ac2302019-12-26 11:43:36 -0800174 }
Yoshie Muranaka9f5cea82020-02-04 09:30:00 -0800175
176 &:focus {
SurenNeware1f8117f2020-09-22 19:28:56 +0530177 background-color: theme-color-level(light, 0);
178 box-shadow: inset 0 0 0 2px theme-color('primary');
Yoshie Muranaka01da8182020-07-08 15:46:43 -0700179 color: theme-color('dark');
Derick Montague59569d82020-10-26 15:17:31 -0500180 outline: 0;
Yoshie Muranaka9f5cea82020-02-04 09:30:00 -0800181 }
SurenNeware1f8117f2020-09-22 19:28:56 +0530182
183 &:active {
Derick Montague59569d82020-10-26 15:17:31 -0500184 background-color: theme-color('secondary');
SurenNeware1f8117f2020-09-22 19:28:56 +0530185 color: $white;
186 }
Yoshie Muranaka71ac2302019-12-26 11:43:36 -0800187}
188
SurenNeware1f8117f2020-09-22 19:28:56 +0530189.nav-link--current {
Yoshie Muranaka71ac2302019-12-26 11:43:36 -0800190 font-weight: $headings-font-weight;
Yoshie Muranaka01da8182020-07-08 15:46:43 -0700191 background-color: theme-color('secondary');
192 color: theme-color('light');
Derick Montague66f903f2020-02-28 11:22:31 -0600193 cursor: default;
SurenNeware1f8117f2020-09-22 19:28:56 +0530194 box-shadow: none;
Yoshie Muranaka71ac2302019-12-26 11:43:36 -0800195
196 &::before {
197 content: '';
198 position: absolute;
199 top: 0;
200 bottom: 0;
201 left: 0;
202 width: 4px;
Yoshie Muranaka01da8182020-07-08 15:46:43 -0700203 background-color: theme-color('primary');
Yoshie Muranaka71ac2302019-12-26 11:43:36 -0800204 }
Derick Montague59569d82020-10-26 15:17:31 -0500205
206 &:hover,
SurenNeware1f8117f2020-09-22 19:28:56 +0530207 &:focus {
Derick Montague59569d82020-10-26 15:17:31 -0500208 background-color: theme-color('secondary');
209 color: theme-color('light');
SurenNeware1f8117f2020-09-22 19:28:56 +0530210 }
211}
Yoshie Muranaka74f86872020-02-10 12:28:37 -0800212
213.nav-container {
214 position: fixed;
215 width: $navigation-width;
216 top: $header-height;
217 bottom: 0;
218 left: 0;
219 z-index: $zindex-fixed;
220 overflow-y: auto;
Derick Montague59569d82020-10-26 15:17:31 -0500221 background-color: theme-color('light');
Yoshie Muranaka74f86872020-02-10 12:28:37 -0800222 transform: translateX(-$navigation-width);
223 transition: transform $exit-easing--productive $duration--moderate-02;
Derick Montague59569d82020-10-26 15:17:31 -0500224 border-right: 1px solid theme-color-level('light', 2.85);
225
SurenNeware057232b2020-06-08 20:53:26 +0530226 @include media-breakpoint-down(md) {
227 z-index: $zindex-fixed + 2;
228 }
Yoshie Muranaka74f86872020-02-10 12:28:37 -0800229
Derick Montague74466b82020-06-28 10:17:32 -0500230 &.open,
231 &:focus-within {
Yoshie Muranaka74f86872020-02-10 12:28:37 -0800232 transform: translateX(0);
233 transition-timing-function: $entrance-easing--productive;
234 }
235
236 @include media-breakpoint-up($responsive-layout-bp) {
237 transition-duration: $duration--fast-01;
238 transform: translateX(0);
239 }
240}
241
242.nav-overlay {
243 position: fixed;
244 top: $header-height;
245 bottom: 0;
246 left: 0;
247 right: 0;
SurenNeware057232b2020-06-08 20:53:26 +0530248 z-index: $zindex-fixed + 1;
Yoshie Muranaka74f86872020-02-10 12:28:37 -0800249 background-color: $black;
250 opacity: 0.5;
251
252 &.fade-enter-active {
253 transition: opacity $duration--moderate-02 $entrance-easing--productive;
254 }
255
256 &.fade-leave-active {
257 transition: opacity $duration--fast-02 $exit-easing--productive;
258 }
259
SurenNeware151dd242020-11-10 20:15:05 +0530260 &.fade-enter, // Remove this vue2 based only class when switching to vue3
261 &.fade-enter-from, // This is vue3 based only class modified from 'fade-enter'
Yoshie Muranaka74f86872020-02-10 12:28:37 -0800262 &.fade-leave-to {
263 opacity: 0;
264 }
265
266 @include media-breakpoint-up($responsive-layout-bp) {
267 display: none;
268 }
269}
Derick Montague42c19892020-01-17 16:10:34 -0600270</style>