ToProgress | toprogress2

Hierarchy

ToProgress

Index

Constructors

constructor

Methods

Constructors

constructor

new ToProgress(opts?: ToProgressOptions): ToProgress

- Defined in index.ts:63
Parameters
- Optional opts: ToProgressOptions
Returns ToProgress

Methods

decrease

decrease(i: number): Promise<void>

- Defined in index.ts:124
Parameters
- i: number
  
  Amount to decrement progress
Returns Promise<void>

Promise which resolves after animation completes

destroy

destroy(): void

- Defined in index.ts:158
Returns void

finish

finish(): Promise<void>

- Defined in index.ts:141
Transition to 100%, hide, and reset

Returns Promise<void>

Promise which resolves after progress bar has been reset

getProgress

getProgress(): number

- Defined in index.ts:78
Note, because .start() uses a single CSS transition, this will not accurately reflect the position on the screen

Returns number

Current progress

hide

hide(): void

- Defined in index.ts:128
Returns void

increase

increase(i: number): Promise<void>

- Defined in index.ts:116
Parameters
- i: number
  
  Amount to increment progress
Returns Promise<void>

Promise which resolves after animation completes

reset

reset(): Promise<void>

- Defined in index.ts:153
Set progress to 0 and show after transition completes

Returns Promise<void>

Promise which resolves after progress bar has been reset

setProgress

setProgress(progress: number): Promise<void>

- Defined in index.ts:86
Parameters
- progress: number
  
  0-100
Returns Promise<void>

Promise which resolves after transition animation completes

show

show(): void

- Defined in index.ts:132
Returns void

start

start(duration?: number, easing?: string): Promise<void>

- Defined in index.ts:97
Parameters
- Default value duration: number = 30
  
  Max amount of time to animate. Larger values = slower moving bar.
- Default value easing: string = "cubic-bezier(0.05, 0.45, 0.05, 0.95)"
  
  CSS transition easing
Returns Promise<void>

Promise which resolves after timeout or .finish()

stop

stop(): void

- Defined in index.ts:107
Returns void

Generated using TypeDoc