Interface NProgressStatic

public configure(options: NProgressConfigureOptions): NProgressStatic

Configures the progress indicator.

Parameters

• options: NProgressConfigureOptions

  An object containing the configuration options.

Returns

NProgressStatic

The current NProgress object, useful for chaining.

public done(forceShow?: boolean): NProgressStatic

Finishes loading by transitioning it to 100%, then fading out.

Parameters

• forceShow?: boolean optional

  Forces the progress bar to show, even if it's not being shown. (The default behavior is that .done() will not do anything if .start() isn't called.)

Returns

NProgressStatic

The current NProgress object, useful for chaining.

public inc(): NProgressStatic

Increments the progress bar with a random amount. This will never get to 100%: use it for every image load (or similar).

Returns

NProgressStatic

The current NProgress object, useful for chaining.

public isStarted(): boolean

Gets whether progress has been started.

Returns

boolean

Whether the progress has started.

public remove()

Removes the progress indicator.

public set(progressPercent: number): NProgressStatic

Sets the progress percentage.

Parameters

• progressPercent: number

  A number between 0.0 and 1.0 that represents the progress percentage.

Returns

NProgressStatic

The current NProgress object, useful for chaining.

public start(): NProgressStatic

Shows the progress bar and begins trickling progress.

Returns

NProgressStatic

The current NProgress object, useful for chaining.