@mantine/nprogress
Version:
Navigation progress bar
25 lines (24 loc) • 1.25 kB
TypeScript
import { BasePortalProps, ElementProps, MantineColor } from '@mantine/core';
import { NprogressStore } from './nprogress.store';
export interface NavigationProgressProps extends ElementProps<'div'> {
/** Component store, controls state */
store?: NprogressStore;
/** Initial progress value @default `0` */
initialProgress?: number;
/** Key of `theme.colors` of any other valid CSS color @default `theme.primaryColor` */
color?: MantineColor;
/** Controls height of the progress bar */
size?: number;
/** Step interval in ms @default `500` */
stepInterval?: number;
/** Determines whether the progress bar should be rendered within `Portal` @default `true` */
withinPortal?: boolean;
/** Props to pass down to the `Portal` when `withinPortal` is `true` */
portalProps?: Omit<BasePortalProps, 'withinPortal'>;
/** Progressbar z-index @default `9999` */
zIndex?: React.CSSProperties['zIndex'];
}
export declare function NavigationProgress({ initialProgress, color, size, stepInterval, withinPortal, portalProps, zIndex, store, ...others }: NavigationProgressProps): import("react/jsx-runtime").JSX.Element;
export declare namespace NavigationProgress {
var displayName: string;
}