Checklist Progress Bar

approved

by Adam Tweedie

Display a progress bar for your checklist (todo) items. - This plugin has not been manually reviewed by Obsidian staff.

389 downloadsUpdated 2mo ago0BSD

Checklist Progress Bar

Automatically display a live progress bar above any checklist block in your Obsidian notes.

Progress bar example


How It Works

Place a > [!progress] callout directly above a checklist block. The plugin will automatically calculate how many items are checked and update the progress bar in real time as you tick things off.

> [!progress] ███████████░░░░░░░░░ 9/16 (56%)

- [x] Set up project repository
- [x] Define initial requirements
- [ ] Design system architecture
- [ ] Implement core data models
...

No configuration needed — just drop in the callout and start checking things off.


Usage

  1. Open any note with a checklist
  2. Add the following line directly above your list:
> [!progress]
  1. The progress bar updates automatically as you check and uncheck items

Note: The > [!progress] line must appear directly before your checklist block. Items are counted from that line down to the next progress bar or end of file.


Features

  • Live updates on every keystroke — no need to reload or save
  • Supports nested checklist items at any indentation level
  • Multiple progress bars per note, each tracking its own block
  • Clean callout styling with both dark and light theme support
  • Zero configuration required

Installation

Via Community Plugins (recommended)

  1. Open Obsidian and go to Settings → Community Plugins
  2. Search for Checklist Progress Bar
  3. Click Install, then Enable

Manual

  1. Download the latest release from GitHub Releases
  2. Copy main.js, manifest.json, and styles.css into your vault at:
    <vault>/.obsidian/plugins/checklist-progress-bar/
    
  3. Restart Obsidian and enable the plugin under Settings → Community Plugins

Compatibility

  • Obsidian v1.0.0 and above
  • Works in both Live Preview and Reading mode

Feedback & Contributions

Found a bug or have a feature request? Open an issue on GitHub. Pull requests are welcome.

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.