useNProgress

カテゴリ

@Integrations

エクスポートサイズ

425 B

パッケージ

@vueuse/integrations

最終更新日

先週

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 の出現箇所を検索して置き換えるだけで済みます。

2 番目のパラメーターとしてオブジェクトを渡すことで、設定できます。

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

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

型定義

typescript

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