1. 22
    Asynchronously Load webpack Bundles through Code-splitting and React Suspense
    4m 10s

Asynchronously Load webpack Bundles through Code-splitting and React Suspense

Andy Van Slaars
InstructorAndy Van Slaars
Share this video with your friends

Social Share Links

Send Tweet
Published 6 years ago
Updated 5 years ago

One approach to building high performance applications with webpack is to take advantage of code-splitting to only load the needed JavaScript on initial load and asynchronously load additional JavaScript bundles when needed. In this lesson, we'll create add some code-splitting to our placeholder application and configure our project to support the dynamic import() syntax.

Instructor: [00:00] I've created this simple warning component that just displays the span with a warning in it. It has this warning class applied to it. If we take a look at app.js, we'll see we're importing warning from the warning file. If I scroll down, we're using it in our render method.

[00:17] If the count is greater than 10, we'll display warning right here after the buttons. Otherwise, we just return null. I'm running this application. If I come over here, we can see the behavior by clicking our count button until we get to 11. Then we'll see that our warning text is displayed here.

[00:35] This warning component is very lightweight, but we can imagine a situation where this is a bigger component, maybe responding to a different event, like a route change. We don't necessarily want this to be included in our initial load, because we may or may not ever load it.

[00:49] By taking it out of the initial bundle, we can improve the load performance of our page, and give our users a better experience. Let's see how we can asynchronously load this component, only when we need it. Now, let's scroll up to the top of the page, and I'm going to get rid of this import for one.

[01:05] I'm going to define a constant, called warning, and I'm going to set this to call to react.lazy. Lazy's going to take a function, and that function is going to use this dynamic import syntax to pull in our warning component, asynchronously. Then, to use this component, we'll go down into our render method.

[01:33] Because we're loading this warning component asynchronously now, we're going to need to wrap it in a suspense component. I'm going to break this out into a few lines here. I'm going to add react.suspense. That's going to take a fallback property. That fallback is going to be what renders if warning isn't quite ready yet.

[01:57] Then I'm going to move warning inside of it, and fallback here, I'm just going to give it null. I don't want anything to show up, kind of like our default before our count reaches over 10. We're going to do the same thing until warning is ready to display. Now, I'm going to save this file.

[02:17] We're going to see that our compile fails. I'm going to expand the terminal, and if I scroll up here a little bit, we're going to see that this is failing on this import syntax. This is because Babel doesn't have support for this experimental dynamic import syntax. We need to add it with a plugin.

[02:34] I'm going to clear that out. We'll use npm i -d to save as a dev dependency, babel/plugin-syntax-dynamic-import. We're going to need to put this in our configuration, so I'm also going to copy this and we'll run that install.

[02:59] With that done, I'm going to come into my webpack.config.base, and under plugins, I'll add that plugin-syntax-dynamic-import. I can save that, then I can go back into the terminal, can do an npm run dev. With that open in the browser, I'm going to open up the dev tools.

[03:27] I'm going to look at the network tab. I'm going to increment my count, and I'm going to get up to 10. Then I'm going to hit it one more time, and this is when we want to asynchronously load that warning component.

[03:41] We'll see that our component shows up, and down in the network tab, we've loaded the second bundle. webpack has separated out this dynamic import into its own bundle, and it doesn't load it into the browser until it's actually needed.

[03:56] Webpack has given us the ability to use this dynamic import syntax to asynchronously load modules only when we need them. By splitting our code this way, we can keep our initial bundle small, and only load things when they're required in the browser.

~ 5 years ago

I would like to know how React Suspense in compare to React Loadable. Will there be any use cases where I would use one over the other and what are their each pro​s and cons?


Alan Baird
Alan Baird
~ 5 years ago

Seems like this syntax is supported out of the box when I tried it - I didn't get the message saying Babel doesn't have support for this experimental dynamic import syntax.

Markdown supported.
Become a member to join the discussionEnroll Today