Migrate to Bootstrap 5 and remove Vue compat plugin
Complete migration from Bootstrap 4 (bootstrap-vue) to Bootstrap 5
(bootstrap-vue-next) and remove the @vue/compat plugin to finalize
the Vue 3 migration.
Bundle size impact:
- Before (Bootstrap 4 + bootstrap-vue): 535 KiB gzipped
- After (Bootstrap 5 + bootstrap-vue-next): 511 KiB gzipped
- Reduction: 24 KiB (4.5% smaller)
Package updates:
- Update bootstrap 4.6.2 -> 5.3.8
- Update bootstrap-vue 2.23.1 -> bootstrap-vue-next 0.40.8
- Remove @vue/compat plugin
- Update vue 3.4.29 -> 3.5.24 and related packages
- Add mitt 3.0.1 for global event bus
- Add vue-demi 0.14.10 for library compatibility
Bootstrap 5 CSS updates:
- Replace directional classes: ml/mr/pl/pr -> ms/me/ps/pe
- Replace text-left/right -> text-start/end
- Replace sr-only -> visually-hidden / visually-hidden-focusable
- Update media breakpoint xs -> sm (Bootstrap 5 removed xs)
- Update color functions: gray("700") -> $gray-700
- Add form-switch border-radius for curved toggles
- Update alert, table, toast, form, and button styles
Bootstrap-Vue-Next API changes:
- Use createBootstrap() for plugin registration
- Update modal footer slots: #modal-footer -> #footer
- Fix form select events: @change -> @update:model-value
- Add v-model bindings to modals instead of manual show()/hide()
- Update toast system with custom plugin wrapping useToast()
- Register components and directives explicitly
Vue 3 specific updates:
- Replace $root.$emit with mitt event bus (eventBus.js)
- Update render function from h(App) to createApp(App)
- Add emits option to components
- Use h() instead of $createElement in mixins
- Add Vue 3 compile-time feature flags with documentation
- Update event listeners: $on/$off to eventBus methods
- Add beforeUnmount cleanup for event listeners
New components and significant additions:
- src/plugins/toast.js - Custom toast plugin wrapping useToast() for
Options API compatibility
- src/components/Global/ConfirmModal.vue - Global confirmation dialog
shim to replace Bootstrap 4's removed bvModal.msgBoxConfirm
- src/eventBus.js - mitt-based event bus with Vue 2-compatible API
- Navigation state preservation on page refresh implemented
Critical fixes:
- Add global API interceptor to strip Vue reactivity from payloads
- Preserve binary data (File, Blob, FormData) in API requests
- Fix Generate CSR modal v-model binding for proper open/close
- Remove debug logging and fix jest configuration
- Fix responsive text visibility in AppHeader
- Update BVTableSelectableMixin for proper row selection
- Fix BVToastMixin VNode rendering for Vue 3
Vue 3 modal fixes (lazy-loaded components):
- Add v-model support to network modals (ModalIpv4, ModalIpv6, ModalDns,
ModalHostname, ModalMacAddress, ModalDefaultGateway) by adding
modelValue prop, watcher on modelValue that triggers show(), and
update:modelValue emit in resetForm
- Remove lazy loading from TableIpv4, TableIpv6, TableDns to ensure
modal component refs are available when v-model triggers
- Fix modal title accessibility by adding title prop to modals
(ModalAddDestination, ModalUser, ModalAddRoleGroup, etc.)
i18n fixes (computed properties):
- Fix computed properties using i18n translations in ModalAddRoleGroup,
ModalUser, and ModalUploadCertificate
- Move useI18n() call from data() to setup() and return i18n object
- Use i18n.t() instead of $t in computed properties and templates
- Prevents "this.$t is not a function" and "_ctx.$t is not a function"
errors in Vue 3
Toast notification fixes:
- Fix toast progress bar visibility by setting progressProps to
undefined (documented way to opt-out) instead of false
- Change modelValue prop to interval for auto-dismiss timing
- Remove temporary CSS display:none hack from _toasts.scss
Network settings fixes:
- Fix checkbox @change event sending Vue reactive proxy object instead
of boolean by casting with !! operator in changeDomainNameState and
related methods in NetworkGlobalSettings.vue
- Ensures API receives plain boolean values in PATCH requests
Navigation fixes:
- Fix nav-link styling for navigation items without children by
replacing b-nav-item with router-link in AppNavigation.vue
- Prevents blue font color from .nav-link CSS class
Configuration updates:
- Remove vue-compat webpack configuration
- Add Vue 3 feature flags (__VUE_OPTIONS_API__, etc.)
- Add .cursor to .gitignore
Accessibility improvements:
- Add autocomplete attributes to password and credential inputs
- Add modal title props for screen reader support
Build completes successfully and UI behavior matches pre-migration.
Extracted features (to be submitted in follow-up PRs):
The following features were removed from this migration PR to keep it
focused on the Bootstrap 5 upgrade. They will be submitted separately:
1. UnresponsiveModal - Server connectivity watchdog with auto-retry
2. Auth token persistence - sessionStorage support for X-Auth-Token
3. Hardware store error handling - try/catch, dynamic discovery
4. Login page connecting indicator - Backend polling with spinner
5. Test updates - Jest setup and snapshot updates for
Bootstrap-Vue-Next
6. Documentation updates - Vue 3 and Vue I18n v9+ API documentation
7. Enhanced ConfirmModal - Feature-rich confirmation dialog with
custom actions
Change-Id: Ib76a58f324b3c926cf536e6e4626e4271639de38
Signed-off-by: Jason Westover <jwestover@nvidia.com>
diff --git a/vue.config.js b/vue.config.js
index 52820ab..3f3b34c 100644
--- a/vue.config.js
+++ b/vue.config.js
@@ -8,8 +8,7 @@
sass: {
additionalData: (() => {
const envName = process.env.VUE_APP_ENV_NAME;
- const hasCustomStyles =
- process.env.CUSTOM_STYLES === 'true' ? true : false;
+ const hasCustomStyles = process.env.CUSTOM_STYLES === 'true';
if (hasCustomStyles && envName !== undefined) {
return `
@import "@/assets/styles/bmc/helpers";
@@ -24,6 +23,24 @@
}
})(), // immediately invoked function expression (IIFE)
},
+ scss: {
+ additionalData: (() => {
+ const envName = process.env.VUE_APP_ENV_NAME;
+ const hasCustomStyles = process.env.CUSTOM_STYLES === 'true';
+ if (hasCustomStyles && envName !== undefined) {
+ return `
+ @import "@/assets/styles/bmc/helpers";
+ @import "@/env/assets/styles/_${envName}";
+ @import "@/assets/styles/bootstrap/_helpers";
+ `;
+ } else {
+ return `
+ @import "@/assets/styles/bmc/helpers";
+ @import "@/assets/styles/bootstrap/_helpers";
+ `;
+ }
+ })(),
+ },
},
},
devServer: {
@@ -43,14 +60,6 @@
},
productionSourceMap: false,
chainWebpack: (config) => {
- config.resolve.alias.set('vue', '@vue/compat');
- config.module
- .rule('vue')
- .use('vue-loader')
- .tap((options) => {
- options['compilerOptions'] = { compatConfig: { MODE: 2 } };
- return options;
- });
config.module
.rule('vue')
.use('vue-svg-inline-loader')
@@ -88,10 +97,9 @@
crypto_orig_createHash(algorithm == 'md4' ? 'sha256' : algorithm);
const envName = process.env.VUE_APP_ENV_NAME;
- const hasCustomStore = process.env.CUSTOM_STORE === 'true' ? true : false;
- const hasCustomRouter = process.env.CUSTOM_ROUTER === 'true' ? true : false;
- const hasCustomAppNav =
- process.env.CUSTOM_APP_NAV === 'true' ? true : false;
+ const hasCustomStore = process.env.CUSTOM_STORE === 'true';
+ const hasCustomRouter = process.env.CUSTOM_ROUTER === 'true';
+ const hasCustomAppNav = process.env.CUSTOM_APP_NAV === 'true';
if (envName !== undefined) {
if (hasCustomStore) {
@@ -126,6 +134,34 @@
};
config.optimization.runtimeChunk = false;
+
+ // Define Vue 3 compile-time feature flags
+ // These flags must be explicitly defined to avoid Vue warnings and optimize bundle size
+ config.plugins.push(
+ new webpack.DefinePlugin({
+ // Enable Options API support (required - this codebase uses Options API extensively)
+ // Setting to true includes Options API in the bundle (~3kb gzipped)
+ // Cannot be disabled until full migration to Composition API
+ __VUE_OPTIONS_API__: JSON.stringify(true),
+
+ // Disable Vue Devtools in production builds for security and performance
+ // Devtools automatically enabled in development mode regardless of this flag
+ __VUE_PROD_DEVTOOLS__: JSON.stringify(false),
+
+ // Disable detailed hydration mismatch warnings in production
+ // This is a SPA (not SSR), so hydration warnings don't apply
+ // Reduces bundle size and eliminates unnecessary runtime checks
+ __VUE_PROD_HYDRATION_MISMATCH_DETAILS__: JSON.stringify(false),
+
+ // Expose session storage toggle to client code
+ 'process.env.STORE_SESSION': JSON.stringify(
+ process.env.STORE_SESSION || '',
+ ),
+ 'process.env.VUE_APP_STORE_SESSION': JSON.stringify(
+ process.env.VUE_APP_STORE_SESSION || '',
+ ),
+ }),
+ );
},
pluginOptions: {
i18n: {