Checklist Progress

approved

by acidghost

Automatically fill progress (as fraction or percentage) of check-lists.

11 stars2,984 downloadsUpdated 1y agoGPL-3.0
View on GitHub

Obsidian Checklist Progress

Simple Obsidian plugin to automatically update the progress in a list of tasks. Given, for example, the following note:

This is a list (/):
- [x] item one
- [ ] item two (%)
    - [ ] sub item one
    - [x] sub item two
- [x] item three

the command provided by this plugin will update it to

This is a list (2/3):
- [x] item one
- [ ] item two (50%)
    - [ ] sub item one
    - [x] sub item two
- [x] item three

providing the fraction / percentage of completed tasks in a sub-list.

Besides using a command to trigger the update (which you can bind to a keyboard shortcut), you can also enable auto-updating when toggling a checkbox in Obsidian Live Preview mode.

Additionally, adding a minus before the fraction or percentage symbol will count unchecked checkboxes. Example:

This is a list (-/):
- [x] item one
- [ ] item two
- [x] item three

will be updated to

This is a list (-1/3):
- [x] item one
- [ ] item two
- [x] item three

Inspiration

This is supposed to mimic a similar feature from Emacs's Org Mode.

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.