mirror of
https://github.com/makeplane/plane
synced 2025-08-07 19:59:33 +00:00
66 lines
2.2 KiB
TypeScript
66 lines
2.2 KiB
TypeScript
import { start, done } from "nprogress";
|
|
import { AppProgressBar as AppProgressBarComponent, useRouter } from "./AppProgressBar";
|
|
import withSuspense from "./withSuspense";
|
|
|
|
export interface NProgressOptions {
|
|
minimum?: number;
|
|
template?: string;
|
|
easing?: string;
|
|
speed?: number;
|
|
trickle?: boolean;
|
|
trickleSpeed?: number;
|
|
showSpinner?: boolean;
|
|
parent?: string;
|
|
positionUsing?: string;
|
|
barSelector?: string;
|
|
spinnerSelector?: string;
|
|
}
|
|
|
|
/**
|
|
* @param color Color of the progress bar. @default #0A2FFF
|
|
* @param height Height of the progress bar. @default 2px
|
|
* @param options NProgress options. @default undefined
|
|
* @param shallowRouting If the progress bar is not displayed when you use shallow routing - @default false
|
|
* @param startPosition The position of the progress bar at the start of the page load - @default 0
|
|
* @param delay When the page loads faster than the progress bar, it does not display - @default 0
|
|
* @param stopDelay Delay to stop the progress bar - @default 0
|
|
* @param style Custom css - @default undefined
|
|
* @param nonce Custom nonce for Content-Security-Policy directives - @default undefined
|
|
* @param shouldCompareComplexProps If you want to compare props in the React.memo return - @default false
|
|
* @param targetPreprocessor If you want to./AppProgressBaress the target URL - @default undefined
|
|
* @param disableAnchorClick Disable triggering progress bar on anchor clicks - @default false
|
|
*/
|
|
export interface ProgressBarProps {
|
|
color?: string;
|
|
height?: string;
|
|
options?: Partial<NProgressOptions>;
|
|
shallowRouting?: boolean;
|
|
disableSameURL?: boolean;
|
|
startPosition?: number;
|
|
delay?: number;
|
|
stopDelay?: number;
|
|
style?: string;
|
|
nonce?: string;
|
|
memo?: boolean;
|
|
shouldCompareComplexProps?: boolean;
|
|
targetPreprocessor?: (url: URL) => URL;
|
|
disableAnchorClick?: boolean;
|
|
}
|
|
|
|
export interface RouterNProgressOptions {
|
|
showProgressBar?: boolean;
|
|
startPosition?: number;
|
|
disableSameURL?: boolean;
|
|
}
|
|
|
|
export const startProgress = () => {
|
|
start();
|
|
};
|
|
|
|
export const stopProgress = (force?: boolean) => {
|
|
done(force);
|
|
};
|
|
|
|
const AppProgressBar = withSuspense<ProgressBarProps>(AppProgressBarComponent);
|
|
export { AppProgressBar, useRouter };
|