Warp/node_modules/@vueuse/integrations/useNProgress.d.mts

21 lines
815 B
TypeScript
Raw Normal View History

2024-01-05 12:14:38 +00:00
import * as vue_demi from 'vue-demi';
import nprogress, { NProgressOptions } from 'nprogress';
import { MaybeRefOrGetter } from '@vueuse/shared';
type UseNProgressOptions = Partial<NProgressOptions>;
/**
* Reactive progress bar.
*
* @see https://vueuse.org/useNProgress
*/
declare function useNProgress(currentProgress?: MaybeRefOrGetter<number | null | undefined>, options?: UseNProgressOptions): {
isLoading: vue_demi.WritableComputedRef<boolean>;
progress: vue_demi.Ref<number | (() => number | null | undefined) | null | undefined>;
start: () => nprogress.NProgress;
done: (force?: boolean | undefined) => nprogress.NProgress;
remove: () => void;
};
type UseNProgressReturn = ReturnType<typeof useNProgress>;
export { type UseNProgressOptions, type UseNProgressReturn, useNProgress };