@vueuse/integrations
Version:
Integration wrappers for utility libraries
21 lines (20 loc) • 815 B
TypeScript
import * as vue4 from "vue";
import { MaybeRefOrGetter } from "vue";
import nprogress, { NProgressOptions } from "nprogress";
//#region useNProgress/index.d.ts
type UseNProgressOptions = Partial<NProgressOptions>;
/**
* Reactive progress bar.
*
* @see https://vueuse.org/useNProgress
*/
declare function useNProgress(currentProgress?: MaybeRefOrGetter<number | null | undefined>, options?: UseNProgressOptions): {
isLoading: vue4.WritableComputedRef<boolean, boolean>;
progress: vue4.Ref<number | null | undefined, number | null | undefined>;
start: () => nprogress.NProgress;
done: (force?: boolean) => nprogress.NProgress;
remove: () => void;
};
type UseNProgressReturn = ReturnType<typeof useNProgress>;
//#endregion
export { UseNProgressReturn as n, useNProgress as r, UseNProgressOptions as t };