@types/nprogress
Advanced tools
TypeScript definitions for nprogress
Package description
@types/nprogress provides TypeScript definitions for the nprogress library, which is a simple and lightweight JavaScript library for showing a progress bar on the top of the page. It is often used to indicate loading states in web applications.
Start the Progress Bar
This feature starts the progress bar animation. It is typically used when an action that takes time begins, such as an AJAX request.
NProgress.start();Set Progress
This feature sets the progress bar to a specific value between 0 and 1. It can be used to manually control the progress bar's state.
NProgress.set(0.5);Increment Progress
This feature increments the progress bar by a random amount. It is useful for showing progress in situations where the exact progress is unknown.
NProgress.inc();Complete the Progress Bar
This feature completes the progress bar animation and hides it. It is typically used when an action that takes time is finished.
NProgress.done();Configure NProgress
This feature allows you to configure various settings of the progress bar, such as whether to show the spinner or not.
NProgress.configure({ showSpinner: false });react-top-loading-bar is a React component that provides a loading bar at the top of the page. It is similar to nprogress but is specifically designed for React applications, making it easier to integrate with React's component-based architecture.
pace-js is a library that automatically shows a progress bar for page loads and AJAX requests. It offers more customization options and different themes compared to nprogress, but it is also larger in size.
progressbar.js is a library for creating progress bars with SVG paths. It offers more advanced and customizable progress bar shapes compared to nprogress, but it requires more setup and configuration.
Readme
npm install --save @types/nprogress
This package contains type definitions for nprogress (https://github.com/rstacruz/nprogress).
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/nprogress.
declare namespace nProgress {
interface NProgressOptions {
minimum: number;
template: string;
easing: string;
speed: number;
trickle: boolean;
trickleSpeed: number;
showSpinner: boolean;
parent: string;
positionUsing: string;
barSelector: string;
spinnerSelector: string;
}
interface NProgress {
version: string;
settings: NProgressOptions;
status: number | null;
configure(options: Partial<NProgressOptions>): NProgress;
set(number: number): NProgress;
isStarted(): boolean;
start(): NProgress;
done(force?: boolean): NProgress;
inc(amount?: number): NProgress;
trickle(): NProgress;
/* Internal */
render(fromStart?: boolean): HTMLDivElement;
remove(): void;
isRendered(): boolean;
getPositioningCSS(): "translate3d" | "translate" | "margin";
}
}
declare const nProgress: nProgress.NProgress;
export = nProgress;
These definitions were written by Judah Gabriel Himango, and Ovyerus.
FAQs
TypeScript definitions for nprogress
The npm package @types/nprogress receives a total of 387,278 weekly downloads. As such, @types/nprogress popularity was classified as popular.
We found that @types/nprogress demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
uv, Python's new package manager, offers a faster and more efficient alternative to pip with features that simplify tooling, manage Python versions, and streamline development workflows.
Research
Security News
Socket researchers have uncovered 3.7 million fake GitHub stars, highlighting a growing threat linked to scams, fraud, and malware, with these campaigns rapidly increasing over the last six months.
Security News
Deno's Standard Library has stabilized after four years of development, offering developers a collection of well-maintained tools compatible with Deno, Node.js, Cloudflare Workers, and browsers with bundlers.