mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-23 06:05:11 +00:00
3ec108493d
* docs: simplify docs to only markdown * Create nuxt-config.md * chore: update * chore: add readme
40 lines
1.3 KiB
Markdown
40 lines
1.3 KiB
Markdown
# `<NuxtLoadingIndicator>`
|
|
|
|
The `<NuxtLoadingIndicator>` component displays a progress bar on page navigation.
|
|
|
|
## Examples
|
|
|
|
### Basic Usage
|
|
|
|
Add `<NuxtLoadingIndicator/>` in your `app.vue` or layouts.
|
|
|
|
```vue [app.vue]
|
|
<template>
|
|
<NuxtLayout>
|
|
<NuxtLoadingIndicator /> <!-- here -->
|
|
<NuxtPage />
|
|
</NuxtLayout>
|
|
</template>
|
|
```
|
|
|
|
:button-link[Open on StackBlitz]{href="https://stackblitz.com/github/nuxt/nuxt/tree/main/examples/routing/pages?terminal=dev&file=/app.vue" blank}
|
|
|
|
::alert{type=warning}
|
|
If you are changing layouts as well as page, the page transition you set here will not run. Instead, you should set a layout transition.
|
|
::
|
|
|
|
## Slots
|
|
|
|
You can pass custom HTML or components through the loading indicator's default slot.
|
|
|
|
## Props
|
|
|
|
- **color**: The color of the loading bar. It can be set to `false` to turn off explicit color styling.
|
|
- **height**: Height of the loading bar, in pixels (default `3`).
|
|
- **duration**: Duration of the loading bar, in milliseconds (default `2000`).
|
|
- **throttle**: Throttle the appearing and hiding, in milliseconds (default `200`).
|
|
|
|
::alert{type=info icon=🔎}
|
|
This component is completely optional. To achieve full customization, you can implement your own one based on [this file](https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/components/nuxt-loading-indicator.ts).
|
|
::
|