Nuxt/docs/3.api/2.composables/use-loading-indicator.md

1.1 KiB

title description links
useLoadingIndicator This composable gives you access to the loading state of the app page.
label icon to size
Source i-simple-icons-github https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/composables/loading-indicator.ts xs

Description

A composable which returns the loading state of the page. Used by <NuxtLoadingIndicator> and controllable. It hooks into page:loading:start and page:loading:end to change its state.

Properties

isLoading

  • type: Ref<boolean>
  • description: The loading state

progress

  • type: Ref<number>
  • description: The progress state. From 0 to 100.

Methods

start()

Set isLoading to true and start to increase the progress value.

finish()

Set the progress value to 100, stop all timers and intervals then reset the loading state 500 ms later.

clear()

Used by finish(). Clear all timers and intervals used by the composable.