The loading property
Nuxt uses its own component to show a progress bar between the routes. You can customize it, disable it or create your own component.
-
Type:
Boolean
orObject
orString
export default {
mounted() {
this.$nextTick(() => {
this.$nuxt.$loading.start()
setTimeout(() => this.$nuxt.$loading.finish(), 500)
})
}
}
Disable the Progress Bar
-
Type:
Boolean
nuxt.config.js
export default {
loading: false
}
Customizing the Progress Bar
-
Type:
Object
export default {
loading: {
color: 'blue',
height: '5px'
}
}
List of properties to customize the progress bar.
Key | Type | Default | Description |
---|---|---|---|
color |
String | 'black' |
CSS color of the progress bar |
failedColor |
String | 'red' |
CSS color of the progress bar when an error appended while rendering the route (if data or fetch sent back an error for example). |
height |
String | '2px' |
Height of the progress bar (used in the style property of the progress bar) |
throttle |
Number | 200 |
In ms, wait for the specified time before displaying the progress bar. Useful for preventing the bar from flashing. |
duration |
Number | 5000 |
In ms, the maximum duration of the progress bar, Nuxt assumes that the route will be rendered before 5 seconds. |
continuous |
Boolean | false |
Keep animating progress bar when loading takes longer than duration . |
css |
Boolean | true |
Set to false to remove default progress bar styles (and add your own). |
rtl |
Boolean | false |
Set the direction of the progress bar from right to left. |
Using a Custom Loading Component
-
Type:
String
Your component has to expose some of these methods:
Method | Required | Description |
---|---|---|
start() |
Required | Called when a route changes, this is where you display your component. |
finish() |
Required | Called when a route is loaded (and data fetched), this is where you hide your component. |
fail(error) |
Optional | Called when a route couldn't be loaded (failed to fetch data for example). |
increase(num) |
Optional | Called during loading the route component, num is an Integer < 100. |
components/loading.vue
<template lang="html">
<div class="loading-page" v-if="loading">
<p>Loading...</p>
</div>
</template>
<script>
export default {
data: () => ({
loading: false
}),
methods: {
start() {
this.loading = true
},
finish() {
this.loading = false
}
}
}
</script>
<style scoped>
.loading-page {
position: fixed;
top: 0;
left: 0;
width: 100%;
height: 100%;
background: rgba(255, 255, 255, 0.8);
text-align: center;
padding-top: 200px;
font-size: 30px;
font-family: sans-serif;
}
</style>
nuxt.config.js
export default {
loading: '~/components/loading.vue'
}
Edit this page on GitHub
Updated at Wed, Jul 24, 2024
![Sébastien Chopin](/_nuxt/image/e847b9.png)
![Nazaré da Piedade](/_nuxt/image/d5c785.png)
![Nobu](/_nuxt/image/888ba6.png)
![川音리오](/_nuxt/image/345a82.png)
![Maciek Palmowski](/_nuxt/image/2bdab1.png)
![Nestor Vera](/_nuxt/image/b6ef28.png)
![Daniel Roe](/_nuxt/image/0786f3.png)
![Yue Yang](/_nuxt/image/40c994.png)
![Jeronimas](/_nuxt/image/ba9a98.png)
![Clément Ollivier](/_nuxt/image/77339c.png)
![Alexander Lichter](/_nuxt/image/073577.png)
![N3-rd](/_nuxt/image/20bdf5.png)
![Adrien Zaganelli](/_nuxt/image/c3f019.png)
![Mag](/_nuxt/image/1fe278.png)
![Stefan Huber](/_nuxt/image/c3653a.png)
![Olga Bulat](/_nuxt/image/e50af3.png)
![Paiva](/_nuxt/image/ea02f0.png)
![Florian Reuschel](/_nuxt/image/ee31ca.png)
![Savas Vedova](/_nuxt/image/d403a7.png)
![HIJACK](/_nuxt/image/d0b78e.png)
![Vinícius Alves](/_nuxt/image/ba75e5.png)
![Kareem Dabbeet](/_nuxt/image/c79dfa.png)
![Valentín Costa](/_nuxt/image/3dd0d7.png)
![Ryan Skinner](/_nuxt/image/ec2d86.png)
![Alex Hirzel](/_nuxt/image/980fb6.png)
![Ajeet Chaulagain](/_nuxt/image/2fb9d1.png)
![René Eschke](/_nuxt/image/ddfbaa.png)
![Nico Devs](/_nuxt/image/5fa1fe.png)
![Muhammad](/_nuxt/image/76bed9.png)
![Naoki Hamada](/_nuxt/image/475300.png)
![Tom](/_nuxt/image/aae9cc.png)
![Yann Aufray](/_nuxt/image/305a71.png)
![Anthony Chu](/_nuxt/image/027d85.png)
![Nuzhat Minhaz](/_nuxt/image/431077.png)
![Lucas Portet](/_nuxt/image/260cbe.png)
![Richard Schloss](/_nuxt/image/7f63ae.png)
![Bobby](/_nuxt/image/42cdae.png)
![bpy](/_nuxt/image/ecc096.png)
![Antony Konstantinidis](/_nuxt/image/1434b0.png)
![Hibariya](/_nuxt/image/febb5a.png)
![Jose Seabra](/_nuxt/image/ede04e.png)
![Eze](/_nuxt/image/f22c13.png)
![Florian Lefebvre](/_nuxt/image/e3705e.png)
![Lucas Recoaro](/_nuxt/image/8cdc5c.png)
![Julien SEIXAS](/_nuxt/image/40a795.png)