Skip to main content
userTourKit
@tour-kit/checklistsUtilities

Progress Utilities

Progress calculation utilities: compute completion percentages, remaining task counts, and estimated time to finish values

domidex01Published

Functions for working with checklist progress.

calculateProgress

Calculate progress for a checklist:

import { calculateProgress } from '@tour-kit/checklists';

const progress = calculateProgress(checklistState);
// { completed: 3, total: 5, percentage: 60, remaining: 2 }

getNextTask

Get the next incomplete, unlocked task:

import { getNextTask } from '@tour-kit/checklists';

const nextTask = getNextTask(checklistState);
if (nextTask) {
  console.log('Next:', nextTask.config.title);
}

getLockedTasks

Get all tasks locked by dependencies:

import { getLockedTasks } from '@tour-kit/checklists';

const locked = getLockedTasks(checklistState);
console.log(`${locked.length} tasks locked`);
Free & open source

Ship onboarding, not config.

npm i @tour-kit/core is MIT and free. The Pro packages work unlicensed too — a one-time $99 license removes the production watermark when you ship.

MIT-licensed — no signup, no credit card. Pay once, only when you ship.