useNProgress

类别

@Integrations

导出大小

448 B

包

@vueuse/integrations

最后更改

5 天前

用于 nprogress 的响应式包装器。

演示

源代码

点击更改进度状态

在 @vueuse/integrations 附加组件中可用。

安装

bash

npm i nprogress@^0

用法

import { useNProgress } from '@vueuse/integrations/useNProgress'

const { isLoading } = useNProgress()

function toggle() {
  isLoading.value = !isLoading.value
}

传递进度百分比

您可以传递一个百分比来指示进度条应从哪里开始。

import { useNProgress } from '@vueuse/integrations/useNProgress'

const { progress } = useNProgress(0.5)

function done() {
  progress.value = 1.0
}

要更改进度百分比，请设置 progress.value = n，其中 n 是介于 0..1 之间的数字。

自定义

只需编辑 nprogress.css 以符合您的喜好。提示：您可能只想查找并替换 #29d 的出现位置。

您可以通过传递一个对象作为第二个参数来配置它。

import { useNProgress } from '@vueuse/integrations/useNProgress'

useNProgress(null, {
  minimum: 0.1,
  // ...
})

类型声明

typescript

export type UseNProgressOptions = Partial<NProgressOptions>
/**
 * Reactive progress bar.
 *
 * @see https://vueuse.org.cn/useNProgress
 */
export declare function useNProgress(
  currentProgress?: MaybeRefOrGetter<number | null | undefined>,
  options?: UseNProgressOptions,
): {
  isLoading: WritableComputedRef<boolean, boolean>
  progress: Ref<number | null | undefined, number | null | undefined>
  start: () => nprogress.NProgress
  done: (force?: boolean) => nprogress.NProgress
  remove: () => void
}
export type UseNProgressReturn = ReturnType<typeof useNProgress>