loading...

The Nuxt Loading Progress Bar

debs_obrien profile image Debbie O'Brien Updated on ・2 min read

Nuxt.js automatically gives you a loading progress bar component which is shown between routes. Did you know you can customise it, disable it or create your own component?

To change the colour for example all you have to do is add the colour you want to the loading property in your nuxt.config.js file.

export default {
  loading: {
    color: 'blue',
  }
}

There are many other things you can change such as the height, the duration, the direction for rtl sites and if it should keep animating the progress bar when loading takes longer than the duration.

export default {
  loading: {
    height: '10px',
    duration: 1000,
    rtl: true,
    continuous: true,    
  }
}

If you don't like the progress bar at all you can disable it completely in the nuxt.config.js

export default {
  loading: false
}

You can also disable it for a specific page.

<template>
  <h1>About Page</h1>
</template>

<script>
export default {
  loading: false
}
</script>

And if you want to show loading but don't like the default loading component you can of course create your own. In the components folder create a component called loading.vue.

<template>
  <div v-if="loading" class="loading-page" >
    <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: yellowgreen;
  text-align: center;
  padding-top: 100px;
  color: red;
  font-size: 80px;
  font-family: sans-serif;
}
</style>

Then in the nuxt.config.js file add the component to the loading property.

export default {
  loading: '~/components/loading.vue'
}

And that's it you now have your own custom loading component for when changing routes and your content is loading.

Posted on by:

debs_obrien profile

Debbie O'Brien

@debs_obrien

Head of Learning and Developer Advocate at NuxtJS, speaker, writer, teacher, open source contributor, vue, nuxt, webpack

Discussion

markdown guide