useLoadingIndicator

描述

一个可组合函数，返回页面的加载状态。由 <NuxtLoadingIndicator> 使用并可控。它通过监听 page:loading:start 和 page:loading:end 来改变其状态。

参数

• duration: 加载条的持续时间，单位毫秒（默认为 2000）。
• throttle: 节流出现和隐藏，单位毫秒（默认为 200）。
• estimatedProgress: 默认情况下，Nuxt 会在接近 100% 时减速。您可以提供一个自定义函数来定制进度估算，该函数接收加载条的持续时间（如上所述）和已用时间。它应该返回一个介于 0 到 100 之间的值。

属性

isLoading

• 类型: Ref<boolean>
• 描述: 加载状态

error

• 类型: Ref<boolean>
• 描述: 错误状态

progress

• 类型: Ref<number>
• 描述: 进度状态。从 0 到 100。

方法

start()

将 isLoading 设置为 true 并开始增加 progress 值。start 接受一个 { force: true } 选项，以跳过间隔并立即显示加载状态。

set()

将 progress 值设置为特定值。set 接受一个 { force: true } 选项，以跳过间隔并立即显示加载状态。

finish()

将 progress 值设置为 100，停止所有计时器和间隔，然后在 500 毫秒后重置加载状态。finish 接受一个 { force: true } 选项，以跳过状态重置前的间隔，以及 { error: true } 以改变加载条颜色并将错误属性设置为 true。

clear()

由 finish() 使用。清除此可组合函数使用的所有计时器和间隔。

示例

<script setup lang="ts">
const { progress, isLoading, start, finish, clear } = useLoadingIndicator({
  duration: 2000,
  throttle: 200,
  // This is how progress is calculated by default
  estimatedProgress: (duration, elapsed) => (2 / Math.PI * 100) * Math.atan(elapsed / duration * 100 / 50),
})
</script>

<script setup lang="ts">
const { start, set } = useLoadingIndicator()
// same as set(0, { force: true })
// set the progress to 0, and show loading immediately
start({ force: true })
</script>