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>