A modern progress bar for web APP. Featuring realistic trickle animations to convince your users that something is happening!

• See Example here.
• Release Notes.

• Support programmatically modify the style of the progress bar.
• Support RTL languages.
• Support Typescript.

# pnpm
$ pnpm add trickling

# yarn
$ yarn add trickling

# npm
$ npm i trickling

1. Imports style.

import 'trickling/lib/style.css'

2. Create a trickling progress instance in a single file.

// @/plugins/trickling-progress.ts

import { createTrickling } from 'trickling'

// Create a Trickling progress instance
const tricklingProgress = createTrickling({
  // Options
  // ...
})

// You can also change options after creating a Trickling progress instance
tricklingProgress.setOptions({
  // ...
})

// Export the instance
export { tricklingProgress }

3. Using it where needed.

import { tricklingProgress } from '@/plugins/trickling-progress.ts'

// ...
// shows the Trickling progress bar
tricklingProgress.start()

// ...
// Then, completes the Trickling progress
tricklingProgress.done()

Using this configuration allows you to easily change the default trickle increasing curve. Thus, each Progress bar has different incremental expressions.

1. Default value

[
  { from: 0, to: 0.2, value: 0.1 },
  { from: 0.2, to: 0.5, value: 0.04 },
  { from: 0.5, to: 0.8, value: 0.02 },
  { from: 0.8, to: 0.99, value: 0.005 },
]

• from: This represents the starting range of the current progress status (including).
• to: This represents the end range of the current progress status (excluding).
• value: This represents the progress increment value of the current range.

2. Type definition see here.

• Function: If you use it as a function, should returns a number or array.
• Array: Just set it via a array.

1. Percentages: To set a progress percentage, call .set(n), where n is a number between 0..1.

trickling.set(0.0);     // Just same as .start()
trickling.set(0.4);
trickling.set(1.0);     // Just same as .done()

2. Incrementing: To increment the progress bar, just use .inc(). This increments it with a random amount. This will never get to 100%: use it for every image load (or similar).

trickling.inc();

3. If you want to increment by a specific value, you can pass that as a parameter:

trickling.inc(0.2);    // This will get the current status value and adds 0.2 until status is 0.994

4. Force-done: By passing true to done(), it will show the progress bar even if it's not being shown. (The default behavior is that .done() will not do anything if .start() isn't called).

trickling.done(true);

5. Get the status value: To get the status value, use .status.

trickling.status