Browse Source

Remove line breaks to simplify syncs

main
Alexey Pyltsyn 4 years ago
committed by GitHub
parent
commit
371156e9c3
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 60
      content/docs/code-splitting.md

60
content/docs/code-splitting.md

@ -6,12 +6,7 @@ permalink: docs/code-splitting.html
## Bundling {#bundling} ## Bundling {#bundling}
Most React apps will have their files "bundled" using tools like Most React apps will have their files "bundled" using tools like [Webpack](https://webpack.js.org/), [Rollup](https://rollupjs.org/) or [Browserify](http://browserify.org/). Bundling is the process of following imported files and merging them into a single file: a "bundle". This bundle can then be included on a webpage to load an entire app at once.
[Webpack](https://webpack.js.org/), [Rollup](https://rollupjs.org/) or
[Browserify](http://browserify.org/).
Bundling is the process of following imported files and merging them into a
single file: a "bundle". This bundle can then be included on a webpage to load
an entire app at once.
#### Example {#example} #### Example {#example}
@ -45,38 +40,22 @@ console.log(add(16, 26)); // 42
> >
> Your bundles will end up looking a lot different than this. > Your bundles will end up looking a lot different than this.
If you're using [Create React App](https://create-react-app.dev/), [Next.js](https://nextjs.org/), [Gatsby](https://www.gatsbyjs.org/), or a similar tool, you will have a Webpack setup out of the box to bundle your If you're using [Create React App](https://create-react-app.dev/), [Next.js](https://nextjs.org/), [Gatsby](https://www.gatsbyjs.org/), or a similar tool, you will have a Webpack setup out of the box to bundle your app.
app.
If you aren't, you'll need to setup bundling yourself. For example, see the If you aren't, you'll need to setup bundling yourself. For example, see the [Installation](https://webpack.js.org/guides/installation/) and [Getting Started](https://webpack.js.org/guides/getting-started/) guides on the Webpack docs.
[Installation](https://webpack.js.org/guides/installation/) and
[Getting Started](https://webpack.js.org/guides/getting-started/) guides on the
Webpack docs.
## Code Splitting {#code-splitting} ## Code Splitting {#code-splitting}
Bundling is great, but as your app grows, your bundle will grow too. Especially Bundling is great, but as your app grows, your bundle will grow too. Especially if you are including large third-party libraries. You need to keep an eye on the code you are including in your bundle so that you don't accidentally make it so large that your app takes a long time to load.
if you are including large third-party libraries. You need to keep an eye on
the code you are including in your bundle so that you don't accidentally make
it so large that your app takes a long time to load.
To avoid winding up with a large bundle, it's good to get ahead of the problem To avoid winding up with a large bundle, it's good to get ahead of the problem and start "splitting" your bundle. Code-Splitting is a feature
and start "splitting" your bundle. supported by bundlers like [Webpack](https://webpack.js.org/guides/code-splitting/), [Rollup](https://rollupjs.org/guide/en/#code-splitting) and Browserify (via [factor-bundle](https://github.com/browserify/factor-bundle)) which can create multiple bundles that can be dynamically loaded at runtime.
Code-Splitting is a feature
supported by bundlers like [Webpack](https://webpack.js.org/guides/code-splitting/), [Rollup](https://rollupjs.org/guide/en/#code-splitting) and Browserify (via
[factor-bundle](https://github.com/browserify/factor-bundle)) which can create
multiple bundles that can be dynamically loaded at runtime.
Code-splitting your app can help you "lazy-load" just the things that are Code-splitting your app can help you "lazy-load" just the things that are currently needed by the user, which can dramatically improve the performance of your app. While you haven't reduced the overall amount of code in your app, you've avoided loading code that the user may never need, and reduced the amount of code needed during the initial load.
currently needed by the user, which can dramatically improve the performance of
your app. While you haven't reduced the overall amount of code in your app,
you've avoided loading code that the user may never need, and reduced the amount
of code needed during the initial load.
## `import()` {#import} ## `import()` {#import}
The best way to introduce code-splitting into your app is through the dynamic The best way to introduce code-splitting into your app is through the dynamic `import()` syntax.
`import()` syntax.
**Before:** **Before:**
@ -94,16 +73,11 @@ import("./math").then(math => {
}); });
``` ```
When Webpack comes across this syntax, it automatically starts code-splitting When Webpack comes across this syntax, it automatically starts code-splitting your app. If you're using Create React App, this is already configured for you and you can [start using it](https://create-react-app.dev/docs/code-splitting/) immediately. It's also supported out of the box in [Next.js](https://nextjs.org/docs/advanced-features/dynamic-import).
your app. If you're using Create React App, this is already configured for you
and you can [start using it](https://create-react-app.dev/docs/code-splitting/) immediately. It's also supported
out of the box in [Next.js](https://nextjs.org/docs/advanced-features/dynamic-import).
If you're setting up Webpack yourself, you'll probably want to read Webpack's If you're setting up Webpack yourself, you'll probably want to read Webpack's [guide on code splitting](https://webpack.js.org/guides/code-splitting/). Your Webpack config should look vaguely [like this](https://gist.github.com/gaearon/ca6e803f5c604d37468b0091d9959269).
[guide on code splitting](https://webpack.js.org/guides/code-splitting/). Your Webpack config should look vaguely [like this](https://gist.github.com/gaearon/ca6e803f5c604d37468b0091d9959269).
When using [Babel](https://babeljs.io/), you'll need to make sure that Babel can When using [Babel](https://babeljs.io/), you'll need to make sure that Babel can parse the dynamic import syntax but is not transforming it. For that you will need [@babel/plugin-syntax-dynamic-import](https://classic.yarnpkg.com/en/package/@babel/plugin-syntax-dynamic-import).
parse the dynamic import syntax but is not transforming it. For that you will need [@babel/plugin-syntax-dynamic-import](https://classic.yarnpkg.com/en/package/@babel/plugin-syntax-dynamic-import).
## `React.lazy` {#reactlazy} ## `React.lazy` {#reactlazy}
@ -196,17 +170,11 @@ const MyComponent = () => (
## Route-based code splitting {#route-based-code-splitting} ## Route-based code splitting {#route-based-code-splitting}
Deciding where in your app to introduce code splitting can be a bit tricky. You Deciding where in your app to introduce code splitting can be a bit tricky. You want to make sure you choose places that will split bundles evenly, but won't disrupt the user experience.
want to make sure you choose places that will split bundles evenly, but won't
disrupt the user experience.
A good place to start is with routes. Most people on the web are used to A good place to start is with routes. Most people on the web are used to page transitions taking some amount of time to load. You also tend to be re-rendering the entire page at once so your users are unlikely to be interacting with other elements on the page at the same time.
page transitions taking some amount of time to load. You also tend to be
re-rendering the entire page at once so your users are unlikely to be
interacting with other elements on the page at the same time.
Here's an example of how to setup route-based code splitting into your app using Here's an example of how to setup route-based code splitting into your app using libraries like [React Router](https://reacttraining.com/react-router/) with `React.lazy`.
libraries like [React Router](https://reacttraining.com/react-router/) with `React.lazy`.
```js ```js
import React, { Suspense, lazy } from 'react'; import React, { Suspense, lazy } from 'react';

Loading…
Cancel
Save