mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-24 22:55:13 +00:00
126 lines
10 KiB
Markdown
126 lines
10 KiB
Markdown
---
|
|
description: "Nuxt supports different rendering modes. Each one has pros and cons covered in this section."
|
|
---
|
|
|
|
# Rendering Modes
|
|
|
|
Both the browser and server can interpret JavaScript code to render Vue.js components into HTML elements. This step is called **rendering**. Nuxt supports both **client-side** and **universal** rendering. The two approaches have pros and cons that we will cover in this section.
|
|
|
|
## Client-side Only Rendering
|
|
|
|
Out of the box, a traditional Vue.js application is rendered in the browser (or **client**). Then, Vue.js generates HTML elements after the browser downloads and parses all the JavaScript code containing the instructions to create the current interface.
|
|
|
|
{.light-img.dark:hidden}
|
|
{.dark-img.hidden.dark:block}
|
|
|
|
While this technique allows building complex and dynamic UIs with smooth page transitions, it has different pros and cons:
|
|
|
|
### Pros
|
|
|
|
- **Development speed**: When working entirely on the client-side, we don't have to worry about the server compatibility of the code, for example, by using browser-only APIs like the `window` object.
|
|
- **Cheaper:** Running a server adds a cost of infrastructure as you would need to run on a platform that supports JavaScript. We can host Client-only applications on any static server with HTML, CSS, and JavaScript files.
|
|
- **Offline:** Because code entirely runs in the browser, it can nicely keep working while the internet is unavailable.
|
|
|
|
### Cons
|
|
|
|
- **Performance**: The user has to wait for the browser to download, parse and run JavaScript files. Depending on the network for the download part and the user's device for the parsing and execution, this can take some time and impact the user's experience.
|
|
- **Search Engine Optimization**: Indexing and updating the content delivered via client-side rendering takes more time than with a server-rendered HTML document. This is related to the performance drawback we discussed, as search engine crawlers won't wait for the interface to be fully rendered on their first try to index the page. Your content will take more time to show and update in search results pages with pure client-side rendering.
|
|
|
|
### Examples
|
|
|
|
Client-side rendering is a good choice for heavily interactive **web applications** that don't need indexing or whose users visit frequently. It can leverage browser caching to skip the download phase on subsequent visits, such as **SaaS, back-office applications, or online games**.
|
|
|
|
## Universal Rendering
|
|
|
|
When the browser requests a URL with universal (client-side + server-side) rendering enabled, the server returns a fully rendered HTML page to the browser. Whether the page has been generated in advance and cached or is rendered on the fly, at some point, Nuxt has run the JavaScript (Vue.js) code in a server environment, producing an HTML document. Users immediately get the content of our application, contrary to client-side rendering. This step is similar to traditional **server-side rendering** performed by PHP or Ruby applications.
|
|
|
|
To not lose the benefits of the client-side rendering method, such as dynamic interfaces and pages transitions, the Client loads the javascript code that runs on the Server in the background once the HTML document has been downloaded. The browser interprets it again (hence **Universal rendering**) and Vue.js takes control of the document and enables interactivity.
|
|
|
|
Making a static page interactive in the browser is called "Hydration."
|
|
|
|
Universal rendering allows a Nuxt application to provide quick page load times while preserving the benefits of client-side rendering. Furthermore, as the content is already present in the HTML document, crawlers can index it without overhead.
|
|
|
|
{.light-img.dark:hidden}
|
|
{.dark-img.hidden.dark:block}
|
|
|
|
### Pros
|
|
|
|
- **Performance**: Users can get immediate access to the page's content because browsers can display static content much faster than JavaScript-generated one. At the same time, Nuxt preserves the interactivity of a web application when the hydration process happens.
|
|
- **Search Engine Optimization**: Universal rendering delivers the entire HTML content of the page to the browser as a classic server application. Web crawlers can directly index the page's content, which makes Universal rendering a great choice for any content that you want to index quickly.
|
|
|
|
### Cons
|
|
|
|
- **Development constraints:** Server and browser environments don't provide the same APIs, and it can be tricky to write code that can run on both sides seamlessly. Fortunately, Nuxt provides guidelines and specific variables to help you determine where a piece of code is executed.
|
|
- **Cost:** A server needs to be running in order to render pages on the fly. This adds a monthly cost like any traditional server. However, the server calls are highly reduced thanks to universal rendering with the browser taking over on client-side navigation.
|
|
|
|
::alert
|
|
For more examples about writing Vue code without hydration mismatch, see [the Vue docs](https://vuejs.org/guide/scaling-up/ssr.html#hydration-mismatch).
|
|
::
|
|
|
|
::alert{type=warning}
|
|
When importing a library that relies on browser APIs and has side effects, make sure the component importing it is only called client-side. Bundlers do not treeshake imports of modules containing side effects.
|
|
::
|
|
|
|
### Examples
|
|
|
|
Universal rendering is very versatile and can fit almost any use case, and is especially appropriate for any content-oriented websites: **blogs, marketing websites, portfolios, e-commerce sites, and marketplaces.**
|
|
|
|
## Summary
|
|
|
|
Client-side and universal rendering are different strategies to display an interface in a browser.
|
|
|
|
By default, Nuxt uses **universal rendering** to provide better user experience and performance, and to optimize search engine indexing, but you can switch rendering modes in [one line of configuration](/docs/api/configuration/nuxt-config#ssr).
|
|
|
|
## New Rendering Patterns in Nuxt 3
|
|
|
|
In most cases, universal rendering as performed in Nuxt 2 offers a good user and developer experience. However, Nuxt 3 takes universal rendering a step further by introducing hybrid rendering and edge-side rendering.
|
|
|
|
### Hybrid Rendering
|
|
|
|
Hybrid rendering allows different caching rules per route using **Route Rules** and decides how the server should respond to a new request on a given URL.
|
|
|
|
### Rendering on CDN Edge Workers
|
|
|
|
Traditionally, server-side and universal rendering was only possible using Node.js. Nuxt 3 takes it to another level by directly rendering code in CDN edge workers, reducing latency and costs.
|
|
|
|
Nitro is the new [server engine](/docs/guide/concepts/server-engine) that powers Nuxt 3. It offers cross-platform support for Node.js, Deno, Workers, and more. Nitro's design is platform-agnostic and allows rendering a Nuxt application at the edge, closer to your users, allowing replication and further optimizations.
|
|
|
|
### Route Rules
|
|
|
|
> 🧪 Route rules are still under active development, and subject to change.
|
|
|
|
Previously every route/page of a Nuxt application and server must use the same rendering mode, client-side or universal. But in various cases, some pages could be generated at build time, while others should be client-side rendered. For example, think of a content website with an admin section. Every content page should be primarily static and generated once, but the admin section requires registration and behaves more like a dynamic application.
|
|
|
|
Nuxt 3 includes route rules and hybrid rendering support. Using route rules you can define rules for a group of nuxt routes, change rendering mode or assign a cache strategy based on route! Nuxt server will automatically register corresponding middleware and wrap routes with cache handlers using [nitro caching layer](https://nitro.unjs.io/guide/cache). Whenever possible, route rules will be automatically applied to the deployment platform's native rules (currently Netlify and Vercel are supported).
|
|
|
|
- `redirect` - Define server-side redirects.
|
|
- `ssr` - Disables server-side rendering for sections of your app and make them SPA-only with `ssr: false`
|
|
- `cors` - Automatically adds cors headers with `cors: true` - you can customize the output by overriding with `headers`
|
|
- `headers` - Add specific headers to sections of your site - for example, your assets
|
|
- `swr` - Add cache headers to the server response and cache it in the server or reverse proxy for a configurable TTL. The `node-server` preset of Nitro is able to cache the full response. For Netlify and Vercel, the response is also added to the CDN layer.
|
|
- `static` - The behavior is the same as `swr` except that there is no TTL; the response is cached until the next deployment. On Netlify and Vercel, it enables full incremental static generation.
|
|
- `prerender` - Prerenders routes at build time and includes them in your build as static assets
|
|
- `experimentalNoScripts` - Disables rendering of Nuxt scripts and JS resource hints for sections of your site.
|
|
|
|
**Examples:**
|
|
|
|
```ts
|
|
export default defineNuxtConfig({
|
|
routeRules: {
|
|
// Static page generated on-demand, revalidates in background
|
|
'/blog/**': { swr: true },
|
|
// Static page generated on-demand once
|
|
'/articles/**': { static: true },
|
|
// Set custom headers matching paths
|
|
'/_nuxt/**': { headers: { 'cache-control': 's-maxage=0' } },
|
|
// Render these routes with SPA
|
|
'/admin/**': { ssr: false },
|
|
// Add cors headers
|
|
'/api/v1/**': { cors: true },
|
|
// Add redirect headers
|
|
'/old-page': { redirect: '/new-page' },
|
|
'/old-page2': { redirect: { to: '/new-page', statusCode: 302 } }
|
|
}
|
|
})
|
|
```
|