Using Dynamic Imports with Laravel Mix

Published on by

Using Dynamic Imports with Laravel Mix image

In the latest release of Laravel Mix (4.0.16), support for dynamic imports was added out of the box. Dynamic imports is a method of code-splitting that allow us to easily split our JavaScript components, packages, and other modules into separate files. If a project is using several packages or has a lot of Vue.js or React components, it’s easy to end up with a 1MB+ JavaScript bundle. If users are on a slow connection, that could take a while to download.

Code-splitting allows us to ship much smaller initial bundles (kilobytes instead of megabytes) and improve load-times significantly for those users. Webpack will then automatically download any additional files needed when the user visits a different page.

Configuring Dynamic Imports

To get started using dynamic imports with Laravel Mix, first ensure you’re using at least version 4.0.16. Then, if you don’t already have one, add a .babelrc file to the root of your project. Inside, add the @babel/plugin-syntax-dynamic-import plugin to a “plugins” array. This will enable the dynamic import syntax via a plugin already included with Laravel Mix.

{
"plugins": [
"@babel/plugin-syntax-dynamic-import"
]
}

Alternatively, if you’d rather configure the plugin in your webpack.mix.js file, you can add it there.

mix.babelConfig({
plugins: ['@babel/plugin-syntax-dynamic-import'],
});

Using Dynamic Imports

To tell Webpack you want to import a file dynamically, you need to use a slightly different syntax. Below, I demonstrate what a standard import looks like compared to a dynamic import.

// Standard import
import StandardComponent from './components/ExampleComponent.vue';
 
// Dynamic import
const DynamicallyImportedComponent =
() => import('./components/ExampleComponent.vue');

By default, Webpack will split the dynamically imported files into chunks and name them 0.js, 1.js, etc. Laravel Mix is configured to name the files using the chunk name, then a hash of the contents, followed by the .js extension. If you want to configure the chunk name for a file, you need to add a “magic” comment to the import statement to tell Webpack the name you want to use. Below, I tell Webpack I want to use dynamically-imported-component as the name which will generate a dynamically-imported-component.[hash].js file.

const DynamicallyImportedComponent =
() => import(/* webpackChunkName: "dynamically-imported-component" */ './components/ExampleComponent.vue');

Using Dynamic Imports with Vue Router

If you are using Vue Router in your project, it’s straightforward to split each page into separate files using dynamic imports. When configuring your routes, you can use the dynamic import syntax instead of require() or the standard import syntax, and Webpack will take care of the rest.

const routes = [
{
name: 'dashboard',
path: '/dashboard',
component:
() => import(/* webpackChunkName: "dashboard" */ './pages/Dashboard.vue'),
},
];

Conclusion

Overall, dynamic imports are a handy tool to have. They’re easy to use and can provide some real benefits to your users, especially in larger applications. I recommend trying them out in a project you are already working on or in your next project!

Jason Beggs photo

TALL stack (Tailwind CSS, Alpine.js, Laravel, and Livewire) consultant and owner of designtotailwind.com.

Filed in:
Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $7500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
Lucky Media logo

Lucky Media

Get Lucky Now - the ideal choice for Laravel Development, with over a decade of experience!

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
LaraJobs logo

LaraJobs

The official Laravel job board

LaraJobs
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Multi-tenant Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector
MongoDB logo

MongoDB

Enhance your PHP applications with the powerful integration of MongoDB and Laravel, empowering developers to build applications with ease and efficiency. Support transactional, search, analytics and mobile use cases while using the familiar Eloquent APIs. Discover how MongoDB's flexible, modern database can transform your Laravel applications.

MongoDB

The latest

View all →
The Inertia.js v2 Beta is Here image

The Inertia.js v2 Beta is Here

Read article
Mastering Laravel, No Compromises, and SourceDive with Joel Clermont image

Mastering Laravel, No Compromises, and SourceDive with Joel Clermont

Read article
Now you can install PHP and the Laravel installer with a single command image

Now you can install PHP and the Laravel installer with a single command

Read article
WireSpy is a Sleek New Debug Bar for Laravel Livewire image

WireSpy is a Sleek New Debug Bar for Laravel Livewire

Read article
The Laracon AU schedule is now live image

The Laracon AU schedule is now live

Read article
Supercharge PhpStorm with Laravel Idea image

Supercharge PhpStorm with Laravel Idea

Read article